File: README.md

package info (click to toggle)
kickpass 0.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 548 kB
  • sloc: ansic: 4,018; python: 402; sh: 15; makefile: 5
file content (69 lines) | stat: -rw-r--r-- 2,094 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
[![Build Status](https://travis-ci.org/paulfariello/kickpass.svg?branch=develop)](https://travis-ci.org/paulfariello/kickpass)
Kickpass
========

Kickpass is a stupid simple password safe. It keep each password in a specific
safe, protected with modern cryptography. Its main user interface is command
line.

Full documentation is available throught manual page ``kickpass(1)``:
```bash
man 1 kickpass
```

Quick help looks like:
```bash
usage: kickpass [-hv] <command> [<cmd_opts>] [<args>]

options:
    -h, --help     Print this help
    -v, --version  Print kickpass version

commands:
    help <command>               Print help for given command
    init                         Initialize a new password safe directory. Default to ~/.kickpass
    create [-hgl] <safe>         Create a new password safe
    open <safe>                  Open a password safe and print its content on stdout
    edit [-pm] <safe>            Edit a password safe with $EDIT
    copy <safe>                  Copy a password (first line of safe) into X clipboard
    list                         List available safes
    delete <safe>                Delete a password safe after password confirmation
    rename <old_safe> <new_safe> Rename a password safe
```

Features
--------

 * One password to rule them all
 * One password to find them
 * One password to bring them all
 * Integrated password generator
 * Full text metadata with your favorite editor
 * Strong encryption: AEAD with chacha20 and poly1305
 * Direct copy to X selection and clipboard

Examples
--------

```bash
$ kickpass create -g www/github.com
[kickpass] master password:

$ kickpass cat www/github.com
url: https://www.github.com
username: paulfariello

$ kickpass copy www/github.com
$
```

Technical overview
------------------

Kickpass is built around a shared library named libkickpass.

libkickpass leverage [libsodium](https://libsodium.org/) to create safes.

Safes are created using authenticated encryption with associated data. As of
now libkickpass use chacha20 along with poly1305 to encrypt and authenticate
the safe.