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