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