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