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