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