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