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