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