Updated Debian package description.
[pwmd.git] / README
blob47c3adcc070d517dd8d559f2755a7b26049069e0
1 Password Manager Daemon is a server that provides a way to securely store
2 data. The data is saved in an AES256 encrypted XML file. Here are some of the
3 features:
5     * Multi-threaded.
6     * Shared memory key cache supporting multiple files and protected with a
7       mutex.
8     * Configuration file which supports file specific settings including
9       encryption iterations, cache expiration, and encryption key or key file.
10     * Compressed data file support.
11     * Secure memory usage. PWMD will zero out memory before freeing it.
13 I needed this because I use a few applications that require the same
14 credentials but hate having to update all those configuration files to reflect
15 any changes in the account. This way, there is a central location for the
16 data.
18 Requirements:
20     pth          - http://www.gnu.org/software/pth/pth.html
21                    Portable multi-threading library.
23     libassuan    - http://www.gnupg.org
24                    Protocol.
26     libgpg-error - http://www.gnupg.org
27                    Error handling.
29     glib2        - http://www.gtk.org
30                    Portability library among other things.
32     libxml2      - http://xmlsoft.org
33                    For XML parsing and data manipulation.
35     libgcrypt    - http://www.gnupg.org
36                    Encryption, decryption and hashing.
38     libz         - http://www.zlib.net version 1.2.2.1 or later
39                    For compressing the data file.
41 Debian has packages for all of these. Your distro may have them too.
44 You can test it out by connecting to the socket with the socat utility
45 (http://www.dest-unreach.org/socat/). Start the daemon then run socat:
47     socat GOPEN:$HOME/.pwmd/socket -
49 There is also a library available that makes it easy for other applications
50 (mail, www, etc) to use the server. Read COMMANDS for protocol commands and
51 syntax. Send me patches or any ideas you may have.
53 Ben Kibbey <bjk@luxsci.net>
54 http://bjk.sourceforge.net/pwmd/