2008-01-28 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / NEWS
1 Noteworthy changes in version 1.1.7 (unreleased)
2 ------------------------------------------------
3
4  * The encoding of gpgme_data_t objects can affect the output encoding
5    of export, sign and encrypt operations now (the same operations
6    that are also affected by the ASCII mode switch).  We believe this
7    change in the ABI is innocent enough not to break existing
8    applications (it only affects the S/MIME backend on certain
9    operations).
10
11  * Interface changes relative to the 1.1.6 release:
12  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13 gpgme_op_encrypt                CHANGED: Output encoding can affect result.
14 gpgme_op_encrypt_start          CHANGED: Output encoding can affect result.
15 gpgme_op_encrypt_sign           CHANGED: Output encoding can affect result.
16 gpgme_op_encrypt_sign_start     CHANGED: Output encoding can affect result.
17 gpgme_op_sign                   CHANGED: Output encoding can affect result.
18 gpgme_op_sign_start             CHANGED: Output encoding can affect result.
19 gpgme_op_export                 CHANGED: Output encoding can affect result.
20 gpgme_op_export_start           CHANGED: Output encoding can affect result.
21 gpgme_op_export_ext             CHANGED: Output encoding can affect result.
22 gpgme_op_export_ext_start       CHANGED: Output encoding can affect result.
23  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24
25
26 Noteworthy changes in version 1.1.6 (2008-01-04)
27 ------------------------------------------------
28
29  * Bug fixes for for W32.
30
31  * A new, experimental (and thus undocumented and potentially
32    unstable) interface for accessing gpg-conf through GPGME has been
33    added.
34
35  * Interface changes relative to the 1.1.1 release:
36  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37  gpgme_signature_t               EXTENDED: New field chain_model.
38  gpgme_op_getauditlog_start      NEW.
39  gpgme_op_getauditlog            NEW.
40  GPGME_AUDITLOG_HTML             NEW.
41  GPGME_AUDITLOG_WITH_HELP        NEW.
42  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
43
44
45 Noteworthy changes in version 1.1.5 (2007-07-09)
46 ------------------------------------------------
47
48  * Bug and portability fixes (mainly for W32).
49
50
51 Noteworthy changes in version 1.1.4 (2007-03-05)
52 ------------------------------------------------
53
54  * Detect and bail out on double plaintext messages.  This is required
55    so that applications can properly detect the signed parts of a
56    message.  Actual there is now a double protection as GnuPG 1.4.7
57    will detect this case too.
58
59
60 Noteworthy changes in version 1.1.3 (2007-01-29)
61 ------------------------------------------------
62
63  * Fixed a memory leak in gpgme_data_release_and_get_mem.
64
65  * Fixed a bug in Windows command line quoting.
66
67
68 Noteworthy changes in version 1.1.2 (2006-03-02)
69 ------------------------------------------------
70
71  * Fixed a bug in the W32 glib backend.
72
73
74 Noteworthy changes in version 1.1.1 (2006-02-23)
75 ------------------------------------------------
76
77  * Fixed a bug in that the fingerprints of subkeys are not available.
78
79  * Clarified usage of the SECRET flag in key listings.  It is now
80    reset for stub keys.
81
82  * Reading signature notations and policy URLs on key signatures is
83    supported.  They can be found in the new field notations of the
84    gpgme_key_sig_t structure.  This has to be enabled with the keylist
85    mode flag GPGME_KEYLIST_MODE_SIG_NOTATIONS.
86
87  * A new gpgme_free() function solves the problem of using different
88    allocators in a single program.  This function should now be used
89    instead calling free() to release the buffer returned by
90    gpgme_data_release_and_get_mem.  It is recommended that you always
91    do this, but it is only necessary on certain platforms, so backwards
92    compatibility is provided.  In other words: If free() worked for
93    you before, it will keep working.
94
95  * New status codes GPGME_PKA_TRUST_GOOD and GPGME_PKA_TRUST_BAD.
96    They are analyzed by the verify handlers and made available in the
97    new PKA_TRUST and PKA_ADDRESS fields of the signature result structure.
98
99  * Interface changes relative to the 1.1.0 release:
100 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
101 gpgme_key_sig_t                 EXTENDED: New field notations.
102 GPGME_KEYLIST_MODE_SIG_NOTATIONS NEW
103 gpgme_free                      NEW
104 GPGME_STATUS_PKA_TRUST_BAD      NEW
105 GPGME_STATUS_PKA_TRUST_GOOD     NEW
106 gpgme_signature_t               EXTENDED: New field pka_trust.
107 gpgme_signature_t               EXTENDED: New field pka_address.
108 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
109
110
111 Noteworthy changes in version 1.1.0 (2005-10-01)
112 ------------------------------------------------
113
114  * You can now configure the backend engine file name and home
115    directory to be used, as default and per context.
116
117  * Information about the recipients of an encrypted text is now
118    available at decryption time.
119
120  * New status GPGME_STATUS_PLAINTEXT.  This is analyzed by the decrypt
121    and verify handlers, the information about the plaintext filename,
122    if available is made available in the new field file_name of the
123    respective result structure.
124
125  * The code for "automagically detecting the thread library" has been
126    removed from libgpgme.  It is deprecated since version 0.4.3.
127    Since then, you had to link against libgpgme-pthread for
128    applications using pthread and libgpgme-pth for applications using
129    GNU Pth.
130
131    The code was removed because it caused compilation problems on
132    systems where the pthread.h header from GNU Pth is available in
133    addition to the system header (FreeBSD 6 and later for example).
134
135  * "./autogen.sh --build-w32" does now build gpgme.dll.
136
137  * [W32] The environment variable GPGME_DEBUG now uses a semicolon as
138    delimiter.  The standard install directory is used when locating
139    gpg or gpgsm before finally falling back to the hardwired name.
140
141  * There is a new flag for keys and subkeys, is_qualified, which
142    indicates if a key can be used for qualified signatures according
143    to local government regulations.
144
145  * You can associate a filename with a data object using the new
146    function gpgme_data_set_file_name().  This filename will be stored
147    in the output when encrypting or signing the data and will be
148    returned when decrypting or verifying the output data.
149
150  * You can now set notation data at signature creation with the new
151    function gpgme_sig_notation_add().
152
153  * Interface changes relative to the 1.0.3 release:
154 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
155 gpgme_set_engine_info           NEW
156 gpgme_ctx_get_engine_info       NEW
157 gpgme_ctx_set_engine_info       NEW
158 gpgme_recipient_t               NEW
159 gpgme_decrypt_result_t          EXTENDED: New field recipients.
160 gpgme_verify_result_t           EXTENDED: New fields pubkey_algo, hash_algo.
161 gpgme_decrypt_result_t          EXTENDED: New field plaintext_filename.
162 gpgme_verify_result_t           EXTENDED: New field plaintext_filename.
163 GPGME_STATUS_PLAINTEXT          NEW
164 gpgme_key_t                     EXTENDED: New field is_qualified.
165 gpgme_subkey_t                  EXTENDED: New field is_qualified.
166 gpgme_data_get_file_name        NEW
167 gpgme_data_set_file_name        NEW
168 gpgme_sig_notation_flags_t      NEW
169 GPGME_SIG_NOTATION_HUMAN_READABLE NEW
170 GPGME_SIG_NOTATAION_CRITICAL    NEW
171 gpgme_sig_notation_clear        NEW
172 gpgme_sig_notation_add          NEW
173 gpgme_sig_notation_get          NEW
174 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
175
176
177 Noteworthy changes in version 1.0.3 (2005-06-20)
178 ------------------------------------------------
179
180  * Previousy, GPGME would use a default "include certs" of 1.  This
181    has been changed.  Now GPGME will use the crypto backend engines
182    default unless you set the value with gpgme_set_include_certs()
183    explicitely.  A new macro GPGME_INCLUDE_CERTS_DEFAULT can be used
184    as a value to explicitely request the new default behaviour.
185
186    Because the default changes, this is a slight change of the API
187    semantics.  We consider it to be a bug fix.
188
189  * A bug which made GPGME hang has been fixed.  If you have
190    experienced hanging before, please try out this version and let me
191    know if you still experience hanging problems.
192
193  * Interface changes relative to the 0.9.0 release:
194 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
195 gpgme_set_include_certs         CHANGED DEFAULT
196 GPGME_INCLUDE_CERTS_DEFAULT     NEW
197 GPGME_STATUS_SIG_SUBPACKET      NEW
198 GPGME_STATUS_NEED_PASSPHRASE_PIN NEW
199 GPGME_STATUS_SC_OP_FAILURE      NEW
200 GPGME_STATUS_SC_OP_SUCCESS      NEW
201 GPGME_STATUS_CARDCTRL           NEW
202 GPGME_STATUS_BACKUP_KEY_CREATED NEW
203 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
204
205
206 Noteworthy changes in version 1.0.2 (2004-12-28)
207 ------------------------------------------------
208
209  * Changed the license of the library to the GNU Lesser General Public
210    License (LGPL), version 2.1 or later.
211
212
213 Noteworthy changes in version 1.0.1 (2004-10-22)
214 ------------------------------------------------
215
216  * Only bug fixes.
217
218
219 Noteworthy changes in version 1.0.0 (2004-09-30)
220 ------------------------------------------------
221
222  * Version 1.0.0!  We are proud to present you with a thoroughly
223    tested and stable version of the GPGME library.  A big Thank You!
224    to all the people who made this possible.
225
226    The development will be branched into a stable 1.x.y series and the
227    head.
228
229  * The gpgme.m4 macro supports checking the API version.  Just prepend
230    it to the required version string, separated by a colon.  For
231    example, this release has the version "1:1.0.0".  The last release
232    to which this version is (mostly) ABI compatible is "1:0.4.2",
233    which is the default required version.
234
235
236 Noteworthy changes in version 0.9.0 (2004-06-08)
237 ------------------------------------------------
238
239  * The type gpgme_key_t has now a new field keylist_mode that contains
240    the keylist mode that was active at the time the key was retrieved.
241
242  * The type gpgme_decrypt_result_t has a new field "wrong_key_usage"
243    that contains a flag indicating that the key should not have been
244    used for encryption.
245
246  * Verifying a signature of a revoked key gives the correct result now
247    (GPG_ERR_CERT_REVOKED error code).
248
249  * Clarified that the error code GPG_ERR_NO_DATA from the decrypt &
250    verify operations still allows you to look at the signature
251    verification result.
252
253  * Clarified that patterns in keylisting operations have an upper
254    limit, and thus are not suited to list many keys at once by their
255    fingerprint.  Also improve the error message if the pattern is too
256    long for the CMS protocol to handle.
257
258 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
259 gpgme_key_t                     EXTENDED: New field keylist_mode.
260 gpgme_decrypt_result_t          EXTENDED: New field wrong_key_usage.
261 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
262
263
264 Noteworthy changes in version 0.4.7 (2004-04-29)
265 ------------------------------------------------
266
267  * Correctly initialize the fields expired, revoked, invalid, and
268    disabled in the gpgme_key_t structures.
269
270  * A bug fix: The flag wrong_key_usage of gpgme_signature_t was
271    accidently of type int instead unsigned int.
272
273  * Interface changes relative to the 0.4.5 release:
274 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
275 gpgme_signature_t               CHANGED: wrong_key_usage is unsigned int now.
276 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
277
278 Noteworthy changes in version 0.4.6 (2004-04-06)
279 ------------------------------------------------
280
281  * Bug fixes
282
283
284 Noteworthy changes in version 0.4.5 (2004-03-07)
285 ------------------------------------------------
286
287  * GPGME is now compiled with LFS (large file support) by default.
288    This means that _all_ programs using GPGME must be compiled with
289    LFS support enabled by default.  You can do this easily with
290    autoconf, by using the AC_SYS_LARGEFILE macro.  Or you can do this
291    without autoconf by defining the preprocessor symbol
292    _FILE_OFFSET_BITS to 64 (by passing the -D_FILE_OFFSET_BITS=64 to
293    the C compiler command line, or by defining this preprocessor
294    symbol before including any system header files).  For more
295    details, read the section on LFS in the manual.
296
297    Up to now, it was undocumented that GPGME was not using LFS.
298    But the public interfaces use off_t, and file descriptors are
299    exchanged between the application and GPGME.  This was an oversight,
300    and bound to cause troubles in the future.
301
302    Writing GPGME as a dual mode library that seamlessly supports LFS
303    while keeping backwards compatibility is possible, but does not
304    solve the problem: Many applications already expect GPGME to have
305    LFS (they are compiled with off_t being a 64bit value).  This is true
306    in particular for the popular Gtk+ and Qt programs.
307
308    So, although this is an ABI (but not an API) break, we will not
309    change the library version to reflect that.  Because the interfaces
310    affected are probably not used yet in any GPGME 0.4 based
311    application, we don't expect any real failures from this change.
312    In fact, applications already using LFS will have some subtle bugs
313    fixed.
314
315    However, if you encounter an application using GPGME 0.4.x that
316    does _not_ use LFS by default (off_t is a 32bit value), _and_
317    uses at least one of the functions gpgme_data_seek,
318    gpgme_data_new_from_filepart, or a gpgme_data_seek_cb_t with
319    gpgme_data_new_from_cbs, then indeed this library will be ABI
320    incompatible with the program.  As said above, we don't believe
321    such a program exists.  If we are in error, then you have two
322    options: As a quick hack, you can configure GPGME with the
323    --disable-largefile option.  This will revert the change, and GPGME
324    will not use LFS.  However, GPGME will be incompatible with
325    programs that expect GPGME to use LFS.  All applications are
326    required to use LFS when using GPGME, so this is only good as a
327    temporary local work-around.
328
329    The other option is to change the versioning of the library and
330    recompile all applications.  We have reserved a special version of
331    the library for that, so you can do that without expecting a
332    version clash in the future.  Furthermore, everyone who does this
333    will agree on the version to use (this is important for
334    distribution makers).  Read the comment in configure.ac (before
335    LIBGPGME_LT_AGE) if you want to do this.  Please don't do this
336    blindly: As stated above, we think it is unlikely this measure is
337    needed.  Still, it is there if necessary.  If in doubt, contact us
338    and we will give our advise for your specific situation.
339
340  * New key listing mode GPGME_KEYLIST_MODE_VALIDATE for validation of
341    the listed keys.
342
343  * New interface gpgme_cancel() that can be used to cancel
344    asynchronous operations.
345
346  * Interface changes relative to the 0.4.4 release:
347 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
348 gpgme_data_seek_cb_t            CHANGED: off_t is now a largefile type.
349 gpgme_data_seek                 CHANGED: off_t is now a largefile type.
350 gpgme_data_new_from_filepart    CHANGED: off_t is now a largefile type.
351 GPGME_KEYLIST_MODE_VALIDATE     NEW
352 gpgme_cancel                    NEW
353 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
354
355 Noteworthy changes in version 0.4.4 (2004-01-12)
356 ------------------------------------------------
357
358  * The member "class" in gpgme_key_sig_t and gpgme_new_signature_t has
359    been renamed to "sig_class", to avoid clash with C++ compilers.  In
360    the C API, the old name "class" has been preserved for backwards
361    compatibility, but is deprecated.
362
363  * Interface changes relative to the 0.4.3 release:
364 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
365 gpgme_key_sig_t                 CHANGED: class deprecated, use new sig_class.
366 gpgme_new_signature_t           CHANGED: class deprecated, use new sig_class.
367 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
368
369 Noteworthy changes in version 0.4.3 (2003-10-06)
370 ------------------------------------------------
371
372  * libgpgme should not be used for threaded programs anymore.  This
373    never worked reliably in all cases, because you had to
374    be careful about the linking order and libtool wouldn't do that for
375    you automatically.  Instead, now you have to link against
376    libgpgme-pthread for applications using pthread and libgpgme-pth for
377    applications using GNU Pth.
378
379    The old code for automagically detecting the thread library is
380    still part of libgpgme, but it is DEPRECATED.
381
382  * There are new automake macros AM_PATH_GPGME_PTH and
383    AM_PATH_GPGME_PTHREAD, which support checking for thread-enabled
384    versions of GPGME.  They define GPGME_PTH_CFLAGS, GPGME_PTH_LIBS,
385    GPGME_PTHREAD_CFLAGS and GPGME_PTHREAD_LIBS respectively.  These
386    variables of course also include the configuration for the thread
387    package itself.  Alternatively, use libtool.
388
389  * gpgme_strerror_r as a thread safe variant of gpgme_strerror was
390    added.
391
392  * gpgme-config doesn't support setting the prefix or exec prefix
393    anymore.  I don't think it ever worked correctly, and it seems to
394    be pointless.
395
396  * gpgme_get_key fails with GPG_ERR_AMBIGUOUS_NAME if the key ID
397    provided was not unique, instead returning the first matching key.
398
399  * gpgme_key_t and gpgme_subkey_t have a new field, can_authenticate,
400    that indicates if the key can be used for authentication.
401
402  * gpgme_signature_t's status field is now correctly set to an error
403    with error code GPG_ERR_NO_PUBKEY if public key is not found.
404
405  * gpgme_new_signature_t's class field is now an unsigned int, rather
406    than an unsigned long (the old class field is preserved for
407    backwards compatibility).
408
409  * A new function gpgme_set_locale() is provided to allow configuring
410    the locale for the crypto backend.  This is necessary for text
411    terminals so that programs like the pinentry can be started with
412    the right locale settings for the terminal the application is running
413    on, in case the terminal has different settings than the system
414    default (for example, if it is a remote terminal).  You are highly
415    recommended to call the following functions directly after
416    gpgme_check_version:
417
418    #include <locale.h>
419
420    setlocale (LC_ALL, "");
421    gpgme_set_locale (NULL, LC_CTYPE, setlocale (LC_CTYPE, NULL));
422    gpgme_set_locale (NULL, LC_MESSAGES, setlocale (LC_MESSAGES, NULL));
423
424    GPGME can not do this for you, as setlocale is not thread safe, and
425    there is no alternative.
426
427  * The signal action for SIGPIPE is now set to SIG_IGN by
428    gpgme_check_version, instead the first time a crypto engine is
429    started (which is not well defined).
430
431  * In the output of gpgme_hash_algo_name, change RMD160 to RIPEMD160,
432    TIGER to TIGER192, CRC32-RFC1510 to CRC32RFC1510, and CRC24-RFC2440
433    to CRC24RFC2440.  For now, these strings can be used as the MIC
434    parameter for PGP/MIME (if appropriately modified).
435
436  * Interface changes relative to the 0.4.2 release:
437 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
438 gpgme_strerror_t                NEW
439 gpgme_get_key                   CHANGED: Fails correctly if key ID not unique.
440 gpgme_key_t                     EXTENDED: New field can_authenticate.
441 gpgme_subkey_t                  EXTENDED: New field can_authenticate.
442 gpgme_new_signature_t           CHANGED: New type for class field.
443 gpgme_set_locale                NEW
444 gpgme_hash_algo_name            CHANGED: Slight adjustment of algo names.
445 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
446
447 Noteworthy changes in version 0.4.2 (2003-07-30)
448 ------------------------------------------------
449
450  * Allow gpg-error to be in non-standard place when linking the test suite.
451
452  * Configure will fail now if gpg-error can not be found.
453
454  * Fixed initialized memory backed data objects for writing, which
455    caused the test program to crash (but only on Mac OS, surprisingly).
456
457  * Eliminate use of C99 constructs.
458
459  * Small improvements to the manual.
460
461
462 Noteworthy changes in version 0.4.1 (2003-06-06)
463 ------------------------------------------------
464
465  This is the release that 0.4.0 should have been.  There are many
466  interface changes, please see below for the details.  The changes are
467  sometimes the result of new functionality, but more often express a
468  paradigm shift.  Others are an overdue cleanup to get GPGME in line
469  with the GNU coding standards and to make the interface more
470  self-consistent.  Here is an overview on the changes:
471
472  All types have been renamed to conform to the GNU coding standards,
473  most of the time by keeping the whole name in lowercase and inserting
474  underscores between words.
475
476  All operations consistently only accept input parameters in their
477  invocation function, and return only an error code directly.  Further
478  information about the result of the operation has to be retrieved
479  afterwards by calling one of the result functions.  This unifies the
480  synchronous and the asynchronous interface.
481
482  The error values have been completely replaced by a more
483  sophisticated model that allows GPGME to transparently and accurately
484  report all errors from the other GnuPG components, irregardless of
485  process boundaries.  This is achieved by using the library
486  libgpg-errors, which is shared by all GnuPG components.  This library
487  is now required for GPGME.
488
489  The results of all operations are now provided by pointers to C
490  structs rather than by XML structs or in other ways.
491
492  Objects which used to be opaque (for example a key) are now pointers
493  to accessible structs, so no accessor functions are necessary.
494
495  Backward compatibility is provided where it was possible without too
496  much effort and did not collide with the overall sanitization effort.
497  However, this is only for ease of transition.  NO DEPRECATED FUNCTION
498  OR DATA TYPE IS CONSIDERED A PART OF THE API OR ABI AND WILL BE
499  DROPPED IN THE FUTURE WITHOUT CHANGING THE SONAME OF THE LIBRARY.
500  Recommendations how to replace deprecated or removed functionality
501  can be found within the description of each change.
502
503  What follows are all changes to the interface and behaviour of GPGME
504  in detail.
505
506  * If gpgme.h is included in sources compiled by GCC 3.1 or later,
507    deprecated attributes will warn about use of obsolete functions and
508    type definitions.  You can suppress these warnings by passing
509    -Wno-deprecated-declarations to the gcc command.
510
511  * The following types have been renamed.  The old types are still
512    available as aliases, but they are deprecated now:
513    Old name:            New name:
514    GpgmeCtx             gpgme_ctx_t
515    GpgmeData            gpgme_data_t
516    GpgmeError           gpgme_error_t
517    GpgmeDataEncoding    gpgme_data_encoding_t
518    GpgmeSigStat         gpgme_sig_stat_t
519    GpgmeSigMode         gpgme_sig_mode_t
520    GpgmeAttr            gpgme_attr_t
521    GpgmeValidity        gpgme_validity_t
522    GpgmeProtocol        gpgme_protocol_t
523    GpgmeKey             gpgme_key_t
524    GpgmePassphraseCb    gpgme_passphrase_cb_t
525    GpgmeProgressCb      gpgme_progress_cb_t
526    GpgmeIOCb            gpgme_io_cb_t
527    GpgmeRegisterIOCb    gpgme_register_io_cb_t
528    GpgmeRemoveIOCb      gpgme_remove_io_cb_t
529    GpgmeEventIO         gpgme_event_io_t
530    GpgmeEventIOCb       gpgme_event_io_cb_t
531    GpgmeIOCbs           gpgme_io_cbs
532    GpgmeDataReadCb      gpgme_data_read_cb_t
533    GpgmeDataWriteCb     gpgme_data_write_cb_t
534    GpgmeDataSeekCb      gpgme_data_seek_cb_t
535    GpgmeDataReleaseCb   gpgme_data_release_cb_t
536    GpgmeDataCbs         gpgme_data_cbs_t
537    GpgmeTrustItem       gpgme_trust_item_t
538    GpgmeStatusCode      gpgme_status_code_t
539
540  * gpgme_error_t is now identical to gpg_error_t, the error type
541    provided by libgpg-error.  More about using libgpg-error with GPGME
542    can be found in the manual.  All error symbols have been removed!
543
544  * All functions and types in libgpg-error have been wrapped in GPGME.
545    The new types are gpgme_err_code_t and gpgme_err_source_t.  The new
546    functions are gpgme_err_code, gpgme_err_source, gpgme_error,
547    gpgme_err_make, gpgme_error_from_errno, gpgme_err_make_from_errno,
548    gpgme_err_code_from_errno, gpgme_err_code_to_errno,
549    gpgme_strsource.
550
551  * GPGME_ATTR_IS_SECRET is not anymore representable as a string.
552
553  * GnuPG 1.2.2 is required.  The progress callback is now also invoked
554    for encrypt, sign, encrypt-sign, decrypt, verify, and
555    decrypt-verify operations.  For verify operations on detached
556    signatures, the progress callback is invoked for both the detached
557    signature and the plaintext message, though.
558
559  * gpgme_passphrase_cb_t has been changed to not provide a complete
560    description, but the UID hint, passphrase info and a flag
561    indicating if this is a repeated attempt individually, so the user
562    can compose his own description from this information.
563
564    The passphrase is not returned as a C string, but must be written
565    to a file descriptor directly.  This allows for secure passphrase
566    entries.
567
568    The return type has been changed to gpgme_error_t value.  This
569    allowed to remove the gpgme_cancel function; just return
570    the error code GPG_ERR_CANCELED in the passphrase callback directly.
571
572  * gpgme_edit_cb_t has been changed to take a file descriptor argument.
573    The user is expected to write the response to the file descriptor,
574    followed by a newline.
575
576  * The recipients interface has been removed.  Instead, you use
577    NULL-terminated lists of keys for specifying the recipients of an
578    encryption operation.  Use the new encryption flag
579    GPGME_ENCRYPT_ALWAYS_TRUST if you want to override the validity of
580    the keys (but note that in general this is not a good idea).
581
582    This change has been made to the prototypes of gpgme_op_encrypt,
583    gpgme_op_encrypt_start, gpgme_op_encrypt_sign and
584    gpgme_op_encrypt_sign_start.
585
586    The export interface has been changed to use pattern strings like
587    the keylist interface.  Thus, new functions gpgme_op_export_ext and
588    gpgme_op_export_ext_start have been added as well.  Now the
589    prototypes of gpgme_op_export_start and gpgme_op_export finally
590    make sense.
591
592  * gpgme_op_verify and gpgme_op_decrypt_verify don't return a status
593    summary anymore.  Use gpgme_get_sig_status to retrieve the individual
594    stati.
595
596  * gpgme_io_cb_t changed from a void function to a function returning
597    a gpgme_error_t value.  However, it will always return 0, so you
598    can safely ignore the return value.
599
600  * A new I/O callback event GPGME_EVENT_START has been added.  The new
601    requirement is that you must wait until this event until you are
602    allowed to call the I/O callback handlers previously registered for
603    this context operation.  Calling I/O callback functions for this
604    context operation before the start event happened is unsafe because
605    it can lead to race conditions in a multi-threaded environment.
606
607  * The idle function feature has been removed.  It was not precisely
608    defined in a multi-threaded environment and is obsoleted by the
609    user I/O callback functions.  If you still need a simple way to
610    call something while waiting on one or multiple asynchronous
611    operations to complete, don't set the HANG flag in gpgme_wait (note
612    that this will return to your program more often than the idle
613    function did).
614
615  * gpgme_wait can return NULL even if hang is true, if an error
616    occurs.  In that case *status contains the error code.
617
618  * gpgme_get_engine_info was radically changed.  Instead an XML
619    string, an info structure of the new type gpgme_engine_info_t is
620    returned.  This makes it easier and more robust to evaluate the
621    information in an application.
622
623  * The new function gpgme_get_protocol_name can be used to convert a
624    gpgme_protocol_t value into a string.
625
626  * The status of a context operation is not checked anymore.  Starting
627    a new operation will silently cancel the previous one.  Calling a
628    function that requires you to have started an operation before without
629    doing so is undefined.
630
631  * The FPR argument to gpgme_op_genkey was removed.  Instead, use the
632    gpgme_op_genkey_result function to retrieve a gpgme_genkey_result_t
633    pointer to a structure which contains the fingerprint.  This also
634    works with gpgme_op_genkey_start.  The structure also provides
635    other information about the generated keys.
636
637    So, instead:
638
639    char *fpr;
640    err = gpgme_op_genkey (ctx, NULL, NULL, &fpr); 
641    if (!err && fpr)
642      printf ("%s\n", fpr);
643
644    you should now do:
645
646    gpgme_genkey_result_t result;
647    err = gpgme_op_genkey (ctx, NULL, NULL);
648    if (!err)
649      {
650        result = gpgme_op_genkey_result (ctx);
651        if (result->fpr)
652          printf ("%s\n", result->fpr);
653      }
654
655  * The new gpgme_op_import_result function provides detailed
656    information about the result of an import operation in
657    gpgme_import_result_t and gpgme_import_status_t objects.
658    Thus, the gpgme_op_import_ext variant is deprecated.
659
660  * The new gpgme_op_sign_result function provides detailed information
661    about the result of a signing operation in gpgme_sign_result_t,
662    gpgme_invalid_key_t and gpgme_new_signature_t objects.
663
664  * The new gpgme_op_encrypt_result function provides detailed
665    information about the result of an encryption operation in
666    a GpgmeEncryptResult object.
667
668  * The new gpgme_op_decrypt_result function provides detailed
669    information about the result of a decryption operation in
670    a GpgmeDecryptResult object.
671
672  * The new gpgme_op_verify_result function provides detailed
673    information about the result of an verify operation in
674    a GpgmeVerifyResult object.  Because of this, the GPGME_SIG_STAT_*
675    values, gpgme_get_sig_status, gpgme_get_sig_ulong_attr,
676    gpgme_get_sig_string_attr and gpgme_get_sig_key are now deprecated,
677    and gpgme_get_notation is removed.
678
679  * GpgmeTrustItem objects have now directly accessible data, so the
680    gpgme_trust_item_get_string_attr and gpgme_trust_item_get_ulong_attr
681    accessor functions are deprecated.  Also, reference counting is
682    available through gpgme_trust_item_ref and gpgme_trust_item_unref
683    (the gpgme_trust_item_release alias for the latter is deprecated).
684
685  * Keys are not cached internally anymore, so the force_update argument
686    to gpgme_get_key has been removed.
687
688  * GpgmeKey objects have now directly accessible data so the
689    gpgme_key_get_string_attr, gpgme_key_get_ulong_attr,
690    gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
691    functions are deprecated.  Also, gpgme_key_release is now
692    deprecated.  The gpgme_key_get_as_xml function has been dropped.
693
694  * Because all interfaces using attributes are deprecated, the
695    GpgmeAttr data type is also deprecated.
696
697  * The new gpgme_op_keylist_result function provides detailed
698    information about the result of a key listing operation in
699    a GpgmeKeyListResult object.
700
701  * Now that each function comes with its own result retrieval
702    interface, the generic gpgme_get_op_info interface is not useful
703    anymore and dropped.
704
705  * The type and mode of data objects is not available anymore.
706
707  * Interface changes relative to the 0.4.0 release:
708 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
709 GpgmeCtx                        DEPRECATED: Use gpgme_ctx_t.
710 GpgmeData                       DEPRECATED: Use gpgme_data_t.
711 GpgmeError                      DEPRECATED: Use gpgme_error_t.
712 GpgmeDataEncoding               DEPRECATED: Use gpgme_data_encoding_t.
713 GpgmeSigStat                    DEPRECATED: Use gpgme_sig_stat_t.
714 GpgmeSigMode                    DEPRECATED: Use gpgme_sig_mode_t.
715 GpgmeAttr                       DEPRECATED: Use gpgme_attr_t.
716 GpgmeValidity                   DEPRECATED: Use gpgme_validity_t.
717 GpgmeProtocol                   DEPRECATED: Use gpgme_protocol_t.
718 GpgmeKey                        DEPRECATED: Use gpgme_key_t.
719 GpgmePassphraseCb               DEPRECATED: Use gpgme_passphrase_cb_t.
720 GpgmeProgressCb                 DEPRECATED: Use gpgme_progress_cb_t.
721 GpgmeIOCb                       DEPRECATED: Use gpgme_io_cb_t.
722 GpgmeRegisterIOCb               DEPRECATED: Use gpgme_register_io_cb_t.
723 GpgmeRemoveIOCb                 DEPRECATED: Use gpgme_remove_io_cb_t.
724 GpgmeEventIO                    DEPRECATED: Use gpgme_event_io_t.
725 GpgmeEventIOCb                  DEPRECATED: Use gpgme_event_io_cb_t.
726 GpgmeIOCbs                      DEPRECATED: Use gpgme_io_cbs.
727 GpgmeDataReadCb                 DEPRECATED: Use gpgme_data_read_cb_t.
728 GpgmeDataWriteCb                DEPRECATED: Use gpgme_data_write_cb_t.
729 GpgmeDataSeekCb                 DEPRECATED: Use gpgme_data_seek_cb_t.
730 GpgmeDataReleaseCb              DEPRECATED: Use gpgme_data_release_cb_t.
731 GpgmeDataCbs                    DEPRECATED: Use gpgme_data_cbs_t.
732 GpgmeTrustItem                  DEPRECATED: Use gpgme_trust_item_t.
733 GpgmeStatusCode                 DEPRECATED: Use gpgme_status_code_t.
734 gpgme_ctx_t                     NEW
735 gpgme_data_t                    NEW
736 gpgme_recipients_t              NEW
737 gpgme_error_t                   NEW
738 gpgme_data_encoding_t           NEW
739 gpgme_sig_stat_t                NEW
740 gpgme_sig_mode_t                NEW
741 gpgme_attr_t                    NEW
742 gpgme_validity_t                NEW
743 gpgme_protocol_t                NEW
744 gpgme_key_t                     NEW
745 gpgme_passphrase_cb_t           NEW
746 gpgme_progress_cb_t             NEW
747 gpgme_io_cb_t                   NEW
748 gpgme_register_io_cb_t          NEW
749 gpgme_remove_io_cb_t            NEW
750 gpgme_event_io_t                NEW
751 gpgme_event_io_cb_t             NEW
752 gpgme_io_cbs                    NEW
753 gpgme_data_read_cb_t            NEW
754 gpgme_data_write_cb_t           NEW
755 gpgme_data_seek_cb_t            NEW
756 gpgme_data_release_cb_t         NEW
757 gpgme_data_cbs_t                NEW
758 gpgme_trust_item_t              NEW
759 gpgme_status_code_t             NEW
760 GPGME_{some error code}         REMOVED! Use GPG_ERR_* from libgpg-error.
761 gpgme_err_code_t                NEW
762 gpgme_err_source_t              NEW
763 gpgme_err_code                  NEW
764 gpgme_err_source                NEW
765 gpgme_error                     NEW
766 gpgme_err_make                  NEW
767 gpgme_error_from_errno          NEW
768 gpgme_err_make_from_errno       NEW
769 gpgme_err_code_from_errno       NEW
770 gpgme_err_code_to_errno         NEW
771 gpgme_strsource                 NEW
772 gpgme_io_cb_t                   CHANGED: Return type from void to GpgmeError.
773 gpgme_event_io_t                CHANGED: New event type (all numbers changed).
774 gpgme_passphrase_cb_t           CHANGED: Desc decomposed, write directly to FD.
775 gpgme_edit_cb_t                 CHANGED: Write directly to FD.
776 gpgme_key_get_string_attr       CHANGED: Don't handle GPGME_ATTR_IS_SECRET.
777 gpgme_op_verify                 CHANGED: Drop R_STAT argument.
778 gpgme_op_decrypt_verify         CHANGED: Drop R_STAT argument.
779 gpgme_wait                      CHANGED: Can return NULL even if hang is true.
780 GpgmeIdleFunc                   REMOVED
781 gpgme_register_idle             REMOVED
782 GpgmeRecipients                 REMOVED
783 gpgme_recipients_new            REMOVED
784 gpgme_recipients_release        REMOVED
785 gpgme_recipients_add_name       REMOVED
786 gpgme_recipients_add_name_with_validity REMOVED
787 gpgme_recipients_count          REMOVED
788 gpgme_recipients_enum_open      REMOVED
789 gpgme_recipients_enum_read      REMOVED
790 gpgme_recipients_enum_close     REMOVED
791 gpgme_encrypt_flags_t           NEW
792 GPGME_ENCRYPT_ALWAYS_TRUST      NEW
793 gpgme_op_encrypt                CHANGED: Recipients passed as gpgme_key_t[].
794 gpgme_op_encrypt_start          CHANGED: Recipients passed as gpgme_key_t[].
795 gpgme_op_encrypt_sign           CHANGED: Recipients passed as gpgme_key_t[].
796 gpgme_op_encrypt_sign_start     CHANGED: Recipients passed as gpgme_key_t[].
797 gpgme_op_export_start           CHANGED: User IDs passed as patterns.
798 gpgme_op_export                 CHANGED: User IDs passed as patterns.
799 gpgme_op_export_ext_start       NEW
800 gpgme_op_export_ext             NEW
801 gpgme_keylist_mode_t            NEW
802 gpgme_sigsum_t                  NEW
803 gpgme_engine_info_t             NEW
804 gpgme_get_engine_info           CHANGED: Return info structure instead XML.
805 gpgme_get_protocol_name         NEW
806 gpgme_cancel                    REMOVED: Return error in callback directly.
807 gpgme_op_genkey                 CHANGED: FPR argument dropped.
808 gpgme_op_genkey_result          NEW
809 gpgme_genkey_result_t           NEW
810 gpgme_op_import_ext             DEPRECATED: Use gpgme_op_import_result.
811 gpgme_op_import_result          NEW
812 gpgme_import_status_t           NEW
813 gpgme_import_result_t           NEW
814 gpgme_pubkey_algo_t             NEW
815 gpgme_hash_algo_t               NEW
816 gpgme_invalid_key_t             NEW
817 gpgme_new_signature_t           NEW
818 gpgme_sign_result_t             NEW
819 gpgme_op_sign_result            NEW
820 gpgme_pubkey_algo_name          NEW
821 gpgme_hash_algo_name            NEW
822 gpgme_encrypt_result_t          NEW
823 gpgme_op_encrypt_result         NEW
824 gpgme_decrypt_result_t          NEW
825 gpgme_op_decrypt_result         NEW
826 gpgme_verify_result_t           NEW
827 gpgme_op_verify_result          NEW
828 gpgme_get_notation              REMOVED: Access verify result directly instead.
829 gpgme_get_sig_key               DEPRECATED: Use gpgme_get_key with fingerprint.
830 gpgme_get_sig_ulong_attr        DEPRECATED: Use verify result directly.
831 gpgme_get_sig_string_attr       DEPRECATED: Use verify result directly.
832 GPGME_SIG_STAT_*                DEPRECATED: Use error value in sig status.
833 gpgme_get_sig_status            DEPRECATED: Use verify result directly.
834 gpgme_trust_item_t              CHANGED: Now has user accessible data members.
835 gpgme_trust_item_ref            NEW
836 gpgme_trust_item_unref          NEW
837 gpgme_trust_item_release        DEPRECATED: Use gpgme_trust_item_unref.
838 gpgme_trust_item_get_string_attr DEPRECATED
839 gpgme_trust_item_get_ulong_attr DEPRECATED
840 gpgme_get_key                   CHANGED: Removed force_update argument.
841 gpgme_sub_key_t                 NEW
842 gpgme_key_sig_t                 NEW
843 gpgme_user_id_t                 NEW
844 gpgme_key_t                     CHANGED: Now has user accessible data members.
845 gpgme_key_get_string_attr       DEPRECATED
846 gpgme_key_get_ulong_attr        DEPRECATED
847 gpgme_key_sig_get_string_attr   DEPRECATED
848 gpgme_key_sig_get_ulong_attr    DEPRECATED
849 gpgme_key_get_as_xml            REMOVED
850 gpgme_key_list_result_t         NEW
851 gpgme_op_keylist_result         NEW
852 gpgme_get_op_info               REMOVED
853 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
854
855 Noteworthy changes in version 0.4.0 (2002-12-23)
856 ------------------------------------------------
857
858  * Key generation returns the fingerprint of the generated key.
859
860  * New convenience function gpgme_get_key.
861
862  * Supports signatures of user IDs in keys via the new
863    GPGME_KEYLIST_MODE_SIGS keylist mode and the
864    gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
865    interfaces.  The XML info about a key also includes the signatures
866    if available.
867
868  * New data object interface, which is more flexible and transparent.
869
870  * Interface changes relative to the 0.3.9 release:
871 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
872 GpgmeDataReadCb                 NEW
873 GpgmeDataWriteCb                NEW
874 GpgmeDataSeekCb                 NEW
875 GpgmeDataReleaseCb              NEW
876 GpgmeDataCbs                    NEW
877 gpgme_data_read                 CHANGED: Match read() closely.
878 gpgme_data_write                CHANGED: Match write() closely.
879 gpgme_data_seek                 NEW
880 gpgme_data_new_from_fd          NEW
881 gpgme_data_new_from_stream      NEW
882 gpgme_data_new_from_cbs         NEW
883 gpgme_data_rewind               DEPRECATED: Replaced by gpgme_data_seek().
884 gpgme_data_new_from_read_cb     DEPRECATED: Replaced by gpgme_data_from_cbs().
885 gpgme_data_get_type             REMOVED: No replacement.
886 gpgme_op_verify                 CHANGED: Take different data objects for
887                                 signed text and plain text.
888 gpgme_op_verify_start           CHANGED: See gpgme_op_verify.
889 gpgme_check_engine              REMOVED: Deprecated since 0.3.0.
890 gpgme_op_genkey                 CHANGED: New parameter FPR.
891 GPGME_KEYLIST_MODE_SIGS         NEW
892 gpgme_key_sig_get_string_attr   NEW
893 gpgme_key_sig_get_ulong_attr    NEW
894 gpgme_get_key                   NEW
895 GPGME_ATTR_SIG_CLASS            NEW
896 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
897
898 Noteworthy changes in version 0.3.16 (2003-11-19)
899 -------------------------------------------------
900
901  * Compatibility fixes for GnuPG 1.9.x
902
903 Noteworthy changes in version 0.3.15 (2003-02-18)
904 -------------------------------------------------
905
906  * The progress status is sent via the progress callbacks in
907    gpgme_op_edit.
908
909  * Bug fix for signing operations with explicit signer settings for
910    the CMS protocol.
911
912 Noteworthy changes in version 0.3.14 (2002-12-04)
913 -------------------------------------------------
914
915  * GPGME-Plug is now in its own package "cryptplug".
916
917  * Workaround for a setlocale problem.  Fixed a segv related to not
918    correctly as closed marked file descriptors.
919
920 Noteworthy changes in version 0.3.13 (2002-11-20)
921 -------------------------------------------------
922
923  * Release due to changes in gpgmeplug.
924
925 Noteworthy changes in version 0.3.12 (2002-10-15)
926 -------------------------------------------------
927
928  * Fixed some bux with key listings.  
929
930  * The development has been branched to clean up some API issues.
931    This 0.3 series will be kept for compatibility reasons; so do don't
932    expect new features.
933
934 Noteworthy changes in version 0.3.11 (2002-09-20)
935 -------------------------------------------------
936         
937  * Bug fixes.
938
939 Noteworthy changes in version 0.3.10 (2002-09-02)
940 -------------------------------------------------
941
942  * Setting the signing keys for the CMS protocol does now work.
943
944  * The signers setting is honoured by gpgme_op_edit.
945
946 Noteworthy changes in version 0.3.9 (2002-08-21)
947 ------------------------------------------------
948
949  * A spec file for creating RPMs has been added.
950
951  * An experimental interface to GnuPG's --edit-key functionality is
952    introduced, see gpgme_op_edit.
953
954  * The new gpgme_import_ext function provides a convenient access to
955    the number of processed keys.
956
957  * Interface changes relative to the 0.3.8 release:
958 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
959 GpgmeStatusCode                 NEW
960 GpgmeEditCb                     NEW
961 gpgme_op_edit_start             NEW
962 gpgme_op_edit                   NEW
963 gpgme_op_import_ext             NEW
964 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
965
966 Noteworthy changes in version 0.3.8 (2002-06-25)
967 ------------------------------------------------
968
969  * It is possible to use an outside event loop for the I/O to the
970    crypto engine by setting the I/O callbacks with gpgme_set_io_cbs.
971
972  * Interface changes relative to the 0.3.6 release:
973 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
974 GpgmeIOCb                       NEW
975 GpgmeRegisterIOCb               NEW
976 GpgmeRemoveIOCb                 NEW
977 GpgmeEventIO                    NEW
978 GpgmeEventIOCb                  NEW
979 struct GpgmeIOCbs               NEW
980 gpgme_set_io_cbs                NEW
981 gpgme_get_io_cbs                NEW
982 GPGME_ATTR_ERRTOK               NEW
983 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
984
985 Noteworthy changes in version 0.3.7 (2002-06-04)
986 ------------------------------------------------
987
988  * GPGME_ATTR_OTRUST is implemented now.
989
990  * A first step toward thread safeness has been achieved, see the
991    documentation for details.  Supported thread libraries are pthread
992    and Pth.
993
994 Noteworthy changes in version 0.3.6 (2002-05-03)
995 ------------------------------------------------
996
997  * All error output of the gpgsm backend is send to the bit bucket.
998
999  * The signature verification functions are extended.  Instead of
1000    always returning GPGME_SIG_STATUS_GOOD, the functions new codes for
1001    expired signatures.  2 new functions may be used to retrieve more
1002    detailed information like the signature expiration time and a
1003    validity information of the key without an extra key looking.
1004
1005  * The current passphrase callback and progress meter callback can be
1006    retrieved with the new functions gpgme_get_passphrase_cb and
1007    gpgme_get_progress_cb respectively.
1008
1009  * Interface changes relative to the 0.3.5 release:
1010 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1011 gpgme_get_passphrase_cb         NEW
1012 gpgme_get_progress_cb           NEW
1013 GpgmeDataEncoding               NEW
1014 gpgme_data_set_encoding         NEW
1015 gpgme_data_get_encoding         NEW
1016 GPGME_SIG_STAT_GOOD_EXP         NEW
1017 GPGME_SIG_STAT_GOOD_EXPKEY      NEW
1018 gpgme_op_verify                 CHANGED: Returns more status codes.
1019 GPGME_ATTR_SIG_STATUS           NEW
1020 gpgme_get_sig_string_attr       NEW
1021 gpgme_get_sig_ulong_attr        NEW
1022 gpgme_get_protocol              NEW
1023 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1024
1025 Noteworthy changes in version 0.3.5 (2002-04-01)
1026 ------------------------------------------------
1027
1028  * gpgme_op_encrypt can be called with RECIPIENTS being 0.  In this
1029    case, symmetric encryption is performed.  Note that this requires a
1030    passphrase from the user.
1031
1032  * More information is returned for X.509 certificates.
1033
1034  * Interface changes relative to the 0.3.4 release:
1035 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1036 gpgme_op_encrypt                EXTENDED: Symmetric encryption possible
1037 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1038
1039 Noteworthy changes in version 0.3.4 (2002-03-04)
1040 ------------------------------------------------
1041
1042  * gpgme_op_encrypt does now fail with GPGME_Invalid_Recipients if
1043    some recipients have been invalid, whereas earlier versions
1044    succeeded in this case.  The plaintext is still encrypted for all valid
1045    recipients, so the application might take this error as a hint that
1046    the ciphertext is not usable for all requested recipients.
1047    Information about invalid recipients is available with gpgme_get_op_info.
1048
1049  * gpgme_op_verify now allows to pass an uninitialized data object as
1050    its plaintext argument to check for normal and cleartext
1051    signatures.  The plaintext is then returned in the data object.
1052
1053  * New interfaces gpgme_set_include_certs and gpgme_get_include_certs
1054    to set and get the number of certifications to include in S/MIME
1055    signed messages.
1056
1057  * New interfaces gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start
1058    to encrypt and sign a message in a combined operation.
1059
1060  * New interface gpgme_op_keylist_ext_start to search for multiple patterns.
1061
1062  * gpgme_key_get_ulong_attr supports the GPGME_ATTR_EXPIRE attribute.
1063
1064  * Interface changes relative to the 0.3.3 release:
1065 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1066 gpgme_op_encrypt                CHANGED: Can fail with GPGME_Invalid_Recipients
1067 gpgme_op_verify                 EXTENDED: Accepts uninitialized text argument
1068 gpgme_key_get_ulong_attr        EXTENDED: Supports GPGME_ATTR_EXPIRE
1069 gpgme_set_include_certs         NEW
1070 gpgme_get_include_certs         NEW
1071 gpgme_op_encrypt_sign           NEW
1072 gpgme_op_encrypt_sign_start     NEW
1073 gpgme_op_keylist_ext_start      NEW
1074 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1075
1076 Noteworthy changes in version 0.3.3 (2002-02-12)
1077 ------------------------------------------------
1078
1079  * Fix the Makefile in jnlib.
1080
1081  * Fix the test suite (hopefully).  It should clean up all its state
1082    with `make check' now.
1083
1084
1085 Noteworthy changes in version 0.3.2 (2002-02-10)
1086 ------------------------------------------------
1087
1088  * Remove erroneous dependency on libgcrypt in jnlib.
1089
1090
1091 Noteworthy changes in version 0.3.1 (2002-02-09)
1092 ------------------------------------------------
1093
1094  * There is a Texinfo manual documenting the API.
1095
1096  * The gpgme_set_keylist_mode function returns an error, and changed
1097    its meaning.  It is no longer usable to select between normal and
1098    fast mode (newer versions of GnuPG will always be fast), but
1099    selects between local keyring, remote keyserver, or both.
1100    For this, two new macros are defined, GPGME_KEYLIST_MODE_LOCAL
1101    and GPGME_KEYLIST_MODE_EXTERN.  To make it possible to modify the
1102    current setting, a fucntion gpgme_get_keylist_mode was added to
1103    retrieve the current mode.
1104
1105  * gpgme_wait accepts a new argument STATUS to return the error status
1106    of the operation on the context.  Its definition is closer to
1107    waitpid() now than before.
1108
1109  * The LENGTH argument to gpgme_data_new_from_filepart changed its
1110    type from off_t to the unsigned size_t.
1111
1112  * The R_HD argument to the GpgmePassphraseCb type changed its type
1113    from void* to void**.
1114
1115  * New interface gpgme_op_trustlist_end() to match
1116    gpgme_op_keylist_end().
1117
1118  * The CryptPlug modules have been renamed to gpgme-openpgp and
1119    gpgme-smime, and they are installed in pkglibdir by `make install'.
1120
1121  * An idle function can be registered with gpgme_register_idle().
1122
1123  * The GpgSM backend supports key generation with gpgme_op_genkey().
1124
1125  * Interface changes relative to the 0.3.0 release:
1126 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1127 gpgme_data_new_from_filepart    CHANGED: Type of LENGTH is size_t.
1128 GpgmePassphraseCb               CHANGED: Type of R_HD is void **.
1129 gpgme_wait                      CHANGED: New argument STATUS.
1130 gpgme_set_keylist_mode          CHANGED: Type of return value is GpgmeError.
1131                                 The function has a new meaning!
1132 gpgme_get_keylist_mode          NEW
1133 GPGME_KEYLIST_MODE_LOCAL        NEW
1134 GPGME_KEYLIST_MODE_EXTERN       NEW
1135 gpgme_op_trustlist_next         NEW
1136 GpgmeIdleFunc                   NEW
1137 gpgme_register_idle             NEW
1138 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1139
1140 Noteworthy changes in version 0.3.0 (2001-12-19)
1141 ------------------------------------------------
1142  
1143  * New interface gpgme_set_protocol() to set the protocol and thus the
1144    crypto engine to be used by the context.  Currently, the OpenPGP
1145    and the CMS protocols are supported.  They are specified by the new
1146    preprocessor symbols GPGME_PROTOCOL_OpenPGP and GPGME_PROTOCOL_CMS.
1147    A new context uses the OpenPGP engine by default.
1148
1149  * gpgme_get_engine_info() returns information for all crypto engines
1150    compiled into the library.  The XML format has changed.  To
1151    reliably get the version of a crypto engine, the <version> tag
1152    after the appropriate <protocol> tag has to be looked for.
1153
1154  * New interface gpgme_engine_check_version(), obsoleting
1155    gpgme_check_engine().  Check the version of all engines you are
1156    supporting in your software.
1157
1158  * GpgmeKey lists the user ids in the order as they are returned by
1159    GnuPG, first the primary key with index 0, then the sub-user ids.
1160
1161  * New operation gpgme_op_decrypt_verify() to decrypt and verify
1162    signatures simultaneously.
1163
1164  * The new interface gpgme_op_keylist_end() terminates a pending
1165    keylist operation.  A keylist operation is also terminated when
1166    gpgme_op_keylist_next() returns GPGME_EOF.
1167
1168  * GPGME can be compiled without GnuPG being installed (`--with-gpg=PATH'),
1169    cross-compiled, or even compiled without support for GnuPG
1170    (`--without-gpg').
1171
1172  * GPGME can be compiled with support for GpgSM (GnuPG for S/MIME,
1173    `--with-gpgsm=PATH').  It is enabled by default if the `gpgsm' is found
1174    in the path, but it can also be compiled without support for GpgSM
1175    (`--without-gpgsm').
1176
1177  * CryptPlug modules for GPGME are included and can be enabled at
1178    configure time (`--enable-gpgmeplug').  There is one module which
1179    uses the GnuPG engine (`gpgmeplug') and one module which uses the
1180    GpgSM engine (`gpgsmplug').
1181
1182  * Interface changes relative to the latest 0.2.x release:
1183 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1184 gpgme_key_get_as_xml            CHANGED: Sub-user ids reversed in order.
1185 gpgme_key_get_string_attr       CHANGED: User ids reversed in order.
1186 gpgme_key_get_ulong_attr        CHANGED: User ids reversed in order.
1187 gpgme_get_engine_info           CHANGED: New format, extended content.
1188 gpgme_engine_check_version      NEW
1189 gpgme_decrypt_verify_start      NEW
1190 gpgme_decrypt_verify            NEW
1191 gpgme_op_keylist_next           NEW
1192 gpgme_set_protocol              NEW
1193 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1194
1195
1196 Noteworthy changes in version 0.2.3 (2001-09-17)
1197 ------------------------------------------------
1198
1199  * New function gpgme_get_op_info which can be used to get the micalg
1200    parameter needed for MOSS.
1201
1202  * New functions gpgme_get_armor and gpgme_get_textmode.
1203
1204  * The usual bug fixes and some minor functionality improvements.
1205
1206  * Added a simple encryption component for MS-Windows; however the
1207    build procedure might have some problems.
1208
1209
1210 Noteworthy changes in version 0.2.2 (2001-06-12)
1211 ------------------------------------------------
1212  
1213  * Implemented a key cache.
1214
1215  * Fixed a race condition under W32 and some other bug fixes.
1216
1217
1218 Noteworthy changes in version 0.2.1 (2001-04-02)
1219 ------------------------------------------------
1220
1221  * Changed debug output and GPGME_DEBUG variable (gpgme/debug.c)
1222
1223  * Handle GnuPG's new key capabilities output and support revocation
1224    et al. attributes
1225
1226  * Made the W32 support more robust.
1227
1228
1229  Copyright 2001, 2002, 2003, 2004, 2005, 2007 g10 Code GmbH
1230
1231  This file is free software; as a special exception the author gives
1232  unlimited permission to copy and/or distribute it, with or without
1233  modifications, as long as this notice is preserved.
1234
1235  This file is distributed in the hope that it will be useful, but
1236  WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
1237  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.