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