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