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