NEWS

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