| blob | 932fac297e9cabf12a3cb6e6bbef2747956157bb |
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 "03 Jul 2007" "Password Manager Daemon" "Password Manager Daemon"
19 .SH NAME
21 pwmd \- local socket data server
22 .SH SYNOPSIS
23 .B pwmd
24 [\-hv] [\-f <rcfile>] [\-I <filename>] [\-D] [\-b] [file] [...]
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.
33 .SH OPTIONS
34 The following are the available command line options. Remaining arguments are
35 files to add to the cache on startup. It works like the \fBcache_push\fP
36 configuration parameter.
37 .TP
38 .I "\-f rcfile"
39 Specify an alternate configuration file. The default is \fB~/.pwmd/config\fR.
40 .TP
41 .I "\-I filename"
42 Import an XML file prompting for a key to use for encryption. The encrypted
43 data will be written to stdout.
44 .TP
45 .I "\-D"
46 Disable the LIST and DUMP protocol commands.
47 .TP
48 .I "\-b"
49 Run as a background process (daemonize).
50 .TP
51 .I "\-v"
52 Version information.
53 .TP
54 .I "\-h"
55 Help text.
57 .SH CONFIGURATION FILE
58 Blank lines and lines beginning with '#' are ignored. Some options can be
59 grouped together to have file specific settings. A file section is declared by
60 surrounding the filename with braces ([filename]). Default options may be
61 specified in a [default] section. If the first character of a string value is
62 a tilde, it will be expanded to your home directory. First the global options:
63 .TP
64 .I "socket_path=<string>"
65 Listen on the specified socket. The default is \fB~/.pwmd/socket\fR.
66 .TP
67 .I "data_directory=<string>"
68 Where
69 .B pwmd
70 should store and retrieve data files. The default is \fB~/.pwmd/data\fR.
71 .TP
72 .I "disable_mlockall=<boolean>"
73 If set to "true" then
74 .B pwmd
75 wont call
76 .BR mlockall (2).
77 If you have resource limits beyond your control and
78 .B pwmd
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
82 .BR mlock (2)
83 will still be used for the file cache. The default is \fBfalse\fR.
84 .TP
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.
88 .TP
89 .I "log_path=<string>"
90 Logs informational messages to the specified file. The default is
91 \fB~/.pwmd/log\fR.
92 .TP
93 .I "enable_logging=<boolean>"
94 Enable or disable logging to \fBlog_path\fR. The default is \fBfalse\fR.
95 .TP
96 .I "cache_push=<list>"
97 A list of filenames separated by commas that will be pushed into the file
98 cache upon startup.
99 .B pwmd
100 will ask for the key for each file specified unless the key was specified with
101 a \fBkey\fR or \fBkey_file\fR parameter in a matching file section. The
102 default is none.
103 .PP
104 Below are options that can be in the [default] or [filename] section. If in
105 both, then [filename] will have precedence.
106 .TP
107 .I "cache_timeout=<integer>"
108 The number of seconds for the life of the cached file. If -1, the file is
109 cached forever. If 0, each time the file is opened or saved a key will be
110 required.
111 .TP
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 0.
115 .TP
116 .I "iteration_progress=<integer>"
117 After the specified number of iterations while encrypting or decrypting, a
118 status message will be sent to the client. Setting to \fB0\fP, the default,
119 disables sending progress messages.
120 .TP
121 .I "key=<string>"
122 The initial key to use for this file. If specified in the "default" section
123 then "default" is treated as a filename and not a default for other files.
124 .TP
125 .I "key_file=<string>"
126 Same as above but obtain the key from the specified filename with the key
127 being on the first line of the file.
128 .SH SIGNALS
129 .TP
130 .B SIGHUP
131 Clears the entire file cache. If there are any clients connected, a key will
132 be required for the next OPEN or SAVE command.
133 .TP
134 .B SIGUSR1
135 Reloads the configuration file.
137 .SH FILES
138 .TP
139 .B ~/.pwmd/config
140 Default configuration file.
141 .TP
142 .B ~/.pwmd/data
143 Default data directory.
144 .TP
145 .B ~/.pwmd/socket
146 Default listening socket.
147 .TP
148 .B ~/.pwmd/log
149 Default log file when logging is enabled.
150 .TP
151 .B /dev/shm/pwmd.<uid>
152 On Linux, and maybe other systems, where the file cache is stored for the
153 duration of the daemon. If your
154 .BR mmap (2)
155 supports MAP_ANONYMOUS with MAP_SHARED then no file will need to be created.
157 .SH AUTHOR
158 Ben Kibbey <bjk@luxsci.net>
159 .br
160 .URL "http://bjk.sourceforge.net/pwmd/" "PWMD Homepage" .
162 .SH "SEE ALSO"
163 .BR shm_open (2),
164 .BR mlock (2),
165 .BR mlockall (2),
166 .BR libxml (3) ,
167 .BR mmap (2)