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