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