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