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