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