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