NEWS

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