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