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