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