NEWS

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