NEWS

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