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