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