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