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