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