The file cache is now locked with a mutex to prevent other processes
[pwmd.git] / README
blob2b6c6c33e0323b2ac3e809b66b393693b38766bb
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     * Shared memory key cache supporting multiple files.
6     * Server configuration file which supports file specific settings
7       including encryption iterations, cache expiration, and encryption key or
8       key file.
9     * Compressed data file support.
10     * Secure memory usage. PWMD will zero out memory before freeing it.
12 I needed this because I use a few applications that require the same
13 credentials but hate having to update all those configuration files to reflect
14 any changes in the account. This way, there is a central location for the
15 data.
17 Requirements:
19     libassuan    - http://www.gnupg.org
20                    Protocol.
22     libgpg-error - http://www.gnupg.org
23                    Error handling.
25     glib2        - http://www.gtk.org
26                    Portability library among other things.
28     libxml2      - http://xmlsoft.org
29                    For XML parsing and data manipulation.
31     libgcrypt    - http://www.gnupg.org
32                    Encryption, decryption and hashing.
34     libz         - http://www.zlib.net
35                    For compressing the data file. Optional.
37 Debian has packages for all of these. Your distro may have them too.
39 You can test it out by connecting to the socket with the socat utility
40 (http://www.dest-unreach.org/socat/). Start the daemon then run socat:
42     socat GOPEN:$HOME/.pwmd/socket -
44 There is a library available (see below) that makes it easy for other
45 applications (mail, www, etc) to use the server. A command line client is
46 included that reads protocol commands from stdin and handles password
47 retrieval.
49 The latest version of the server and library can be found at
50 http://bjk.sourceforge.net/pwmd/.
52 Read COMMANDS for protocol commands and syntax. Send me patches or any ideas
53 you may have.
55 Ben Kibbey <bjk@luxsci.net>