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