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