core: New context flag "ignore-mdc-error".
[gpgme.git] / NEWS
1 Noteworthy changes in version 1.11.2 (unreleased)
2 -------------------------------------------------
3
4  * Even for old versions of gpg a missing MDC will now lead to a
5    decryption failure.
6
7  * Interface changes relative to the 1.11.1 release:
8  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9  gpgme_decrypt_result_t           EXTENDED: New field legacy_cipher_nomdc.
10  gpgme_set_ctx_flag               EXTENDED: New flag 'ignore-mdc-error'.
11  cpp: DecryptionResult::sessionKey     NEW.
12  cpp: DecryptionResult::symkeyAlgo     NEW.
13  cpp: Data::rewind                     NEW.
14
15
16 Noteworthy changes in version 1.11.1 (2018-04-20)
17 -------------------------------------------------
18
19  * Fixed build problems in the 1.11.0 release.
20
21  * Added C++ interfaces which were planned for 1.11.0.
22
23  * Interface changes relative to the 1.10.0 release:
24  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25  cpp: Key::origin                     NEW.
26  cpp: Key::lastUpdate                 NEW.
27  cpp: UserID::origin                  NEW.
28  cpp: UserID::lastUpdate              NEW.
29
30  [c=C31/A20/R1 cpp=C13/A7/R0 qt=C10/A3/R2]
31
32
33 Noteworthy changes in version 1.11.0 (2018-04-18)
34 -------------------------------------------------
35
36  * New encryption API to support direct key specification including
37    hidden recipients option and taking keys from a file.  This also
38    allows to enforce the use of a subkey.
39
40  * New encryption flag for the new API to enforce the use of plain
41    mail addresses (addr-spec).
42
43  * The import API can now tell whether v3 keys are skipped.  These old
44    and basically broken keys are not anymore supported by GnuPG 2.1.
45
46  * The decrypt and verify API will now return the MIME flag as
47    specified by RFC-4880bis.
48
49  * The offline mode now has an effect on gpg by disabling all network
50    access.  [#3831]
51
52  * A failed OpenPGP verification how returns the fingerprint of the
53    intended key if a recent gpg version was used for signature
54    creation.
55
56  * New tool gpgme-json as native messaging server for web browsers.
57    As of now public key encryption and decryption is supported.
58    Requires Libgpg-error 1.29.
59
60  * New context flag "request-origin" which has an effect when used
61    with GnuPG 2.2.6 or later.
62
63  * New context flag "no-symkey-cache" which has an effect when used
64    with GnuPG 2.2.7 or later.
65
66  * New convenience constant GPGME_KEYLIST_MODE_LOCATE.
67
68  * Improved the Python documentation.
69
70  * Fixed a potential regression with GnuPG 2.2.6 or later.
71
72  * Fixed a crash in the Python bindings on 32 bit platforms.  [#3892]
73
74  * Various minor fixes.
75
76  * Interface changes relative to the 1.10.0 release:
77  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
78  gpgme_op_encrypt_ext             NEW.
79  gpgme_op_encrypt_ext_start       NEW.
80  gpgme_op_encrypt_sign_ext        NEW.
81  gpgme_op_encrypt_sign_ext_start  NEW.
82  GPGME_ENCRYPT_WANT_ADDRESS       NEW.
83  GPGME_KEYLIST_MODE_LOCATE        NEW.
84  gpgme_import_result_t            EXTENDED: New field 'skipped_v3_keys'.
85  gpgme_decrypt_result_t           EXTENDED: New field 'symkey_algo'.
86  gpgme_decrypt_result_t           EXTENDED: New field 'is_mime'.
87  gpgme_verify_result_t            EXTENDED: New field 'is_mime'.
88  cpp: Key::locate                 NEW.
89  cpp: Data::toString              NEW.
90  cpp: ImportResult::numV3KeysSkipped  NEW.
91
92  [c=C31/A20/R0 cpp=C12/A6/R0 qt=C10/A3/R1]
93
94
95 Noteworthy changes in version 1.10.0 (2017-12-12)
96 -------------------------------------------------
97
98  * Now returns more specific error codes for decryption to distinguish
99    between bad passphrase, user canceled, and no secret key.
100
101  * Now returns key origin information if available.
102
103  * Added context flag "auto-key-retrieve" to selectively enable the
104    corresponding gpg option.
105
106  * Added flag is_de_vs to decryption and verify results.
107
108  * py: Use SEEK_SET as default for data.seek.
109
110  * cpp: Various new APIs.
111
112  * Reduced spawn overhead on Linux again.  Added new configure option
113    --disable-linux-getdents to disable this feature for very old
114    Linux versions.
115
116  * Improved the Python bindings build system.
117
118  * Made the test suite less fragile.
119
120  * Interface changes relative to the 1.9.0 release:
121  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
122  gpgme_decrypt_result_t      EXTENDED: New field 'is_de_vs'.
123  gpgme_signature_t           EXTENDED: New field 'is_de_vs'.
124  gpgme_keyorg_t              NEW.
125  gpgme_op_delete_ext         NEW.
126  gpgme_op_delete_ext_start   NEW.
127  GPGME_DELETE_ALLOW_SECRET   NEW.
128  GPGME_DELETE_FORCE          NEW.
129  gpgme_op_conf_dir           NEW.
130  gpgme_set_ctx_flag          EXTENDED: New flag 'auto-key-retrieve'.
131  cpp: DecryptionResult::isDeVs         NEW.
132  cpp: Signature::isDeVs                NEW.
133  cpp: EngineInfo::Version::operator>   NEW.
134  cpp: Context::createKey               NEW.
135  cpp: Context::startCreateKey          NEW.
136  cpp: Context::createSubkey            NEW.
137  cpp: Context::startCreateSubkey       NEW.
138  qt: QuickJob                          NEW.
139  py: DecryptResult           EXTENDED: New boolean field 'is_de_vs'.
140  py: Signature               EXTENDED: New boolean field 'is_de_vs'.
141  py: GpgError                EXTENDED: Partial results in 'results'.
142
143  [c=C30/A19/R0 cpp=C11/A5/R0 qt=C10/A3/R0]
144
145
146 Noteworthy changes in version 1.9.0 (2017-03-28)
147 ------------------------------------------------
148
149  * Clarified meaning of the 'expire' parameter of gpgme_op_createkey
150    and gpgme_op_createsubkey.  New flag to force a key without an
151    expiration date.
152
153  * New function gpgme_op_keylist_from_data_start to list keys from
154    data objects without importing them.
155
156  * New function gpgme_op_set_uid_flag to flag a key as primary.
157
158  * New function gpgme_op_decrypt_ext to run decryption with special
159    flags.  This can for example be used to unwrap keys (remove only
160    the encryption layer).
161
162  * New encryption flags to wrap a key (adding an encryption layer to
163    an OpenPGP message) or to create anonymously encrypted messages.
164
165  * Support for adduid and revuid operations in the C++ bindings.
166
167  * Support for smartcard key generation in the C++ bindings.
168
169  * Several new functions for the Python binding.
170
171  * Many smaller bug fixes.
172
173  * Interface changes relative to the 1.8.0 release:
174  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
175  gpgme_op_createkey          CHANGED: Meaning of 'expire' parameter.
176  gpgme_op_createsubkey       CHANGED: Meaning of 'expire' parameter.
177  GPGME_CREATE_NOEXPIRE       NEW.
178  gpgme_key_t                 EXTENDED: New field 'origin'.
179  gpgme_key_t                 EXTENDED: New field 'last_update'.
180  gpgme_subkey_t              EXTENDED: New field 'is_de_vs'.
181  gpgme_user_id_t             EXTENDED: New field 'origin'.
182  gpgme_user_id_t             EXTENDED: New field 'last_update'.
183  gpgme_op_keylist_from_data_start NEW.
184  gpgme_op_set_uid_flag_start      NEW.
185  gpgme_op_set_uid_flag            NEW.
186  gpgme_op_decrypt_ext_start       NEW.
187  gpgme_op_decrypt_ext             NEW.
188  GPGME_ENCRYPT_THROW_KEYIDS       NEW.
189  GPGME_ENCRYPT_WRAP               NEW.
190  GPGME_DECRYPT_VERIFY             NEW.
191  GPGME_DECRYPT_UNWRAP             NEW.
192  gpgme_data_rewind                UN-DEPRECATE.
193  cpp: Context::revUid(const Key&, const char*)      NEW.
194  cpp: Context::startRevUid(const Key&, const char*) NEW.
195  cpp: Context::addUid(const Key&, const char*)      NEW.
196  cpp: Context::startAddUid(const Key&, const char*) NEW.
197  cpp: Key::UserID::revoke()                         NEW.
198  cpp: Key::addUid()                                 NEW.
199  cpp: Key::isDeVs                                   NEW.
200  cpp: GpgGenCardKeyInteractor                       NEW.
201  cpp: Subkey::keyGrip                               NEW.
202  cpp: Subkey::isDeVs                                NEW.
203  cpp: Data::toKeys                                  NEW.
204  cpp: Context::setDecryptFlags                      NEW.
205  cpp: Context::decrypt                         EXTENDED: Flags added.
206  cpp: Context::startDecrypt                    EXTENDED: Flags added.
207  cpp: Context::decryptAndVerify                EXTENDED: Flags added.
208  cpp: Context::startCombinedDecryptionAndVerification EXTENDED: Flags.
209  cpp: Context::encryptFlags                    EXTENDED: New flags.
210  qt: CryptoConfig::stringValueList()                NEW.
211  py: Context.__init__        EXTENDED: New keyword arg home_dir.
212  py: Context.home_dir        NEW.
213  py: Context.keylist         EXTENDED: New keyword arg mode.
214  py: Context.keylist         EXTENDED: New keyword arg source.
215  py: Context.create_key      NEW.
216  py: Context.create_subkey   NEW.
217  py: Context.key_add_uid     NEW.
218  py: Context.key_revoke_uid  NEW.
219  py: Context.key_sign        NEW.
220  py: Context.key_tofu_policy NEW.
221  py: core.pubkey_algo_string NEW.
222  py: core.addrspec_from_uid  NEW.
223
224  [c=C29/A18/R0 cpp=C10/A4/R0 qt=C9/A2/R0]
225
226
227 Noteworthy changes in version 1.8.0 (2016-11-16)
228 ------------------------------------------------
229
230  * The module of the Python bindings has been renamed to 'gpg'.
231
232  * New interface to query current software versions.
233
234  * New feature to use gpg's --{show,override}session-key options.
235
236  * New interface to set the sender of a mail.
237
238  * qt: Added Distinguished Name parser from libkleo
239
240  * The --homedir option is now used with recent gpgconf versions.
241
242  * On 64 bit Windows systems gpgconf is now properly located.
243
244  * The internal locking functions have been replaced by libgpg-error
245    locking functions.
246
247  * Interface changes relative to the 1.7.1 release:
248  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
249  gpgme_set_sender                NEW.
250  gpgme_get_sender                NEW.
251  gpgme_op_query_swdb             NEW.
252  gpgme_op_query_swdb_result      NEW.
253  gpgme_query_swdb_result_t       NEW.
254  gpgme_get_ctx_flag              NEW.
255  gpgme_decrypt_result_t          EXTENDED: New field session_key.
256  qt: DN                          NEW.
257  qt: DN::Attribute               NEW.
258  qt: Job::context(Job*)          NEW.
259  cpp: EngineInfo::Version::Version(const char*) NEW.
260  cpp: EngineInfo::Version::Version()            NEW.
261  cpp: SwdbResult                                NEW.
262  cpp: Context::setSender(const char*)           NEW.
263  cpp: Context::getSender()                      NEW.
264
265  [c=C28/A17/R0 cpp=C9/A3/R0 qt=C8/A1/R0]
266
267
268 Noteworthy changes in version 1.7.1 (2016-10-18)
269 ------------------------------------------------
270
271  * Fixed problems with the new language bindings.
272
273  * New helper function gpgme_addrspec_from_uid.
274
275  * Use option --exit-on-status-write-error with newer gpg versions.
276
277  * qt: Missed API from the Qt Binding inclusion has
278    been added again.
279
280  * qt: abstractimportjob.h is now installed to that
281    ImportJobs can be used again.
282
283  * qt: Fixed spelling error in API (startReceive).
284
285  * Interface changes relative to the 1.7.0 release:
286  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
287  gpgme_addrspec_from_uid         NEW.
288  qt: WksPublishJob::startRecieve RENAMED to ::startReceive.
289  qt: MultiDeleteJob              NEW.
290  qt: AbstractImportJob           NEW.
291  qt: SpecialJob                  NEW.
292  cpp: Signature::key(bool, bool)              NEW.
293  cpp: UserID::addrSpecFromString(const char*) NEW.
294  cpp: UserID::addrSpec()                      NEW.
295
296  [c=C27/A16/R0 cpp=C8/A2/R0 qt=C7/A0/R0]
297
298
299 Noteworthy changes in version 1.7.0 (2016-09-21)
300 ------------------------------------------------
301
302  * New language bindings for Python 2 and 3.
303
304  * New language Bindings for C++ and the Qt-Framework API.
305
306  * New functions gpgme_op_createkey and gpgme_op_createsubkey to make
307    key creation easier (requires GnuPG 2.1).
308
309  * New functions gpgme_op_adduid and gpgme_op_revuid to make user id
310    management easier (requires GnuPG 2.1).
311
312  * New function gpgme_op_keysign to make key signing easier (requires
313    GnuPG 2.1).
314
315  * New function gpgme_op_interact to replace the now deprecated
316    functions gpgme_op_edit and gpgme_op_card_edit.
317
318  * New function gpgme_pubkey_algo_string to convert a public key
319    algorithm into a GnuPG 2.1 style string.
320
321  * Support for GnuPG 2.1's TOFU trust model.
322
323  * Notation flags are now correctly set on verify.
324
325  * New global flag "require-gnupg" to set a minimal gnupg version.
326
327  * More supported items in gpgme_get_dirinfo.
328
329  * New function gpgme_data_set_flag and flag "size-hint".
330
331  * New function gpgme_set_ctx_flag and flags "full-status" and
332    "raw-description".
333
334  * Improved gpgme_data_identify to distinguish more file types.
335
336  * New flag GPGME_ENCRYPT_SYMMETRIC for gpgme_op_encrypt to allow
337    mixed public key and symmetric encryption.
338
339  * New field KEYGRIP in gpgme_subkey_t.  New fields FPR in gpgme_key_t.
340
341  * New flag GPGME_DATA_ENCODING_MIME to declare that the encrypted or
342    signed data is a valid MIME part.  This is to support future GnuPG
343    versions.
344
345  * Interface changes relative to the 1.6.0 release:
346  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
347  gpgme_pubkey_algo_string       NEW.
348  GPGME_PK_EDDSA                 NEW.
349  gpgme_set_ctx_flag             NEW.
350  gpgme_data_set_flag            NEW.
351  gpgme_op_createkey             NEW.
352  gpgme_op_createkey_start       NEW.
353  gpgme_op_createsubkey          NEW.
354  gpgme_op_createsubkey_start    NEW.
355  gpgme_op_adduid_start          NEW.
356  gpgme_op_adduid                NEW.
357  gpgme_op_revuid_start          NEW.
358  gpgme_op_revuid                NEW.
359  gpgme_op_keysign_start         NEW.
360  gpgme_op_keysign               NEW.
361  gpgme_op_tofu_policy_start     NEW.
362  gpgme_op_tofu_policy           NEW.
363  gpgme_op_interact_start        NEW.
364  gpgme_op_interact              NEW.
365  gpgme_interact_cb_t            NEW.
366  gpgme_op_edit_start            DEPRECATED.
367  gpgme_op_edit                  DEPRECATED.
368  gpgme_op_card_edit_start       DEPRECATED.
369  gpgme_op_card_edit             DEPRECATED.
370  gpgme_edit_cb_t                DEPRECATED.
371  gpgme_status_code_t            DEPRECATED.
372  gpgme_genkey_result_t          EXTENDED: New fields pubkey and seckey.
373  gpgme_signature_t              EXTENDED: New field key.
374  gpgme_key_t                    EXTENDED: New field fpr.
375  gpgme_subkey_t                 EXTENDED: New field keygrip.
376  gpgme_user_id_t                EXTENDED: New field tofu.
377  gpgme_tofu_policy_t            NEW.
378  gpgme_tofu_info_t              NEW.
379  GPGME_STATUS_KEY_CONSIDERED    NEW.
380  GPGME_STATUS_TOFU_USER         NEW.
381  GPGME_STATUS_TOFU_STATS        NEW.
382  GPGME_STATUS_TOFU_STATS_LONG   NEW.
383  GPGME_STATUS_NOTATION_FLAGS    NEW.
384  GPGME_KEYLIST_MODE_WITH_TOFU   NEW.
385  GPGME_DATA_TYPE_PGP_ENCRYPTED  NEW.
386  GPGME_DATA_TYPE_PGP_SIGNATURE  NEW.
387  GPGME_DATA_ENCODING_MIME       NEW.
388  GPGME_ENCRYPT_SYMMETRIC        NEW.
389  GPGME_CREATE_SIGN              NEW.
390  GPGME_CREATE_ENCR              NEW.
391  GPGME_CREATE_CERT              NEW.
392  GPGME_CREATE_AUTH              NEW.
393  GPGME_CREATE_NOPASSWD          NEW.
394  GPGME_CREATE_SELFSIGNED        NEW.
395  GPGME_CREATE_NOSTORE           NEW.
396  GPGME_CREATE_WANTPUB           NEW.
397  GPGME_CREATE_WANTSEC           NEW.
398  GPGME_CREATE_FORCE             NEW.
399  GPGME_KEYSIGN_LOCAL            NEW.
400  GPGME_KEYSIGN_LFSEP            NEW.
401  GPGME_INTERACT_CARD            NEW.
402
403  [c=C26/A15/R0 cpp=C6/A0/R1 qt=C6/A0/R1]
404
405
406 Noteworthy changes in version 1.6.0 (2015-08-26) [C25/A14/R0]
407 ------------------------------------------------
408
409  * Added gpgme_set_offline to do a key listinging w/o requiring CRL.
410
411  * Added gpgme_set_status_cb to allow a user to see some status
412    messages.
413
414  * Added an export mode for secret keys.
415
416  * More precise error codes are returned if GnuPG >= 2.1.8 is used.
417
418  * The passphrase handler for the loopback mode has been improved and may
419    also be used with genkey.
420
421  * [w32] The standard GnuPG 2.1 install directory is now seached for
422    gpgconf.exe before a registry specified directory and the Gpg4win
423    install directory.
424
425  * [w32] gpgme-w32spawn.exe will now only be searched in the gpgme DLL
426    directory.
427
428  * Interface changes relative to the 1.5.1 release:
429  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
430  gpgme_set_offline              NEW.
431  gpgme_get_offline              NEW.
432  gpgme_set_status_cb            NEW.
433  gpgme_get_status_cb            NEW.
434  GPGME_EXPORT_MODE_SECRET       NEW
435  GPGME_EXPORT_MODE_RAW          NEW.
436  GPGME_EXPORT_MODE_PKCS12       NEW.
437
438
439 Noteworthy changes in version 1.5.5 (2015-06-08) [C24/A13/R4]
440 ------------------------------------------------
441
442  * Fixed crash in key listings for user ids with a backslash.
443
444  * Fixed regression for GPGSM use with GnuPG < 2.1.
445
446  * Properly set signature summary for revoked OpenPGP keys.
447
448
449 Noteworthy changes in version 1.5.4 (2015-04-13) [C24/A13/R3]
450 ------------------------------------------------
451
452  * Fixed a possible crash in the debug code.
453
454  * Fixed building for Windows with newer versions of Mingw.
455
456
457 Noteworthy changes in version 1.5.3 (2014-12-11) [C24/A13/R2]
458 -------------------------------------------------------------
459
460  * The export key functions do now return an error if used with the
461    latest GnuPG version.
462
463
464 Noteworthy changes in version 1.5.2 (2014-11-21) [C24/A13/R1]
465 -------------------------------------------------------------
466
467  * gpgme-tool is now installed.
468
469  * Fix external listing for modern keyservers.
470
471  * Minor other fixes.
472
473
474 Noteworthy changes in version 1.5.1 (2014-07-30) [C24/A13/R0]
475 -------------------------------------------------------------
476
477  * Fixed possible overflow in gpgsm and uiserver engines.
478    [CVE-2014-3564]
479
480  * Added support for GnuPG 2.1's --with-secret option.
481
482  * Interface changes relative to the 1.5.0 release:
483  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
484  GPGME_KEYLIST_MODE_WITH_SECRET NEW.
485
486
487 Noteworthy changes in version 1.5.0 (2014-05-21) [C23/A12/R0]
488 -------------------------------------------------------------
489
490  * On Unices the engine file names are not not anymore hardwired but
491    located via the envvar PATH.  All options to set the name of the
492    engines for the configure run are removed.
493
494  * If GPGME finds the gpgconf binary it defaults to using gpg2 or
495    whatever gpgconf tells as name for the OpenPGP engine.  If gpgconf
496    is not found, GPGME looks for an engine named "gpg".
497
498  * New feature to use the gpgme I/O subsystem to run arbitrary
499    commands.
500
501  * New flag to use encryption without the default compression step.
502
503  * New function to access "gpg-conf --list-dirs"
504
505  * New configure option --enable-fixed-path for use by Android.
506
507  * Support ECC algorithms.
508
509  * Interface changes relative to the 1.4.3 release:
510  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
511  gpgme_get_dirinfo              NEW.
512  gpgme_op_spawn_start           NEW.
513  gpgme_op_spawn                 NEW.
514  GPGME_PROTOCOL_SPAWN           NEW.
515  GPGME_SPAWN_DETACHED           NEW.
516  GPGME_SPAWN_ALLOW_SET_FG       NEW.
517  GPGME_ENCRYPT_NO_COMPRESS      NEW.
518  GPGME_PK_ECC                   NEW.
519  GPGME_MD_SHA224                NEW.
520  gpgme_subkey_t                 EXTENDED: New field curve.
521  GPGME_STATUS_PLAINTEXT_LENGTH  NEW.
522  GPGME_STATUS_MOUNTPOINT        NEW.
523  GPGME_STATUS_PINENTRY_LAUNCHED NEW.
524  GPGME_STATUS_ATTRIBUTE         NEW.
525  GPGME_STATUS_BEGIN_SIGNING     NEW.
526  GPGME_STATUS_KEY_NOT_CREATED   NEW.
527
528
529 Noteworthy changes in version 1.4.3 (2013-08-12) [C22/A11/R0]
530 -------------------------------------------------------------
531
532  * The default engine names are now taken from the output of gpgconf.
533    If gpgconf is not found the use of gpg 1 is assumed.
534
535  * Under Windows the default engines names are first searched in the
536    installation directory of the gpgme DLL.
537
538  * New function gpgme_data_identify to detect the type of a message.
539
540  * Interface changes relative to the 1.4.2 release:
541  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
542  gpgme_signers_count            NEW.
543  gpgme_data_type_t              NEW.
544  gpgme_data_identify            NEW.
545
546
547 Noteworthy changes in version 1.4.2 (2013-05-28) [C21/A10/R0]
548 -------------------------------------------------------------
549
550  * Allow symmetric encryption with gpgme_op_encrypt_sign.
551
552  * Fixed mismatching off_t definitions on Windows.
553
554  * Interface changes relative to the 1.4.1 release:
555  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
556  gpgme_off_t                    NEW.
557  gpgme_size_t                   NEW.
558  GPGME_PROTOCOL_OPENPGP         NEW alias.
559
560
561 Noteworthy changes in version 1.4.1 (2013-05-01) [C20/A9/R1]
562 ------------------------------------------------------------
563
564  * Fixed reading of gpg.conf files with excessive use of the group
565    option.
566
567  * Fixed building with the i686-w64-mingw32 toolchain.
568
569  * Disabled FD passing by default for Apple.
570
571
572 Noteworthy changes in version 1.4.0 (2013-02-26) [C20/A9/R0]
573 ------------------------------------------------------------
574
575  * New function gpgme_set_global_flag to help debugging on Android.
576
577  * New function gpgme_io_writen as a convenience wrapper around
578    gpgme_io_write.
579
580  * New functions to support the pinentry mode feature of GnuPG 2.1.
581
582  * New macro GPGME_VERSION_NUMBER to allow supporting different API
583    versions without the need for a configure test.
584
585  * Several improvements for gpgme-tool.
586
587  * Better logging of the common "invalid engine" error code.
588
589  * Support for FD passing is now enabled by default.  The configure
590    option --disable-fd-passing may be used to disable this.
591
592  * Interface changes relative to the 1.3.1 release:
593  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
594  GPGME_VERSION_NUMBER           NEW.
595  gpgme_io_writen                NEW.
596  gpgme_set_global_flag          NEW.
597  gpgme_set_pinentry_mode        NEW.
598  gpgme_get_pinentry_mode        NEW.
599  gpgme_pinentry_mode_t          NEW.
600  GPGME_PINENTRY_MODE_DEFAULT    NEW.
601  GPGME_PINENTRY_MODE_ASK        NEW.
602  GPGME_PINENTRY_MODE_CANCEL     NEW.
603  GPGME_PINENTRY_MODE_ERROR      NEW.
604  GPGME_PINENTRY_MODE_LOOPBACK   NEW.
605
606
607 Noteworthy changes in version 1.3.2 (2012-05-02)
608 ------------------------------------------------
609
610  * Remove support for libgpgme-pth.  As far as we know, this was never used,
611    and GnuPG is going to use our own npth in the future.
612
613  * Fix signature summary information for a missing X.509 key.
614
615  * Fix parsing of dates >= year 2038.
616
617
618 Noteworthy changes in version 1.3.1 (2011-06-16)
619 ------------------------------------------------
620
621  * Ported to Windows CE.
622
623  * Detect GPG versions not supporting ---passwd.
624
625  * Interface changes relative to the 1.3.0 release:
626  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
627  GPGME_EXPORT_MODE_MINIMAL      NEW
628  GPGME_STATUS_SUCCESS           NEW
629  gpgme_err_code_from_syserror   NEW
630  gpgme_err_set_errno            NEW
631  gpgme_error_from_errno         CHANGED: Return gpgme_error_t (compatible type).
632  gpgme_error_from_syserror      NEW
633  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
634
635
636 Noteworthy changes in version 1.3.0 (2010-01-11)
637 ------------------------------------------------
638
639  * GPGME does not come with an internal libassuan version anymore.
640    The external libassuan 1.1.0 release or later is required.  For
641    application programmers on systems that can resolve inter-library
642    dependencies at runtime, this is a transparent change.
643
644  * New engine GPGME_PROTOCOL_G13 to support the new g13 tool.
645
646  * New engine GPGME_PROTOCOL_UISERVER to support UI Servers.
647
648  * New API to change the passphrase of a key.
649
650  * Interface changes relative to the 1.2.0 release:
651  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
652  GPGME_STATUS_INV_SGNR    NEW.
653  GPGME_STATUS_NO_SGNR     NEW.
654  GPGME_PROTOCOL_G13       NEW.
655  gpgme_op_g13_mount       NEW.
656  gpgme_g13_result_t       NEW.
657  GPGME_PK_ECDSA           NEW.
658  GPGME_PK_ECDH            NEW.
659  gpgme_op_passwd_start    NEW.
660  gpgme_op_passwd          NEW.
661  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
662
663
664 Noteworthy changes in version 1.2.0 (2009-06-18)
665 ------------------------------------------------
666
667  * New encryption flag GPGME_ENCRYPT_NO_ENCRYPT_TO to disable default
668    recipients.
669
670  * gpgme_new will fail if gpgme_check_version was not called, or a
671    selftest failed (for example, if -mms-bitfields was not used on
672    MingW32 targets).
673
674  * New functions gpgme_io_read and gpgme_io_write for use with
675    gpgme_passphrase_cb_t and gpgme_edit_cb_t functions.
676
677  * New functions gpgme_result_ref and gpgme_result_unref to detach
678    result structures from a context.
679
680  * New functions gpgme_op_export_keys_start and gpgme_op_export_keys
681    that allow to specify exported keys through gpgme_key_t objects
682    instead of patterns.
683
684  * New mode of operation gpgme_export_mode_t that allows exporting
685    external keys.
686
687  * Interface changes relative to the 1.1.7 release:
688  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
689  GPGME_KEYLIST_MODE_EPHEMERAL   NEW.
690  GPGME_PROTOCOL_ASSUAN          NEW.
691  gpgme_assuan_data_cb_t         NEW.
692  gpgme_assuan_inquire_cb_t      NEW.
693  gpgme_assuan_status_cb_t       NEW.
694  gpgme_op_assuan_transact_start NEW.
695  gpgme_op_assuan_transact       NEW.
696  gpgme_op_assuan_result         NEW.
697  gpgme_op_import_keys           NEW.
698  gpgme_op_import_keys_start     NEW.
699  gpgme_subkey_t                 EXTENDED: New fields is_cardkey, card_number.
700  GPGME_ENCRYPT_NO_ENCRYPT_TO    NEW.
701  gpgme_check_version            CHANGED: Is now a macro.
702  gpgme_new                      EXTENDED: More failure codes.
703  gpgme_io_read                  NEW.
704  gpgme_io_write                 NEW.
705  gpgme_result_ref               NEW.
706  gpgme_result_unref             NEW.
707  gpgme_export_mode_t            NEW.
708  gpgme_export_ext_start         EXTENDED: Arg RESERVED is now a MODE flag.
709  gpgme_op_export                EXTENDED: Arg RESERVED is now a MODE flag.
710  gpgme_op_export_ext_start      EXTENDED: Arg RESERVED is now a MODE flag.
711  gpgme_op_export_ext            EXTENDED: Arg RESERVED is now a MODE flag.
712  gpgme_op_export_keys_start     NEW.
713  gpgme_op_export_keys           NEW.
714  GPGME_DATA_ENCODING_URL        NEW.
715  GPGME_DATA_ENCODING_URL0       NEW.
716  GPGME_DATA_ENCODING_URLESC     NEW.
717  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
718
719
720 Noteworthy changes in version 1.1.8 (2008-12-08)
721 ------------------------------------------------
722
723  * SIGPIPE is now again ignored as described in the manual.  Fixes
724    regresion introduced with 1.1.6.
725
726
727 Noteworthy changes in version 1.1.7 (2008-10-17)
728 ------------------------------------------------
729
730  * Using GPGME_KEYLIST_MODE_LOCAL combined with
731    GPGME_KEYLIST_MODE_EXTERN is now supported; it uses the
732    --locate-keys feature of gpg (>= 2.0.10).
733
734  * The encoding of gpgme_data_t objects can affect the output encoding
735    of export, sign and encrypt operations now (the same operations
736    that are also affected by the ASCII mode switch).  We believe this
737    change in the ABI is innocent enough not to break existing
738    applications (it only affects the S/MIME backend on certain
739    operations).
740
741  * The reference manual now includes the specification of "The GnuPG
742    UI Server protocol".
743
744  * A new function gpgme_cancel_async can be used to asynchronously
745    cancel any pending operation at any time, from any thread.
746
747  * Interface changes relative to the 1.1.6 release:
748  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
749 gpgme_op_encrypt                CHANGED: Output encoding can affect result.
750 gpgme_op_encrypt_start          CHANGED: Output encoding can affect result.
751 gpgme_op_encrypt_sign           CHANGED: Output encoding can affect result.
752 gpgme_op_encrypt_sign_start     CHANGED: Output encoding can affect result.
753 gpgme_op_sign                   CHANGED: Output encoding can affect result.
754 gpgme_op_sign_start             CHANGED: Output encoding can affect result.
755 gpgme_op_export                 CHANGED: Output encoding can affect result.
756 gpgme_op_export_start           CHANGED: Output encoding can affect result.
757 gpgme_op_export_ext             CHANGED: Output encoding can affect result.
758 gpgme_op_export_ext_start       CHANGED: Output encoding can affect result.
759 gpgme_cancel_async              NEW
760  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
761
762
763 Noteworthy changes in version 1.1.6 (2008-01-04)
764 ------------------------------------------------
765
766  * Bug fixes for for W32.
767
768  * A new, experimental (and thus undocumented and potentially
769    unstable) interface for accessing gpg-conf through GPGME has been
770    added.
771
772  * Interface changes relative to the 1.1.1 release:
773  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
774  gpgme_signature_t               EXTENDED: New field chain_model.
775  gpgme_op_getauditlog_start      NEW.
776  gpgme_op_getauditlog            NEW.
777  GPGME_AUDITLOG_HTML             NEW.
778  GPGME_AUDITLOG_WITH_HELP        NEW.
779  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
780
781
782 Noteworthy changes in version 1.1.5 (2007-07-09)
783 ------------------------------------------------
784
785  * Bug and portability fixes (mainly for W32).
786
787
788 Noteworthy changes in version 1.1.4 (2007-03-05)
789 ------------------------------------------------
790
791  * Detect and bail out on double plaintext messages.  This is required
792    so that applications can properly detect the signed parts of a
793    message.  Actual there is now a double protection as GnuPG 1.4.7
794    will detect this case too.
795
796
797 Noteworthy changes in version 1.1.3 (2007-01-29)
798 ------------------------------------------------
799
800  * Fixed a memory leak in gpgme_data_release_and_get_mem.
801
802  * Fixed a bug in Windows command line quoting.
803
804
805 Noteworthy changes in version 1.1.2 (2006-03-02)
806 ------------------------------------------------
807
808  * Fixed a bug in the W32 glib backend.
809
810
811 Noteworthy changes in version 1.1.1 (2006-02-23)
812 ------------------------------------------------
813
814  * Fixed a bug in that the fingerprints of subkeys are not available.
815
816  * Clarified usage of the SECRET flag in key listings.  It is now
817    reset for stub keys.
818
819  * Reading signature notations and policy URLs on key signatures is
820    supported.  They can be found in the new field notations of the
821    gpgme_key_sig_t structure.  This has to be enabled with the keylist
822    mode flag GPGME_KEYLIST_MODE_SIG_NOTATIONS.
823
824  * A new gpgme_free() function solves the problem of using different
825    allocators in a single program.  This function should now be used
826    instead calling free() to release the buffer returned by
827    gpgme_data_release_and_get_mem.  It is recommended that you always
828    do this, but it is only necessary on certain platforms, so backwards
829    compatibility is provided.  In other words: If free() worked for
830    you before, it will keep working.
831
832  * New status codes GPGME_PKA_TRUST_GOOD and GPGME_PKA_TRUST_BAD.
833    They are analyzed by the verify handlers and made available in the
834    new PKA_TRUST and PKA_ADDRESS fields of the signature result structure.
835
836  * Interface changes relative to the 1.1.0 release:
837 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
838 gpgme_key_sig_t                 EXTENDED: New field notations.
839 GPGME_KEYLIST_MODE_SIG_NOTATIONS NEW
840 gpgme_free                      NEW
841 GPGME_STATUS_PKA_TRUST_BAD      NEW
842 GPGME_STATUS_PKA_TRUST_GOOD     NEW
843 gpgme_signature_t               EXTENDED: New field pka_trust.
844 gpgme_signature_t               EXTENDED: New field pka_address.
845 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
846
847
848 Noteworthy changes in version 1.1.0 (2005-10-01)
849 ------------------------------------------------
850
851  * You can now configure the backend engine file name and home
852    directory to be used, as default and per context.
853
854  * Information about the recipients of an encrypted text is now
855    available at decryption time.
856
857  * New status GPGME_STATUS_PLAINTEXT.  This is analyzed by the decrypt
858    and verify handlers, the information about the plaintext filename,
859    if available is made available in the new field file_name of the
860    respective result structure.
861
862  * The code for "automagically detecting the thread library" has been
863    removed from libgpgme.  It is deprecated since version 0.4.3.
864    Since then, you had to link against libgpgme-pthread for
865    applications using pthread and libgpgme-pth for applications using
866    GNU Pth.
867
868    The code was removed because it caused compilation problems on
869    systems where the pthread.h header from GNU Pth is available in
870    addition to the system header (FreeBSD 6 and later for example).
871
872  * "./autogen.sh --build-w32" does now build gpgme.dll.
873
874  * [W32] The environment variable GPGME_DEBUG now uses a semicolon as
875    delimiter.  The standard install directory is used when locating
876    gpg or gpgsm before finally falling back to the hardwired name.
877
878  * There is a new flag for keys and subkeys, is_qualified, which
879    indicates if a key can be used for qualified signatures according
880    to local government regulations.
881
882  * You can associate a filename with a data object using the new
883    function gpgme_data_set_file_name().  This filename will be stored
884    in the output when encrypting or signing the data and will be
885    returned when decrypting or verifying the output data.
886
887  * You can now set notation data at signature creation with the new
888    function gpgme_sig_notation_add().
889
890  * Interface changes relative to the 1.0.3 release:
891 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
892 gpgme_set_engine_info           NEW
893 gpgme_ctx_get_engine_info       NEW
894 gpgme_ctx_set_engine_info       NEW
895 gpgme_recipient_t               NEW
896 gpgme_decrypt_result_t          EXTENDED: New field recipients.
897 gpgme_verify_result_t           EXTENDED: New fields pubkey_algo, hash_algo.
898 gpgme_decrypt_result_t          EXTENDED: New field plaintext_filename.
899 gpgme_verify_result_t           EXTENDED: New field plaintext_filename.
900 GPGME_STATUS_PLAINTEXT          NEW
901 gpgme_key_t                     EXTENDED: New field is_qualified.
902 gpgme_subkey_t                  EXTENDED: New field is_qualified.
903 gpgme_data_get_file_name        NEW
904 gpgme_data_set_file_name        NEW
905 gpgme_sig_notation_flags_t      NEW
906 GPGME_SIG_NOTATION_HUMAN_READABLE NEW
907 GPGME_SIG_NOTATAION_CRITICAL    NEW
908 gpgme_sig_notation_clear        NEW
909 gpgme_sig_notation_add          NEW
910 gpgme_sig_notation_get          NEW
911 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
912
913
914 Noteworthy changes in version 1.0.3 (2005-06-20)
915 ------------------------------------------------
916
917  * Previousy, GPGME would use a default "include certs" of 1.  This
918    has been changed.  Now GPGME will use the crypto backend engines
919    default unless you set the value with gpgme_set_include_certs()
920    explicitely.  A new macro GPGME_INCLUDE_CERTS_DEFAULT can be used
921    as a value to explicitely request the new default behaviour.
922
923    Because the default changes, this is a slight change of the API
924    semantics.  We consider it to be a bug fix.
925
926  * A bug which made GPGME hang has been fixed.  If you have
927    experienced hanging before, please try out this version and let me
928    know if you still experience hanging problems.
929
930  * Interface changes relative to the 0.9.0 release:
931 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
932 gpgme_set_include_certs         CHANGED DEFAULT
933 GPGME_INCLUDE_CERTS_DEFAULT     NEW
934 GPGME_STATUS_SIG_SUBPACKET      NEW
935 GPGME_STATUS_NEED_PASSPHRASE_PIN NEW
936 GPGME_STATUS_SC_OP_FAILURE      NEW
937 GPGME_STATUS_SC_OP_SUCCESS      NEW
938 GPGME_STATUS_CARDCTRL           NEW
939 GPGME_STATUS_BACKUP_KEY_CREATED NEW
940 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
941
942
943 Noteworthy changes in version 1.0.2 (2004-12-28)
944 ------------------------------------------------
945
946  * Changed the license of the library to the GNU Lesser General Public
947    License (LGPL), version 2.1 or later.
948
949
950 Noteworthy changes in version 1.0.1 (2004-10-22)
951 ------------------------------------------------
952
953  * Only bug fixes.
954
955
956 Noteworthy changes in version 1.0.0 (2004-09-30)
957 ------------------------------------------------
958
959  * Version 1.0.0!  We are proud to present you with a thoroughly
960    tested and stable version of the GPGME library.  A big Thank You!
961    to all the people who made this possible.
962
963    The development will be branched into a stable 1.x.y series and the
964    head.
965
966  * The gpgme.m4 macro supports checking the API version.  Just prepend
967    it to the required version string, separated by a colon.  For
968    example, this release has the version "1:1.0.0".  The last release
969    to which this version is (mostly) ABI compatible is "1:0.4.2",
970    which is the default required version.
971
972
973 Noteworthy changes in version 0.9.0 (2004-06-08)
974 ------------------------------------------------
975
976  * The type gpgme_key_t has now a new field keylist_mode that contains
977    the keylist mode that was active at the time the key was retrieved.
978
979  * The type gpgme_decrypt_result_t has a new field "wrong_key_usage"
980    that contains a flag indicating that the key should not have been
981    used for encryption.
982
983  * Verifying a signature of a revoked key gives the correct result now
984    (GPG_ERR_CERT_REVOKED error code).
985
986  * Clarified that the error code GPG_ERR_NO_DATA from the decrypt &
987    verify operations still allows you to look at the signature
988    verification result.
989
990  * Clarified that patterns in keylisting operations have an upper
991    limit, and thus are not suited to list many keys at once by their
992    fingerprint.  Also improve the error message if the pattern is too
993    long for the CMS protocol to handle.
994
995 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
996 gpgme_key_t                     EXTENDED: New field keylist_mode.
997 gpgme_decrypt_result_t          EXTENDED: New field wrong_key_usage.
998 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
999
1000
1001 Noteworthy changes in version 0.4.7 (2004-04-29)
1002 ------------------------------------------------
1003
1004  * Correctly initialize the fields expired, revoked, invalid, and
1005    disabled in the gpgme_key_t structures.
1006
1007  * A bug fix: The flag wrong_key_usage of gpgme_signature_t was
1008    accidently of type int instead unsigned int.
1009
1010  * Interface changes relative to the 0.4.5 release:
1011 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1012 gpgme_signature_t               CHANGED: wrong_key_usage is unsigned int now.
1013 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1014
1015 Noteworthy changes in version 0.4.6 (2004-04-06)
1016 ------------------------------------------------
1017
1018  * Bug fixes
1019
1020
1021 Noteworthy changes in version 0.4.5 (2004-03-07)
1022 ------------------------------------------------
1023
1024  * GPGME is now compiled with LFS (large file support) by default.
1025    This means that _all_ programs using GPGME must be compiled with
1026    LFS support enabled by default.  You can do this easily with
1027    autoconf, by using the AC_SYS_LARGEFILE macro.  Or you can do this
1028    without autoconf by defining the preprocessor symbol
1029    _FILE_OFFSET_BITS to 64 (by passing the -D_FILE_OFFSET_BITS=64 to
1030    the C compiler command line, or by defining this preprocessor
1031    symbol before including any system header files).  For more
1032    details, read the section on LFS in the manual.
1033
1034    Up to now, it was undocumented that GPGME was not using LFS.
1035    But the public interfaces use off_t, and file descriptors are
1036    exchanged between the application and GPGME.  This was an oversight,
1037    and bound to cause troubles in the future.
1038
1039    Writing GPGME as a dual mode library that seamlessly supports LFS
1040    while keeping backwards compatibility is possible, but does not
1041    solve the problem: Many applications already expect GPGME to have
1042    LFS (they are compiled with off_t being a 64bit value).  This is true
1043    in particular for the popular Gtk+ and Qt programs.
1044
1045    So, although this is an ABI (but not an API) break, we will not
1046    change the library version to reflect that.  Because the interfaces
1047    affected are probably not used yet in any GPGME 0.4 based
1048    application, we don't expect any real failures from this change.
1049    In fact, applications already using LFS will have some subtle bugs
1050    fixed.
1051
1052    However, if you encounter an application using GPGME 0.4.x that
1053    does _not_ use LFS by default (off_t is a 32bit value), _and_
1054    uses at least one of the functions gpgme_data_seek,
1055    gpgme_data_new_from_filepart, or a gpgme_data_seek_cb_t with
1056    gpgme_data_new_from_cbs, then indeed this library will be ABI
1057    incompatible with the program.  As said above, we don't believe
1058    such a program exists.  If we are in error, then you have two
1059    options: As a quick hack, you can configure GPGME with the
1060    --disable-largefile option.  This will revert the change, and GPGME
1061    will not use LFS.  However, GPGME will be incompatible with
1062    programs that expect GPGME to use LFS.  All applications are
1063    required to use LFS when using GPGME, so this is only good as a
1064    temporary local work-around.
1065
1066    The other option is to change the versioning of the library and
1067    recompile all applications.  We have reserved a special version of
1068    the library for that, so you can do that without expecting a
1069    version clash in the future.  Furthermore, everyone who does this
1070    will agree on the version to use (this is important for
1071    distribution makers).  Read the comment in configure.ac (before
1072    LIBGPGME_LT_AGE) if you want to do this.  Please don't do this
1073    blindly: As stated above, we think it is unlikely this measure is
1074    needed.  Still, it is there if necessary.  If in doubt, contact us
1075    and we will give our advise for your specific situation.
1076
1077  * New key listing mode GPGME_KEYLIST_MODE_VALIDATE for validation of
1078    the listed keys.
1079
1080  * New interface gpgme_cancel() that can be used to cancel
1081    asynchronous operations.
1082
1083  * Interface changes relative to the 0.4.4 release:
1084 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1085 gpgme_data_seek_cb_t            CHANGED: off_t is now a largefile type.
1086 gpgme_data_seek                 CHANGED: off_t is now a largefile type.
1087 gpgme_data_new_from_filepart    CHANGED: off_t is now a largefile type.
1088 GPGME_KEYLIST_MODE_VALIDATE     NEW
1089 gpgme_cancel                    NEW
1090 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1091
1092 Noteworthy changes in version 0.4.4 (2004-01-12)
1093 ------------------------------------------------
1094
1095  * The member "class" in gpgme_key_sig_t and gpgme_new_signature_t has
1096    been renamed to "sig_class", to avoid clash with C++ compilers.  In
1097    the C API, the old name "class" has been preserved for backwards
1098    compatibility, but is deprecated.
1099
1100  * Interface changes relative to the 0.4.3 release:
1101 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1102 gpgme_key_sig_t                 CHANGED: class deprecated, use new sig_class.
1103 gpgme_new_signature_t           CHANGED: class deprecated, use new sig_class.
1104 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1105
1106 Noteworthy changes in version 0.4.3 (2003-10-06)
1107 ------------------------------------------------
1108
1109  * libgpgme should not be used for threaded programs anymore.  This
1110    never worked reliably in all cases, because you had to
1111    be careful about the linking order and libtool wouldn't do that for
1112    you automatically.  Instead, now you have to link against
1113    libgpgme-pthread for applications using pthread and libgpgme-pth for
1114    applications using GNU Pth.
1115
1116    The old code for automagically detecting the thread library is
1117    still part of libgpgme, but it is DEPRECATED.
1118
1119  * There are new automake macros AM_PATH_GPGME_PTH and
1120    AM_PATH_GPGME_PTHREAD, which support checking for thread-enabled
1121    versions of GPGME.  They define GPGME_PTH_CFLAGS, GPGME_PTH_LIBS,
1122    GPGME_PTHREAD_CFLAGS and GPGME_PTHREAD_LIBS respectively.  These
1123    variables of course also include the configuration for the thread
1124    package itself.  Alternatively, use libtool.
1125
1126  * gpgme_strerror_r as a thread safe variant of gpgme_strerror was
1127    added.
1128
1129  * gpgme-config doesn't support setting the prefix or exec prefix
1130    anymore.  I don't think it ever worked correctly, and it seems to
1131    be pointless.
1132
1133  * gpgme_get_key fails with GPG_ERR_AMBIGUOUS_NAME if the key ID
1134    provided was not unique, instead returning the first matching key.
1135
1136  * gpgme_key_t and gpgme_subkey_t have a new field, can_authenticate,
1137    that indicates if the key can be used for authentication.
1138
1139  * gpgme_signature_t's status field is now correctly set to an error
1140    with error code GPG_ERR_NO_PUBKEY if public key is not found.
1141
1142  * gpgme_new_signature_t's class field is now an unsigned int, rather
1143    than an unsigned long (the old class field is preserved for
1144    backwards compatibility).
1145
1146  * A new function gpgme_set_locale() is provided to allow configuring
1147    the locale for the crypto backend.  This is necessary for text
1148    terminals so that programs like the pinentry can be started with
1149    the right locale settings for the terminal the application is running
1150    on, in case the terminal has different settings than the system
1151    default (for example, if it is a remote terminal).  You are highly
1152    recommended to call the following functions directly after
1153    gpgme_check_version:
1154
1155    #include <locale.h>
1156
1157    setlocale (LC_ALL, "");
1158    gpgme_set_locale (NULL, LC_CTYPE, setlocale (LC_CTYPE, NULL));
1159    gpgme_set_locale (NULL, LC_MESSAGES, setlocale (LC_MESSAGES, NULL));
1160
1161    GPGME can not do this for you, as setlocale is not thread safe, and
1162    there is no alternative.
1163
1164  * The signal action for SIGPIPE is now set to SIG_IGN by
1165    gpgme_check_version, instead the first time a crypto engine is
1166    started (which is not well defined).
1167
1168  * In the output of gpgme_hash_algo_name, change RMD160 to RIPEMD160,
1169    TIGER to TIGER192, CRC32-RFC1510 to CRC32RFC1510, and CRC24-RFC2440
1170    to CRC24RFC2440.  For now, these strings can be used as the MIC
1171    parameter for PGP/MIME (if appropriately modified).
1172
1173  * Interface changes relative to the 0.4.2 release:
1174 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1175 gpgme_strerror_t                NEW
1176 gpgme_get_key                   CHANGED: Fails correctly if key ID not unique.
1177 gpgme_key_t                     EXTENDED: New field can_authenticate.
1178 gpgme_subkey_t                  EXTENDED: New field can_authenticate.
1179 gpgme_new_signature_t           CHANGED: New type for class field.
1180 gpgme_set_locale                NEW
1181 gpgme_hash_algo_name            CHANGED: Slight adjustment of algo names.
1182 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1183
1184 Noteworthy changes in version 0.4.2 (2003-07-30)
1185 ------------------------------------------------
1186
1187  * Allow gpg-error to be in non-standard place when linking the test suite.
1188
1189  * Configure will fail now if gpg-error can not be found.
1190
1191  * Fixed initialized memory backed data objects for writing, which
1192    caused the test program to crash (but only on Mac OS, surprisingly).
1193
1194  * Eliminate use of C99 constructs.
1195
1196  * Small improvements to the manual.
1197
1198
1199 Noteworthy changes in version 0.4.1 (2003-06-06)
1200 ------------------------------------------------
1201
1202  This is the release that 0.4.0 should have been.  There are many
1203  interface changes, please see below for the details.  The changes are
1204  sometimes the result of new functionality, but more often express a
1205  paradigm shift.  Others are an overdue cleanup to get GPGME in line
1206  with the GNU coding standards and to make the interface more
1207  self-consistent.  Here is an overview on the changes:
1208
1209  All types have been renamed to conform to the GNU coding standards,
1210  most of the time by keeping the whole name in lowercase and inserting
1211  underscores between words.
1212
1213  All operations consistently only accept input parameters in their
1214  invocation function, and return only an error code directly.  Further
1215  information about the result of the operation has to be retrieved
1216  afterwards by calling one of the result functions.  This unifies the
1217  synchronous and the asynchronous interface.
1218
1219  The error values have been completely replaced by a more
1220  sophisticated model that allows GPGME to transparently and accurately
1221  report all errors from the other GnuPG components, irregardless of
1222  process boundaries.  This is achieved by using the library
1223  libgpg-errors, which is shared by all GnuPG components.  This library
1224  is now required for GPGME.
1225
1226  The results of all operations are now provided by pointers to C
1227  structs rather than by XML structs or in other ways.
1228
1229  Objects which used to be opaque (for example a key) are now pointers
1230  to accessible structs, so no accessor functions are necessary.
1231
1232  Backward compatibility is provided where it was possible without too
1233  much effort and did not collide with the overall sanitization effort.
1234  However, this is only for ease of transition.  NO DEPRECATED FUNCTION
1235  OR DATA TYPE IS CONSIDERED A PART OF THE API OR ABI AND WILL BE
1236  DROPPED IN THE FUTURE WITHOUT CHANGING THE SONAME OF THE LIBRARY.
1237  Recommendations how to replace deprecated or removed functionality
1238  can be found within the description of each change.
1239
1240  What follows are all changes to the interface and behaviour of GPGME
1241  in detail.
1242
1243  * If gpgme.h is included in sources compiled by GCC 3.1 or later,
1244    deprecated attributes will warn about use of obsolete functions and
1245    type definitions.  You can suppress these warnings by passing
1246    -Wno-deprecated-declarations to the gcc command.
1247
1248  * The following types have been renamed.  The old types are still
1249    available as aliases, but they are deprecated now:
1250    Old name:            New name:
1251    GpgmeCtx             gpgme_ctx_t
1252    GpgmeData            gpgme_data_t
1253    GpgmeError           gpgme_error_t
1254    GpgmeDataEncoding    gpgme_data_encoding_t
1255    GpgmeSigStat         gpgme_sig_stat_t
1256    GpgmeSigMode         gpgme_sig_mode_t
1257    GpgmeAttr            gpgme_attr_t
1258    GpgmeValidity        gpgme_validity_t
1259    GpgmeProtocol        gpgme_protocol_t
1260    GpgmeKey             gpgme_key_t
1261    GpgmePassphraseCb    gpgme_passphrase_cb_t
1262    GpgmeProgressCb      gpgme_progress_cb_t
1263    GpgmeIOCb            gpgme_io_cb_t
1264    GpgmeRegisterIOCb    gpgme_register_io_cb_t
1265    GpgmeRemoveIOCb      gpgme_remove_io_cb_t
1266    GpgmeEventIO         gpgme_event_io_t
1267    GpgmeEventIOCb       gpgme_event_io_cb_t
1268    GpgmeIOCbs           gpgme_io_cbs
1269    GpgmeDataReadCb      gpgme_data_read_cb_t
1270    GpgmeDataWriteCb     gpgme_data_write_cb_t
1271    GpgmeDataSeekCb      gpgme_data_seek_cb_t
1272    GpgmeDataReleaseCb   gpgme_data_release_cb_t
1273    GpgmeDataCbs         gpgme_data_cbs_t
1274    GpgmeTrustItem       gpgme_trust_item_t
1275    GpgmeStatusCode      gpgme_status_code_t
1276
1277  * gpgme_error_t is now identical to gpg_error_t, the error type
1278    provided by libgpg-error.  More about using libgpg-error with GPGME
1279    can be found in the manual.  All error symbols have been removed!
1280
1281  * All functions and types in libgpg-error have been wrapped in GPGME.
1282    The new types are gpgme_err_code_t and gpgme_err_source_t.  The new
1283    functions are gpgme_err_code, gpgme_err_source, gpgme_error,
1284    gpgme_err_make, gpgme_error_from_errno, gpgme_err_make_from_errno,
1285    gpgme_err_code_from_errno, gpgme_err_code_to_errno,
1286    gpgme_strsource.
1287
1288  * GPGME_ATTR_IS_SECRET is not anymore representable as a string.
1289
1290  * GnuPG 1.2.2 is required.  The progress callback is now also invoked
1291    for encrypt, sign, encrypt-sign, decrypt, verify, and
1292    decrypt-verify operations.  For verify operations on detached
1293    signatures, the progress callback is invoked for both the detached
1294    signature and the plaintext message, though.
1295
1296  * gpgme_passphrase_cb_t has been changed to not provide a complete
1297    description, but the UID hint, passphrase info and a flag
1298    indicating if this is a repeated attempt individually, so the user
1299    can compose his own description from this information.
1300
1301    The passphrase is not returned as a C string, but must be written
1302    to a file descriptor directly.  This allows for secure passphrase
1303    entries.
1304
1305    The return type has been changed to gpgme_error_t value.  This
1306    allowed to remove the gpgme_cancel function; just return
1307    the error code GPG_ERR_CANCELED in the passphrase callback directly.
1308
1309  * gpgme_edit_cb_t has been changed to take a file descriptor argument.
1310    The user is expected to write the response to the file descriptor,
1311    followed by a newline.
1312
1313  * The recipients interface has been removed.  Instead, you use
1314    NULL-terminated lists of keys for specifying the recipients of an
1315    encryption operation.  Use the new encryption flag
1316    GPGME_ENCRYPT_ALWAYS_TRUST if you want to override the validity of
1317    the keys (but note that in general this is not a good idea).
1318
1319    This change has been made to the prototypes of gpgme_op_encrypt,
1320    gpgme_op_encrypt_start, gpgme_op_encrypt_sign and
1321    gpgme_op_encrypt_sign_start.
1322
1323    The export interface has been changed to use pattern strings like
1324    the keylist interface.  Thus, new functions gpgme_op_export_ext and
1325    gpgme_op_export_ext_start have been added as well.  Now the
1326    prototypes of gpgme_op_export_start and gpgme_op_export finally
1327    make sense.
1328
1329  * gpgme_op_verify and gpgme_op_decrypt_verify don't return a status
1330    summary anymore.  Use gpgme_get_sig_status to retrieve the individual
1331    stati.
1332
1333  * gpgme_io_cb_t changed from a void function to a function returning
1334    a gpgme_error_t value.  However, it will always return 0, so you
1335    can safely ignore the return value.
1336
1337  * A new I/O callback event GPGME_EVENT_START has been added.  The new
1338    requirement is that you must wait until this event until you are
1339    allowed to call the I/O callback handlers previously registered for
1340    this context operation.  Calling I/O callback functions for this
1341    context operation before the start event happened is unsafe because
1342    it can lead to race conditions in a multi-threaded environment.
1343
1344  * The idle function feature has been removed.  It was not precisely
1345    defined in a multi-threaded environment and is obsoleted by the
1346    user I/O callback functions.  If you still need a simple way to
1347    call something while waiting on one or multiple asynchronous
1348    operations to complete, don't set the HANG flag in gpgme_wait (note
1349    that this will return to your program more often than the idle
1350    function did).
1351
1352  * gpgme_wait can return NULL even if hang is true, if an error
1353    occurs.  In that case *status contains the error code.
1354
1355  * gpgme_get_engine_info was radically changed.  Instead an XML
1356    string, an info structure of the new type gpgme_engine_info_t is
1357    returned.  This makes it easier and more robust to evaluate the
1358    information in an application.
1359
1360  * The new function gpgme_get_protocol_name can be used to convert a
1361    gpgme_protocol_t value into a string.
1362
1363  * The status of a context operation is not checked anymore.  Starting
1364    a new operation will silently cancel the previous one.  Calling a
1365    function that requires you to have started an operation before without
1366    doing so is undefined.
1367
1368  * The FPR argument to gpgme_op_genkey was removed.  Instead, use the
1369    gpgme_op_genkey_result function to retrieve a gpgme_genkey_result_t
1370    pointer to a structure which contains the fingerprint.  This also
1371    works with gpgme_op_genkey_start.  The structure also provides
1372    other information about the generated keys.
1373
1374    So, instead:
1375
1376    char *fpr;
1377    err = gpgme_op_genkey (ctx, NULL, NULL, &fpr);
1378    if (!err && fpr)
1379      printf ("%s\n", fpr);
1380
1381    you should now do:
1382
1383    gpgme_genkey_result_t result;
1384    err = gpgme_op_genkey (ctx, NULL, NULL);
1385    if (!err)
1386      {
1387        result = gpgme_op_genkey_result (ctx);
1388        if (result->fpr)
1389          printf ("%s\n", result->fpr);
1390      }
1391
1392  * The new gpgme_op_import_result function provides detailed
1393    information about the result of an import operation in
1394    gpgme_import_result_t and gpgme_import_status_t objects.
1395    Thus, the gpgme_op_import_ext variant is deprecated.
1396
1397  * The new gpgme_op_sign_result function provides detailed information
1398    about the result of a signing operation in gpgme_sign_result_t,
1399    gpgme_invalid_key_t and gpgme_new_signature_t objects.
1400
1401  * The new gpgme_op_encrypt_result function provides detailed
1402    information about the result of an encryption operation in
1403    a GpgmeEncryptResult object.
1404
1405  * The new gpgme_op_decrypt_result function provides detailed
1406    information about the result of a decryption operation in
1407    a GpgmeDecryptResult object.
1408
1409  * The new gpgme_op_verify_result function provides detailed
1410    information about the result of an verify operation in
1411    a GpgmeVerifyResult object.  Because of this, the GPGME_SIG_STAT_*
1412    values, gpgme_get_sig_status, gpgme_get_sig_ulong_attr,
1413    gpgme_get_sig_string_attr and gpgme_get_sig_key are now deprecated,
1414    and gpgme_get_notation is removed.
1415
1416  * GpgmeTrustItem objects have now directly accessible data, so the
1417    gpgme_trust_item_get_string_attr and gpgme_trust_item_get_ulong_attr
1418    accessor functions are deprecated.  Also, reference counting is
1419    available through gpgme_trust_item_ref and gpgme_trust_item_unref
1420    (the gpgme_trust_item_release alias for the latter is deprecated).
1421
1422  * Keys are not cached internally anymore, so the force_update argument
1423    to gpgme_get_key has been removed.
1424
1425  * GpgmeKey objects have now directly accessible data so the
1426    gpgme_key_get_string_attr, gpgme_key_get_ulong_attr,
1427    gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
1428    functions are deprecated.  Also, gpgme_key_release is now
1429    deprecated.  The gpgme_key_get_as_xml function has been dropped.
1430
1431  * Because all interfaces using attributes are deprecated, the
1432    GpgmeAttr data type is also deprecated.
1433
1434  * The new gpgme_op_keylist_result function provides detailed
1435    information about the result of a key listing operation in
1436    a GpgmeKeyListResult object.
1437
1438  * Now that each function comes with its own result retrieval
1439    interface, the generic gpgme_get_op_info interface is not useful
1440    anymore and dropped.
1441
1442  * The type and mode of data objects is not available anymore.
1443
1444  * Interface changes relative to the 0.4.0 release:
1445 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1446 GpgmeCtx                        DEPRECATED: Use gpgme_ctx_t.
1447 GpgmeData                       DEPRECATED: Use gpgme_data_t.
1448 GpgmeError                      DEPRECATED: Use gpgme_error_t.
1449 GpgmeDataEncoding               DEPRECATED: Use gpgme_data_encoding_t.
1450 GpgmeSigStat                    DEPRECATED: Use gpgme_sig_stat_t.
1451 GpgmeSigMode                    DEPRECATED: Use gpgme_sig_mode_t.
1452 GpgmeAttr                       DEPRECATED: Use gpgme_attr_t.
1453 GpgmeValidity                   DEPRECATED: Use gpgme_validity_t.
1454 GpgmeProtocol                   DEPRECATED: Use gpgme_protocol_t.
1455 GpgmeKey                        DEPRECATED: Use gpgme_key_t.
1456 GpgmePassphraseCb               DEPRECATED: Use gpgme_passphrase_cb_t.
1457 GpgmeProgressCb                 DEPRECATED: Use gpgme_progress_cb_t.
1458 GpgmeIOCb                       DEPRECATED: Use gpgme_io_cb_t.
1459 GpgmeRegisterIOCb               DEPRECATED: Use gpgme_register_io_cb_t.
1460 GpgmeRemoveIOCb                 DEPRECATED: Use gpgme_remove_io_cb_t.
1461 GpgmeEventIO                    DEPRECATED: Use gpgme_event_io_t.
1462 GpgmeEventIOCb                  DEPRECATED: Use gpgme_event_io_cb_t.
1463 GpgmeIOCbs                      DEPRECATED: Use gpgme_io_cbs.
1464 GpgmeDataReadCb                 DEPRECATED: Use gpgme_data_read_cb_t.
1465 GpgmeDataWriteCb                DEPRECATED: Use gpgme_data_write_cb_t.
1466 GpgmeDataSeekCb                 DEPRECATED: Use gpgme_data_seek_cb_t.
1467 GpgmeDataReleaseCb              DEPRECATED: Use gpgme_data_release_cb_t.
1468 GpgmeDataCbs                    DEPRECATED: Use gpgme_data_cbs_t.
1469 GpgmeTrustItem                  DEPRECATED: Use gpgme_trust_item_t.
1470 GpgmeStatusCode                 DEPRECATED: Use gpgme_status_code_t.
1471 gpgme_ctx_t                     NEW
1472 gpgme_data_t                    NEW
1473 gpgme_recipients_t              NEW
1474 gpgme_error_t                   NEW
1475 gpgme_data_encoding_t           NEW
1476 gpgme_sig_stat_t                NEW
1477 gpgme_sig_mode_t                NEW
1478 gpgme_attr_t                    NEW
1479 gpgme_validity_t                NEW
1480 gpgme_protocol_t                NEW
1481 gpgme_key_t                     NEW
1482 gpgme_passphrase_cb_t           NEW
1483 gpgme_progress_cb_t             NEW
1484 gpgme_io_cb_t                   NEW
1485 gpgme_register_io_cb_t          NEW
1486 gpgme_remove_io_cb_t            NEW
1487 gpgme_event_io_t                NEW
1488 gpgme_event_io_cb_t             NEW
1489 gpgme_io_cbs                    NEW
1490 gpgme_data_read_cb_t            NEW
1491 gpgme_data_write_cb_t           NEW
1492 gpgme_data_seek_cb_t            NEW
1493 gpgme_data_release_cb_t         NEW
1494 gpgme_data_cbs_t                NEW
1495 gpgme_trust_item_t              NEW
1496 gpgme_status_code_t             NEW
1497 GPGME_{some error code}         REMOVED! Use GPG_ERR_* from libgpg-error.
1498 gpgme_err_code_t                NEW
1499 gpgme_err_source_t              NEW
1500 gpgme_err_code                  NEW
1501 gpgme_err_source                NEW
1502 gpgme_error                     NEW
1503 gpgme_err_make                  NEW
1504 gpgme_error_from_errno          NEW
1505 gpgme_err_make_from_errno       NEW
1506 gpgme_err_code_from_errno       NEW
1507 gpgme_err_code_to_errno         NEW
1508 gpgme_strsource                 NEW
1509 gpgme_io_cb_t                   CHANGED: Return type from void to GpgmeError.
1510 gpgme_event_io_t                CHANGED: New event type (all numbers changed).
1511 gpgme_passphrase_cb_t           CHANGED: Desc decomposed, write directly to FD.
1512 gpgme_edit_cb_t                 CHANGED: Write directly to FD.
1513 gpgme_key_get_string_attr       CHANGED: Don't handle GPGME_ATTR_IS_SECRET.
1514 gpgme_op_verify                 CHANGED: Drop R_STAT argument.
1515 gpgme_op_decrypt_verify         CHANGED: Drop R_STAT argument.
1516 gpgme_wait                      CHANGED: Can return NULL even if hang is true.
1517 GpgmeIdleFunc                   REMOVED
1518 gpgme_register_idle             REMOVED
1519 GpgmeRecipients                 REMOVED
1520 gpgme_recipients_new            REMOVED
1521 gpgme_recipients_release        REMOVED
1522 gpgme_recipients_add_name       REMOVED
1523 gpgme_recipients_add_name_with_validity REMOVED
1524 gpgme_recipients_count          REMOVED
1525 gpgme_recipients_enum_open      REMOVED
1526 gpgme_recipients_enum_read      REMOVED
1527 gpgme_recipients_enum_close     REMOVED
1528 gpgme_encrypt_flags_t           NEW
1529 GPGME_ENCRYPT_ALWAYS_TRUST      NEW
1530 gpgme_op_encrypt                CHANGED: Recipients passed as gpgme_key_t[].
1531 gpgme_op_encrypt_start          CHANGED: Recipients passed as gpgme_key_t[].
1532 gpgme_op_encrypt_sign           CHANGED: Recipients passed as gpgme_key_t[].
1533 gpgme_op_encrypt_sign_start     CHANGED: Recipients passed as gpgme_key_t[].
1534 gpgme_op_export_start           CHANGED: User IDs passed as patterns.
1535 gpgme_op_export                 CHANGED: User IDs passed as patterns.
1536 gpgme_op_export_ext_start       NEW
1537 gpgme_op_export_ext             NEW
1538 gpgme_keylist_mode_t            NEW
1539 gpgme_sigsum_t                  NEW
1540 gpgme_engine_info_t             NEW
1541 gpgme_get_engine_info           CHANGED: Return info structure instead XML.
1542 gpgme_get_protocol_name         NEW
1543 gpgme_cancel                    REMOVED: Return error in callback directly.
1544 gpgme_op_genkey                 CHANGED: FPR argument dropped.
1545 gpgme_op_genkey_result          NEW
1546 gpgme_genkey_result_t           NEW
1547 gpgme_op_import_ext             DEPRECATED: Use gpgme_op_import_result.
1548 gpgme_op_import_result          NEW
1549 gpgme_import_status_t           NEW
1550 gpgme_import_result_t           NEW
1551 gpgme_pubkey_algo_t             NEW
1552 gpgme_hash_algo_t               NEW
1553 gpgme_invalid_key_t             NEW
1554 gpgme_new_signature_t           NEW
1555 gpgme_sign_result_t             NEW
1556 gpgme_op_sign_result            NEW
1557 gpgme_pubkey_algo_name          NEW
1558 gpgme_hash_algo_name            NEW
1559 gpgme_encrypt_result_t          NEW
1560 gpgme_op_encrypt_result         NEW
1561 gpgme_decrypt_result_t          NEW
1562 gpgme_op_decrypt_result         NEW
1563 gpgme_verify_result_t           NEW
1564 gpgme_op_verify_result          NEW
1565 gpgme_get_notation              REMOVED: Access verify result directly instead.
1566 gpgme_get_sig_key               DEPRECATED: Use gpgme_get_key with fingerprint.
1567 gpgme_get_sig_ulong_attr        DEPRECATED: Use verify result directly.
1568 gpgme_get_sig_string_attr       DEPRECATED: Use verify result directly.
1569 GPGME_SIG_STAT_*                DEPRECATED: Use error value in sig status.
1570 gpgme_get_sig_status            DEPRECATED: Use verify result directly.
1571 gpgme_trust_item_t              CHANGED: Now has user accessible data members.
1572 gpgme_trust_item_ref            NEW
1573 gpgme_trust_item_unref          NEW
1574 gpgme_trust_item_release        DEPRECATED: Use gpgme_trust_item_unref.
1575 gpgme_trust_item_get_string_attr DEPRECATED
1576 gpgme_trust_item_get_ulong_attr DEPRECATED
1577 gpgme_get_key                   CHANGED: Removed force_update argument.
1578 gpgme_subkey_t                  NEW
1579 gpgme_key_sig_t                 NEW
1580 gpgme_user_id_t                 NEW
1581 gpgme_key_t                     CHANGED: Now has user accessible data members.
1582 gpgme_key_get_string_attr       DEPRECATED
1583 gpgme_key_get_ulong_attr        DEPRECATED
1584 gpgme_key_sig_get_string_attr   DEPRECATED
1585 gpgme_key_sig_get_ulong_attr    DEPRECATED
1586 gpgme_key_get_as_xml            REMOVED
1587 gpgme_key_list_result_t         NEW
1588 gpgme_op_keylist_result         NEW
1589 gpgme_get_op_info               REMOVED
1590 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1591
1592 Noteworthy changes in version 0.4.0 (2002-12-23)
1593 ------------------------------------------------
1594
1595  * Key generation returns the fingerprint of the generated key.
1596
1597  * New convenience function gpgme_get_key.
1598
1599  * Supports signatures of user IDs in keys via the new
1600    GPGME_KEYLIST_MODE_SIGS keylist mode and the
1601    gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
1602    interfaces.  The XML info about a key also includes the signatures
1603    if available.
1604
1605  * New data object interface, which is more flexible and transparent.
1606
1607  * Interface changes relative to the 0.3.9 release:
1608 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1609 GpgmeDataReadCb                 NEW
1610 GpgmeDataWriteCb                NEW
1611 GpgmeDataSeekCb                 NEW
1612 GpgmeDataReleaseCb              NEW
1613 GpgmeDataCbs                    NEW
1614 gpgme_data_read                 CHANGED: Match read() closely.
1615 gpgme_data_write                CHANGED: Match write() closely.
1616 gpgme_data_seek                 NEW
1617 gpgme_data_new_from_fd          NEW
1618 gpgme_data_new_from_stream      NEW
1619 gpgme_data_new_from_cbs         NEW
1620 gpgme_data_rewind               DEPRECATED: Replaced by gpgme_data_seek().
1621 gpgme_data_new_from_read_cb     DEPRECATED: Replaced by gpgme_data_from_cbs().
1622 gpgme_data_get_type             REMOVED: No replacement.
1623 gpgme_op_verify                 CHANGED: Take different data objects for
1624                                 signed text and plain text.
1625 gpgme_op_verify_start           CHANGED: See gpgme_op_verify.
1626 gpgme_check_engine              REMOVED: Deprecated since 0.3.0.
1627 gpgme_op_genkey                 CHANGED: New parameter FPR.
1628 GPGME_KEYLIST_MODE_SIGS         NEW
1629 gpgme_key_sig_get_string_attr   NEW
1630 gpgme_key_sig_get_ulong_attr    NEW
1631 gpgme_get_key                   NEW
1632 GPGME_ATTR_SIG_CLASS            NEW
1633 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1634
1635 Noteworthy changes in version 0.3.16 (2003-11-19)
1636 -------------------------------------------------
1637
1638  * Compatibility fixes for GnuPG 1.9.x
1639
1640 Noteworthy changes in version 0.3.15 (2003-02-18)
1641 -------------------------------------------------
1642
1643  * The progress status is sent via the progress callbacks in
1644    gpgme_op_edit.
1645
1646  * Bug fix for signing operations with explicit signer settings for
1647    the CMS protocol.
1648
1649 Noteworthy changes in version 0.3.14 (2002-12-04)
1650 -------------------------------------------------
1651
1652  * GPGME-Plug is now in its own package "cryptplug".
1653
1654  * Workaround for a setlocale problem.  Fixed a segv related to not
1655    correctly as closed marked file descriptors.
1656
1657 Noteworthy changes in version 0.3.13 (2002-11-20)
1658 -------------------------------------------------
1659
1660  * Release due to changes in gpgmeplug.
1661
1662 Noteworthy changes in version 0.3.12 (2002-10-15)
1663 -------------------------------------------------
1664
1665  * Fixed some bux with key listings.
1666
1667  * The development has been branched to clean up some API issues.
1668    This 0.3 series will be kept for compatibility reasons; so do don't
1669    expect new features.
1670
1671 Noteworthy changes in version 0.3.11 (2002-09-20)
1672 -------------------------------------------------
1673
1674  * Bug fixes.
1675
1676 Noteworthy changes in version 0.3.10 (2002-09-02)
1677 -------------------------------------------------
1678
1679  * Setting the signing keys for the CMS protocol does now work.
1680
1681  * The signers setting is honoured by gpgme_op_edit.
1682
1683 Noteworthy changes in version 0.3.9 (2002-08-21)
1684 ------------------------------------------------
1685
1686  * A spec file for creating RPMs has been added.
1687
1688  * An experimental interface to GnuPG's --edit-key functionality is
1689    introduced, see gpgme_op_edit.
1690
1691  * The new gpgme_import_ext function provides a convenient access to
1692    the number of processed keys.
1693
1694  * Interface changes relative to the 0.3.8 release:
1695 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1696 GpgmeStatusCode                 NEW
1697 GpgmeEditCb                     NEW
1698 gpgme_op_edit_start             NEW
1699 gpgme_op_edit                   NEW
1700 gpgme_op_import_ext             NEW
1701 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1702
1703 Noteworthy changes in version 0.3.8 (2002-06-25)
1704 ------------------------------------------------
1705
1706  * It is possible to use an outside event loop for the I/O to the
1707    crypto engine by setting the I/O callbacks with gpgme_set_io_cbs.
1708
1709  * Interface changes relative to the 0.3.6 release:
1710 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1711 GpgmeIOCb                       NEW
1712 GpgmeRegisterIOCb               NEW
1713 GpgmeRemoveIOCb                 NEW
1714 GpgmeEventIO                    NEW
1715 GpgmeEventIOCb                  NEW
1716 struct GpgmeIOCbs               NEW
1717 gpgme_set_io_cbs                NEW
1718 gpgme_get_io_cbs                NEW
1719 GPGME_ATTR_ERRTOK               NEW
1720 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1721
1722 Noteworthy changes in version 0.3.7 (2002-06-04)
1723 ------------------------------------------------
1724
1725  * GPGME_ATTR_OTRUST is implemented now.
1726
1727  * A first step toward thread safeness has been achieved, see the
1728    documentation for details.  Supported thread libraries are pthread
1729    and Pth.
1730
1731 Noteworthy changes in version 0.3.6 (2002-05-03)
1732 ------------------------------------------------
1733
1734  * All error output of the gpgsm backend is send to the bit bucket.
1735
1736  * The signature verification functions are extended.  Instead of
1737    always returning GPGME_SIG_STATUS_GOOD, the functions new codes for
1738    expired signatures.  2 new functions may be used to retrieve more
1739    detailed information like the signature expiration time and a
1740    validity information of the key without an extra key looking.
1741
1742  * The current passphrase callback and progress meter callback can be
1743    retrieved with the new functions gpgme_get_passphrase_cb and
1744    gpgme_get_progress_cb respectively.
1745
1746  * Interface changes relative to the 0.3.5 release:
1747 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1748 gpgme_get_passphrase_cb         NEW
1749 gpgme_get_progress_cb           NEW
1750 GpgmeDataEncoding               NEW
1751 gpgme_data_set_encoding         NEW
1752 gpgme_data_get_encoding         NEW
1753 GPGME_SIG_STAT_GOOD_EXP         NEW
1754 GPGME_SIG_STAT_GOOD_EXPKEY      NEW
1755 gpgme_op_verify                 CHANGED: Returns more status codes.
1756 GPGME_ATTR_SIG_STATUS           NEW
1757 gpgme_get_sig_string_attr       NEW
1758 gpgme_get_sig_ulong_attr        NEW
1759 gpgme_get_protocol              NEW
1760 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1761
1762 Noteworthy changes in version 0.3.5 (2002-04-01)
1763 ------------------------------------------------
1764
1765  * gpgme_op_encrypt can be called with RECIPIENTS being 0.  In this
1766    case, symmetric encryption is performed.  Note that this requires a
1767    passphrase from the user.
1768
1769  * More information is returned for X.509 certificates.
1770
1771  * Interface changes relative to the 0.3.4 release:
1772 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1773 gpgme_op_encrypt                EXTENDED: Symmetric encryption possible
1774 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1775
1776 Noteworthy changes in version 0.3.4 (2002-03-04)
1777 ------------------------------------------------
1778
1779  * gpgme_op_encrypt does now fail with GPGME_Invalid_Recipients if
1780    some recipients have been invalid, whereas earlier versions
1781    succeeded in this case.  The plaintext is still encrypted for all valid
1782    recipients, so the application might take this error as a hint that
1783    the ciphertext is not usable for all requested recipients.
1784    Information about invalid recipients is available with gpgme_get_op_info.
1785
1786  * gpgme_op_verify now allows to pass an uninitialized data object as
1787    its plaintext argument to check for normal and cleartext
1788    signatures.  The plaintext is then returned in the data object.
1789
1790  * New interfaces gpgme_set_include_certs and gpgme_get_include_certs
1791    to set and get the number of certifications to include in S/MIME
1792    signed messages.
1793
1794  * New interfaces gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start
1795    to encrypt and sign a message in a combined operation.
1796
1797  * New interface gpgme_op_keylist_ext_start to search for multiple patterns.
1798
1799  * gpgme_key_get_ulong_attr supports the GPGME_ATTR_EXPIRE attribute.
1800
1801  * Interface changes relative to the 0.3.3 release:
1802 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1803 gpgme_op_encrypt                CHANGED: Can fail with GPGME_Invalid_Recipients
1804 gpgme_op_verify                 EXTENDED: Accepts uninitialized text argument
1805 gpgme_key_get_ulong_attr        EXTENDED: Supports GPGME_ATTR_EXPIRE
1806 gpgme_set_include_certs         NEW
1807 gpgme_get_include_certs         NEW
1808 gpgme_op_encrypt_sign           NEW
1809 gpgme_op_encrypt_sign_start     NEW
1810 gpgme_op_keylist_ext_start      NEW
1811 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1812
1813 Noteworthy changes in version 0.3.3 (2002-02-12)
1814 ------------------------------------------------
1815
1816  * Fix the Makefile in jnlib.
1817
1818  * Fix the test suite (hopefully).  It should clean up all its state
1819    with `make check' now.
1820
1821
1822 Noteworthy changes in version 0.3.2 (2002-02-10)
1823 ------------------------------------------------
1824
1825  * Remove erroneous dependency on libgcrypt in jnlib.
1826
1827
1828 Noteworthy changes in version 0.3.1 (2002-02-09)
1829 ------------------------------------------------
1830
1831  * There is a Texinfo manual documenting the API.
1832
1833  * The gpgme_set_keylist_mode function returns an error, and changed
1834    its meaning.  It is no longer usable to select between normal and
1835    fast mode (newer versions of GnuPG will always be fast), but
1836    selects between local keyring, remote keyserver, or both.
1837    For this, two new macros are defined, GPGME_KEYLIST_MODE_LOCAL
1838    and GPGME_KEYLIST_MODE_EXTERN.  To make it possible to modify the
1839    current setting, a fucntion gpgme_get_keylist_mode was added to
1840    retrieve the current mode.
1841
1842  * gpgme_wait accepts a new argument STATUS to return the error status
1843    of the operation on the context.  Its definition is closer to
1844    waitpid() now than before.
1845
1846  * The LENGTH argument to gpgme_data_new_from_filepart changed its
1847    type from off_t to the unsigned size_t.
1848
1849  * The R_HD argument to the GpgmePassphraseCb type changed its type
1850    from void* to void**.
1851
1852  * New interface gpgme_op_trustlist_end() to match
1853    gpgme_op_keylist_end().
1854
1855  * The CryptPlug modules have been renamed to gpgme-openpgp and
1856    gpgme-smime, and they are installed in pkglibdir by `make install'.
1857
1858  * An idle function can be registered with gpgme_register_idle().
1859
1860  * The GpgSM backend supports key generation with gpgme_op_genkey().
1861
1862  * Interface changes relative to the 0.3.0 release:
1863 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1864 gpgme_data_new_from_filepart    CHANGED: Type of LENGTH is size_t.
1865 GpgmePassphraseCb               CHANGED: Type of R_HD is void **.
1866 gpgme_wait                      CHANGED: New argument STATUS.
1867 gpgme_set_keylist_mode          CHANGED: Type of return value is GpgmeError.
1868                                 The function has a new meaning!
1869 gpgme_get_keylist_mode          NEW
1870 GPGME_KEYLIST_MODE_LOCAL        NEW
1871 GPGME_KEYLIST_MODE_EXTERN       NEW
1872 gpgme_op_trustlist_next         NEW
1873 GpgmeIdleFunc                   NEW
1874 gpgme_register_idle             NEW
1875 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1876
1877 Noteworthy changes in version 0.3.0 (2001-12-19)
1878 ------------------------------------------------
1879
1880  * New interface gpgme_set_protocol() to set the protocol and thus the
1881    crypto engine to be used by the context.  Currently, the OpenPGP
1882    and the CMS protocols are supported.  They are specified by the new
1883    preprocessor symbols GPGME_PROTOCOL_OpenPGP and GPGME_PROTOCOL_CMS.
1884    A new context uses the OpenPGP engine by default.
1885
1886  * gpgme_get_engine_info() returns information for all crypto engines
1887    compiled into the library.  The XML format has changed.  To
1888    reliably get the version of a crypto engine, the <version> tag
1889    after the appropriate <protocol> tag has to be looked for.
1890
1891  * New interface gpgme_engine_check_version(), obsoleting
1892    gpgme_check_engine().  Check the version of all engines you are
1893    supporting in your software.
1894
1895  * GpgmeKey lists the user ids in the order as they are returned by
1896    GnuPG, first the primary key with index 0, then the sub-user ids.
1897
1898  * New operation gpgme_op_decrypt_verify() to decrypt and verify
1899    signatures simultaneously.
1900
1901  * The new interface gpgme_op_keylist_end() terminates a pending
1902    keylist operation.  A keylist operation is also terminated when
1903    gpgme_op_keylist_next() returns GPGME_EOF.
1904
1905  * GPGME can be compiled without GnuPG being installed (`--with-gpg=PATH'),
1906    cross-compiled, or even compiled without support for GnuPG
1907    (`--without-gpg').
1908
1909  * GPGME can be compiled with support for GpgSM (GnuPG for S/MIME,
1910    `--with-gpgsm=PATH').  It is enabled by default if the `gpgsm' is found
1911    in the path, but it can also be compiled without support for GpgSM
1912    (`--without-gpgsm').
1913
1914  * CryptPlug modules for GPGME are included and can be enabled at
1915    configure time (`--enable-gpgmeplug').  There is one module which
1916    uses the GnuPG engine (`gpgmeplug') and one module which uses the
1917    GpgSM engine (`gpgsmplug').
1918
1919  * Interface changes relative to the latest 0.2.x release:
1920 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1921 gpgme_key_get_as_xml            CHANGED: Sub-user ids reversed in order.
1922 gpgme_key_get_string_attr       CHANGED: User ids reversed in order.
1923 gpgme_key_get_ulong_attr        CHANGED: User ids reversed in order.
1924 gpgme_get_engine_info           CHANGED: New format, extended content.
1925 gpgme_engine_check_version      NEW
1926 gpgme_decrypt_verify_start      NEW
1927 gpgme_decrypt_verify            NEW
1928 gpgme_op_keylist_next           NEW
1929 gpgme_set_protocol              NEW
1930 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1931
1932
1933 Noteworthy changes in version 0.2.3 (2001-09-17)
1934 ------------------------------------------------
1935
1936  * New function gpgme_get_op_info which can be used to get the micalg
1937    parameter needed for MOSS.
1938
1939  * New functions gpgme_get_armor and gpgme_get_textmode.
1940
1941  * The usual bug fixes and some minor functionality improvements.
1942
1943  * Added a simple encryption component for MS-Windows; however the
1944    build procedure might have some problems.
1945
1946
1947 Noteworthy changes in version 0.2.2 (2001-06-12)
1948 ------------------------------------------------
1949
1950  * Implemented a key cache.
1951
1952  * Fixed a race condition under W32 and some other bug fixes.
1953
1954
1955 Noteworthy changes in version 0.2.1 (2001-04-02)
1956 ------------------------------------------------
1957
1958  * Changed debug output and GPGME_DEBUG variable (gpgme/debug.c)
1959
1960  * Handle GnuPG's new key capabilities output and support revocation
1961    et al. attributes
1962
1963  * Made the W32 support more robust.
1964
1965
1966  Copyright 2001, 2002, 2003, 2004, 2005, 2007, 2008, 2009,
1967            2010 g10 Code GmbH
1968
1969  This file is free software; as a special exception the author gives
1970  unlimited permission to copy and/or distribute it, with or without
1971  modifications, as long as this notice is preserved.
1972
1973  This file is distributed in the hope that it will be useful, but
1974  WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
1975  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.