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