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