doc/pwmd.1

   1 .\" This program is free software; you can redistribute it and/or modify
   2 .\" it under the terms of the GNU General Public License as published by
   3 .\" the Free Software Foundation; either version 2 of the License, or
   4 .\" (at your option) any later version.
   5 .\"
   6 .\" This program is distributed in the hope that it will be useful,
   7 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
   8 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   9 .\" GNU General Public License for more details.
  10 .\"
  11 .\" You should have received a copy of the GNU General Public License
  12 .\" along with this program; if not, write to the Free Software
  13 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  14 .de URL
  15 \\$2 \(laURL: \\$1 \(ra\\$3
  16 ..
  17 .if \n[.g] .mso www.tmac
  18 .TH PWMD 1 "13 Jan 2007" "Password Manager Daemon" "Password Manager Daemon"
  19 .SH NAME
  20
  21 pwmd \- local socket data server
  22 .SH SYNOPSIS
  23 .B pwmd
  24 [\-hv] [\-f <rcfile>] [\-I <filename>]
  25
  26 .SH DESCRIPTION
  27 .B pwmd
  28 is a daemon that listens for connections on a local socket. Clients connect to
  29 the server and can get or modify "account" data. The word "account" is just a
  30 placeholder for the element describing and item. But what the data actually is
  31 can be anything. The data is stored in an AES encrypted XML file.
  32
  33 .SH OPTIONS
  34 .TP
  35 .I "\-f rcfile"
  36 Specify an alternate configuration file. The default is \fB~/.pwmdrc\fR.
  37 .TP
  38 .I "\-I filename"
  39 Import an XML file prompting for a key to use for encryption. The encrypted
  40 data will be written to stdout.
  41 .TP
  42 .I "\-v"
  43 Version information.
  44 .TP
  45 .I "\-h"
  46 Help text.
  47
  48 .SH CONFIGURATION FILE
  49 Blank lines and lines beginning with '#' are ignored. The file requires a
  50 group of options named "default". Groups are declared with [groupname]. Only
  51 the group "default" will be used. If the first character of a string value is
  52 a tilde, it will be expanded to your home directory.
  53 .TP
  54 .I "socket_path=<string>"
  55 Listen on the specified socket. The default is \fB~/.pwmd/socket\fR.
  56 .TP
  57 .I "data_directory=<string>"
  58 Where
  59 .B pwmd
  60 should store and retrieve data files. The default is \fB~/.pwmd\fR.
  61 .TP
  62 .I "disable_mlockall=<boolean>"
  63 If set to "true" then
  64 .B pwmd
  65 wont call
  66 .BR mlockall (2).
  67 If you have resource limits beyond your control and
  68 .B pwmd
  69 is taking to much physical memory then this option may help at the cost of
  70 security. The data might be swapped to virtual memory and later recovered.
  71 Reguardless of this option
  72 .BR mlock (2)
  73 will still be used for the file cache. The default is \fBfalse\fR.
  74 .TP
  75 .I "cache_size=<integer>"
  76 Specfies the size of the file cache. Must be in multiples of your systems
  77 \fBPAGE_SIZE\fR. The default is one page which on Linux-x86 is 4096 bytes or
  78 78 files.
  79 .TP
  80 .I "log_path=<string>"
  81 Logs informational messages to the specified file. The default is
  82 \fB~/.pwmd/.log\fR.
  83 .TP
  84 .I "enable_logging=<boolean>"
  85 Enable or disable logging to \fBlog_path\fR. The default is \fBfalse\fR.
  86 .TP
  87 .I "iterations=<integer>"
  88 The number of times to encrypt the data. A value of 10000 or more will make
  89 dictionary attacks very slow depending on the CPU. The default is 0.
  90 .TP
  91 .I "cache_push=<list>"
  92 A list of filenames separated by commas that will be pushed into the file
  93 cache upon startup.
  94 .B pwmd
  95 will ask for the key for each file specified. The default is none.
  96 .SH SIGNALS
  97 .TP
  98 .B SIGHUP
  99 Clears the entire file cache. If there are any clients connected, a key will
 100 be required for the next OPEN or SAVE command.
 101
 102 .SH FILES
 103 .TP
 104 .B ~/.pwmdrc
 105 Default configuration file.
 106 .TP
 107 .B ~/.pwmd
 108 Default data directory.
 109 .TP
 110 .B ~/.pwmd/socket
 111 Default listening socket.
 112 .TP
 113 .B /dev/shm/pwmd.<uid>
 114 On Linux, and maybe other systems, where the file cache is stored for the
 115 duration of the daemon. If your
 116 .BR mmap (2)
 117 supports MAP_ANONYMOUS with MAP_SHARED then no file will need to be created.
 118
 119 .SH AUTHOR
 120 Ben Kibbey <bjk@luxsci.net>
 121 .br
 122 .URL "http://bjk.sourceforge.net/pwmd/" "PWMD Homepage" .
 123
 124 .SH "SEE ALSO"
 125 .BR shm_open (2),
 126 .BR mlock (2),
 127 .BR mlockall (2),
 128 .BR libxml (3) ,
 129 .BR mmap (2)