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