README

   1 This is a library making it easy to patch applications to send commands to
   2 PWMD. Features include:
   3
   4         * Thread safe: POSIX or libpth2
   5         * Asynchronous pinentry when threading isn't possible
   6         * Secure remote connections over SSH using libssh2
   7         * Secure memory functions which applications may 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 (and pwmd) returns gpg error codes.
  20
  21     libpth2      - http://www.gnu.org/software/pth/pth.html
  22                    Portable multi-threading library. Optional.
  23
  24     libreadline  - http://www.gnu.org/software/readline/
  25                    For an interactive shell-like interface to the connection.
  26                    Optional.
  27
  28     pwmd         - http://bjk.sourceforge.net/pwmd/
  29                    Version 2.18 or later.
  30
  31 If you want to do remote SSH connections to a pwmd server:
  32
  33     libssh2      - http://libssh2.org/
  34                    Version 1.2.8 or later is required.
  35
  36     libc-ares    - http://c-ares.haxx.se/
  37                    For asynchronous DNS lookups. Version 1.5.2 has been tested
  38                    to work.
  39
  40 For functions that use a local pinentry (and not pwmd's pinentry) and if
  41 --disable-pinentry is not passed to configure, then you'll need:
  42
  43     pinentry     - ftp://ftp.gnupg.org/gcrypt/pinentry/
  44                    There are various interfaces for passphrase entry:
  45                    console/curses, X11/GTK2, X11/QT. The X11 versions also
  46                    support console/curses. Version 0.7.5 or later is required.
  47
  48     cracklib2    - http://sourceforge.net/projects/cracklib
  49                    If --enable-quality is passed to ./configure then a
  50                    passphrase quality meter is used with the local pinentry.
  51                    Optional.
  52
  53
  54 GIT Repository
  55 --------------
  56 There is a public GIT repository available at repo.or.cz. Anonymous checkouts
  57 can be done by:
  58
  59     git clone git://repo.or.cz/libpwmd.git
  60
  61 The gitweb interface can be viewed at http://repo.or.cz/w/libpwmd.git.
  62
  63 Ben Kibbey <bjk@luxsci.net>
  64 http://bjk.sourceforge.net/pwmd/.