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