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