Cleanup of command_startup().
[pwmd.git] / NEWS
blob8feb3741e2e4610f944cdb16d8eaaed5ae7d9ebc
1 PWMD v2.18
2 ----------
3 Added OPEN and SAVE command option --inquire to use a server inquire to
4 retrieve the filename and passphrase. This lets the passphrase be more than
5 the assuan protocol line limit of 1000 bytes. This option also changes how the
6 "key_file" configuration parameter is handled when it exists for a file that
7 doesn't have a cache entry: an --inquire can be used to set the key rather
8 than returning an error.
10 Added OPEN and SAVE command option --base64 to specifiy that the passphrase is
11 Base64 encoded. The passphrase will be decoded before encryption and
12 decryption. This allows for binary keys which may be sent via an --inquire.
14 GPG_ERR_NOT_IMPLEMENTED is returned when a known pinentry command or option is
15 requested but no pinentry support was compiled in. Previously,
16 GPG_ERR_UNKNOWN_OPTION or other error was returned.
18 Fixed the CLEARCACHE command corrupting the key_cache when clearing all cache
19 entries.
21 A few other changes and cleanups. See ChangeLog for details.
24 PWMD v2.17
25 ----------
26 This version introduces command options which should be specified before
27 command arguments. The SET command which used to be the way to specify an
28 option is deprecated for the option that can be used in a command.
30 Added OPEN options --lock and --pinentry.
32 Added SAVE options --reset, --pinentry, --iterations and --cipher.
34 Added LIST options --no-recurse and --verbose.
36 Fixed a segfault in pinentry on the second try of the same client.
38 Changed how the OPEN command handles a previously opened file on failure. Now,
39 the previously opened file will be closed rather then kept open.
41 The _mtime attribute is now modified when creating root elements and with the
42 IMPORT, RENAME, COPY and MOVE commands.
44 COPY command bugfix when the source element path contained no child element
45 nodes. The node was being renamed.
47 The cipher for the data file is now properly restored during the next SAVE. It
48 always reverted back to AES256.
51 PWMD v2.16
52 ----------
53 Portability fix for systems without SO_PEERCRED.
55 Use xmlSetProp() for settings attributes. May fix something, not sure.
57 Added an "_mtime" attribute which is updated each time an element is modified.
60 PWMD v2.15
61 ----------
62 Fixed the RC_ON_LOCKED and LOCK_ON_OPEN options when opening another file
63 using the same connection.
65 Fixed cleaning up the client when it disconnects while waiting for a file
66 mutex lock. This fixes sending the STATUS_CLIENTS message to other connected
67 clients rather than having to wait for the next client connect or disconnect.
70 PWMD v2.14
71 ----------
72 Security fix for the key_file configuration parameter. Previous versions used
73 fgets() to read up to one line of key data. The problem is that it stops
74 reading at a null byte or a newline character which will truncate your key
75 data at that byte position. This can be very bad if you think you have secure
76 randomly generated key data since those bytes can be anywhere in the key file.
78 The fix is to pay attention to the log message warning about truncated key
79 data and make note of the byte position. If you were to SAVE the associated
80 data file and haven't already truncated your key_file to the mentioned byte
81 position then the next OPEN will fail. You'll can truncate the actual key_file
82 by doing:
84         head -c BYTE_OFFSET < key_file > new_key_file
86 The BYTE_OFFSET is the truncated byte position mentioned in the log message.
87 Then move the new_key_file to replace the old key_file.
89 Or you can skip that step and do:
91         echo DUMP | pwmc datafile > raw_xml
93 Then do an pwmd XML import (--import) of raw_xml file using a newly generated
94 key_file (--key-file) which may now contain null bytes or newline characters
95 without any problems. The 'pwmc' command is included with libpwmd.
98 PWMD v2.13
99 ----------
100 Fixed a segfault in the MOVE command.
102 Fixed the MOVE command to allow overwriting the destination even if the
103 destination is a parent of the source.
105 Fixed a segfault in do_assuan_command() do to an invalid free().
107 Fixed commands returning GPG_ERR_ASS_WRITE_ERROR when no keepalive timeout was
108 specified (disabled). Don't create a timeout event. Also changed the timeout
109 event error code to return GPG_ERR_TIMEOUT.
111 The default iteration_progress has changed from 0 to 1000.
113 Fixed a segfault in the COPY command that would get triggered when copying a
114 tree previously copied and the destination was to a child of the copy.
116 Changed how the SAVE command handles a specified key when encryption
117 iterations is 0. Rather than keep the iterations at 0, reset it to the global
118 iterations settings or 1 if that setting is also 0. Since a key was specified
119 it is assumed that the file should be encrypted. This prevents misuse and
120 confusion.
123 PWMD v2.12
124 ----------
125 This version changes how the elements are accessed and breaks data file
126 compatibility with previous versions. Conversion is done automatically unless
127 you have elements in your data file name "element" or attributes named "_name".
128 The reason for the change is that the XML parser doesn't like commonly used
129 characters in element names (for example, an email address or digit as the
130 first character). So the solution is to use an attribute to store the name of
131 the element and let the actual element be generic. All elements in your data
132 file will be renamed to "element" with an attribute "_name" being the original
133 element name. Be sure to make a backup copy of your data file. I hope you find
134 the change worth it.
136 Fixed creating element paths that had children of the same name as the parent.
138 Added the MOVE command. This will move an element path to another location in
139 the document. Faster than a COPY/DELETE.
141 Added client option RC_ON_LOCKED. If set, rather than sending a status message
142 when the file mutex is locked, an error code will be sent instead; stopping
143 the command.
146 PWMD v2.11
147 ----------
148 Another fix for the COPY command. This one fixes copy siblings of the source
149 element and also fixes references to a free'd pointer.
152 PWMD v2.10
153 ----------
154 Added command XPATHATTR. This will operate on attributes of the expression
155 nodeset.
157 XPATH now return GPG_ERR_ELEMENT_NOT_FOUND when the expression doens't match
158 any elements. It used to return GPG_ERR_NO_VALUE.
160 ATTR SET no longer requires a value.
162 GPG_ERR_NO_VALUE is returned from ATTR GET for attributes without a value.
165 PWMD v2.9
166 ----------
167 Don't require libassuan 2.0 anymore. Use the static library included in the
168 archive like was done before pwmd 2.2. This is needed for use with libpwmd
169 and fixes a bug with libgpg-error return codes.
171 Fixed another stupid bug with the RENAME command.
173 Added SET option LOCK_ON_OPEN to lock the file mutex after a successful OPEN
174 as if the LOCK command had been sent.
176 Added the LS protocol command to list files in data_directory.
179 PWMD v2.8
180 ----------
181 Fixed the RENAME command to handle target attributes and ambiguities.
183 Unicode fixes.
185 Fixed validating element names.
188 PWMD v2.7
189 ----------
190 Fixed the COPY command to handle root elements and to copy attributes too.
192 Fixed the RENAME command to overwrite an existing element tree of the same
193 value.
195 Since Valgrind and dmalloc don't like PTH threads --enable-debug now prints
196 out a backtrace of each allocation so finding memory leaks is easier/possible.
197 The output of xdump() shows non-freed pointers which can be found in the
198 backtrace output then processed through addr2line to find where it occured.
200 Fixed a few memory leaks.
202 Fixed handling of SIGABRT.
205 PWMD v2.6
206 ----------
207 Fixed a nasty bug that may have existed in all previous versions that would
208 cause a segfault do to an invalid return value from pth_exit().
210 The default keepalive is now 0 or disabled. It was added during testing of
211 remote connections over TLS and kept for use with libpwmd and SSH connections.
212 The development version of libssh2 has connection timeout support so there
213 really isn't any reason for doing keepalives in pwmd. This also fixes longer
214 running processes linked with libpwmd that keep a connection open but do not
215 parse status messages. pwmd would therefore kill the connection.
218 PWMD v2.5
219 ----------
220 New configuration parameter "allowed" to specify which users are allowed to
221 connect to the unix domain socket. The default is the invoking user only.
223 Fixed the IMPORT command to let it handle "target" attributes properly.
225 Let "disable_list_and_dump" be resetable during SIGHUP but only if not
226 permissive (TRUE).
229 PWMD v2.4
230 ----------
231 Reworked the IMPORT command to let it create root elements. The syntax has
232 changed to have the content as the first argument and the element path, if
233 any, as the remaining arguments after the content which is now TAB, rather
234 than space, separated.
236 Changed how the "target" attribute value is stored in the document.  Rather
237 than storing the resolved destination argument, first check to see if the
238 element path (which may contain other target attributes) is valid then store
239 the specified path as the "target" attribute value.
241 A few bugfixes. See ChangeLog for details.
244 PWMD v2.3
245 ----------
246 The DISPLAY and TERM environment variables are unset just before entering the
247 server loop. Clients wanting to use pinentry must set these options manually
248 or configure ~/.pwmd/pinentry.conf. This fixes pwmd using these variables
249 which may no longer be valid.
251 Ported to libassuan 2.0. There is no longer a static libassuan included in the
252 archive since this version supports building a DSO.
254 Fixed the COPY command copying only the the first element of the tree. How'd
255 that happen?
258 PWMD v2.2
259 ----------
260 Bugfix for pushing non-encrypted files into the cache.
263 PWMD v2.1
264 ----------
265 A new GnuPG key is being used to sign releases and git tags. The new key-id is
266 0xB140DCE2. The old key-id 0xF2B33BEF should be considered revoked do to a
267 data loss (not pwmd's fault, though).
269 Added an "age" attribute to the document element. This attribute is updated to
270 the time of the last SAVE.
272 Added support for using different ciphers when saving a data file. This adds a
273 new configuration parameter "cipher" and also adds a new option "SET CIPHER".
274 See the manual page for supported ciphers.
276 Added a new configuration parameter "log_level".
278 Added the RENAME command to rename an element.
280 Added the COPY command to copy an element tree to an element path.
282 Always use the passphrase specified with the OPEN command, if any, even when
283 the (encrypted) file has been cached.
285 Fixed converting an unencrypted data file.
287 A few portability fixes for 64-bit machines.
289 Added configuration parameter "debug_file" to log all protocol IO to the
290 specified file.
293 PWMD v2.0
294 ----------
295 This version breaks data file compatibility with previous versions but has an
296 option to convert your existing data file to the new format. See the manual
297 page about the --convert command line switch. Future versions that have data
298 file changes shouldn't have this problem.
300 Requires a C99 compiler.
302 libassuan is included statically. There is no longer an external dependency.
304 Better handling of unexpected client disconnects and status messages.
306 Added new protocol command VERSION.
308 Added new protocol commands SET and UNSET. SET replaces the old OPTION
309 command. UNSET resets an option to its default value.
311 Pinentry is used when importing, converting and pushing files from the command
312 line. It can also be disabled to use regular terminal input.
314 The file cache is a GSList rather than a mmap()'ed page of memory. This allows
315 for an unlimited number of data files but changes the CACHE status message to
316 only show the number of cached files and not any total.
318 Removed EPWMD_MAX_SLOTS, EPWMD_ERROR and EPWMD_ELOOP.
320 Added new XFER status message. This is sent after every ASSUAN_LINELENGTH
321 bytes when tranferring data lines. This adds a new configurations parameter
322 "xfer_progress".
324 Option ACL (Access Control List) support. When --enable-acl is passed to
325 configure, data files with an ACL will be retained after a SAVE or inherited
326 from the data_directory if new.
328 The ISCACHED command now checks for file existance. Returns GPG_ERR_NOT_FOUND
329 if it exists but not found in the file cache or an errno from access(2).
331 Renamed a few SET (old OPTION command) parameters to match the rcfile
332 parameter names so GETCONFIG will work better:
333         PINENTRY -> ENABLE_PINENTRY
334         TIMEOUT  -> PINENTRY_TIMEOUT
335         PATH     -> PINENTRY_PATH
337 Removed the old CLIENT option. The old NAME sub-option can be set with SET
338 NAME=VALUE.
340 Changed how GETCONFIG handles per-session option changes for some options. If
341 no file is specified and the specified option was previouly SET, then the SET
342 value is returned. Else the option for the specified file is read from the
343 configuration file.
345 GETCONFIG <filename> ITERATIONS will read the file header of the specified
346 file. Useful if using a local pinentry and you need to determine if a filename
347 is encrypted or not.
349 SET ITERATIONS requires an open file.
351 The configuration parameters "pinentry_timeout" and "enable_pinentry" can now
352 be set per-file in the configuration file.
354 Can now use both short and long command line options.
356 The CACHETIMEOUT command has had its arguments flipped to keep consistancy
357 with other commands: CACHETIMEOUT <filename> <seconds>