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