NEWS

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