Pileus Git - ~andy/fetchmail/blob - README.PWMD

   1 When compiled with pwmd (Password Manager Daemon) support (--enable-pwmd)
   2 fetchmail can retrieve server details from pwmd. pwmd v2.0 and libpwmd v6.0.0
   3 or later are required.
   4
   5 Three new configuration parameters are added: pwmd_socket (optional) to
   6 specify the socket to connect to (default is ~/.pwmd/socket), pwmd_file
   7 (required) which specifies the filename on the server to open, and a global
   8 parameter pinentry_timeout (optional) which specifies the number of seconds
   9 until pinentry is cancelled while waiting for the password.
  10
  11 Three new command line options are also added:
  12     --pwmd-socket, -C      same as pwmd_socket
  13     --pwmd-file, -G        same as pwmd_file
  14     --pinentry_timeout, -O same as pinentry_timeout
  15
  16 If no pinentry timeout value is specified then the server default will be
  17 used.
  18
  19 The format of pwmd_socket and --pwmd-socket can be either a URL string in the
  20 form of:
  21         file://[path/to/socket]
  22
  23         or
  24
  25         ssh[46]://[username@]hostname[:port],identity_file,known_hosts_file
  26
  27 If neither file:// or ssh[46]:// are specified it is assumed to be a local
  28 UNIX domain socket to connect to (file://~/.pwmd/socket).
  29
  30 See the pwmc(1) manual page for details about the identity and known_hosts
  31 files. Note that if connecting to a remote pwmd server, pwmd's pinentry will
  32 be disabled and a local pinentry will be tried.
  33
  34 The data that pwmd uses to serve clients is stored in an (encrypted) XML file.
  35 You'll need to create the file you want fetchmail to use by connecting to the
  36 server with a pwmd client (socat or pwmc from libpwmd) and send commands to
  37 store the data. See COMMANDS included with pwmd for details.
  38
  39 The password, if any, to open the encrypted data file is either cached on the
  40 server (the file has been opened before), or gotten from pinentry(1). See the
  41 pwmd(1) manual page for information about the ~/.pwmd/pinentry.conf file which
  42 may contain DISPLAY and TTYNAME settings to let pinentry(1) know where to
  43 prompt for the password.
  44
  45 An account (e.g., pollname) may be an element path. Instead of separating the
  46 elements with a TAB character, separate them with a '^'.
  47
  48 Here are the elements that fetchmail uses:
  49
  50     [...]elements in the element path (^ separated)[...]
  51     <pollname>
  52         <username>              - Optional (--username/username)
  53         <password>              - Optional (--password/password)
  54         <POP3|IMAP|etc..>       - Server protocol (must match the protocol
  55                                   keyword from the rcfile or command line)
  56             <hostname>          - Required (servername/via)
  57             <port>              - Required (--service/protocol)
  58             <ssl>               - Optional (--ssl/ssl)
  59             <sslfingerprint>    - Optional (--sslfingerprint/sslfingerprint)
  60         </POP3|IMAP|etc..>
  61     </pollname>
  62
  63
  64 A minimal fetchmailrc might look like this:
  65
  66     set pinentry_timeout 30
  67     poll isp proto POP3:
  68         pwmd_file default
  69
  70     poll myaccounts^isp proto IMAP:
  71         pwmd_file default
  72         pwmd_socket "ssh://user@host,~/.pwmd/fetchmail,~/.pwmd/known_hosts"
  73
  74
  75 Or from the command line:
  76
  77     fetchmail -f fetchmailrc isp
  78     fetchmail --pwmd-file somefile -p POP3 isp
  79
  80
  81 Ben Kibbey <bjk@luxsci.net>
  82 http://bjk.sourceforge.net/pwmd/.