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