2003-01-30 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / NEWS
1 Noteworthy changes in version 0.4.1 (unreleased)
2 ------------------------------------------------
3
4  * GPGME_ATTR_IS_SECRET is not anymore representable as a string.
5
6  * gpgme_op_verify and gpgme_op_decrypt_verify don't return a status
7    summary anymore.  Use gpgme_get_sig_status to retrieve the individual stati.
8
9  * GpgmeIOCb changed from a void function to a function returning a
10    GpgmeError value.  However, it will always return 0, so you can
11    safely ignore the return value.
12
13  * A new I/O callback event GPGME_EVENT_START has been added.  The new
14    requirement is that you must wait until this event until you are
15    allowed to call the I/O callback handlers previously registered for
16    this context operation.  Calling I/O callback functions for this
17    context operation before the start event happened is unsafe because
18    it can lead to race conditions in a multi-threaded environment.
19
20  * The idle function feature has been removed.  It was not precisely
21    defined in a multi-threaded environment and is obsoleted by the
22    user I/O callback functions.  If you still need a simple way to
23    call something while waiting on one or multiple asynchronous
24    operations to complete, don't set the HANG flag in gpgme_wait (note
25    that this will return to your program more often than the idle
26    function did).
27
28  * gpgme_wait can return NULL even if hang is true, if an error
29    occurs.  In that case *status contains the error code.
30
31  * gpgme_get_engine_info was radically changed.  Instead an XML
32    string, an info structure of the new type GpgmeEngineInfo is
33    returned.  This makes it easier and more robust to evaluate the
34    information in an application.
35
36  * The new function gpgme_get_protocol_name can be used to convert a
37    GpgmeProtocol value into a string.
38
39  * Interface changes relative to the 0.4.0 release:
40 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
41 GpgmeIOCb                       CHANGED: Return type from void to GpgmeError.
42 GpgmeEventIO                    CHANGED: New event type (all numbers changed).
43 gpgme_key_get_string_attr       CHANGED: Don't handle GPGME_ATTR_IS_SECRET.
44 gpgme_op_verify                 CHANGED: Drop R_STAT argument.
45 gpgme_op_decrypt_verify         CHANGED: Drop R_STAT argument.
46 gpgme_wait                      CHANGED: Can return NULL even if hang is true.
47 GpgmeIdleFunc                   REMOVED
48 gpgme_register_idle             REMOVED
49 GpgmeEngineInfo                 NEW
50 gpgme_get_engine_info           CHANGED: Return info structure instead XML.
51 gpgme_get_protocol_name         NEW
52 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
53
54 Noteworthy changes in version 0.4.0 (2002-12-23)
55 ------------------------------------------------
56
57  * Key generation returns the fingerprint of the generated key.
58
59  * New convenience function gpgme_get_key.
60
61  * Supports signatures of user IDs in keys via the new
62    GPGME_KEYLIST_MODE_SIGS keylist mode and the
63    gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
64    interfaces.  The XML info about a key also includes the signatures
65    if available.
66
67  * New data object interface, which is more flexible and transparent.
68
69  * Interface changes relative to the 0.3.9 release:
70 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71 GpgmeDataReadCb                 NEW
72 GpgmeDataWriteCb                NEW
73 GpgmeDataSeekCb                 NEW
74 GpgmeDataReleaseCb              NEW
75 GpgmeDataCbs                    NEW
76 gpgme_data_read                 CHANGED: Match read() closely.
77 gpgme_data_write                CHANGED: Match write() closely.
78 gpgme_data_seek                 NEW
79 gpgme_data_new_from_fd          NEW
80 gpgme_data_new_from_stream      NEW
81 gpgme_data_new_from_cbs         NEW
82 gpgme_data_rewind               DEPRECATED: Replaced by gpgme_data_seek().
83 gpgme_data_new_from_read_cb     DEPRECATED: Replaced by gpgme_data_from_cbs().
84 gpgme_data_get_type             REMOVED: No replacement.
85 gpgme_op_verify                 CHANGED: Take different data objects for
86                                 signed text and plain text.
87 gpgme_op_verify_start           CHANGED: See gpgme_op_verify.
88 gpgme_check_engine              REMOVED: Deprecated since 0.3.0.
89 gpgme_op_genkey                 CHANGED: New parameter FPR.
90 GPGME_KEYLIST_MODE_SIGS         NEW
91 gpgme_key_sig_get_string_attr   NEW
92 gpgme_key_sig_get_ulong_attr    NEW
93 gpgme_get_key                   NEW
94 GPGME_ATTR_SIG_CLASS            NEW
95 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
96
97 Noteworthy changes in version 0.3.14 (2002-12-04)
98 -------------------------------------------------
99
100  * GPGME-Plug is now in its own package "cryptplug".
101
102  * Workaround for a setlocale problem.  Fixed a segv related to not
103    correctly as closed marked file descriptors.
104
105 Noteworthy changes in version 0.3.13 (2002-11-20)
106 -------------------------------------------------
107
108  * Release due to changes in gpgmeplug.
109
110 Noteworthy changes in version 0.3.12 (2002-10-15)
111 -------------------------------------------------
112
113  * Fixed some bux with key listings.  
114
115  * The development has been branched to clean up some API issues.
116    This 0.3 series will be kept for compatibility reasons; so do don't
117    expect new features.
118
119 Noteworthy changes in version 0.3.11 (2002-09-20)
120 -------------------------------------------------
121         
122  * Bug fixes.
123
124 Noteworthy changes in version 0.3.10 (2002-09-02)
125 -------------------------------------------------
126
127  * Setting the signing keys for the CMS protocol does now work.
128
129  * The signers setting is honoured by gpgme_op_edit.
130
131 Noteworthy changes in version 0.3.9 (2002-08-21)
132 ------------------------------------------------
133
134  * A spec file for creating RPMs has been added.
135
136  * An experimental interface to GnuPG's --edit-key functionality is
137    introduced, see gpgme_op_edit.
138
139  * The new gpgme_import_ext function provides a convenient access to
140    the number of processed keys.
141
142  * Interface changes relative to the 0.3.8 release:
143 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
144 GpgmeStatusCode                 NEW
145 GpgmeEditCb                     NEW
146 gpgme_op_edit_start             NEW
147 gpgme_op_edit                   NEW
148 gpgme_op_import_ext             NEW
149 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
150
151 Noteworthy changes in version 0.3.8 (2002-06-25)
152 ------------------------------------------------
153
154  * It is possible to use an outside event loop for the I/O to the
155    crypto engine by setting the I/O callbacks with gpgme_set_io_cbs.
156
157  * Interface changes relative to the 0.3.6 release:
158 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
159 GpgmeIOCb                       NEW
160 GpgmeRegisterIOCb               NEW
161 GpgmeRemoveIOCb                 NEW
162 GpgmeEventIO                    NEW
163 GpgmeEventIOCb                  NEW
164 struct GpgmeIOCbs               NEW
165 gpgme_set_io_cbs                NEW
166 gpgme_get_io_cbs                NEW
167 GPGME_ATTR_ERRTOK               NEW
168 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
169
170 Noteworthy changes in version 0.3.7 (2002-06-04)
171 ------------------------------------------------
172
173  * GPGME_ATTR_OTRUST is implemented now.
174
175  * A first step toward thread safeness has been achieved, see the
176    documentation for details.  Supported thread libraries are pthread
177    and Pth.
178
179 Noteworthy changes in version 0.3.6 (2002-05-03)
180 ------------------------------------------------
181
182  * All error output of the gpgsm backend is send to the bit bucket.
183
184  * The signature verification functions are extended.  Instead of
185    always returning GPGME_SIG_STATUS_GOOD, the functions new codes for
186    expired signatures.  2 new functions may be used to retrieve more
187    detailed information like the signature expiration time and a
188    validity information of the key without an extra key looking.
189
190  * The current passphrase callback and progress meter callback can be
191    retrieved with the new functions gpgme_get_passphrase_cb and
192    gpgme_get_progress_cb respectively.
193
194  * Interface changes relative to the 0.3.5 release:
195 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
196 gpgme_get_passphrase_cb         NEW
197 gpgme_get_progress_cb           NEW
198 GpgmeDataEncoding               NEW
199 gpgme_data_set_encoding         NEW
200 gpgme_data_get_encoding         NEW
201 GPGME_SIG_STAT_GOOD_EXP         NEW
202 GPGME_SIG_STAT_GOOD_EXPKEY      NEW
203 gpgme_op_verify                 CHANGED: Returns more status codes.
204 GPGME_ATTR_SIG_STATUS           NEW
205 gpgme_get_sig_string_attr       NEW
206 gpgme_get_sig_ulong_attr        NEW
207 gpgme_get_protocol              NEW
208 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
209
210 Noteworthy changes in version 0.3.5 (2002-04-01)
211 ------------------------------------------------
212
213  * gpgme_op_encrypt can be called with RECIPIENTS being 0.  In this
214    case, symmetric encryption is performed.  Note that this requires a
215    passphrase from the user.
216
217  * More information is returned for X.509 certificates.
218
219  * Interface changes relative to the 0.3.4 release:
220 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221 gpgme_op_encrypt                EXTENDED: Symmetric encryption possible
222 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
223
224 Noteworthy changes in version 0.3.4 (2002-03-04)
225 ------------------------------------------------
226
227  * gpgme_op_encrypt does now fail with GPGME_Invalid_Recipients if
228    some recipients have been invalid, whereas earlier versions
229    succeeded in this case.  The plaintext is still encrypted for all valid
230    recipients, so the application might take this error as a hint that
231    the ciphertext is not usable for all requested recipients.
232    Information about invalid recipients is available with gpgme_get_op_info.
233
234  * gpgme_op_verify now allows to pass an uninitialized data object as
235    its plaintext argument to check for normal and cleartext
236    signatures.  The plaintext is then returned in the data object.
237
238  * New interfaces gpgme_set_include_certs and gpgme_get_include_certs
239    to set and get the number of certifications to include in S/MIME
240    signed messages.
241
242  * New interfaces gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start
243    to encrypt and sign a message in a combined operation.
244
245  * New interface gpgme_op_keylist_ext_start to search for multiple patterns.
246
247  * gpgme_key_get_ulong_attr supports the GPGME_ATTR_EXPIRE attribute.
248
249  * Interface changes relative to the 0.3.3 release:
250 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
251 gpgme_op_encrypt                CHANGED: Can fail with GPGME_Invalid_Recipients
252 gpgme_op_verify                 EXTENDED: Accepts uninitialized text argument
253 gpgme_key_get_ulong_attr        EXTENDED: Supports GPGME_ATTR_EXPIRE
254 gpgme_set_include_certs         NEW
255 gpgme_get_include_certs         NEW
256 gpgme_op_encrypt_sign           NEW
257 gpgme_op_encrypt_sign_start     NEW
258 gpgme_op_keylist_ext_start      NEW
259 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
260
261 Noteworthy changes in version 0.3.3 (2002-02-12)
262 ------------------------------------------------
263
264  * Fix the Makefile in jnlib.
265
266  * Fix the test suite (hopefully).  It should clean up all its state
267    with `make check' now.
268
269
270 Noteworthy changes in version 0.3.2 (2002-02-10)
271 ------------------------------------------------
272
273  * Remove erroneous dependency on libgcrypt in jnlib.
274
275
276 Noteworthy changes in version 0.3.1 (2002-02-09)
277 ------------------------------------------------
278
279  * There is a Texinfo manual documenting the API.
280
281  * The gpgme_set_keylist_mode function returns an error, and changed
282    its meaning.  It is no longer usable to select between normal and
283    fast mode (newer versions of GnuPG will always be fast), but
284    selects between local keyring, remote keyserver, or both.
285    For this, two new macros are defined, GPGME_KEYLIST_MODE_LOCAL
286    and GPGME_KEYLIST_MODE_EXTERN.  To make it possible to modify the
287    current setting, a fucntion gpgme_get_keylist_mode was added to
288    retrieve the current mode.
289
290  * gpgme_wait accepts a new argument STATUS to return the error status
291    of the operation on the context.  Its definition is closer to
292    waitpid() now than before.
293
294  * The LENGTH argument to gpgme_data_new_from_filepart changed its
295    type from off_t to the unsigned size_t.
296
297  * The R_HD argument to the GpgmePassphraseCb type changed its type
298    from void* to void**.
299
300  * New interface gpgme_op_trustlist_end() to match
301    gpgme_op_keylist_end().
302
303  * The CryptPlug modules have been renamed to gpgme-openpgp and
304    gpgme-smime, and they are installed in pkglibdir by `make install'.
305
306  * An idle function can be registered with gpgme_register_idle().
307
308  * The GpgSM backend supports key generation with gpgme_op_genkey().
309
310  * Interface changes relative to the 0.3.0 release:
311 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
312 gpgme_data_new_from_filepart    CHANGED: Type of LENGTH is size_t.
313 GpgmePassphraseCb               CHANGED: Type of R_HD is void **.
314 gpgme_wait                      CHANGED: New argument STATUS.
315 gpgme_set_keylist_mode          CHANGED: Type of return value is GpgmeError.
316                                 The function has a new meaning!
317 gpgme_get_keylist_mode          NEW
318 GPGME_KEYLIST_MODE_LOCAL        NEW
319 GPGME_KEYLIST_MODE_EXTERN       NEW
320 gpgme_op_trustlist_next         NEW
321 GpgmeIdleFunc                   NEW
322 gpgme_register_idle             NEW
323 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
324
325 Noteworthy changes in version 0.3.0 (2001-12-19)
326 ------------------------------------------------
327  
328  * New interface gpgme_set_protocol() to set the protocol and thus the
329    crypto engine to be used by the context.  Currently, the OpenPGP
330    and the CMS protocols are supported.  They are specified by the new
331    preprocessor symbols GPGME_PROTOCOL_OpenPGP and GPGME_PROTOCOL_CMS.
332    A new context uses the OpenPGP engine by default.
333
334  * gpgme_get_engine_info() returns information for all crypto engines
335    compiled into the library.  The XML format has changed.  To
336    reliably get the version of a crypto engine, the <version> tag
337    after the appropriate <protocol> tag has to be looked for.
338
339  * New interface gpgme_engine_check_version(), obsoleting
340    gpgme_check_engine().  Check the version of all engines you are
341    supporting in your software.
342
343  * GpgmeKey lists the user ids in the order as they are returned by
344    GnuPG, first the primary key with index 0, then the sub-user ids.
345
346  * New operation gpgme_op_decrypt_verify() to decrypt and verify
347    signatures simultaneously.
348
349  * The new interface gpgme_op_keylist_end() terminates a pending
350    keylist operation.  A keylist operation is also terminated when
351    gpgme_op_keylist_next() returns GPGME_EOF.
352
353  * GPGME can be compiled without GnuPG being installed (`--with-gpg=PATH'),
354    cross-compiled, or even compiled without support for GnuPG
355    (`--without-gpg').
356
357  * GPGME can be compiled with support for GpgSM (GnuPG for S/MIME,
358    `--with-gpgsm=PATH').  It is enabled by default if the `gpgsm' is found
359    in the path, but it can also be compiled without support for GpgSM
360    (`--without-gpgsm').
361
362  * CryptPlug modules for GPGME are included and can be enabled at
363    configure time (`--enable-gpgmeplug').  There is one module which
364    uses the GnuPG engine (`gpgmeplug') and one module which uses the
365    GpgSM engine (`gpgsmplug').
366
367  * Interface changes relative to the latest 0.2.x release:
368 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
369 gpgme_key_get_as_xml            CHANGED: Sub-user ids reversed in order.
370 gpgme_key_get_string_attr       CHANGED: User ids reversed in order.
371 gpgme_key_get_ulong_attr        CHANGED: User ids reversed in order.
372 gpgme_get_engine_info           CHANGED: New format, extended content.
373 gpgme_engine_check_version      NEW
374 gpgme_decrypt_verify_start      NEW
375 gpgme_decrypt_verify            NEW
376 gpgme_op_keylist_next           NEW
377 gpgme_set_protocol              NEW
378 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
379
380
381 Noteworthy changes in version 0.2.3 (2001-09-17)
382 ------------------------------------------------
383
384  * New function gpgme_get_op_info which can be used to get the micalg
385    parameter needed for MOSS.
386
387  * New functions gpgme_get_armor and gpgme_get_textmode.
388
389  * The usual bug fixes and some minor functionality improvements.
390
391  * Added a simple encryption component for MS-Windows; however the
392    build procedure might have some problems.
393
394
395 Noteworthy changes in version 0.2.2 (2001-06-12)
396 ------------------------------------------------
397  
398  * Implemented a key cache.
399
400  * Fixed a race condition under W32 and some other bug fixes.
401
402
403 Noteworthy changes in version 0.2.1 (2001-04-02)
404 ------------------------------------------------
405
406  * Changed debug output and GPGME_DEBUG variable (gpgme/debug.c)
407
408  * Handle GnuPG's new key capabilities output and support revocation
409    et al. attributes
410
411  * Made the W32 support more robust.
412
413
414  Copyright 2001, 2002 g10 Code GmbH
415
416  This file is free software; as a special exception the author gives
417  unlimited permission to copy and/or distribute it, with or without
418  modifications, as long as this notice is preserved.
419
420  This file is distributed in the hope that it will be useful, but
421  WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
422  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.