1 unstable release

0.0.1 Jun 1, 2021

#36 in #secure-password

MIT license

5KB
56 lines

🔑 ky

Simple & Secure password manager

build crates.io

EXPERIMENTAL: This project is very much in development and can introduce breaking changes at any moment. Also, I am not an expert in cryptography, if you know something about cryptography then I will be more than happy to recieve your feedback.

🚀 Installation

Using cargo (Linux/macOS/Windows)

Using yay or pamac (Arch Linux)

# Using `yay`
yay -S ky

# Using `pamac`
pamac build ky

Using release binaries (Linux/macOS/Windows)

Check out the release page for prebuild binaries for ky, available for different operating systems.

🤞 Usage

Global Options/Flags

Options Env Variable Description
--vault-path KY_VAULT_DIR Path for the backup/export directory
--backup-path KY_BACKUP_DIR Path for the vault directory
--git-repo KY_GIT_REPO Git repo used as a storage for backup
--git-branch KY_GIT_BRANCH Default branch for the git repo
Flags Description
--version Prints the version
--help Prints the help doc

Basics

  • Getting HELP

If you wanna deep dive to undertand every command, options and flags. ky help or ky --help if your friend. help command and --help flag is also available for all the subcommands.

  • Initializing the vault (required)

Everything is stored in a small lmdb database. Hence, it is required to initialized the vault before saving your password. To initialize the vault run ky init. After running this, you will be prompted for a master password, make sure you enter a strong and memorable password, as this will be required for every other action afterwards.

ky init

# help
ky init --help
  • Adding an entry

So, you want to create/add a password, just run ky add with a key which will act as a unique id. After that, you will be asked to enter more details like username, website, expiry-date, notes, which are totally optional for now. After recieving all the details, those will be encrypted with master password and saved into the vault.

Remember, password will be auto generated and encrypted with the rest of the details.

ky add <key>

# help
ky add --help
  • Showing an entry

Hmmm...You have added an entry. Now you want to see it. You can do that by running ky show with the key. If the key is valid, then the data associated with the key will be decrypted and printed to the stdout.

By default, the password will not decrypted and will shown as hidden. You need to pass --clear flag to show the password in clear text.

You can also print the password in a qr-code format by adding --qr-code flag.

ky show <key> # password will be hidden
ky show <key> --clear # now password will shown
ky show <key> --qr-code --mute # only print qr-code

# help
ky show --help
  • Editing an entry

Oh ho! Made some mistake or want to update the details. Fear not, just run ky edit with the key and go through the prompts similar to adding an entry.

By default, password will not touched. But, if you want to regenerate the password, just add --password flag then password will be regenerated at the end. Sadly, you can't manually update or edit the password.

ky edit <key> # just edit the details
ky edit <key> # edit details and also regenerate password

# help
ky edit --help
  • List all the entry

Just run ky list to list all the entries saved in the vault. This will only show you the keys without touching the details associated with the respective key.

ky list

# help
ky list --help
  • Renaming the key

For some reason you want to change the key or you made some type and you want to fix that. Run ky move provided with old key and new key. Your data will be decrypted using old key and re-encrypted using the new key combined with the master password, and saved in the vault.

ky move <old_key> <new_key>

# help
ky move --help
  • Deleting an entry

If you no longer needed a saved password, then run ky remove provided with the key to remove the entry from the vault. This action is permanent.

ky remove <key>

# help
ky remove --help

Backup/Restore

  • Backup the vault

Sometimes you want to backup the whole vault, maybe to setup the vault on a different machine. You can use ky backup optionally providing a path, which will take the whole vault and other required files, compresses as it is and make a backup file to restore at later point in time.

Keep in mind, that the vault data are totally untouched i.e hashed and encrypted. So, all the data like master password and other passwords, will be the same when you restore the backup vault.

ky backup # backup vault in the default backup path
ky backup -p <path> # backup in provided path

# help
ky backup --help
  • Restore the vault

Backup is done, now you need to restore that backup. Run ky restore to restore the vault backup, you can also provide a custom path where the backup is stored. Everything will be restored i.e hashed and encrypted, as it was before the backup like nothing is changed.

ky restore # restore from default path
ky restore -p <path> # restore from the provided path

# help
ky restore --help
  • Export the vault

Making a decrypted export of your vault is also possible and very easy. Just run ky export optionally providing a export path, and now you will have csv file with all the data decrypted inside it.

Beware that all the data is in clear text and anyone with the access to the export file will be able to read your passwords.

ky export # export in the default path
ky export -p <path> # export in provided path

# help
ky export --help
  • Import the vault

You can import your exported data or also any csv file which is in a certain format. While import, you'll be asked for a master password and all the data will be encrypted using the master password and after encrypting, everything will be saved in the vault.

ky import # import from the default path
ky import -p <path> # import from the provided path

# help
ky import --help

Git

ky supports git as a way to track and making a backup of your vault using a git repository. Which is very useful for backing and restoring your password vault, if you frequently use multiple machines. Although it is not a replacement for git, but it depends on git.

To use this feature there are few things to consider:

1. Git has to be installed on your machine
2. Repo name is retrieved from either `KY_GIT_REPO` env variable or `--git-repo` option.
3. Similarly, branch name is retrieved from either `KY_GIT_BRANCH` env variable or `--git-branch` option.

Git commands are present under the ky git subcommand. So, let have a look at those

# help
ky git --help
  • Initialize

Just like git init, You can run ky git init to a initialize a git repository, which initializes and make a first commit. Optionally, you can also push after the first comit.

ky git init # init and make first commit
ky git init -p # init, commit, and push

# help
ky git init --help
  • Backup

Making backup using git is like pushing your changes, under the hood it uses git {add,commit,push}. Run ky git backup to commit and push your database changes to the repository.

ky git backup # commit and push
ky git backup -n # don't commit, only push

# help
ky git backup --help
  • Restore

You can also restore the vault using git, under the hood it uses git clone. Run ky git restore to clone and restore the vault from the repository.

ky git restore

# help
ky git restore --help

Misc

  • Random password

You can also generate a random and cryptographically strong password. Run ky gen to generated the password. ky add also utilizes the same underlying function to generate the random password.

By default, the length of password is 20 but you can that by passing --length option.

ky gen # generate 20 char password
ky gen -l 25 # generate 25 char password
ky gen -l 25 --qr-code # generate and also print a qr-code

# help
ky gen --help
  • Deleting vault

DON'T USE THIS. This is just for convenience, if you ever wanted to delete your vault permanently.

ky nuke
ky nuke --all # delete vault and backups
  • Shell completions

You can generate completions for different shells that are listed below.

# For bash
ky completions bash

# For zsh
ky completions zsh

# For fish
ky completions fish

# For Elvish
ky completions elvish

# Windows Powershell
ky completions pwsh

🔧 Building

ky is written in Rust, so you'll need to install the latest Rust toolchain in order to compile it. Visit rustup.rs to download the toolchain.

To build ky:

  • Setup
git clone https://github.com/numToStr/ky

cd ky
  • Running
# same as `ky help`
cargo run -- help

# same as `ky init`
cargo run -- init
  • Build
# debug build
cargo build

# release build
cargo build --release

🚗 Roadmap

  • ky-reinit
  • ky-session
  • ky-purge

💐 Credits

  • This video for giving me idea of how password manager actually works.
  • kure for giving a blueprint for the CLI
  • And, Thanks to all the crates that have used to make this application.

Dependencies

~26MB
~537K SLoC