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