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