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