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