NEWS

   1 libPWMD v5.0.2
   2 --------------
   3 Added pwmd_open_async(), pwmd_save_async(), pwmd_process(), pwmd_finalize()
   4 and pwmd_async_t. This will replace pwmd_open_nb(), pwmd_open_nb_finalize(),
   5 pwmd_save_nb(), pwmd_save_nb_finalize() and pwmd_nb_state_t in a future
   6 version. These new functions allow pwmd to use its pinentry method rather than
   7 having libpwmd fork() and launch pinentry for nonblocking IO.
   8
   9 When DEBUG is defined, a few new command line options are available to pwmc to
  10 test password retrieval methods.
  11
  12
  13 libPWMD v5.0.1
  14 --------------
  15 Let pwmc handle the new IMPORT command.
  16
  17 Fixed disconnecting pinentry.
  18
  19 When the inquire callback returns GPG_ERR_EOF and 'result' is not NULL, send
  20 the rest of 'result' before terminating the callback.
  21
  22
  23 libPWMD v5.0.0
  24 --------------
  25 This version breaks backward compatibility and requires pwmd 1.4 or later. The
  26 reason is because of how commands that use the INQUIRE response (the "STORE"
  27 command) from the server has changed. To do a INQUIRE command, use the new
  28 pwmd_inquire() function and not pwmd_command(). The reason for this is to use
  29 less memory when large amounts of data is to be sent. The entire data doesn't
  30 need to be stored in a buffer before sending. It can be sent ASSUAN_LINELENGTH
  31 bytes at a time (~1000) and also removes the one-line-per-command restriction;
  32 the data can contain newline characters. See pwmc.c for example usage.
  33
  34 Updated to use new pwmd error codes.
  35
  36 Fixed pwmd_connect() not setting the error parameter on success.
  37
  38 Only one command can be processed with pwmc do to the new INQUIRE code. This
  39 removes pwmc command line option -E.
  40
  41 Added pwmc command line option -I to read INQUIRE (STORE command) data
  42 from the specified file descriptor. Reading from a file descriptor rather from
  43 a pipe can save memory when large amounts of data is being sent. See the pwmc
  44 manual page for example usage.
  45
  46 The result of a pwmc command is not modified at all (newline characters).
  47
  48 Send OPTION CLIENT NAME=pwmc when pwmc connects to the server.
  49
  50 Server status messages are printed to stderr by default. Use the new command
  51 line option -X to suppress status messages.
  52
  53 Since pwmd 1.4 includes it's own pinentry support, setting
  54 PWMD_OPTION_PINENTRY with pwmd_setopt() will send "OPTION PINENTRY=0" to the
  55 server to prevent pwmd from using its pinentry support.
  56
  57 Renamed 'configure' option --with-pinentry-path to --with-pinentry.
  58
  59 Look for ~/.pwmd/pinentry.conf rather than ~/.pwmd/env. The variable names
  60 have also changed. They are now: TTYNAME, TTYTYPE, DISPLAY and PATH.
  61
  62 A few bugfixes. See ChangeLog for details.
  63
  64
  65 libPWMD v4.0.3
  66 --------------
  67 Added --with-pinentry-path to configure to set the default location of the
  68 pinentry binary. The default is /usr/bin/pinentry.
  69
  70 The timeout (if set) is cancelled after pinentry returns since this means
  71 input was read.
  72
  73 PWMD no longer returns EPWMD_FILE_NOT_FOUND anywhere. It is up to the client
  74 to figure out if the file is new or not by using the GETCONFIG protocol
  75 command.
  76
  77 Added the -d command line switch to pwmc. This will redirect any command
  78 output to the specified file descriptor. If your using pinentry to retrieve a
  79 password from the same tty as pwmc and redirecting output, this is needed.
  80
  81 Added pwmc command line options -D, -T and -N. These can set the pinentry
  82 display, tty and terminal type.
  83
  84 A couple of minor bugfixes.
  85
  86
  87 libPWMD v4.0.2
  88 --------------
  89 Added gettext support.
  90
  91 Don't free the password when set with pwmd_setopt() until pwmd_close() is
  92 called. Fixes pwmc -p for example.
  93
  94 Fixed pwmc and looping when an error occurs and pinentry is used to get the
  95 password.
  96
  97
  98 libPWMD v4.0.1
  99 --------------
 100 FreeBSD compile-time fix.
 101
 102 pwmd_open() will return GPG_ERR_TIMEOUT after pwmd_terminate_pinentry() is
 103 called.
 104
 105 Warn about unused function results at compile-time.
 106
 107
 108 libPWMD v4.0.0
 109 --------------
 110 Fixed gpg-error descriptions. Client's linked to this version of libpwmd
 111 should be using pwmd v0.10 or later.
 112
 113 Made the pwm_t structure private.
 114
 115 Library functions returning PWMD_OK or PWMD_ERROR now are prototyped to return
 116 a type of gpg_error_t. This removes the extra needed parameter when calling
 117 these functions. When these functions succeed, 0 is returned. Otherwise it's
 118 an error code that pwmd_strerror() can describe.
 119
 120 Renamed pwmd_option to pwmd_option_t.
 121
 122 Added PWMD_OPTION_STATUS_FUNC and PWMD_OPTION_STATUS_DATA. The set function
 123 will be called when pwmd sends a status (S) line. The function should return 0
 124 on success or a gpg_error_t which will fail the current command with the
 125 returned error code.
 126
 127 Renamed PWMD_OPTION_[TITLE|PROMPT|DESC] to PWMD_OPTION_PINENTRY_...
 128
 129 When using pinentry for password retrieval, PWMD_OPTION_PINENTRY_TRIES can
 130 be set to specify the number of times before giving up after an invalid
 131 password.
 132
 133 The custom memory de/allocator symbols are now hidden.
 134
 135 Renamed pwmd_password_func to pwmd_password_fn. A pwm_t * is also a required
 136 argument.
 137
 138 Renamed pwmd_status_func to pwmd_status_fn.
 139
 140 Removed pwmd_get_password(). This has been replaced by pwmd_open_nb() and
 141 pwmd_save_nb(). These function's will return a file descriptor that select()
 142 can use when a file isn't cached. When available for a read(), a
 143 pwmd_nb_status_t should be read and then passed to pwmd_open_nb_finalize() or
 144 pwmd_save_nb_finalize() to update the pwm handle. pwmd_open_nb() also has an
 145 option to specify the number of seconds until the pinentry process will
 146 timeout.
 147
 148 Added pwmd_terminate_pinentry() which will kill the pinentry process
 149 associated with the specified pwm handle. Use this if you need a pinentry
 150 timeout but don't call pwmd_open_nb().
 151
 152 Added pwmc command line option -t to specified the pinentry timeout.
 153
 154 When a file ~/.pwmd/env exists, it is read before calling pinentry. This file
 155 contains NAME=VALUE pinentry settings where NAME is one of TTY, TERM or
 156 DISPLAY. These settings will overwrite the ones set by pwmd_setopt(). This
 157 allows a daemon process to use pinentry after it's cache entry has been
 158 removed.
 159
 160 Quite a few API changes and bugfixes. Read libpwmd.3 for details.
 161
 162
 163 libPWMD v3.0.0
 164 --------------
 165 Now uses the assuan protocol for communicating with pwmd. This changes things
 166 quite a bit. Read on...
 167
 168 Uses more secure memory allocation. Kinda. It mainly just zero's out what is
 169 allocated before free()'ing it.
 170
 171 Added pwmd_init(). Call this before anything else.
 172
 173 Added pwmd_open() and pwmd_save(). This removes PWMD_OPEN and PWMD_SAVE.
 174
 175 Removed PWMD_COMMAND. pwmd_command() now accepts a format string as the
 176 command.
 177
 178 Added pwmd_free_result(). Use this to free a result from pwmd_command().
 179
 180 Removed PWMD_SETOPT. Changed to pwmd_setopt().
 181
 182 Added options for setting up the pinentry terminal and display.
 183
 184 Added pwmd_get_password(). This is a nonblocking way of calling pinentry. It
 185 returns a file descriptor that select() can use to read from when a password
 186 is ready to be read from with read() (mostly ripped from Elinks'
 187 start_thread()). Thanks Kalle Olavi Niemitalo <kon@iki.fi> for the idea.
 188
 189 Now uses libgpg-error error codes.
 190
 191 Fixed pwmc and the BYE command.
 192
 193 A few other changes. Read the libpwmd.h header file, libpwmd.3 and ChangeLog
 194 for all the details.
 195
 196
 197 libPWMD v2.0.3
 198 --------------
 199 Split pwmd and libpwmd into their own packages.
 200
 201 Added PWMD_SETOPT options PWMD_OPTION_PASSWORD_FUNC and
 202 PWMD_OPTION_PASSWORD_DATA to specify a custom password retrieval function for
 203 use with the PWMD_OPEN and PWMD_SAVE commands.
 204
 205 gpg-agent(1) is no longer used for interacting with pinentry(1). Now libassuan
 206 calls pinentry directly. This adds PWMD_OPTION_PINENTRY_PATH to specify the
 207 location of the pinentry program. The default is /usr/bin/pinentry. New
 208 programs should use PWMD_OPTION_PINENTRY instead of PWMD_OPTION_USEAGENT and
 209 EPWMD_PINENTRY_ERROR instead of EPWMD_AGENT_ERROR.
 210
 211
 212 libPWMD v2.0.2
 213 --------------
 214 Added a manual page.
 215
 216 Removed pwmd_list_free(). The prototype disappeared but I forgot to remove the
 217 code.
 218
 219
 220 libPWMD v2.0.1
 221 --------------
 222 Restore the working directory after connecting to the socket.
 223
 224 Changed the gpg-agent title and description strings in pwmc.
 225
 226 Fixed a segfault when looking for the empty string in a result from
 227 pwmd_command().
 228
 229
 230 libPWMD v2.0.0
 231 --------------
 232 Most of the PWMD_* commands have been removed. PWMD_OPEN, PWMD_SAVE,
 233 PWMD_SETOPT and the new PWMD_COMMAND remain. PWMD_COMMAND takes a char*
 234 argument being the protocol command along with any argument to send to the
 235 server. This is alot simpler and less error prone than before. Also the
 236 library won't need to be updated if a protocol command changed or is added.
 237
 238 Fixed PWMD_SAVE and asking for a password when the file was cached.
 239
 240 Added pwmc. This is a command line client for pwmd. It reads protocol commands
 241 from stdin.
 242
 243 Removed pwmd_base64_encode() and pwmd_base64_decode().
 244
 245 Added a pkg-config meta file.
 246
 247
 248 libPWMD v1.0.1
 249 --------------
 250 Added PWMD_ATTR_GET to get an attribute value from an element path.
 251
 252 pwmd_base64_decode() bugfix. Don't assume the return value is a character
 253 array by nul-terminating it.
 254
 255 Added pwmd_list_free() to free a "list" result.
 256
 257 Can compile with g++ and maybe other C++ compilers.
 258
 259 Fixed some memory leaks.
 260
 261 Bugfix for the protocol parser.
 262
 263
 264 libPWMD v1.0.0
 265 --------------
 266 Changed the version number as suggested by the libtool docs.
 267
 268 pwmd_base64_decode() bugfix. The returned string wasn't NULL terminated.
 269
 270 Updates for the OPEN and SAVE protocol commands. libPWMD no longer base64
 271 encodes the key.
 272
 273 Updates for the new ATTR protocol command.
 274
 275
 276 libPWMD v0.0.1
 277 --------------
 278 Initial release.