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