Use pth_fork().
[pwmd.git] / NEWS
blobfb65f711fd97ad4cc8fddf892ce4dfa28840d05f
1 PWMD v1.4
2 ----------
3 Ported to libPth2. This fixes key cache locking portability and removes the
4 --disable-locking 'configure' option.
6 Added configuration parameter "syslog" to enable logging to the syslog daemon
7 with facility LOG_DAEMON and priority LOG_INFO.
9 When the key cache changes, send the CACHE status message to each connected
10 client.
12 Reuse libgpg-error error codes more often. If your using libpwmd, please
13 update to the latest version of libpwmd otherwise error codes will be wrong.
15 Fixed creating illegal account names.
17 Added configuration option "keepalive" to specify the interval, in seconds, to
18 send the new KEEPALIVE status message.
20 A couple bugfixes. See ChangeLog for details.
23 PWMD v1.3
24 ----------
25 More safety checks when writing the data file after a SAVE command.
27 Added configuration parameter "socket_perms" to set the permissions of the
28 created socked overriding any umask setting. May be useful if a client
29 other than the user who invoked pwmd needs to connect (i.e., ACL's).
31 Added 'configure' option --disable-locking to disable key cache mutex locking.
32 Some systems don't have a complete pthread_mutex_t data type which is needed
33 rather than a pointer (FreeBSD and others probably). Note that using this
34 option increases the risk of key cache and data file corruption when more than
35 one client is using pwmd at the same time and save to the same file. If
36 possible, upgrade your OS and see if this fixes things.
38 A few bugfixes. See ChangeLog for details.
41 PWMD v1.2
42 ----------
43 Added locking of the file/key cache with certain commands. This prevents other
44 clients from modifying the cache until the lock is released. This adds a new
45 pthread compile time dependency.
47 Zlib version 1.2.2.1 or later is now a requirement.
50 PWMD v1.1
51 ----------
52 Added configuration parameter "recursion_depth". This specifies the maximum
53 number of times to follow a "target" attribute for a single element. The
54 default is 20.
56 When creating a "target" attribute, each element in the element path value is
57 no longer modified with the literal '!' character at all. You need to specify
58 the literal instead. This keeps the syntax more consistent with the other
59 commands.
61 Added the COMPRESS and DECOMPRESS status messages. Both show the bytes
62 processed so far, and the total bytes. In order to see the total after
63 upgrading from a previous version you need to save the data file once.
65 Changed the PROGRESS status message to ENCRYPT and DECRYPT.
67 The "disable_mlockall" configuration parameter now defaults to "true". Saves
68 RAM and is overkill for most since each memory deallocation is cleared before
69 being freed. The file cache is still locked in RAM though (if possible).
71 Bugfixes. See ChangeLog for details.
74 PWMD v1.0
75 ----------
76 EPWMD_FILE_NOT_FOUND is no longer used. It is up to the client to determine
77 if the file exists by using the GETCONFIG command along with 'data_directory'.
79 The CLEARCACHE command will always succeed (return 0) even if the file is not
80 found.
82 A few minor bugfixes.
85 PWMD v0.12
86 ----------
87 Added gettext support. Translations welcome.
89 Strip the first '!' of a newly created element. If there's a following one
90 it's an error. This is to avoid syntax errors and confusion with other
91 commands and element paths.
93 Only show the number of iterations so far when showing the PROGRESS status
94 message. The client can get the percentage by calculating the
95 "iteration_progress" with GETCONFIG.
97 Fixed a huge memory leak with (de)compression.
99 The cache status message format has changed to only show the used and
100 available slots and without any text strings to make it easier for clients to
101 parse.
103 SIGUSR1 is caught in the child process. This allows for reloading of the
104 configuration file.
106 Fixed pushing files and xml import with compression.
108 Added --enable-mem-debug to use the standard memory allocators. Valgrind seems
109 to work better this way.
111 Fixed a few memory leaks.
113 Fixed creating invalid XML elements. Elements must not begin with punctuation
114 or digit and not contain any whitespace.
116 The output of the LIST command is no longer sorted. Leave it up to the client.
119 PWMD v0.11
120 ----------
121 Added the GETCONFIG command. This will return a value for a configuration
122 parameter for the opened file or the default value if no file has been opened.
123 The "key" and "key_file" parameters are ignored.
125 Rewrote how element handling is done. No longer uses an xmlTextReader but
126 accesses the xmlDocPtr nodes directly.
128 The STORE command will no longer overwrite the element tree of the last
129 element in the specified element path. Instead it will set the content as
130 usual and keep the child nodes. This affects how GET handles empty elements.
131 GET will return EPWMD_EMPTY instead of EPWMD_TRAILING_ELEMENT. The STORE
132 command can also store content in a root element (account) and remove content
133 or store an empty element by not specifying any content after the last TAB in
134 the element path.
136 Each element in an element path can now be prefixed with the literal '!'
137 character. This allows for following targets of elements other than the root
138 element.
140 The LIST command will now shows all reachable elements including target
141 elements for the specified element path. It also prefixes each element with
142 the literal '!' when needed.
144 Added support for compressing data files before encryption. This adds the
145 "compression_level" configuration parameter. The default is 6 and setting to 0
146 will disable.
148 A couple of bug fixes.
151 PWMD v0.10
152 ----------
153 Fixed libgpg-error descriptions. The errors that pwmd uses for bad syntax and
154 invalid keys etc. used to return an error code that used
155 GPG_ERR_SOURCE_DEFAULT as the source. GPG_ERR_SOURCE_USER_1 is what pwmd uses
156 now. This breaks compatibility with clients that make use of the error codes
157 (i.e., libpwmd). Be sure to update.
159 Non-option arguments on the command line are files to cache upon startup. This
160 acts like the 'cache_push' configuration parameter.
162 The location of the default configuration file is now ~/.pwmd/config and the
163 default data directory is ~/.pwmd/data, and the default log file ~/.pwmd/log.
164 This fixes clients opening these non-data filenames.
166 Fixed default configuration values when an rcfile doesn't have one.
168 The configuration parameters 'key' and 'key_file' now check to make sure the
169 key is valid before adding it to the cache like 'cache_push' does.
171 Clear the file cache and free the memlist on SIGABRT when debugging is not
172 enabled.
174 Added command line option -b to fork pwmd to the background.
176 Added configuration parameter "iteration_progress". pwmd will send the client
177 a status message showing the percent of iterations that are complete while
178 encrypting or decrypting a data file. The default is 0 which disables sending
179 status messages.
181 Sending SIGUSR1 to pwmd will reload the configuration file.
183 New protocol command REALPATH. This will resolve any "target" attribute for
184 all elements in the specified element path and return the result.
186 Some portability (FreeBSD and maybe others) fixes.
188 SIGTERM and SIGABRT are now properly caught in a child process.
190 Bugfixes.
193 PWMD v0.9
194 ---------
195 Now uses the assuan protocol. This requires libassuan and libgpg-error.
197 Clear the shared memory on exit.
199 The CACHE sub-commands ISCACHED, CLEARCACHE and CACHETIMEOUT have been made
200 into their own commands removing the CACHE command itself.
202 The RESETCACHE command and the cache_reset_timeout configuration parameter
203 have been removed. The cached files timeout is reset to it's configured value
204 (or set value with CACHETIMEOUT) after each OPEN or SAVE command.
206 The OPEN command can open another file using the same connection. Beware
207 though that if the OPEN of the new file fails, no file will be open at all.
209 When OPEN'ing a new file with a specified key, cache both the filename and
210 key. Before you had to SAVE to cache the key.
212 All commands will check if the file has been modified before continueing. Not
213 the cache commands though.
215 Don't unlink() a socket filename that wasn't created by pwmd.
217 Fixed allocating more slots than needed.
219 The commands GET, STORE, DELETE and ATTR make use of the "target" attribute
220 unless the element path argument is prefixed with a '!'. The LIST command
221 will support "target" in the next release, hopefully.
223 Accounts names can no longer begin with a '!' character to avoid problems with
224 the "target" attribute.
226 Removed EPWMD_ROOT_TEXT_ELEMENT. The STORE command will return
227 EPWMD_COMMAND_SYNTAX instead.
229 Added command line option -D and configuration parameter
230 "disable_list_and_dump". When specified or enabled, the LIST and DUMP protocol
231 commands will return EPWMD_EMPTY_ELEMENT.
234 PWMD v0.8
235 ---------
236 Use AM_XML2_PATH() for finding libxml2.
238 Split pwmd and libpwmd into their own projects. Both can be found at
239 http://bjk.sourceforge.net/pwmd/.
242 PWMD v0.7
243 ---------
244 cache_push and working directory bugfix.
246 Added two new configuration options "key" and "key_file". Works with
247 cache_push too.
249 Added a boolean "cache_reset_timeout" configuration option to reset the timer
250 for a cached key when the OPEN or SAVE commands are used.
252 Added two new protocol commands CACHE RESET which clears only the key for the
253 specified file and CACHE RESETALL which clears the key for all files.
255 The "name" and "target" attributes are now case-sensitive.
257 The value of an element path that contains a "target" attribute can be
258 obtained by prefixing the account element with a '!'.
261 PWMD v0.6
262 ---------
263 Fix for the LIST command. When an element path was specified and the document
264 had following elements in the tree the following elements would be shown.
266 Added the CACHE TIMEOUT command to specify the lifetime of a cached file in
267 seconds. This adds a new configuration file setting "cache_timeout".
269 Added per-file settings in the configuration file. A file section is declared
270 by placing the filename in braces. Only the "iterations" and "cache_timeout"
271 settings are used in a file section.
273 No longer chdir() to the data directory.
276 PWMD v0.5
277 ---------
278 If a file size is 0 then CACHE ISCACHED will return EPWMD_FILE_NOT_FOUND.
280 Write a structure to the data file which specifies the iterations and IV. This
281 lets you open a file that had a different iteration setting than the current
282 setting. Breaks file compatibility with previous versions for hopefully the
283 last time.
285 cache_push with an invalid password bugfix.
287 Added command line option -I to import an XML file and write the encrypted
288 data to stdout.
291 PWMD v0.4
292 ---------
293 Use AES-256-CBC to store the data file. This breaks file compatibility with
294 older versions. Sorry.
296 The ATTR protocol command has a new GET sub-command to get an attribute value
297 for an element path.
299 The LIST protocol command can now take an element path.
301 The DUMP command will format it's output.
303 Use MAP_ANONYMOUS|MAP_SHARED mmap() flags on Linux 2.4+. This won't create a
304 file in /dev/shm. #define MMAP_ANONYMOUS_SHARED in config.h if your OS
305 supports this.
307 Fixed closing file descriptors.
309 Fixed some memory leaks.
311 The contents of all memory allocated by Glib, libXML and libgcrypt is cleared
312 before free()ing.
314 Added an "iterations" configuration parameter. This specifies the amount of
315 times to encrypt the data to prevent dictionary attacks. Idea borrowed from
316 aespipe.
319 PWMD v0.3
320 ---------
321 The SETATTR protocol command has been renamed to ATTR. This new command
322 includes three new sub-commands: SET, DELETE and LIST, to SET or update an
323 attribute, DELETE to delete an attribute and LIST to list attributes of an
324 element path. Read PROTOCOL for details.
326 Added the TARGET attribute. If an element has this attribute set, it's value
327 is another element path. It's recursive too so the destination element path
328 can be an element with a TARGET attribute. Be careful of loops though.
330 Added the DUMP protocol command. It shows the in-memory document. Useful for
331 cleaning up empty elements that aren't shown with any command.
333 The "name" attribute can be used in any element but cannot be removed for the
334 root "account" element.
336 More strict element name validation for new elements.
338 Code reorganization. Protocol commands have been put in src/commands.c.
340 The LIST command won't show element values anymore unless DEBUG was defined at
341 compile time. You must use the GET command to get a value.
343 The OPEN and SAVE protocol commands no longer expect a base64 encoded key.
344 Plain text is where it's at.
346 The STORE command wont base64 encode the value. We'll leave it up to the
347 client. But it's still recommended to avoid parsing errors.
349 All of the command line options have been moved into a configuration file. By
350 default pwmd will look for it in ~/.pwmdrc. You can use -f to specify an
351 alternate file. If the file doesn't exist, then some defaults will be used.
352 There is one new config option though; "cache_push" will take a list of
353 filenames as an argument. This will prompt for passwords upon startup and add
354 the file to the cache. It's a (temporary?) fix for background processes that
355 don't have an attached tty (see libpwmd/KnownBugs). Just make sure the file
356 the other process needs is added to the cache.
359 PWMD v0.2
360 ---------
361 There is a library included in the archive to make interfacing the pwmd alot
362 easier. See libpwmd/README for more information.
364 A (temporary) fix for 100% CPU usage after a client connects.
366 GnuPG is no longer used for data encryption. Instead, libgcrypt will
367 encrypt/decrypt the data with AES-128 key. The OPEN and SAVE commands will
368 need the base64 encoded key.
370 Renamed host to hostname and added sslfingerprint to the DTD.
372 Added command line option -s to specify the socket path.
374 Added command line option -d to specify where pwmd will open and save the data
375 files.
377 Renamed protocol command SET to SETATTR.
379 Added shared memory file caching. If a file is found in the cache then the
380 cached password associated with the file will be used with the OPEN command.
381 With SAVE, if there is no cached password a key is required, else the cached
382 password will be used unless there is a key argument. This also adds a new
383 protocol command CACHE with 3 subcommands CLEARALL, CLEAR and ISCACHED.
384 Sending the SIGHUP signal to pwmd will clear the file cache.
386 Added command line option -M to disable calling mlockall(). mlock() will still
387 be used for the file cache reguardless of this option.
389 Added command line option -C to specify the file cache size. The cache size
390 must be in multiples of PAGE_SIZE.
392 Added command line option -l to enable logging to the specified file.
394 If there is a protocol command error, ERR is returned along with a protocol
395 error code and description. See src/pwmd_error.h for error codes.
397 Fix for the DELETE command and deleting an entire element tree when an invalid
398 element was in the element path.
400 Fix for the GET command and finding elements of the same name in other
401 accounts.
403 Added a manual page.
406 PWMD v0.1
407 ---------
408 Initial release.