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