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