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 There is an included command line client 'pwmc' that reads protocol commands
  10 from stdin and sends them to the pwmd server. Read libpwmd(3) or pwmc(1) for
  11 all the details.
  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 pwmc. Optional.
  26
  27     pwmd         - http://bjk.sourceforge.net/pwmd/
  28                    Version 2.18 or later.
  29
  30 If you want to do remote SSH connections to a pwmd server:
  31
  32     libssh2      - http://libssh2.org/
  33                    Version 1.2.7 or later is required.
  34
  35     libc-ares    - http://c-ares.haxx.se/
  36                    For asynchronous DNS lookups. Version 1.5.2 has been tested
  37                    to work.
  38
  39 For functions that use a local pinentry (and not pwmd's pinentry) and if
  40 --disable-pinentry is not passed to configure, then you'll need:
  41
  42     pinentry     - ftp://ftp.gnupg.org/gcrypt/pinentry/
  43                    There are various interfaces for passphrase entry:
  44                    console/curses, X11/GTK2, X11/QT. The X11 versions also
  45                    support console/curses. Version 0.7.5 or later is required.
  46
  47     cracklib2    - http://sourceforge.net/projects/cracklib
  48                    If --enable-quality is passed to ./configure then a
  49                    passphrase quality meter is used with the local pinentry.
  50                    Optional.
  51
  52
  53 GIT Repository
  54 --------------
  55 There is a public GIT repository available at repo.or.cz. Anonymous checkouts
  56 can be done by:
  57
  58     git clone git://repo.or.cz/libpwmd.git
  59
  60 The gitweb interface can be viewed at http://repo.or.cz/w/libpwmd.git.
  61
  62 Ben Kibbey <bjk@luxsci.net>
  63 http://bjk.sourceforge.net/pwmd/.