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