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.
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.
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
15 \\$2 \(laURL: \\$1 \(ra\\$3
17 .if \n[.g] .mso www.tmac
18 .TH PWMD 1 "21 Sep 2007" "Password Manager Daemon" "Password Manager Daemon"
21 pwmd \- local socket data server
24 [\-hv] [\-f <rcfile>] [\-I <filename>] [\-D] [\-b] [file] [...]
28 is a daemon that listens for connections on a local socket. Clients connect to
29 the server and can retrieve or modify "account" data. The word "account" is
30 just a placeholder for the element describing and item. But what the data
31 actually is can be anything. The data is stored in an AES encrypted XML file.
34 The following are the available command line options. Remaining arguments are
35 files to add to the cache on startup.
38 Specify an alternate configuration file. The default is \fI~/.pwmd/config\fR.
41 Import an XML file prompting for a key to use for encryption. The encrypted
42 data will be written to stdout.
45 Disable the LIST and DUMP protocol commands.
48 Run as a background process (daemonize).
56 .SH CONFIGURATION FILE
57 Blank lines and lines beginning with '#' are ignored. Some options can be
58 grouped together to have file specific settings. A file section is declared by
59 surrounding the filename with braces (i.e., \fI[filename]\fP). Default options
60 may be specified in a \fI[default]\fP section. If the first character of a
61 string value is a tilde, it will be expanded to your home directory. First the
64 .I "socket_path=<string>"
65 Listen on the specified socket. The default is \fI~/.pwmd/socket\fR.
67 .I "data_directory=<string>"
70 should store and retrieve data files. The default is \fI~/.pwmd/data\fR.
72 .I "disable_mlockall=<boolean>"
77 If you have resource limits beyond your control and
79 is taking to much physical memory then this option may help at the cost of
80 security. The data might be swapped to virtual memory and later recovered.
81 Reguardless of this option
83 will still be used for the file cache if possible. The default is \fIfalse\fR.
85 .I "cache_size=<integer>"
86 Specfies the size of the file cache. Must be in multiples of your systems
87 \fBPAGE_SIZE\fR. The default is one page.
89 .I "log_path=<string>"
90 Logs informational messages to the specified file. The default is
93 .I "enable_logging=<boolean>"
94 Enable or disable logging to \fIlog_path\fR. The default is \fIfalse\fR.
96 .I "cache_push=<list>"
97 A list of filenames separated by commas that will be pushed into the file
100 will ask for the key for each file specified unless the key was specified with
101 the \fBkey\fR or \fBkey_file\fR parameters in a matching file section. The
104 Below are options that can be in the \fI[default]\fP or \fI[filename]\fP
105 section. If in both, then \fI[filename]\fP will have precedence.
107 .I "cache_timeout=<integer>"
108 The number of seconds for the life of the cached file. If \fI-1\fP, the file
109 is cached forever. If \fI0\fP, each time the file is opened or saved a key
112 .I "iterations=<integer>"
113 The number of times to encrypt the data. A value of 10000 or more will make
114 dictionary attacks very slow depending on the CPU. The default is \fI0\fP.
116 .I "iteration_progress=<integer>"
117 After the specified number of iterations while encrypting or decrypting, a
118 status message with the keyword \fBPROGRESS\fP will be sent to the client.
119 Setting to \fI0\fP, the default, disables sending progress messages.
122 The initial key to use for this file. If specified in the \fI[default]\fP
123 section then "\fIdefault\fP" is treated as a filename and not a default for
126 .I "key_file=<string>"
127 Same as above but obtain the key from the specified filename with the key
128 being on the first line of the file.
130 .I "compression_level=<integer>"
131 The default compression level for data files from \fI1\fP to \fI9\fP, \fI1\fP
132 being the fastest but least compression and \fI9\fP being the slowest but best
133 compression. To disable compression entirely, set to \fI0\fP. The default is
136 .I "recursion_depth=<integer>"
137 The maximum number of times to resolve a target attribute for a single element
138 in an element path. An error is returned when this value is exceeded. The
139 default is \fI20\fP but can be disabled by setting to \fI0\fP.
143 Clears the entire file cache. If there are any clients connected, a key will
144 be required for the next \fBOPEN\fP or \fBSAVE\fP command.
147 Reloads the configuration file.
152 Default configuration file.
155 Default data directory.
158 Default listening socket.
161 Default log file when logging is enabled.
163 .B /dev/shm/pwmd.<uid>
164 On Linux, and maybe other systems, where the file cache is stored for the
165 duration of the daemon. If your
167 supports MAP_ANONYMOUS with MAP_SHARED then no file will need to be created.
170 Ben Kibbey <bjk@luxsci.net>
172 .URL "http://bjk.sourceforge.net/pwmd/" "PWMD Homepage" .
181 Also see \fBCOMMANDS\fP included in the archive for protocol commands.