Check for getopt.h for systems that have getopt_long().
[libpwmd.git] / NEWS
blob42b554a4e3e320173ff3a961bf6e10aaece09f64
1 libPWMD v5.0.8
2 --------------
3 Ported to libpth. Two versions of libpwmd will be built when libpth is
4 available and --with-pth is passed to configure (the default). The libpth
5 version will be called libpwmd-pth and clients should link with -lpwmd-pth or
6 use the libpwmd-pth.pc pkg-config metadata file. Pass --without-pth to
7 configure to disable libpth support.
9 pwmd_open_nb(), pwmd_save_nb(), pwmd_open_nb_finalize() and
10 pwmd_save_nb_finalize() are no longer flagged as deprecated. Clients that
11 connect to a pwmd that cannot use pinentry can use these functions to locally
12 get a passphrase from pinentry.
14 pwmd_open_nb() and pwmd_save_nb() will set the error code to zero before
15 returning a valid file descriptor. Only for convenience.
18 libPWMD v5.0.7
19 --------------
20 There is now a GIT repository allowing anonymous checkouts and a web interface
21 at http://repo.or.cz/w/libpwmd.git. To clone the repository:
23     git clone git://repo.or.cz/libpwmd.git
25     To get the latest changes:
27     git pull
29 Fixed setting the pinentry title string when an invalid password was entered.
31 g++ compile time fix.
34 libPWMD v5.0.6
35 --------------
36 pwmc now sends the LOCK command after opening the data file.
38 Added pwmc command line option -t to specify the pinentry timeout.
40 Requires pinentry 0.7.5 or later when using pwmd_open_nb(). This version uses
41 gpg error codes.
43 pwmd_open() now uses pwmd's pinentry method rather than forking. This makes
44 version 1.11 of pwmd a requirement.
46 pwmd_open_async() now honors PWMD_OPTION_PINENTRY_TRIES.
49 libPWMD v5.0.5
50 --------------
51 Fixed pwmd_process() to make sure all pending data has read.
53 A couple minor bugfixes.
56 libPWMD v5.0.4
57 --------------
58 Added pwmc command line option -i to specify the number of iterations when
59 saving (-S). Requires pwmd v1.9.
62 libPWMD v5.0.3
63 --------------
64 This release is mainly fixes and features for asynchronous clients.
66 Added pwmd_assuan_ctx() to return both the assuan context and socket file
67 descriptor associated with the specified pwm_t handle.
69 Added pwmd_pending_line() which is a wrapper around assuan_pending_line() and
70 assuan_read_line().
72 Don't return an error if the data file is unreadable when pwmd_open() is
73 called.
75 The socket file descriptor is set to block when doing an INQUIRE. Fixes
76 GPG_ERR_EAGAIN being returned from assuan_transact().
78 Fixed status messages when using pwmd_process().
80 Removed assuan.h client dependency.
83 libPWMD v5.0.2
84 --------------
85 Added pwmd_open_async(), pwmd_save_async(), pwmd_process(), pwmd_finalize()
86 and pwmd_async_t. This will replace pwmd_open_nb(), pwmd_open_nb_finalize(),
87 pwmd_save_nb(), pwmd_save_nb_finalize() and pwmd_nb_state_t in a future
88 version. These new functions allow pwmd to use its pinentry method rather than
89 having libpwmd fork() and launch pinentry for nonblocking IO.
91 When DEBUG is defined, a few new command line options are available to pwmc to
92 test password retrieval methods.
95 libPWMD v5.0.1
96 --------------
97 Let pwmc handle the new IMPORT command.
99 Fixed disconnecting pinentry.
101 When the inquire callback returns GPG_ERR_EOF and 'result' is not NULL, send
102 the rest of 'result' before terminating the callback.
105 libPWMD v5.0.0
106 --------------
107 This version breaks backward compatibility and requires pwmd 1.4 or later. The
108 reason is because of how commands that use the INQUIRE response (the "STORE"
109 command) from the server has changed. To do a INQUIRE command, use the new
110 pwmd_inquire() function and not pwmd_command(). The reason for this is to use
111 less memory when large amounts of data is to be sent. The entire data doesn't
112 need to be stored in a buffer before sending. It can be sent ASSUAN_LINELENGTH
113 bytes at a time (~1000) and also removes the one-line-per-command restriction;
114 the data can contain newline characters. See pwmc.c for example usage.
116 Updated to use new pwmd error codes.
118 Fixed pwmd_connect() not setting the error parameter on success.
120 Only one command can be processed with pwmc do to the new INQUIRE code. This
121 removes pwmc command line option -E.
123 Added pwmc command line option -I to read INQUIRE (STORE command) data
124 from the specified file descriptor. Reading from a file descriptor rather from
125 a pipe can save memory when large amounts of data is being sent. See the pwmc
126 manual page for example usage.
128 The result of a pwmc command is not modified at all (newline characters).
130 Send OPTION CLIENT NAME=pwmc when pwmc connects to the server.
132 Server status messages are printed to stderr by default. Use the new command
133 line option -X to suppress status messages.
135 Since pwmd 1.4 includes it's own pinentry support, setting
136 PWMD_OPTION_PINENTRY with pwmd_setopt() will send "OPTION PINENTRY=0" to the
137 server to prevent pwmd from using its pinentry support.
139 Renamed 'configure' option --with-pinentry-path to --with-pinentry.
141 Look for ~/.pwmd/pinentry.conf rather than ~/.pwmd/env. The variable names
142 have also changed. They are now: TTYNAME, TTYTYPE, DISPLAY and PATH.
144 A few bugfixes. See ChangeLog for details.
147 libPWMD v4.0.3
148 --------------
149 Added --with-pinentry-path to configure to set the default location of the
150 pinentry binary. The default is /usr/bin/pinentry.
152 The timeout (if set) is cancelled after pinentry returns since this means
153 input was read.
155 PWMD no longer returns EPWMD_FILE_NOT_FOUND anywhere. It is up to the client
156 to figure out if the file is new or not by using the GETCONFIG protocol
157 command.
159 Added the -d command line switch to pwmc. This will redirect any command
160 output to the specified file descriptor. If your using pinentry to retrieve a
161 password from the same tty as pwmc and redirecting output, this is needed.
163 Added pwmc command line options -D, -T and -N. These can set the pinentry
164 display, tty and terminal type.
166 A couple of minor bugfixes.
169 libPWMD v4.0.2
170 --------------
171 Added gettext support.
173 Don't free the password when set with pwmd_setopt() until pwmd_close() is
174 called. Fixes pwmc -p for example.
176 Fixed pwmc and looping when an error occurs and pinentry is used to get the
177 password.
180 libPWMD v4.0.1
181 --------------
182 FreeBSD compile-time fix.
184 pwmd_open() will return GPG_ERR_TIMEOUT after pwmd_terminate_pinentry() is
185 called.
187 Warn about unused function results at compile-time.
190 libPWMD v4.0.0
191 --------------
192 Fixed gpg-error descriptions. Client's linked to this version of libpwmd
193 should be using pwmd v0.10 or later.
195 Made the pwm_t structure private.
197 Library functions returning PWMD_OK or PWMD_ERROR now are prototyped to return
198 a type of gpg_error_t. This removes the extra needed parameter when calling
199 these functions. When these functions succeed, 0 is returned. Otherwise it's
200 an error code that pwmd_strerror() can describe.
202 Renamed pwmd_option to pwmd_option_t.
204 Added PWMD_OPTION_STATUS_FUNC and PWMD_OPTION_STATUS_DATA. The set function
205 will be called when pwmd sends a status (S) line. The function should return 0
206 on success or a gpg_error_t which will fail the current command with the
207 returned error code.
209 Renamed PWMD_OPTION_[TITLE|PROMPT|DESC] to PWMD_OPTION_PINENTRY_...
211 When using pinentry for password retrieval, PWMD_OPTION_PINENTRY_TRIES can
212 be set to specify the number of times before giving up after an invalid
213 password.
215 The custom memory de/allocator symbols are now hidden.
217 Renamed pwmd_password_func to pwmd_password_fn. A pwm_t * is also a required
218 argument.
220 Renamed pwmd_status_func to pwmd_status_fn.
222 Removed pwmd_get_password(). This has been replaced by pwmd_open_nb() and
223 pwmd_save_nb(). These function's will return a file descriptor that select()
224 can use when a file isn't cached. When available for a read(), a
225 pwmd_nb_status_t should be read and then passed to pwmd_open_nb_finalize() or
226 pwmd_save_nb_finalize() to update the pwm handle. pwmd_open_nb() also has an
227 option to specify the number of seconds until the pinentry process will
228 timeout.
230 Added pwmd_terminate_pinentry() which will kill the pinentry process
231 associated with the specified pwm handle. Use this if you need a pinentry
232 timeout but don't call pwmd_open_nb().
234 Added pwmc command line option -t to specified the pinentry timeout.
236 When a file ~/.pwmd/env exists, it is read before calling pinentry. This file
237 contains NAME=VALUE pinentry settings where NAME is one of TTY, TERM or
238 DISPLAY. These settings will overwrite the ones set by pwmd_setopt(). This
239 allows a daemon process to use pinentry after it's cache entry has been
240 removed.
242 Quite a few API changes and bugfixes. Read libpwmd.3 for details. 
245 libPWMD v3.0.0
246 --------------
247 Now uses the assuan protocol for communicating with pwmd. This changes things
248 quite a bit. Read on...
250 Uses more secure memory allocation. Kinda. It mainly just zero's out what is
251 allocated before free()'ing it.
253 Added pwmd_init(). Call this before anything else.
255 Added pwmd_open() and pwmd_save(). This removes PWMD_OPEN and PWMD_SAVE.
257 Removed PWMD_COMMAND. pwmd_command() now accepts a format string as the
258 command.
260 Added pwmd_free_result(). Use this to free a result from pwmd_command().
262 Removed PWMD_SETOPT. Changed to pwmd_setopt().
264 Added options for setting up the pinentry terminal and display.
266 Added pwmd_get_password(). This is a nonblocking way of calling pinentry. It
267 returns a file descriptor that select() can use to read from when a password
268 is ready to be read from with read() (mostly ripped from Elinks'
269 start_thread()). Thanks Kalle Olavi Niemitalo <kon@iki.fi> for the idea.
271 Now uses libgpg-error error codes.
273 Fixed pwmc and the BYE command.
275 A few other changes. Read the libpwmd.h header file, libpwmd.3 and ChangeLog
276 for all the details.
279 libPWMD v2.0.3
280 --------------
281 Split pwmd and libpwmd into their own packages.
283 Added PWMD_SETOPT options PWMD_OPTION_PASSWORD_FUNC and
284 PWMD_OPTION_PASSWORD_DATA to specify a custom password retrieval function for
285 use with the PWMD_OPEN and PWMD_SAVE commands.
287 gpg-agent(1) is no longer used for interacting with pinentry(1). Now libassuan
288 calls pinentry directly. This adds PWMD_OPTION_PINENTRY_PATH to specify the
289 location of the pinentry program. The default is /usr/bin/pinentry. New
290 programs should use PWMD_OPTION_PINENTRY instead of PWMD_OPTION_USEAGENT and
291 EPWMD_PINENTRY_ERROR instead of EPWMD_AGENT_ERROR.
294 libPWMD v2.0.2
295 --------------
296 Added a manual page.
298 Removed pwmd_list_free(). The prototype disappeared but I forgot to remove the
299 code.
302 libPWMD v2.0.1
303 --------------
304 Restore the working directory after connecting to the socket.
306 Changed the gpg-agent title and description strings in pwmc.
308 Fixed a segfault when looking for the empty string in a result from
309 pwmd_command().
312 libPWMD v2.0.0
313 --------------
314 Most of the PWMD_* commands have been removed. PWMD_OPEN, PWMD_SAVE,
315 PWMD_SETOPT and the new PWMD_COMMAND remain. PWMD_COMMAND takes a char*
316 argument being the protocol command along with any argument to send to the
317 server. This is alot simpler and less error prone than before. Also the
318 library won't need to be updated if a protocol command changed or is added.
320 Fixed PWMD_SAVE and asking for a password when the file was cached.
322 Added pwmc. This is a command line client for pwmd. It reads protocol commands
323 from stdin.
325 Removed pwmd_base64_encode() and pwmd_base64_decode().
327 Added a pkg-config meta file.
330 libPWMD v1.0.1
331 --------------
332 Added PWMD_ATTR_GET to get an attribute value from an element path.
334 pwmd_base64_decode() bugfix. Don't assume the return value is a character
335 array by nul-terminating it.
337 Added pwmd_list_free() to free a "list" result.
339 Can compile with g++ and maybe other C++ compilers.
341 Fixed some memory leaks.
343 Bugfix for the protocol parser.
346 libPWMD v1.0.0
347 --------------
348 Changed the version number as suggested by the libtool docs.
350 pwmd_base64_decode() bugfix. The returned string wasn't NULL terminated.
352 Updates for the OPEN and SAVE protocol commands. libPWMD no longer base64
353 encodes the key.
355 Updates for the new ATTR protocol command.
358 libPWMD v0.0.1
359 --------------
360 Initial release.