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