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 Some of the features include:
   5
   6     * Multi-threaded. More than one client may access the data at the same
   7       time.
   8     * Optional data file encryption with a configurable cipher.
   9     * A key cache so clients won't need to enter a key each time a file is
  10       opened or saved.
  11     * Key retrieval via pinentry(1).
  12     * Local Unix Domain Socket connections which can safely be accessed
  13       remotely over an SSH channel when using libpwmd(3).
  14     * Configuration file which supports file specific settings including:
  15       encryption iterations, cache expiration and encryption key or key file
  16       and more.
  17     * Compressed data file support.
  18     * Logging to file and/or syslog.
  19     * Secure memory usage. PWMD will zero out memory before freeing it and
  20       also has the option to lock the entire process in RAM to avoid swapping
  21       the data to virtual memory.
  22
  23 I needed this because I use a few applications that require the same
  24 credentials but hate having to update all those configuration files to reflect
  25 any changes. This way, there is a central location for the needed data.
  26
  27 Requirements:
  28 -------------
  29     C99 compiler - http://www.gnu.org/software/gcc
  30                    Is a good choice.
  31
  32     libpth2      - http://www.gnu.org/software/pth/pth.html
  33                    Portable multi-threading library.
  34
  35     libgpg-error - http://www.gnupg.org
  36                    Error handling.
  37
  38     glib2        - http://www.gtk.org
  39                    Portability library among other things. Version 2.16.0 or
  40                    later is required.
  41
  42     libxml2      - http://xmlsoft.org
  43                    For XML parsing and data manipulation.
  44
  45     libgcrypt    - http://www.gnupg.org
  46                    Encryption, decryption and hashing.
  47
  48     libz         - http://www.zlib.net
  49                    For compressing the data file. Version 1.2.2.1 or later is
  50                    required.
  51
  52     pinentry     - http://www.gnupg.org/aegypten
  53                    There are various interfaces for password entry:
  54                    console/curses, X11/GTK2, X11/QT. The X11 versions also
  55                    support console/curses. Version 0.7.5 or later is required
  56                    unless --disable-pinentry is passed to ./configure.
  57
  58     cracklib2    - http://sourceforge.net/projects/cracklib
  59                    If --enable-quality is passed to ./configure then a
  60                    password quality meter is used with pinentry. Optional.
  61
  62     libacl       - ftp://acl.bestbits.at
  63                    To retain an ACL for a data file. Optional.
  64
  65 Installation:
  66 -------------
  67 ./configure && make install
  68
  69 If the build succeeded run 'pwmd'. This will start the server and wait for
  70 connections to ~/.pwmd/socket.
  71
  72
  73 Connecting:
  74 -----------
  75 Any program that can connect to a UNIX domain socket will work:
  76
  77     socat UNIX-CONNECT:$HOME/.pwmd/socket -
  78     echo command | pwmc filename
  79
  80 Libpwmd is a library making it easy for applications to use pwmd. There is
  81 also a command line pwmd client "pwmc" included. You can find it at the pwmd
  82 homepage.  There are also some patches already written (some could use
  83 improvement) for a few apps too.
  84
  85 Read COMMANDS for protocol commands and syntax.
  86
  87
  88 GIT Repository
  89 --------------
  90 There is a public GIT repository available at repo.or.cz. Anonymous checkouts
  91 can be done by:
  92
  93     git clone git://repo.or.cz/pwmd.git
  94
  95 The gitweb interface can be viewed at http://repo.or.cz/w/pwmd.git.
  96
  97
  98 Please feel free to send me any patches, bug reports or feature requests.
  99
 100 Ben Kibbey <bjk@luxsci.net>
 101 Jabber: bjk AT thiessen DOT org - (bjk) FreeNode/OFTC
 102 http://pwmd.sourceforge.net/