README

   1 This is a library making it easy to patch applications to send commands to
   2 PWMD. Features include:
   3
   4         * Thread safe (libpth2 supported)
   5         * Asynchronous pinentry when threading isn't available
   6         * Secure remote connections over SSH using libssh2
   7         * Secure memory management which applications can also use
   8
   9 Read libpwmd.h or libpwmd(3) for all the details. There is an included
  10 command line client 'pwmc' that reads protocol commands from stdin and sends
  11 them to the pwmd server.
  12
  13
  14 Requirements:
  15     C99 compiler - http://www.gnu.org/software/gcc/
  16                    Is a good choice.
  17
  18     libgpg-error - http://www.gnupg.org/
  19                    libassuan returns gpg error codes.
  20
  21     libpth2      - http://www.gnu.org/software/pth/pth.html
  22                    Portable multi-threading library. Optional.
  23
  24     pwmd         - http://bjk.sourceforge.net/pwmd/
  25                    Version 1.11 or later.
  26
  27 If you want to do remote SSH connections:
  28
  29     libssh2      - http://libssh2.org/
  30                    Version 1.0 has been tested to work.
  31
  32     libc-ares    - http://c-ares.haxx.se/
  33                    For asynchronous DNS lookups. Version 1.5.2 has been tested
  34                    to work.
  35
  36 For functions that require a local pinentry (and not pwmd's pinentry) and if
  37 --disable-pinentry is not passed to configure, then you'll need:
  38
  39     pinentry     - ftp://ftp.gnupg.org/gcrypt/pinentry/
  40                    There are various interfaces for passphrase entry:
  41                    console/curses, X11/GTK2, X11/QT. The X11 versions also
  42                    support console/curses. Version 0.7.5 or later is required.
  43
  44
  45 GIT Repository
  46 --------------
  47 There is a public GIT repository available at repo.or.cz. Anonymous checkouts
  48 can be done by:
  49
  50     git clone git://repo.or.cz/libpwmd.git
  51
  52 The gitweb interface can be viewed at http://repo.or.cz/w/libpwmd.git.
  53
  54 Ben Kibbey <bjk@luxsci.net>
  55 http://bjk.sourceforge.net/pwmd/.