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