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