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