Skip to content

Commit

Permalink
chore: bump version, update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
anssip committed Jul 6, 2024
1 parent 474a2c3 commit d7471fd
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 38 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog

## [2.4.1]

- Fix to validate all input from the command line to be stored (to remove all characters not allowed in Keepass XML)
- Show last modified date for each entry in the results tables
- Fix to store OTPs as protected values in the Keepass file

## [2.4.0]

- Added support for TOTP (Time-based One-Time Password) codes
Expand Down
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[package]
name = "passlane"
version = "2.4.0"
version = "2.4.2"
edition = "2021"
authors = ["Anssi Piirainen <anssip@email.com>"]
license = "GPL-3.0-or-later"
description = "A password manager for the command line"
description = "A password manager and authenticator for the command line"
readme = "README.md"
homepage = "https://github.com/anssip/passlane"
repository = "https://github.com/anssip/passlane"
Expand Down
69 changes: 34 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

![passlane-logo-small](https://github.com/anssip/passlane/assets/271711/6041f6fb-816f-43e9-b54c-325180addef1)

A password manager CLI using Keepass as the storage backend. In addition to passwords, it supports
**authenticator functionality** with Timed One Time Passwords (TOTP), secure saving and managing of
**payment cards** and **secure notes**.
A password manager and authenticator CLI using Keepass as the storage backend. In addition to passwords, it supports
**authenticator functionality** with Timed One Time Passwords (TOTP), secure saving and managing of
**payment cards** and **secure notes**.

Passlane uses the Keepass encrypted file format for storing the data.

Expand Down Expand Up @@ -66,8 +66,8 @@ See below for more information on how to use the CLI.
### First time setup

When you run Passlane for the first time, it will create a new vault file at `~/.passlane/store.kdbx`. This is a
Keepass compatible file that stores all your passwords, payment cards, and secure notes. You will be asked to enter a
master password that will be used to encrypt the vault contents. You can also store the master password in your
Keepass compatible file that stores all your passwords, payment cards, and secure notes. You will be asked to enter a
master password that will be used to encrypt the vault contents. You can also store the master password in your
computer's keychain to avoid typing it every time, see below for more info.

You can also move the vault file to the cloud allowing access from all your devices. [See below for more info](#syncing-data-to-your-devices).
Expand Down Expand Up @@ -149,21 +149,21 @@ Run `passlane show foobard.com` --> shows foobar.com's password and also copies
If the search finds more than one matches:

```bash
$ passlane show google.com
Found 9 matches:
+---+--------------------------------+------------------------------------+
| | Service | Username/email |
+=========================================================================+
| 0 | https://accounts.google.com | jack@megacorp.com |
|---+--------------------------------+------------------------------------|
| 1 | https://accounts.google.com | jack1p@gmail.com |
|---+--------------------------------+------------------------------------|
| 2 | https://accounts.google.com | jck@hey.com |
|---+--------------------------------+------------------------------------|
| 3 | https://accounts.google.com | jackrussel@gmail.com |
|---+--------------------------------+------------------------------------|
To copy one of these passwords to clipboard, please enter a row number from
the table above, or press q to exit: 3
➜ bin passlane show google
Unlocking vault...
Found 6 credentials:
+---+-----------------------------------------------------+--------------------------------+------------------+
| | Service | Username/email | Modified |
+=============================================================================================================+
| 0 | https://accounts.google.com/signin/v2/challenge/pwd | anssi@amm.co.jp | 23.04.2024 14:15 |
|---+-----------------------------------------------------+--------------------------------+------------------|
| 1 | google.com | anssi.piirainen@flowplayer.com | 23.04.2024 14:15 |
|---+-----------------------------------------------------+--------------------------------+------------------|
| 2 | google.com | anssip | 23.04.2024 14:15 |
|---+-----------------------------------------------------+--------------------------------+------------------|
| 3 | google.com | anssi@carbon.video | 23.04.2024 14:15 |
+---+-----------------------------------------------------+--------------------------------+------------------+
To copy one of these passwords to clipboard, please enter a row number from the table above, or press q to exit: 3
Password from index 3 copied to clipboard!
```

Expand All @@ -172,15 +172,15 @@ Password from index 3 copied to clipboard!
To list all your saved payment cards.

```bash
passlane show -p

➜ bin passlane show -p
Unlocking vault...
Found 1 payment cards:
+---+---------------+-------+--------+--------+
| | Name | Color | Last 4 | Expiry |
+=============================================+
| 0 | Personal Visa | White | 1234 | 9/25 |
+---+---------------+-------+--------+--------+
Do you want to see the card details? (y/n) y
+---+----------------------+-------+--------+------------------+
| | Name | Color | Expiry | Modified |
+==============================================================+
| 0 | Visa Gold (personal) | Gold | 6/2025 | 06.07.2024 10:51 |
+---+----------------------+-------+--------+------------------+
Do you want to see the full card details? (y/n)
```

To save a payment card:
Expand Down Expand Up @@ -224,12 +224,12 @@ you gain the benefit of two-factor authentication. You don't want to store these
Here is an example where teh totp vault file is stored in Dropbox:

```bash
~/.passlane > cat .totp_vault_path
/Users/anssi/Dropbox/stuff/totp.kdbx
~/.passlane > cat .totp_vault_path
/Users/anssi/Dropbox/stuff/totp.kdbx
```

The TOTP vault has a separate master password that you need to enter when you access the one time passwords.
You can also store the master password in your computer's keychain to avoid typing it every time. Use
The TOTP vault has a separate master password that you need to enter when you access the one time passwords.
You can also store the master password in your computer's keychain to avoid typing it every time. Use
the unlock command with the `-o` option for this purpose.

```bash
Expand Down Expand Up @@ -317,9 +317,9 @@ passlane export -n notes.csv

## Syncing data to your devices

You can place the vault file to a cloud storage service like Dropbox, Google Drive, or iCloud Drive.
You can place the vault file to a cloud storage service like Dropbox, Google Drive, or iCloud Drive.
This way you can access your passwords from all your devices.
By default, Passlane assumes that the file is located at `~/.passlane/store.kdbx`.
By default, Passlane assumes that the file is located at `~/.passlane/store.kdbx`.
You can change the location by storing the file path in a text file called `.vault_path` at the `~/.passlane/` directory.

For example, this shows how John has stored the path `/Users/john/Dropbox/Stuff/store.kdbx` to the `.vault_path` file:
Expand All @@ -337,4 +337,3 @@ There are several other Keepass compatible applications that you can use to acce
- [KeepassXC-Browser](https://github.com/keepassxreboot/keepassxc-browser)
- [KeePassium](https://keepassium.com/) is a mobile application for iOS
- ... and many others

0 comments on commit d7471fd

Please sign in to comment.