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