Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vitalvas committed Mar 31, 2024
1 parent 28cd61e commit 702299c
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,36 @@
# GoPass

Simple password manager
GoPass is a simple password manager for the command line.

## Installation

```bash
go install -v github.com/vitalvas/gopass@latest
```

## GoPass vs Pass

GoPass is a simple password manager written in Go. It is inspired by [Pass](https://www.passwordstore.org/), but is not compatible with it for the storage layer.

Cli commands are as compatible as possible (about 90%), to preserve user experience

| Feature | GoPass | Pass |
| --- | --- | --- |
| Storage | Plugin backend | Encrypted files |
| Encryption | ChaCha20-Poly1305 | GPG |
| Encryption key | Yes | No |
| Encryption value | Yes | Yes |
| Password generation | Yes | Yes |
| Writed in | Go | Shell |

### Storage

* `file` - stores data in a tree structure of keys. Each file is an independent key.

## Security

GoPass uses the ChaCha20-Poly1305 algorithm for encryption. The system represents itself as a key-value store.

Encryption and decryption occurs on the cli side, which allows you to protect data during transmission and storage.

The key and values are encrypted in a special way. The key is encrypted using a hash from the correct phrase. The values are encrypted using a hash of the key and passphrase combination, which reduces the ability for an attacker to track key movements.

0 comments on commit 702299c

Please sign in to comment.