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