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