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