cloak

cloak 是一个用 Rust 编写的命令行 OTP（一次性密码）身份验证应用程序，可以生成基于时间和计数的 OTP 代码。

动机

• 为什么你不应该扫描两步验证 QR 码！
• 作为学习 Rust 编程语言的一种方式。
• 从我的终端复制 OTP 代码到登录表单比从我的手机复制到笔记本电脑更容易。

示例

安装

要安装 cloak，你可以执行以下任一操作

1. 二进制文件

   你可以从这里下载二进制文件 这里。请确保将二进制文件的路径添加到你的 PATH。

2. Crates.io

   安装 Rust 后，在终端中输入以下命令安装 cloak

   cargo install cloak
   

   这将下载并编译 cloak。完成后，将 Cargo bin 目录添加到你的 PATH。

使用方法

cloak 包含以下子命令

$ cloak -h
cloak 0.1.0
Evans Murithi <[email protected]>
A Command Line OTP Authenticator application.

USAGE:
    cloak [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    add               Add a new account
    delete            Delete an account
    help              Prints this message or the help of the given subcommand(s)
    list              List OTP for all accounts
    recovery_codes    View recovery codes for an account
    view              View the OTP for an account

要查看以下任何子命令的帮助，请添加 -h 或 --help，例如 cloak add -h。

• cloak add<account> <key>

  这将添加一个新账户。你需要提供账户名称以及有效的 base32 编码密钥。示例

  $ cloak add github 4AZJFQFIGYM2KMTOO72I6FAOZ6ZFWJR6
  

• cloak view<account>

  这将打印你想要查看的账户的 TOTP/HOTP。示例

  $ cloak view github
  123456
  

• cloak list

  这将打印所有账户及其相应的 TOTP/HOTP 代码。示例

  $ cloak list
  Account: github
  TOTP: 607091
  
  Account: gitlab
  TOTP: 325414
  

• cloak delete<account>

  这将删除一个账户。一旦删除，你将无法查看该账户的 OTP 代码。示例

  $ cloak delete github
  Account successfully deleted
  $ cloak view github
  Account with the name 'github' does not exist. Consider adding it.
  

• cloak recovery_codes<account>

  这将打开一个文件，使用你喜欢的编辑器保存新的恢复代码或查看现有的恢复代码。

贡献

如果你想为 cloak 做贡献，你必须在本地机器上克隆仓库

$ git clone https://github.com/evansmurithi/cloak.git

要构建，请在 cd 到 cloak/ 并运行

$ cargo build

要运行测试

$ cargo test