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