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