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