1// -*- adoc -*-
2= YAPET - Yet Another Password Encryption Tool 2.3
3Rafael Ostertag <rafi@guengel.ch>
4
5== Introduction
6
7YAPET is a text based password manager using the AES-256 encryption
8algorithm to store passwords and associated information encrypted on
9disk. Its primary aim is to provide a safe way to store passwords in a
10file on disk while having a small footprint, and compiling and running
11under today's most popular Unix Systems.
12
13The password records are protected by a master password which is used
14to encrypt and decrypt the password records.
15
16== Supported Platforms
17
18YAPET has been tested on following platforms:
19
20* FreeBSD
21* OpenBSD
22* NetBSD
23* Linux
24
25== Features
26
27YAPET features:
28
29* AES-256 encryption.
30* Passwords are not kept clear text in memory.
31* Locks the terminal on inactivity.
32* Utilities to convert to and from CSV format.
33* Built-in password generator.
34
35Depends only on three libraries:
36
37* http://www.openssl.org/[OpenSSL]
38* Curses or http://www.gnu.org/software/ncurses/[Ncurses]
39* https://github.com/P-H-C/phc-winner-argon2[Argon2]
40
41
42CAUTION: Although several precautions were taken to avoid having any
43  passwords stored clear text in memory, there were occasions when
44  core files contained the master password. This means that it is
45  possible, though not likely, for a malicious user to get hold of one
46  or more passwords *while* YAPET is running.
47
48