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