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