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