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