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