NEWS

   1 PWMD v1.6
   2 ----------
   3 IMPORT command bugfix. It now overwrites the node of the same name as the root
   4 node of the content argument.
   5
   6 When a client sends OPTION PINENTRY, the option value is valid for the current
   7 session only, and not any future sessions of the same file.
   8
   9
  10 PWMD v1.5
  11 ----------
  12 Added the "backup" configuration parameter. When true, the default, a backup
  13 of the opened file will be saved in "data_directory" when a SAVE command is
  14 sent. The filename will have the ".backup" extension appended to it.
  15
  16 Added the XPATH command. This command can retrieve a result of the specified
  17 expression or set a value to the result of the specified expression.
  18
  19 Added the IMPORT command. This is like STORE but reads real XML data and
  20 stores it at the specified element path.
  21
  22 A few bugfixes. See ChangeLog for details.
  23
  24
  25 PWMD v1.4
  26 ----------
  27 Ported to libPth2. This fixes key cache locking portability and removes the
  28 --disable-locking 'configure' option.
  29
  30 Added configuration parameter "syslog" to enable logging to the syslog daemon
  31 with facility LOG_DAEMON and priority LOG_INFO.
  32
  33 When the key cache changes, send the CACHE status message to each connected
  34 client.
  35
  36 Reuse libgpg-error error codes more often. If your using libpwmd, please
  37 update to libpwmd5 otherwise error codes will be wrong.
  38
  39 Added configuration option "keepalive" to specify the interval, in seconds, to
  40 send the new KEEPALIVE status message.
  41
  42 Added pinentry(1) support. This adds a new configuration parameter
  43 "enable_pinentry" (the default is enabled), and a few options that can be set
  44 with the new OPTION command: PATH, TTYNAME, TTYTYPE, DISPLAY, TITLE, PROMPT,
  45 DESC and PINENTRY. Read COMMANDS for details.
  46
  47 Added OPTION CLIENT NAME=VALUE to let clients set a string that is associated
  48 with the connection thread ID. This may be useful for debugging log messages.
  49
  50 The "iterations" configuration parameter can be set to -1 to disable
  51 encryption. Setting to 0, the default, will still encrypt with 1 iteration (I
  52 know it doesn't make sense, but it's needed for compatibility with previous
  53 data files).
  54
  55 Empty (null) keys are now allowed.
  56
  57 Changed the "default" configuration file section to "global". Be sure to
  58 update your config file(s).
  59
  60 A few bug fixes. See ChangeLog for details.
  61
  62
  63 PWMD v1.3
  64 ----------
  65 More safety checks when writing the data file after a SAVE command.
  66
  67 Added configuration parameter "socket_perms" to set the permissions of the
  68 created socked overriding any umask setting. May be useful if a client
  69 other than the user who invoked pwmd needs to connect (i.e., ACL's).
  70
  71 Added 'configure' option --disable-locking to disable key cache mutex locking.
  72 Some systems don't have a complete pthread_mutex_t data type which is needed
  73 rather than a pointer (FreeBSD and others probably). Note that using this
  74 option increases the risk of key cache and data file corruption when more than
  75 one client is using pwmd at the same time and save to the same file. If
  76 possible, upgrade your OS and see if this fixes things.
  77
  78 A few bugfixes. See ChangeLog for details.
  79
  80
  81 PWMD v1.2
  82 ----------
  83 Added locking of the file/key cache with certain commands. This prevents other
  84 clients from modifying the cache until the lock is released. This adds a new
  85 pthread compile time dependency.
  86
  87 Zlib version 1.2.2.1 or later is now a requirement.
  88
  89
  90 PWMD v1.1
  91 ----------
  92 Added configuration parameter "recursion_depth". This specifies the maximum
  93 number of times to follow a "target" attribute for a single element. The
  94 default is 20.
  95
  96 When creating a "target" attribute, each element in the element path value is
  97 no longer modified with the literal '!' character at all. You need to specify
  98 the literal instead. This keeps the syntax more consistent with the other
  99 commands.
 100
 101 Added the COMPRESS and DECOMPRESS status messages. Both show the bytes
 102 processed so far, and the total bytes. In order to see the total after
 103 upgrading from a previous version you need to save the data file once.
 104
 105 Changed the PROGRESS status message to ENCRYPT and DECRYPT.
 106
 107 The "disable_mlockall" configuration parameter now defaults to "true". Saves
 108 RAM and is overkill for most since each memory deallocation is cleared before
 109 being freed. The file cache is still locked in RAM though (if possible).
 110
 111 Bugfixes. See ChangeLog for details.
 112
 113
 114 PWMD v1.0
 115 ----------
 116 EPWMD_FILE_NOT_FOUND is no longer used. It is up to the client to determine
 117 if the file exists by using the GETCONFIG command along with 'data_directory'.
 118
 119 The CLEARCACHE command will always succeed (return 0) even if the file is not
 120 found.
 121
 122 A few minor bugfixes.
 123
 124
 125 PWMD v0.12
 126 ----------
 127 Added gettext support. Translations welcome.
 128
 129 Strip the first '!' of a newly created element. If there's a following one
 130 it's an error. This is to avoid syntax errors and confusion with other
 131 commands and element paths.
 132
 133 Only show the number of iterations so far when showing the PROGRESS status
 134 message. The client can get the percentage by calculating the
 135 "iteration_progress" with GETCONFIG.
 136
 137 Fixed a huge memory leak with (de)compression.
 138
 139 The cache status message format has changed to only show the used and
 140 available slots and without any text strings to make it easier for clients to
 141 parse.
 142
 143 SIGUSR1 is caught in the child process. This allows for reloading of the
 144 configuration file.
 145
 146 Fixed pushing files and xml import with compression.
 147
 148 Added --enable-mem-debug to use the standard memory allocators. Valgrind seems
 149 to work better this way.
 150
 151 Fixed a few memory leaks.
 152
 153 Fixed creating invalid XML elements. Elements must not begin with punctuation
 154 or digit and not contain any whitespace.
 155
 156 The output of the LIST command is no longer sorted. Leave it up to the client.
 157
 158
 159 PWMD v0.11
 160 ----------
 161 Added the GETCONFIG command. This will return a value for a configuration
 162 parameter for the opened file or the default value if no file has been opened.
 163 The "key" and "key_file" parameters are ignored.
 164
 165 Rewrote how element handling is done. No longer uses an xmlTextReader but
 166 accesses the xmlDocPtr nodes directly.
 167
 168 The STORE command will no longer overwrite the element tree of the last
 169 element in the specified element path. Instead it will set the content as
 170 usual and keep the child nodes. This affects how GET handles empty elements.
 171 GET will return EPWMD_EMPTY instead of EPWMD_TRAILING_ELEMENT. The STORE
 172 command can also store content in a root element (account) and remove content
 173 or store an empty element by not specifying any content after the last TAB in
 174 the element path.
 175
 176 Each element in an element path can now be prefixed with the literal '!'
 177 character. This allows for following targets of elements other than the root
 178 element.
 179
 180 The LIST command will now shows all reachable elements including target
 181 elements for the specified element path. It also prefixes each element with
 182 the literal '!' when needed.
 183
 184 Added support for compressing data files before encryption. This adds the
 185 "compression_level" configuration parameter. The default is 6 and setting to 0
 186 will disable.
 187
 188 A couple of bug fixes.
 189
 190
 191 PWMD v0.10
 192 ----------
 193 Fixed libgpg-error descriptions. The errors that pwmd uses for bad syntax and
 194 invalid keys etc. used to return an error code that used
 195 GPG_ERR_SOURCE_DEFAULT as the source. GPG_ERR_SOURCE_USER_1 is what pwmd uses
 196 now. This breaks compatibility with clients that make use of the error codes
 197 (i.e., libpwmd). Be sure to update.
 198
 199 Non-option arguments on the command line are files to cache upon startup. This
 200 acts like the 'cache_push' configuration parameter.
 201
 202 The location of the default configuration file is now ~/.pwmd/config and the
 203 default data directory is ~/.pwmd/data, and the default log file ~/.pwmd/log.
 204 This fixes clients opening these non-data filenames.
 205
 206 Fixed default configuration values when an rcfile doesn't have one.
 207
 208 The configuration parameters 'key' and 'key_file' now check to make sure the
 209 key is valid before adding it to the cache like 'cache_push' does.
 210
 211 Clear the file cache and free the memlist on SIGABRT when debugging is not
 212 enabled.
 213
 214 Added command line option -b to fork pwmd to the background.
 215
 216 Added configuration parameter "iteration_progress". pwmd will send the client
 217 a status message showing the percent of iterations that are complete while
 218 encrypting or decrypting a data file. The default is 0 which disables sending
 219 status messages.
 220
 221 Sending SIGUSR1 to pwmd will reload the configuration file.
 222
 223 New protocol command REALPATH. This will resolve any "target" attribute for
 224 all elements in the specified element path and return the result.
 225
 226 Some portability (FreeBSD and maybe others) fixes.
 227
 228 SIGTERM and SIGABRT are now properly caught in a child process.
 229
 230 Bugfixes.
 231
 232
 233 PWMD v0.9
 234 ---------
 235 Now uses the assuan protocol. This requires libassuan and libgpg-error.
 236
 237 Clear the shared memory on exit.
 238
 239 The CACHE sub-commands ISCACHED, CLEARCACHE and CACHETIMEOUT have been made
 240 into their own commands removing the CACHE command itself.
 241
 242 The RESETCACHE command and the cache_reset_timeout configuration parameter
 243 have been removed. The cached files timeout is reset to it's configured value
 244 (or set value with CACHETIMEOUT) after each OPEN or SAVE command.
 245
 246 The OPEN command can open another file using the same connection. Beware
 247 though that if the OPEN of the new file fails, no file will be open at all.
 248
 249 When OPEN'ing a new file with a specified key, cache both the filename and
 250 key. Before you had to SAVE to cache the key.
 251
 252 All commands will check if the file has been modified before continueing. Not
 253 the cache commands though.
 254
 255 Don't unlink() a socket filename that wasn't created by pwmd.
 256
 257 Fixed allocating more slots than needed.
 258
 259 The commands GET, STORE, DELETE and ATTR make use of the "target" attribute
 260 unless the element path argument is prefixed with a '!'. The LIST command
 261 will support "target" in the next release, hopefully.
 262
 263 Accounts names can no longer begin with a '!' character to avoid problems with
 264 the "target" attribute.
 265
 266 Removed EPWMD_ROOT_TEXT_ELEMENT. The STORE command will return
 267 EPWMD_COMMAND_SYNTAX instead.
 268
 269 Added command line option -D and configuration parameter
 270 "disable_list_and_dump". When specified or enabled, the LIST and DUMP protocol
 271 commands will return EPWMD_EMPTY_ELEMENT.
 272
 273
 274 PWMD v0.8
 275 ---------
 276 Use AM_XML2_PATH() for finding libxml2.
 277
 278 Split pwmd and libpwmd into their own projects. Both can be found at
 279 http://bjk.sourceforge.net/pwmd/.
 280
 281
 282 PWMD v0.7
 283 ---------
 284 cache_push and working directory bugfix.
 285
 286 Added two new configuration options "key" and "key_file". Works with
 287 cache_push too.
 288
 289 Added a boolean "cache_reset_timeout" configuration option to reset the timer
 290 for a cached key when the OPEN or SAVE commands are used.
 291
 292 Added two new protocol commands CACHE RESET which clears only the key for the
 293 specified file and CACHE RESETALL which clears the key for all files.
 294
 295 The "name" and "target" attributes are now case-sensitive.
 296
 297 The value of an element path that contains a "target" attribute can be
 298 obtained by prefixing the account element with a '!'.
 299
 300
 301 PWMD v0.6
 302 ---------
 303 Fix for the LIST command. When an element path was specified and the document
 304 had following elements in the tree the following elements would be shown.
 305
 306 Added the CACHE TIMEOUT command to specify the lifetime of a cached file in
 307 seconds. This adds a new configuration file setting "cache_timeout".
 308
 309 Added per-file settings in the configuration file. A file section is declared
 310 by placing the filename in braces. Only the "iterations" and "cache_timeout"
 311 settings are used in a file section.
 312
 313 No longer chdir() to the data directory.
 314
 315
 316 PWMD v0.5
 317 ---------
 318 If a file size is 0 then CACHE ISCACHED will return EPWMD_FILE_NOT_FOUND.
 319
 320 Write a structure to the data file which specifies the iterations and IV. This
 321 lets you open a file that had a different iteration setting than the current
 322 setting. Breaks file compatibility with previous versions for hopefully the
 323 last time.
 324
 325 cache_push with an invalid password bugfix.
 326
 327 Added command line option -I to import an XML file and write the encrypted
 328 data to stdout.
 329
 330
 331 PWMD v0.4
 332 ---------
 333 Use AES-256-CBC to store the data file. This breaks file compatibility with
 334 older versions. Sorry.
 335
 336 The ATTR protocol command has a new GET sub-command to get an attribute value
 337 for an element path.
 338
 339 The LIST protocol command can now take an element path.
 340
 341 The DUMP command will format it's output.
 342
 343 Use MAP_ANONYMOUS|MAP_SHARED mmap() flags on Linux 2.4+. This won't create a
 344 file in /dev/shm. #define MMAP_ANONYMOUS_SHARED in config.h if your OS
 345 supports this.
 346
 347 Fixed closing file descriptors.
 348
 349 Fixed some memory leaks.
 350
 351 The contents of all memory allocated by Glib, libXML and libgcrypt is cleared
 352 before free()ing.
 353
 354 Added an "iterations" configuration parameter. This specifies the amount of
 355 times to encrypt the data to prevent dictionary attacks. Idea borrowed from
 356 aespipe.
 357
 358
 359 PWMD v0.3
 360 ---------
 361 The SETATTR protocol command has been renamed to ATTR. This new command
 362 includes three new sub-commands: SET, DELETE and LIST, to SET or update an
 363 attribute, DELETE to delete an attribute and LIST to list attributes of an
 364 element path. Read PROTOCOL for details.
 365
 366 Added the TARGET attribute. If an element has this attribute set, it's value
 367 is another element path. It's recursive too so the destination element path
 368 can be an element with a TARGET attribute. Be careful of loops though.
 369
 370 Added the DUMP protocol command. It shows the in-memory document. Useful for
 371 cleaning up empty elements that aren't shown with any command.
 372
 373 The "name" attribute can be used in any element but cannot be removed for the
 374 root "account" element.
 375
 376 More strict element name validation for new elements.
 377
 378 Code reorganization. Protocol commands have been put in src/commands.c.
 379
 380 The LIST command won't show element values anymore unless DEBUG was defined at
 381 compile time. You must use the GET command to get a value.
 382
 383 The OPEN and SAVE protocol commands no longer expect a base64 encoded key.
 384 Plain text is where it's at.
 385
 386 The STORE command wont base64 encode the value. We'll leave it up to the
 387 client. But it's still recommended to avoid parsing errors.
 388
 389 All of the command line options have been moved into a configuration file. By
 390 default pwmd will look for it in ~/.pwmdrc. You can use -f to specify an
 391 alternate file. If the file doesn't exist, then some defaults will be used.
 392 There is one new config option though; "cache_push" will take a list of
 393 filenames as an argument. This will prompt for passwords upon startup and add
 394 the file to the cache. It's a (temporary?) fix for background processes that
 395 don't have an attached tty (see libpwmd/KnownBugs). Just make sure the file
 396 the other process needs is added to the cache.
 397
 398
 399 PWMD v0.2
 400 ---------
 401 There is a library included in the archive to make interfacing the pwmd alot
 402 easier. See libpwmd/README for more information.
 403
 404 A (temporary) fix for 100% CPU usage after a client connects.
 405
 406 GnuPG is no longer used for data encryption. Instead, libgcrypt will
 407 encrypt/decrypt the data with AES-128 key. The OPEN and SAVE commands will
 408 need the base64 encoded key.
 409
 410 Renamed host to hostname and added sslfingerprint to the DTD.
 411
 412 Added command line option -s to specify the socket path.
 413
 414 Added command line option -d to specify where pwmd will open and save the data
 415 files.
 416
 417 Renamed protocol command SET to SETATTR.
 418
 419 Added shared memory file caching. If a file is found in the cache then the
 420 cached password associated with the file will be used with the OPEN command.
 421 With SAVE, if there is no cached password a key is required, else the cached
 422 password will be used unless there is a key argument. This also adds a new
 423 protocol command CACHE with 3 subcommands CLEARALL, CLEAR and ISCACHED.
 424 Sending the SIGHUP signal to pwmd will clear the file cache.
 425
 426 Added command line option -M to disable calling mlockall(). mlock() will still
 427 be used for the file cache reguardless of this option.
 428
 429 Added command line option -C to specify the file cache size. The cache size
 430 must be in multiples of PAGE_SIZE.
 431
 432 Added command line option -l to enable logging to the specified file.
 433
 434 If there is a protocol command error, ERR is returned along with a protocol
 435 error code and description. See src/pwmd_error.h for error codes.
 436
 437 Fix for the DELETE command and deleting an entire element tree when an invalid
 438 element was in the element path.
 439
 440 Fix for the GET command and finding elements of the same name in other
 441 accounts.
 442
 443 Added a manual page.
 444
 445
 446 PWMD v0.1
 447 ---------
 448 Initial release.