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