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