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