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