README

   1 Password Manager Daemon is a server that provides a way for applications to
   2 securely store and retrieve data at a centralized location. The data is stored
   3 in an XML file and clients connect and send commands to manipulate the data.
   4
   5 I needed this because I use a few applications that require the same
   6 credentials but hate having to update all those configuration files to reflect
   7 any changes. This way, there is a central location for the needed data.
   8
   9 Some of the features include:
  10
  11     * Multi-threaded. More than one client may access the data at the same
  12       time.
  13     * Optionally uses the GnuPG Agent for key caching and smartcard support.
  14     * Remote network connctions via GnuTLS or SSH via a proxy using libpwmd(3).
  15     * Configuration file which supports file specific settings including:
  16       cache expiration and encryption key or key file and more.
  17     * Logging to file and/or syslog.
  18     * Secure memory usage. PWMD will zero out memory before freeing it and
  19       also has the option to lock the entire process in RAM to avoid swapping
  20       the data to virtual memory.
  21
  22
  23 Requirements:
  24 -------------
  25     C99 compiler - http://www.gnu.org/software/gcc
  26                    Has been tested to work. Others should work fine, too.
  27
  28     libassuan    - ftp://ftp.gnupg.org/gcrypt/libassuan
  29                    Protocol. Version 2.0.2 or later is required.
  30
  31     libgpg-error - http://www.gnupg.org
  32                    Error handling. Required.
  33
  34     gpg-agent    - http://www.gnupg.org
  35                    Keypair generation, decryption and caching. Version 2.1.0
  36                    or later is required when --no-agent is not specified.
  37
  38     pinentry     - http://www.gnupg.org
  39                    Required for passphrase retrieval from either gpg-agent or
  40                    pwmd itself.
  41
  42     libxml2      - http://xmlsoft.org
  43                    For XML parsing and data manipulation.
  44
  45     libgcrypt    - http://www.gnupg.org
  46                    Encryption and hashing. Version 1.5.0 or later is required.
  47
  48     libz         - http://www.zlib.net
  49                    For data file conversion. Version 1.2.2.1 or later is
  50                    required.
  51
  52     libgnutls    - http://www.gnu.org/software/gnutls/
  53                    For encrypted connections over a TCP network. Optional.
  54
  55     libacl       - ftp://acl.bestbits.at
  56                    To retain an ACL for a data file. Optional.
  57
  58
  59 Installation:
  60 -------------
  61 ./configure && make install
  62
  63 Typing 'pwmd' will start the server and wait for connections to
  64 ~/.pwmd/socket. Be sure gpg-agent is running (see manual). Passing
  65 --allow-preset-passphrase to gpg-agent is recommended and
  66 --allow-loopback-pinentry is required if using a keyfile.
  67
  68
  69 Connecting:
  70 -----------
  71 Any program that can connect to a UNIX domain socket will work although using
  72 pwmc, a client included with libpwmd, is recommended:
  73
  74     echo command | pwmc filename
  75 or interactively
  76     pwmc filename
  77 or
  78     socat UNIX-CONNECT:$HOME/.pwmd/socket -
  79
  80 Please read the pwmd.info manual for protocol commands, syntax and
  81 configuration details.
  82
  83
  84 GIT Repository
  85 --------------
  86 There is a public GIT repository available at repo.or.cz. Anonymous checkouts
  87 can be done by:
  88
  89     git clone git://repo.or.cz/pwmd.git
  90
  91 The gitweb interface can be viewed at http://repo.or.cz/w/pwmd.git.
  92
  93
  94 Please feel free to send me any patches, bug reports or feature requests.
  95
  96 Ben Kibbey <bjk@luxsci.net>
  97 XMPP: bjk@jabber.org
  98 http://pwmd.sourceforge.net/