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