d9f736693e83a46d34a9732aa8adb00ed6f9a538
[gpgme.git] / NEWS
1 Noteworthy changes in version 1.3.1 (2011-06-16)
2 ------------------------------------------------
3
4  * Ported to Windows CE.
5
6  * Detect GPG versions not supporting ---passwd.
7
8  * Interface changes relative to the 1.3.0 release:
9  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10  GPGME_EXPORT_MODE_MINIMAL      NEW
11  GPGME_STATUS_SUCCESS           NEW
12  gpgme_err_code_from_syserror   NEW
13  gpgme_err_set_errno            NEW
14  gpgme_error_from_errno         CHANGED: Return gpgme_error_t (compatible type).
15  gpgme_error_from_syserror      NEW
16  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17
18
19 Noteworthy changes in version 1.3.0 (2010-01-11)
20 ------------------------------------------------
21
22  * GPGME does not come with an internal libassuan version anymore.
23    The external libassuan 1.1.0 release or later is required.  For
24    application programmers on systems that can resolve inter-library
25    dependencies at runtime, this is a transparent change.
26
27  * New engine GPGME_PROTOCOL_G13 to support the new g13 tool.
28
29  * New engine GPGME_PROTOCOL_UISERVER to support UI Servers.
30
31  * New API to change the passphrase of a key.
32
33  * Interface changes relative to the 1.2.0 release:
34  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35  GPGME_STATUS_INV_SGNR    NEW.
36  GPGME_STATUS_NO_SGNR     NEW.
37  GPGME_PROTOCOL_G13       NEW.
38  gpgme_op_g13_mount       NEW.
39  gpgme_g13_result_t       NEW.
40  GPGME_PK_ECDSA           NEW.
41  GPGME_PK_ECDH            NEW.
42  gpgme_op_passwd_start    NEW.
43  gpgme_op_passwd          NEW.
44  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
45
46
47 Noteworthy changes in version 1.2.0 (2009-06-18)
48 ------------------------------------------------
49
50  * New encryption flag GPGME_ENCRYPT_NO_ENCRYPT_TO to disable default
51    recipients.
52
53  * gpgme_new will fail if gpgme_check_version was not called, or a
54    selftest failed (for example, if -mms-bitfields was not used on
55    MingW32 targets).
56
57  * New functions gpgme_io_read and gpgme_io_write for use with
58    gpgme_passphrase_cb_t and gpgme_edit_cb_t functions.
59
60  * New functions gpgme_result_ref and gpgme_result_unref to detach
61    result structures from a context.
62
63  * New functions gpgme_op_export_keys_start and gpgme_op_export_keys
64    that allow to specify exported keys through gpgme_key_t objects
65    instead of patterns.
66
67  * New mode of operation gpgme_export_mode_t that allows exporting
68    external keys.
69
70  * Interface changes relative to the 1.1.7 release:
71  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
72  GPGME_KEYLIST_MODE_EPHEMERAL   NEW.
73  GPGME_PROTOCOL_ASSUAN          NEW.
74  gpgme_assuan_data_cb_t         NEW.
75  gpgme_assuan_inquire_cb_t      NEW.
76  gpgme_assuan_status_cb_t       NEW.
77  gpgme_op_assuan_transact_start NEW.
78  gpgme_op_assuan_transact       NEW.
79  gpgme_op_assuan_result         NEW.
80  gpgme_op_import_keys           NEW.
81  gpgme_op_import_keys_start     NEW.
82  gpgme_subkey_t                 EXTENDED: New fields is_cardkey, card_number.
83  GPGME_ENCRYPT_NO_ENCRYPT_TO    NEW.
84  gpgme_check_version            CHANGED: Is now a macro.
85  gpgme_new                      EXTENDED: More failure codes.
86  gpgme_io_read                  NEW.
87  gpgme_io_write                 NEW.
88  gpgme_result_ref               NEW.
89  gpgme_result_unref             NEW.
90  gpgme_export_mode_t            NEW.
91  gpgme_export_ext_start         EXTENDED: Arg RESERVED is now a MODE flag.
92  gpgme_op_export                EXTENDED: Arg RESERVED is now a MODE flag.
93  gpgme_op_export_ext_start      EXTENDED: Arg RESERVED is now a MODE flag.
94  gpgme_op_export_ext            EXTENDED: Arg RESERVED is now a MODE flag.
95  gpgme_op_export_keys_start     NEW.
96  gpgme_op_export_keys           NEW.
97  GPGME_DATA_ENCODING_URL        NEW.
98  GPGME_DATA_ENCODING_URL0       NEW.
99  GPGME_DATA_ENCODING_URLESC     NEW.
100  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
101
102
103 Noteworthy changes in version 1.1.8 (2008-12-08)
104 ------------------------------------------------
105
106  * SIGPIPE is now again ignored as described in the manual.  Fixes
107    regresion introduced with 1.1.6.
108
109
110 Noteworthy changes in version 1.1.7 (2008-10-17)
111 ------------------------------------------------
112
113  * Using GPGME_KEYLIST_MODE_LOCAL combined with
114    GPGME_KEYLIST_MODE_EXTERN is now supported; it uses the
115    --locate-keys feature of gpg (>= 2.0.10).
116    
117  * The encoding of gpgme_data_t objects can affect the output encoding
118    of export, sign and encrypt operations now (the same operations
119    that are also affected by the ASCII mode switch).  We believe this
120    change in the ABI is innocent enough not to break existing
121    applications (it only affects the S/MIME backend on certain
122    operations).
123
124  * The reference manual now includes the specification of "The GnuPG
125    UI Server protocol".
126
127  * A new function gpgme_cancel_async can be used to asynchronously
128    cancel any pending operation at any time, from any thread.
129
130  * Interface changes relative to the 1.1.6 release:
131  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
132 gpgme_op_encrypt                CHANGED: Output encoding can affect result.
133 gpgme_op_encrypt_start          CHANGED: Output encoding can affect result.
134 gpgme_op_encrypt_sign           CHANGED: Output encoding can affect result.
135 gpgme_op_encrypt_sign_start     CHANGED: Output encoding can affect result.
136 gpgme_op_sign                   CHANGED: Output encoding can affect result.
137 gpgme_op_sign_start             CHANGED: Output encoding can affect result.
138 gpgme_op_export                 CHANGED: Output encoding can affect result.
139 gpgme_op_export_start           CHANGED: Output encoding can affect result.
140 gpgme_op_export_ext             CHANGED: Output encoding can affect result.
141 gpgme_op_export_ext_start       CHANGED: Output encoding can affect result.
142 gpgme_cancel_async              NEW
143  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
144
145
146 Noteworthy changes in version 1.1.6 (2008-01-04)
147 ------------------------------------------------
148
149  * Bug fixes for for W32.
150
151  * A new, experimental (and thus undocumented and potentially
152    unstable) interface for accessing gpg-conf through GPGME has been
153    added.
154
155  * Interface changes relative to the 1.1.1 release:
156  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
157  gpgme_signature_t               EXTENDED: New field chain_model.
158  gpgme_op_getauditlog_start      NEW.
159  gpgme_op_getauditlog            NEW.
160  GPGME_AUDITLOG_HTML             NEW.
161  GPGME_AUDITLOG_WITH_HELP        NEW.
162  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
163
164
165 Noteworthy changes in version 1.1.5 (2007-07-09)
166 ------------------------------------------------
167
168  * Bug and portability fixes (mainly for W32).
169
170
171 Noteworthy changes in version 1.1.4 (2007-03-05)
172 ------------------------------------------------
173
174  * Detect and bail out on double plaintext messages.  This is required
175    so that applications can properly detect the signed parts of a
176    message.  Actual there is now a double protection as GnuPG 1.4.7
177    will detect this case too.
178
179
180 Noteworthy changes in version 1.1.3 (2007-01-29)
181 ------------------------------------------------
182
183  * Fixed a memory leak in gpgme_data_release_and_get_mem.
184
185  * Fixed a bug in Windows command line quoting.
186
187
188 Noteworthy changes in version 1.1.2 (2006-03-02)
189 ------------------------------------------------
190
191  * Fixed a bug in the W32 glib backend.
192
193
194 Noteworthy changes in version 1.1.1 (2006-02-23)
195 ------------------------------------------------
196
197  * Fixed a bug in that the fingerprints of subkeys are not available.
198
199  * Clarified usage of the SECRET flag in key listings.  It is now
200    reset for stub keys.
201
202  * Reading signature notations and policy URLs on key signatures is
203    supported.  They can be found in the new field notations of the
204    gpgme_key_sig_t structure.  This has to be enabled with the keylist
205    mode flag GPGME_KEYLIST_MODE_SIG_NOTATIONS.
206
207  * A new gpgme_free() function solves the problem of using different
208    allocators in a single program.  This function should now be used
209    instead calling free() to release the buffer returned by
210    gpgme_data_release_and_get_mem.  It is recommended that you always
211    do this, but it is only necessary on certain platforms, so backwards
212    compatibility is provided.  In other words: If free() worked for
213    you before, it will keep working.
214
215  * New status codes GPGME_PKA_TRUST_GOOD and GPGME_PKA_TRUST_BAD.
216    They are analyzed by the verify handlers and made available in the
217    new PKA_TRUST and PKA_ADDRESS fields of the signature result structure.
218
219  * Interface changes relative to the 1.1.0 release:
220 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221 gpgme_key_sig_t                 EXTENDED: New field notations.
222 GPGME_KEYLIST_MODE_SIG_NOTATIONS NEW
223 gpgme_free                      NEW
224 GPGME_STATUS_PKA_TRUST_BAD      NEW
225 GPGME_STATUS_PKA_TRUST_GOOD     NEW
226 gpgme_signature_t               EXTENDED: New field pka_trust.
227 gpgme_signature_t               EXTENDED: New field pka_address.
228 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
229
230
231 Noteworthy changes in version 1.1.0 (2005-10-01)
232 ------------------------------------------------
233
234  * You can now configure the backend engine file name and home
235    directory to be used, as default and per context.
236
237  * Information about the recipients of an encrypted text is now
238    available at decryption time.
239
240  * New status GPGME_STATUS_PLAINTEXT.  This is analyzed by the decrypt
241    and verify handlers, the information about the plaintext filename,
242    if available is made available in the new field file_name of the
243    respective result structure.
244
245  * The code for "automagically detecting the thread library" has been
246    removed from libgpgme.  It is deprecated since version 0.4.3.
247    Since then, you had to link against libgpgme-pthread for
248    applications using pthread and libgpgme-pth for applications using
249    GNU Pth.
250
251    The code was removed because it caused compilation problems on
252    systems where the pthread.h header from GNU Pth is available in
253    addition to the system header (FreeBSD 6 and later for example).
254
255  * "./autogen.sh --build-w32" does now build gpgme.dll.
256
257  * [W32] The environment variable GPGME_DEBUG now uses a semicolon as
258    delimiter.  The standard install directory is used when locating
259    gpg or gpgsm before finally falling back to the hardwired name.
260
261  * There is a new flag for keys and subkeys, is_qualified, which
262    indicates if a key can be used for qualified signatures according
263    to local government regulations.
264
265  * You can associate a filename with a data object using the new
266    function gpgme_data_set_file_name().  This filename will be stored
267    in the output when encrypting or signing the data and will be
268    returned when decrypting or verifying the output data.
269
270  * You can now set notation data at signature creation with the new
271    function gpgme_sig_notation_add().
272
273  * Interface changes relative to the 1.0.3 release:
274 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
275 gpgme_set_engine_info           NEW
276 gpgme_ctx_get_engine_info       NEW
277 gpgme_ctx_set_engine_info       NEW
278 gpgme_recipient_t               NEW
279 gpgme_decrypt_result_t          EXTENDED: New field recipients.
280 gpgme_verify_result_t           EXTENDED: New fields pubkey_algo, hash_algo.
281 gpgme_decrypt_result_t          EXTENDED: New field plaintext_filename.
282 gpgme_verify_result_t           EXTENDED: New field plaintext_filename.
283 GPGME_STATUS_PLAINTEXT          NEW
284 gpgme_key_t                     EXTENDED: New field is_qualified.
285 gpgme_subkey_t                  EXTENDED: New field is_qualified.
286 gpgme_data_get_file_name        NEW
287 gpgme_data_set_file_name        NEW
288 gpgme_sig_notation_flags_t      NEW
289 GPGME_SIG_NOTATION_HUMAN_READABLE NEW
290 GPGME_SIG_NOTATAION_CRITICAL    NEW
291 gpgme_sig_notation_clear        NEW
292 gpgme_sig_notation_add          NEW
293 gpgme_sig_notation_get          NEW
294 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
295
296
297 Noteworthy changes in version 1.0.3 (2005-06-20)
298 ------------------------------------------------
299
300  * Previousy, GPGME would use a default "include certs" of 1.  This
301    has been changed.  Now GPGME will use the crypto backend engines
302    default unless you set the value with gpgme_set_include_certs()
303    explicitely.  A new macro GPGME_INCLUDE_CERTS_DEFAULT can be used
304    as a value to explicitely request the new default behaviour.
305
306    Because the default changes, this is a slight change of the API
307    semantics.  We consider it to be a bug fix.
308
309  * A bug which made GPGME hang has been fixed.  If you have
310    experienced hanging before, please try out this version and let me
311    know if you still experience hanging problems.
312
313  * Interface changes relative to the 0.9.0 release:
314 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
315 gpgme_set_include_certs         CHANGED DEFAULT
316 GPGME_INCLUDE_CERTS_DEFAULT     NEW
317 GPGME_STATUS_SIG_SUBPACKET      NEW
318 GPGME_STATUS_NEED_PASSPHRASE_PIN NEW
319 GPGME_STATUS_SC_OP_FAILURE      NEW
320 GPGME_STATUS_SC_OP_SUCCESS      NEW
321 GPGME_STATUS_CARDCTRL           NEW
322 GPGME_STATUS_BACKUP_KEY_CREATED NEW
323 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
324
325
326 Noteworthy changes in version 1.0.2 (2004-12-28)
327 ------------------------------------------------
328
329  * Changed the license of the library to the GNU Lesser General Public
330    License (LGPL), version 2.1 or later.
331
332
333 Noteworthy changes in version 1.0.1 (2004-10-22)
334 ------------------------------------------------
335
336  * Only bug fixes.
337
338
339 Noteworthy changes in version 1.0.0 (2004-09-30)
340 ------------------------------------------------
341
342  * Version 1.0.0!  We are proud to present you with a thoroughly
343    tested and stable version of the GPGME library.  A big Thank You!
344    to all the people who made this possible.
345
346    The development will be branched into a stable 1.x.y series and the
347    head.
348
349  * The gpgme.m4 macro supports checking the API version.  Just prepend
350    it to the required version string, separated by a colon.  For
351    example, this release has the version "1:1.0.0".  The last release
352    to which this version is (mostly) ABI compatible is "1:0.4.2",
353    which is the default required version.
354
355
356 Noteworthy changes in version 0.9.0 (2004-06-08)
357 ------------------------------------------------
358
359  * The type gpgme_key_t has now a new field keylist_mode that contains
360    the keylist mode that was active at the time the key was retrieved.
361
362  * The type gpgme_decrypt_result_t has a new field "wrong_key_usage"
363    that contains a flag indicating that the key should not have been
364    used for encryption.
365
366  * Verifying a signature of a revoked key gives the correct result now
367    (GPG_ERR_CERT_REVOKED error code).
368
369  * Clarified that the error code GPG_ERR_NO_DATA from the decrypt &
370    verify operations still allows you to look at the signature
371    verification result.
372
373  * Clarified that patterns in keylisting operations have an upper
374    limit, and thus are not suited to list many keys at once by their
375    fingerprint.  Also improve the error message if the pattern is too
376    long for the CMS protocol to handle.
377
378 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
379 gpgme_key_t                     EXTENDED: New field keylist_mode.
380 gpgme_decrypt_result_t          EXTENDED: New field wrong_key_usage.
381 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
382
383
384 Noteworthy changes in version 0.4.7 (2004-04-29)
385 ------------------------------------------------
386
387  * Correctly initialize the fields expired, revoked, invalid, and
388    disabled in the gpgme_key_t structures.
389
390  * A bug fix: The flag wrong_key_usage of gpgme_signature_t was
391    accidently of type int instead unsigned int.
392
393  * Interface changes relative to the 0.4.5 release:
394 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
395 gpgme_signature_t               CHANGED: wrong_key_usage is unsigned int now.
396 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
397
398 Noteworthy changes in version 0.4.6 (2004-04-06)
399 ------------------------------------------------
400
401  * Bug fixes
402
403
404 Noteworthy changes in version 0.4.5 (2004-03-07)
405 ------------------------------------------------
406
407  * GPGME is now compiled with LFS (large file support) by default.
408    This means that _all_ programs using GPGME must be compiled with
409    LFS support enabled by default.  You can do this easily with
410    autoconf, by using the AC_SYS_LARGEFILE macro.  Or you can do this
411    without autoconf by defining the preprocessor symbol
412    _FILE_OFFSET_BITS to 64 (by passing the -D_FILE_OFFSET_BITS=64 to
413    the C compiler command line, or by defining this preprocessor
414    symbol before including any system header files).  For more
415    details, read the section on LFS in the manual.
416
417    Up to now, it was undocumented that GPGME was not using LFS.
418    But the public interfaces use off_t, and file descriptors are
419    exchanged between the application and GPGME.  This was an oversight,
420    and bound to cause troubles in the future.
421
422    Writing GPGME as a dual mode library that seamlessly supports LFS
423    while keeping backwards compatibility is possible, but does not
424    solve the problem: Many applications already expect GPGME to have
425    LFS (they are compiled with off_t being a 64bit value).  This is true
426    in particular for the popular Gtk+ and Qt programs.
427
428    So, although this is an ABI (but not an API) break, we will not
429    change the library version to reflect that.  Because the interfaces
430    affected are probably not used yet in any GPGME 0.4 based
431    application, we don't expect any real failures from this change.
432    In fact, applications already using LFS will have some subtle bugs
433    fixed.
434
435    However, if you encounter an application using GPGME 0.4.x that
436    does _not_ use LFS by default (off_t is a 32bit value), _and_
437    uses at least one of the functions gpgme_data_seek,
438    gpgme_data_new_from_filepart, or a gpgme_data_seek_cb_t with
439    gpgme_data_new_from_cbs, then indeed this library will be ABI
440    incompatible with the program.  As said above, we don't believe
441    such a program exists.  If we are in error, then you have two
442    options: As a quick hack, you can configure GPGME with the
443    --disable-largefile option.  This will revert the change, and GPGME
444    will not use LFS.  However, GPGME will be incompatible with
445    programs that expect GPGME to use LFS.  All applications are
446    required to use LFS when using GPGME, so this is only good as a
447    temporary local work-around.
448
449    The other option is to change the versioning of the library and
450    recompile all applications.  We have reserved a special version of
451    the library for that, so you can do that without expecting a
452    version clash in the future.  Furthermore, everyone who does this
453    will agree on the version to use (this is important for
454    distribution makers).  Read the comment in configure.ac (before
455    LIBGPGME_LT_AGE) if you want to do this.  Please don't do this
456    blindly: As stated above, we think it is unlikely this measure is
457    needed.  Still, it is there if necessary.  If in doubt, contact us
458    and we will give our advise for your specific situation.
459
460  * New key listing mode GPGME_KEYLIST_MODE_VALIDATE for validation of
461    the listed keys.
462
463  * New interface gpgme_cancel() that can be used to cancel
464    asynchronous operations.
465
466  * Interface changes relative to the 0.4.4 release:
467 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
468 gpgme_data_seek_cb_t            CHANGED: off_t is now a largefile type.
469 gpgme_data_seek                 CHANGED: off_t is now a largefile type.
470 gpgme_data_new_from_filepart    CHANGED: off_t is now a largefile type.
471 GPGME_KEYLIST_MODE_VALIDATE     NEW
472 gpgme_cancel                    NEW
473 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
474
475 Noteworthy changes in version 0.4.4 (2004-01-12)
476 ------------------------------------------------
477
478  * The member "class" in gpgme_key_sig_t and gpgme_new_signature_t has
479    been renamed to "sig_class", to avoid clash with C++ compilers.  In
480    the C API, the old name "class" has been preserved for backwards
481    compatibility, but is deprecated.
482
483  * Interface changes relative to the 0.4.3 release:
484 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
485 gpgme_key_sig_t                 CHANGED: class deprecated, use new sig_class.
486 gpgme_new_signature_t           CHANGED: class deprecated, use new sig_class.
487 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
488
489 Noteworthy changes in version 0.4.3 (2003-10-06)
490 ------------------------------------------------
491
492  * libgpgme should not be used for threaded programs anymore.  This
493    never worked reliably in all cases, because you had to
494    be careful about the linking order and libtool wouldn't do that for
495    you automatically.  Instead, now you have to link against
496    libgpgme-pthread for applications using pthread and libgpgme-pth for
497    applications using GNU Pth.
498
499    The old code for automagically detecting the thread library is
500    still part of libgpgme, but it is DEPRECATED.
501
502  * There are new automake macros AM_PATH_GPGME_PTH and
503    AM_PATH_GPGME_PTHREAD, which support checking for thread-enabled
504    versions of GPGME.  They define GPGME_PTH_CFLAGS, GPGME_PTH_LIBS,
505    GPGME_PTHREAD_CFLAGS and GPGME_PTHREAD_LIBS respectively.  These
506    variables of course also include the configuration for the thread
507    package itself.  Alternatively, use libtool.
508
509  * gpgme_strerror_r as a thread safe variant of gpgme_strerror was
510    added.
511
512  * gpgme-config doesn't support setting the prefix or exec prefix
513    anymore.  I don't think it ever worked correctly, and it seems to
514    be pointless.
515
516  * gpgme_get_key fails with GPG_ERR_AMBIGUOUS_NAME if the key ID
517    provided was not unique, instead returning the first matching key.
518
519  * gpgme_key_t and gpgme_subkey_t have a new field, can_authenticate,
520    that indicates if the key can be used for authentication.
521
522  * gpgme_signature_t's status field is now correctly set to an error
523    with error code GPG_ERR_NO_PUBKEY if public key is not found.
524
525  * gpgme_new_signature_t's class field is now an unsigned int, rather
526    than an unsigned long (the old class field is preserved for
527    backwards compatibility).
528
529  * A new function gpgme_set_locale() is provided to allow configuring
530    the locale for the crypto backend.  This is necessary for text
531    terminals so that programs like the pinentry can be started with
532    the right locale settings for the terminal the application is running
533    on, in case the terminal has different settings than the system
534    default (for example, if it is a remote terminal).  You are highly
535    recommended to call the following functions directly after
536    gpgme_check_version:
537
538    #include <locale.h>
539
540    setlocale (LC_ALL, "");
541    gpgme_set_locale (NULL, LC_CTYPE, setlocale (LC_CTYPE, NULL));
542    gpgme_set_locale (NULL, LC_MESSAGES, setlocale (LC_MESSAGES, NULL));
543
544    GPGME can not do this for you, as setlocale is not thread safe, and
545    there is no alternative.
546
547  * The signal action for SIGPIPE is now set to SIG_IGN by
548    gpgme_check_version, instead the first time a crypto engine is
549    started (which is not well defined).
550
551  * In the output of gpgme_hash_algo_name, change RMD160 to RIPEMD160,
552    TIGER to TIGER192, CRC32-RFC1510 to CRC32RFC1510, and CRC24-RFC2440
553    to CRC24RFC2440.  For now, these strings can be used as the MIC
554    parameter for PGP/MIME (if appropriately modified).
555
556  * Interface changes relative to the 0.4.2 release:
557 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
558 gpgme_strerror_t                NEW
559 gpgme_get_key                   CHANGED: Fails correctly if key ID not unique.
560 gpgme_key_t                     EXTENDED: New field can_authenticate.
561 gpgme_subkey_t                  EXTENDED: New field can_authenticate.
562 gpgme_new_signature_t           CHANGED: New type for class field.
563 gpgme_set_locale                NEW
564 gpgme_hash_algo_name            CHANGED: Slight adjustment of algo names.
565 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
566
567 Noteworthy changes in version 0.4.2 (2003-07-30)
568 ------------------------------------------------
569
570  * Allow gpg-error to be in non-standard place when linking the test suite.
571
572  * Configure will fail now if gpg-error can not be found.
573
574  * Fixed initialized memory backed data objects for writing, which
575    caused the test program to crash (but only on Mac OS, surprisingly).
576
577  * Eliminate use of C99 constructs.
578
579  * Small improvements to the manual.
580
581
582 Noteworthy changes in version 0.4.1 (2003-06-06)
583 ------------------------------------------------
584
585  This is the release that 0.4.0 should have been.  There are many
586  interface changes, please see below for the details.  The changes are
587  sometimes the result of new functionality, but more often express a
588  paradigm shift.  Others are an overdue cleanup to get GPGME in line
589  with the GNU coding standards and to make the interface more
590  self-consistent.  Here is an overview on the changes:
591
592  All types have been renamed to conform to the GNU coding standards,
593  most of the time by keeping the whole name in lowercase and inserting
594  underscores between words.
595
596  All operations consistently only accept input parameters in their
597  invocation function, and return only an error code directly.  Further
598  information about the result of the operation has to be retrieved
599  afterwards by calling one of the result functions.  This unifies the
600  synchronous and the asynchronous interface.
601
602  The error values have been completely replaced by a more
603  sophisticated model that allows GPGME to transparently and accurately
604  report all errors from the other GnuPG components, irregardless of
605  process boundaries.  This is achieved by using the library
606  libgpg-errors, which is shared by all GnuPG components.  This library
607  is now required for GPGME.
608
609  The results of all operations are now provided by pointers to C
610  structs rather than by XML structs or in other ways.
611
612  Objects which used to be opaque (for example a key) are now pointers
613  to accessible structs, so no accessor functions are necessary.
614
615  Backward compatibility is provided where it was possible without too
616  much effort and did not collide with the overall sanitization effort.
617  However, this is only for ease of transition.  NO DEPRECATED FUNCTION
618  OR DATA TYPE IS CONSIDERED A PART OF THE API OR ABI AND WILL BE
619  DROPPED IN THE FUTURE WITHOUT CHANGING THE SONAME OF THE LIBRARY.
620  Recommendations how to replace deprecated or removed functionality
621  can be found within the description of each change.
622
623  What follows are all changes to the interface and behaviour of GPGME
624  in detail.
625
626  * If gpgme.h is included in sources compiled by GCC 3.1 or later,
627    deprecated attributes will warn about use of obsolete functions and
628    type definitions.  You can suppress these warnings by passing
629    -Wno-deprecated-declarations to the gcc command.
630
631  * The following types have been renamed.  The old types are still
632    available as aliases, but they are deprecated now:
633    Old name:            New name:
634    GpgmeCtx             gpgme_ctx_t
635    GpgmeData            gpgme_data_t
636    GpgmeError           gpgme_error_t
637    GpgmeDataEncoding    gpgme_data_encoding_t
638    GpgmeSigStat         gpgme_sig_stat_t
639    GpgmeSigMode         gpgme_sig_mode_t
640    GpgmeAttr            gpgme_attr_t
641    GpgmeValidity        gpgme_validity_t
642    GpgmeProtocol        gpgme_protocol_t
643    GpgmeKey             gpgme_key_t
644    GpgmePassphraseCb    gpgme_passphrase_cb_t
645    GpgmeProgressCb      gpgme_progress_cb_t
646    GpgmeIOCb            gpgme_io_cb_t
647    GpgmeRegisterIOCb    gpgme_register_io_cb_t
648    GpgmeRemoveIOCb      gpgme_remove_io_cb_t
649    GpgmeEventIO         gpgme_event_io_t
650    GpgmeEventIOCb       gpgme_event_io_cb_t
651    GpgmeIOCbs           gpgme_io_cbs
652    GpgmeDataReadCb      gpgme_data_read_cb_t
653    GpgmeDataWriteCb     gpgme_data_write_cb_t
654    GpgmeDataSeekCb      gpgme_data_seek_cb_t
655    GpgmeDataReleaseCb   gpgme_data_release_cb_t
656    GpgmeDataCbs         gpgme_data_cbs_t
657    GpgmeTrustItem       gpgme_trust_item_t
658    GpgmeStatusCode      gpgme_status_code_t
659
660  * gpgme_error_t is now identical to gpg_error_t, the error type
661    provided by libgpg-error.  More about using libgpg-error with GPGME
662    can be found in the manual.  All error symbols have been removed!
663
664  * All functions and types in libgpg-error have been wrapped in GPGME.
665    The new types are gpgme_err_code_t and gpgme_err_source_t.  The new
666    functions are gpgme_err_code, gpgme_err_source, gpgme_error,
667    gpgme_err_make, gpgme_error_from_errno, gpgme_err_make_from_errno,
668    gpgme_err_code_from_errno, gpgme_err_code_to_errno,
669    gpgme_strsource.
670
671  * GPGME_ATTR_IS_SECRET is not anymore representable as a string.
672
673  * GnuPG 1.2.2 is required.  The progress callback is now also invoked
674    for encrypt, sign, encrypt-sign, decrypt, verify, and
675    decrypt-verify operations.  For verify operations on detached
676    signatures, the progress callback is invoked for both the detached
677    signature and the plaintext message, though.
678
679  * gpgme_passphrase_cb_t has been changed to not provide a complete
680    description, but the UID hint, passphrase info and a flag
681    indicating if this is a repeated attempt individually, so the user
682    can compose his own description from this information.
683
684    The passphrase is not returned as a C string, but must be written
685    to a file descriptor directly.  This allows for secure passphrase
686    entries.
687
688    The return type has been changed to gpgme_error_t value.  This
689    allowed to remove the gpgme_cancel function; just return
690    the error code GPG_ERR_CANCELED in the passphrase callback directly.
691
692  * gpgme_edit_cb_t has been changed to take a file descriptor argument.
693    The user is expected to write the response to the file descriptor,
694    followed by a newline.
695
696  * The recipients interface has been removed.  Instead, you use
697    NULL-terminated lists of keys for specifying the recipients of an
698    encryption operation.  Use the new encryption flag
699    GPGME_ENCRYPT_ALWAYS_TRUST if you want to override the validity of
700    the keys (but note that in general this is not a good idea).
701
702    This change has been made to the prototypes of gpgme_op_encrypt,
703    gpgme_op_encrypt_start, gpgme_op_encrypt_sign and
704    gpgme_op_encrypt_sign_start.
705
706    The export interface has been changed to use pattern strings like
707    the keylist interface.  Thus, new functions gpgme_op_export_ext and
708    gpgme_op_export_ext_start have been added as well.  Now the
709    prototypes of gpgme_op_export_start and gpgme_op_export finally
710    make sense.
711
712  * gpgme_op_verify and gpgme_op_decrypt_verify don't return a status
713    summary anymore.  Use gpgme_get_sig_status to retrieve the individual
714    stati.
715
716  * gpgme_io_cb_t changed from a void function to a function returning
717    a gpgme_error_t value.  However, it will always return 0, so you
718    can safely ignore the return value.
719
720  * A new I/O callback event GPGME_EVENT_START has been added.  The new
721    requirement is that you must wait until this event until you are
722    allowed to call the I/O callback handlers previously registered for
723    this context operation.  Calling I/O callback functions for this
724    context operation before the start event happened is unsafe because
725    it can lead to race conditions in a multi-threaded environment.
726
727  * The idle function feature has been removed.  It was not precisely
728    defined in a multi-threaded environment and is obsoleted by the
729    user I/O callback functions.  If you still need a simple way to
730    call something while waiting on one or multiple asynchronous
731    operations to complete, don't set the HANG flag in gpgme_wait (note
732    that this will return to your program more often than the idle
733    function did).
734
735  * gpgme_wait can return NULL even if hang is true, if an error
736    occurs.  In that case *status contains the error code.
737
738  * gpgme_get_engine_info was radically changed.  Instead an XML
739    string, an info structure of the new type gpgme_engine_info_t is
740    returned.  This makes it easier and more robust to evaluate the
741    information in an application.
742
743  * The new function gpgme_get_protocol_name can be used to convert a
744    gpgme_protocol_t value into a string.
745
746  * The status of a context operation is not checked anymore.  Starting
747    a new operation will silently cancel the previous one.  Calling a
748    function that requires you to have started an operation before without
749    doing so is undefined.
750
751  * The FPR argument to gpgme_op_genkey was removed.  Instead, use the
752    gpgme_op_genkey_result function to retrieve a gpgme_genkey_result_t
753    pointer to a structure which contains the fingerprint.  This also
754    works with gpgme_op_genkey_start.  The structure also provides
755    other information about the generated keys.
756
757    So, instead:
758
759    char *fpr;
760    err = gpgme_op_genkey (ctx, NULL, NULL, &fpr); 
761    if (!err && fpr)
762      printf ("%s\n", fpr);
763
764    you should now do:
765
766    gpgme_genkey_result_t result;
767    err = gpgme_op_genkey (ctx, NULL, NULL);
768    if (!err)
769      {
770        result = gpgme_op_genkey_result (ctx);
771        if (result->fpr)
772          printf ("%s\n", result->fpr);
773      }
774
775  * The new gpgme_op_import_result function provides detailed
776    information about the result of an import operation in
777    gpgme_import_result_t and gpgme_import_status_t objects.
778    Thus, the gpgme_op_import_ext variant is deprecated.
779
780  * The new gpgme_op_sign_result function provides detailed information
781    about the result of a signing operation in gpgme_sign_result_t,
782    gpgme_invalid_key_t and gpgme_new_signature_t objects.
783
784  * The new gpgme_op_encrypt_result function provides detailed
785    information about the result of an encryption operation in
786    a GpgmeEncryptResult object.
787
788  * The new gpgme_op_decrypt_result function provides detailed
789    information about the result of a decryption operation in
790    a GpgmeDecryptResult object.
791
792  * The new gpgme_op_verify_result function provides detailed
793    information about the result of an verify operation in
794    a GpgmeVerifyResult object.  Because of this, the GPGME_SIG_STAT_*
795    values, gpgme_get_sig_status, gpgme_get_sig_ulong_attr,
796    gpgme_get_sig_string_attr and gpgme_get_sig_key are now deprecated,
797    and gpgme_get_notation is removed.
798
799  * GpgmeTrustItem objects have now directly accessible data, so the
800    gpgme_trust_item_get_string_attr and gpgme_trust_item_get_ulong_attr
801    accessor functions are deprecated.  Also, reference counting is
802    available through gpgme_trust_item_ref and gpgme_trust_item_unref
803    (the gpgme_trust_item_release alias for the latter is deprecated).
804
805  * Keys are not cached internally anymore, so the force_update argument
806    to gpgme_get_key has been removed.
807
808  * GpgmeKey objects have now directly accessible data so the
809    gpgme_key_get_string_attr, gpgme_key_get_ulong_attr,
810    gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
811    functions are deprecated.  Also, gpgme_key_release is now
812    deprecated.  The gpgme_key_get_as_xml function has been dropped.
813
814  * Because all interfaces using attributes are deprecated, the
815    GpgmeAttr data type is also deprecated.
816
817  * The new gpgme_op_keylist_result function provides detailed
818    information about the result of a key listing operation in
819    a GpgmeKeyListResult object.
820
821  * Now that each function comes with its own result retrieval
822    interface, the generic gpgme_get_op_info interface is not useful
823    anymore and dropped.
824
825  * The type and mode of data objects is not available anymore.
826
827  * Interface changes relative to the 0.4.0 release:
828 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
829 GpgmeCtx                        DEPRECATED: Use gpgme_ctx_t.
830 GpgmeData                       DEPRECATED: Use gpgme_data_t.
831 GpgmeError                      DEPRECATED: Use gpgme_error_t.
832 GpgmeDataEncoding               DEPRECATED: Use gpgme_data_encoding_t.
833 GpgmeSigStat                    DEPRECATED: Use gpgme_sig_stat_t.
834 GpgmeSigMode                    DEPRECATED: Use gpgme_sig_mode_t.
835 GpgmeAttr                       DEPRECATED: Use gpgme_attr_t.
836 GpgmeValidity                   DEPRECATED: Use gpgme_validity_t.
837 GpgmeProtocol                   DEPRECATED: Use gpgme_protocol_t.
838 GpgmeKey                        DEPRECATED: Use gpgme_key_t.
839 GpgmePassphraseCb               DEPRECATED: Use gpgme_passphrase_cb_t.
840 GpgmeProgressCb                 DEPRECATED: Use gpgme_progress_cb_t.
841 GpgmeIOCb                       DEPRECATED: Use gpgme_io_cb_t.
842 GpgmeRegisterIOCb               DEPRECATED: Use gpgme_register_io_cb_t.
843 GpgmeRemoveIOCb                 DEPRECATED: Use gpgme_remove_io_cb_t.
844 GpgmeEventIO                    DEPRECATED: Use gpgme_event_io_t.
845 GpgmeEventIOCb                  DEPRECATED: Use gpgme_event_io_cb_t.
846 GpgmeIOCbs                      DEPRECATED: Use gpgme_io_cbs.
847 GpgmeDataReadCb                 DEPRECATED: Use gpgme_data_read_cb_t.
848 GpgmeDataWriteCb                DEPRECATED: Use gpgme_data_write_cb_t.
849 GpgmeDataSeekCb                 DEPRECATED: Use gpgme_data_seek_cb_t.
850 GpgmeDataReleaseCb              DEPRECATED: Use gpgme_data_release_cb_t.
851 GpgmeDataCbs                    DEPRECATED: Use gpgme_data_cbs_t.
852 GpgmeTrustItem                  DEPRECATED: Use gpgme_trust_item_t.
853 GpgmeStatusCode                 DEPRECATED: Use gpgme_status_code_t.
854 gpgme_ctx_t                     NEW
855 gpgme_data_t                    NEW
856 gpgme_recipients_t              NEW
857 gpgme_error_t                   NEW
858 gpgme_data_encoding_t           NEW
859 gpgme_sig_stat_t                NEW
860 gpgme_sig_mode_t                NEW
861 gpgme_attr_t                    NEW
862 gpgme_validity_t                NEW
863 gpgme_protocol_t                NEW
864 gpgme_key_t                     NEW
865 gpgme_passphrase_cb_t           NEW
866 gpgme_progress_cb_t             NEW
867 gpgme_io_cb_t                   NEW
868 gpgme_register_io_cb_t          NEW
869 gpgme_remove_io_cb_t            NEW
870 gpgme_event_io_t                NEW
871 gpgme_event_io_cb_t             NEW
872 gpgme_io_cbs                    NEW
873 gpgme_data_read_cb_t            NEW
874 gpgme_data_write_cb_t           NEW
875 gpgme_data_seek_cb_t            NEW
876 gpgme_data_release_cb_t         NEW
877 gpgme_data_cbs_t                NEW
878 gpgme_trust_item_t              NEW
879 gpgme_status_code_t             NEW
880 GPGME_{some error code}         REMOVED! Use GPG_ERR_* from libgpg-error.
881 gpgme_err_code_t                NEW
882 gpgme_err_source_t              NEW
883 gpgme_err_code                  NEW
884 gpgme_err_source                NEW
885 gpgme_error                     NEW
886 gpgme_err_make                  NEW
887 gpgme_error_from_errno          NEW
888 gpgme_err_make_from_errno       NEW
889 gpgme_err_code_from_errno       NEW
890 gpgme_err_code_to_errno         NEW
891 gpgme_strsource                 NEW
892 gpgme_io_cb_t                   CHANGED: Return type from void to GpgmeError.
893 gpgme_event_io_t                CHANGED: New event type (all numbers changed).
894 gpgme_passphrase_cb_t           CHANGED: Desc decomposed, write directly to FD.
895 gpgme_edit_cb_t                 CHANGED: Write directly to FD.
896 gpgme_key_get_string_attr       CHANGED: Don't handle GPGME_ATTR_IS_SECRET.
897 gpgme_op_verify                 CHANGED: Drop R_STAT argument.
898 gpgme_op_decrypt_verify         CHANGED: Drop R_STAT argument.
899 gpgme_wait                      CHANGED: Can return NULL even if hang is true.
900 GpgmeIdleFunc                   REMOVED
901 gpgme_register_idle             REMOVED
902 GpgmeRecipients                 REMOVED
903 gpgme_recipients_new            REMOVED
904 gpgme_recipients_release        REMOVED
905 gpgme_recipients_add_name       REMOVED
906 gpgme_recipients_add_name_with_validity REMOVED
907 gpgme_recipients_count          REMOVED
908 gpgme_recipients_enum_open      REMOVED
909 gpgme_recipients_enum_read      REMOVED
910 gpgme_recipients_enum_close     REMOVED
911 gpgme_encrypt_flags_t           NEW
912 GPGME_ENCRYPT_ALWAYS_TRUST      NEW
913 gpgme_op_encrypt                CHANGED: Recipients passed as gpgme_key_t[].
914 gpgme_op_encrypt_start          CHANGED: Recipients passed as gpgme_key_t[].
915 gpgme_op_encrypt_sign           CHANGED: Recipients passed as gpgme_key_t[].
916 gpgme_op_encrypt_sign_start     CHANGED: Recipients passed as gpgme_key_t[].
917 gpgme_op_export_start           CHANGED: User IDs passed as patterns.
918 gpgme_op_export                 CHANGED: User IDs passed as patterns.
919 gpgme_op_export_ext_start       NEW
920 gpgme_op_export_ext             NEW
921 gpgme_keylist_mode_t            NEW
922 gpgme_sigsum_t                  NEW
923 gpgme_engine_info_t             NEW
924 gpgme_get_engine_info           CHANGED: Return info structure instead XML.
925 gpgme_get_protocol_name         NEW
926 gpgme_cancel                    REMOVED: Return error in callback directly.
927 gpgme_op_genkey                 CHANGED: FPR argument dropped.
928 gpgme_op_genkey_result          NEW
929 gpgme_genkey_result_t           NEW
930 gpgme_op_import_ext             DEPRECATED: Use gpgme_op_import_result.
931 gpgme_op_import_result          NEW
932 gpgme_import_status_t           NEW
933 gpgme_import_result_t           NEW
934 gpgme_pubkey_algo_t             NEW
935 gpgme_hash_algo_t               NEW
936 gpgme_invalid_key_t             NEW
937 gpgme_new_signature_t           NEW
938 gpgme_sign_result_t             NEW
939 gpgme_op_sign_result            NEW
940 gpgme_pubkey_algo_name          NEW
941 gpgme_hash_algo_name            NEW
942 gpgme_encrypt_result_t          NEW
943 gpgme_op_encrypt_result         NEW
944 gpgme_decrypt_result_t          NEW
945 gpgme_op_decrypt_result         NEW
946 gpgme_verify_result_t           NEW
947 gpgme_op_verify_result          NEW
948 gpgme_get_notation              REMOVED: Access verify result directly instead.
949 gpgme_get_sig_key               DEPRECATED: Use gpgme_get_key with fingerprint.
950 gpgme_get_sig_ulong_attr        DEPRECATED: Use verify result directly.
951 gpgme_get_sig_string_attr       DEPRECATED: Use verify result directly.
952 GPGME_SIG_STAT_*                DEPRECATED: Use error value in sig status.
953 gpgme_get_sig_status            DEPRECATED: Use verify result directly.
954 gpgme_trust_item_t              CHANGED: Now has user accessible data members.
955 gpgme_trust_item_ref            NEW
956 gpgme_trust_item_unref          NEW
957 gpgme_trust_item_release        DEPRECATED: Use gpgme_trust_item_unref.
958 gpgme_trust_item_get_string_attr DEPRECATED
959 gpgme_trust_item_get_ulong_attr DEPRECATED
960 gpgme_get_key                   CHANGED: Removed force_update argument.
961 gpgme_sub_key_t                 NEW
962 gpgme_key_sig_t                 NEW
963 gpgme_user_id_t                 NEW
964 gpgme_key_t                     CHANGED: Now has user accessible data members.
965 gpgme_key_get_string_attr       DEPRECATED
966 gpgme_key_get_ulong_attr        DEPRECATED
967 gpgme_key_sig_get_string_attr   DEPRECATED
968 gpgme_key_sig_get_ulong_attr    DEPRECATED
969 gpgme_key_get_as_xml            REMOVED
970 gpgme_key_list_result_t         NEW
971 gpgme_op_keylist_result         NEW
972 gpgme_get_op_info               REMOVED
973 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
974
975 Noteworthy changes in version 0.4.0 (2002-12-23)
976 ------------------------------------------------
977
978  * Key generation returns the fingerprint of the generated key.
979
980  * New convenience function gpgme_get_key.
981
982  * Supports signatures of user IDs in keys via the new
983    GPGME_KEYLIST_MODE_SIGS keylist mode and the
984    gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
985    interfaces.  The XML info about a key also includes the signatures
986    if available.
987
988  * New data object interface, which is more flexible and transparent.
989
990  * Interface changes relative to the 0.3.9 release:
991 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
992 GpgmeDataReadCb                 NEW
993 GpgmeDataWriteCb                NEW
994 GpgmeDataSeekCb                 NEW
995 GpgmeDataReleaseCb              NEW
996 GpgmeDataCbs                    NEW
997 gpgme_data_read                 CHANGED: Match read() closely.
998 gpgme_data_write                CHANGED: Match write() closely.
999 gpgme_data_seek                 NEW
1000 gpgme_data_new_from_fd          NEW
1001 gpgme_data_new_from_stream      NEW
1002 gpgme_data_new_from_cbs         NEW
1003 gpgme_data_rewind               DEPRECATED: Replaced by gpgme_data_seek().
1004 gpgme_data_new_from_read_cb     DEPRECATED: Replaced by gpgme_data_from_cbs().
1005 gpgme_data_get_type             REMOVED: No replacement.
1006 gpgme_op_verify                 CHANGED: Take different data objects for
1007                                 signed text and plain text.
1008 gpgme_op_verify_start           CHANGED: See gpgme_op_verify.
1009 gpgme_check_engine              REMOVED: Deprecated since 0.3.0.
1010 gpgme_op_genkey                 CHANGED: New parameter FPR.
1011 GPGME_KEYLIST_MODE_SIGS         NEW
1012 gpgme_key_sig_get_string_attr   NEW
1013 gpgme_key_sig_get_ulong_attr    NEW
1014 gpgme_get_key                   NEW
1015 GPGME_ATTR_SIG_CLASS            NEW
1016 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1017
1018 Noteworthy changes in version 0.3.16 (2003-11-19)
1019 -------------------------------------------------
1020
1021  * Compatibility fixes for GnuPG 1.9.x
1022
1023 Noteworthy changes in version 0.3.15 (2003-02-18)
1024 -------------------------------------------------
1025
1026  * The progress status is sent via the progress callbacks in
1027    gpgme_op_edit.
1028
1029  * Bug fix for signing operations with explicit signer settings for
1030    the CMS protocol.
1031
1032 Noteworthy changes in version 0.3.14 (2002-12-04)
1033 -------------------------------------------------
1034
1035  * GPGME-Plug is now in its own package "cryptplug".
1036
1037  * Workaround for a setlocale problem.  Fixed a segv related to not
1038    correctly as closed marked file descriptors.
1039
1040 Noteworthy changes in version 0.3.13 (2002-11-20)
1041 -------------------------------------------------
1042
1043  * Release due to changes in gpgmeplug.
1044
1045 Noteworthy changes in version 0.3.12 (2002-10-15)
1046 -------------------------------------------------
1047
1048  * Fixed some bux with key listings.  
1049
1050  * The development has been branched to clean up some API issues.
1051    This 0.3 series will be kept for compatibility reasons; so do don't
1052    expect new features.
1053
1054 Noteworthy changes in version 0.3.11 (2002-09-20)
1055 -------------------------------------------------
1056         
1057  * Bug fixes.
1058
1059 Noteworthy changes in version 0.3.10 (2002-09-02)
1060 -------------------------------------------------
1061
1062  * Setting the signing keys for the CMS protocol does now work.
1063
1064  * The signers setting is honoured by gpgme_op_edit.
1065
1066 Noteworthy changes in version 0.3.9 (2002-08-21)
1067 ------------------------------------------------
1068
1069  * A spec file for creating RPMs has been added.
1070
1071  * An experimental interface to GnuPG's --edit-key functionality is
1072    introduced, see gpgme_op_edit.
1073
1074  * The new gpgme_import_ext function provides a convenient access to
1075    the number of processed keys.
1076
1077  * Interface changes relative to the 0.3.8 release:
1078 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1079 GpgmeStatusCode                 NEW
1080 GpgmeEditCb                     NEW
1081 gpgme_op_edit_start             NEW
1082 gpgme_op_edit                   NEW
1083 gpgme_op_import_ext             NEW
1084 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1085
1086 Noteworthy changes in version 0.3.8 (2002-06-25)
1087 ------------------------------------------------
1088
1089  * It is possible to use an outside event loop for the I/O to the
1090    crypto engine by setting the I/O callbacks with gpgme_set_io_cbs.
1091
1092  * Interface changes relative to the 0.3.6 release:
1093 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1094 GpgmeIOCb                       NEW
1095 GpgmeRegisterIOCb               NEW
1096 GpgmeRemoveIOCb                 NEW
1097 GpgmeEventIO                    NEW
1098 GpgmeEventIOCb                  NEW
1099 struct GpgmeIOCbs               NEW
1100 gpgme_set_io_cbs                NEW
1101 gpgme_get_io_cbs                NEW
1102 GPGME_ATTR_ERRTOK               NEW
1103 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1104
1105 Noteworthy changes in version 0.3.7 (2002-06-04)
1106 ------------------------------------------------
1107
1108  * GPGME_ATTR_OTRUST is implemented now.
1109
1110  * A first step toward thread safeness has been achieved, see the
1111    documentation for details.  Supported thread libraries are pthread
1112    and Pth.
1113
1114 Noteworthy changes in version 0.3.6 (2002-05-03)
1115 ------------------------------------------------
1116
1117  * All error output of the gpgsm backend is send to the bit bucket.
1118
1119  * The signature verification functions are extended.  Instead of
1120    always returning GPGME_SIG_STATUS_GOOD, the functions new codes for
1121    expired signatures.  2 new functions may be used to retrieve more
1122    detailed information like the signature expiration time and a
1123    validity information of the key without an extra key looking.
1124
1125  * The current passphrase callback and progress meter callback can be
1126    retrieved with the new functions gpgme_get_passphrase_cb and
1127    gpgme_get_progress_cb respectively.
1128
1129  * Interface changes relative to the 0.3.5 release:
1130 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1131 gpgme_get_passphrase_cb         NEW
1132 gpgme_get_progress_cb           NEW
1133 GpgmeDataEncoding               NEW
1134 gpgme_data_set_encoding         NEW
1135 gpgme_data_get_encoding         NEW
1136 GPGME_SIG_STAT_GOOD_EXP         NEW
1137 GPGME_SIG_STAT_GOOD_EXPKEY      NEW
1138 gpgme_op_verify                 CHANGED: Returns more status codes.
1139 GPGME_ATTR_SIG_STATUS           NEW
1140 gpgme_get_sig_string_attr       NEW
1141 gpgme_get_sig_ulong_attr        NEW
1142 gpgme_get_protocol              NEW
1143 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1144
1145 Noteworthy changes in version 0.3.5 (2002-04-01)
1146 ------------------------------------------------
1147
1148  * gpgme_op_encrypt can be called with RECIPIENTS being 0.  In this
1149    case, symmetric encryption is performed.  Note that this requires a
1150    passphrase from the user.
1151
1152  * More information is returned for X.509 certificates.
1153
1154  * Interface changes relative to the 0.3.4 release:
1155 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1156 gpgme_op_encrypt                EXTENDED: Symmetric encryption possible
1157 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1158
1159 Noteworthy changes in version 0.3.4 (2002-03-04)
1160 ------------------------------------------------
1161
1162  * gpgme_op_encrypt does now fail with GPGME_Invalid_Recipients if
1163    some recipients have been invalid, whereas earlier versions
1164    succeeded in this case.  The plaintext is still encrypted for all valid
1165    recipients, so the application might take this error as a hint that
1166    the ciphertext is not usable for all requested recipients.
1167    Information about invalid recipients is available with gpgme_get_op_info.
1168
1169  * gpgme_op_verify now allows to pass an uninitialized data object as
1170    its plaintext argument to check for normal and cleartext
1171    signatures.  The plaintext is then returned in the data object.
1172
1173  * New interfaces gpgme_set_include_certs and gpgme_get_include_certs
1174    to set and get the number of certifications to include in S/MIME
1175    signed messages.
1176
1177  * New interfaces gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start
1178    to encrypt and sign a message in a combined operation.
1179
1180  * New interface gpgme_op_keylist_ext_start to search for multiple patterns.
1181
1182  * gpgme_key_get_ulong_attr supports the GPGME_ATTR_EXPIRE attribute.
1183
1184  * Interface changes relative to the 0.3.3 release:
1185 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1186 gpgme_op_encrypt                CHANGED: Can fail with GPGME_Invalid_Recipients
1187 gpgme_op_verify                 EXTENDED: Accepts uninitialized text argument
1188 gpgme_key_get_ulong_attr        EXTENDED: Supports GPGME_ATTR_EXPIRE
1189 gpgme_set_include_certs         NEW
1190 gpgme_get_include_certs         NEW
1191 gpgme_op_encrypt_sign           NEW
1192 gpgme_op_encrypt_sign_start     NEW
1193 gpgme_op_keylist_ext_start      NEW
1194 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1195
1196 Noteworthy changes in version 0.3.3 (2002-02-12)
1197 ------------------------------------------------
1198
1199  * Fix the Makefile in jnlib.
1200
1201  * Fix the test suite (hopefully).  It should clean up all its state
1202    with `make check' now.
1203
1204
1205 Noteworthy changes in version 0.3.2 (2002-02-10)
1206 ------------------------------------------------
1207
1208  * Remove erroneous dependency on libgcrypt in jnlib.
1209
1210
1211 Noteworthy changes in version 0.3.1 (2002-02-09)
1212 ------------------------------------------------
1213
1214  * There is a Texinfo manual documenting the API.
1215
1216  * The gpgme_set_keylist_mode function returns an error, and changed
1217    its meaning.  It is no longer usable to select between normal and
1218    fast mode (newer versions of GnuPG will always be fast), but
1219    selects between local keyring, remote keyserver, or both.
1220    For this, two new macros are defined, GPGME_KEYLIST_MODE_LOCAL
1221    and GPGME_KEYLIST_MODE_EXTERN.  To make it possible to modify the
1222    current setting, a fucntion gpgme_get_keylist_mode was added to
1223    retrieve the current mode.
1224
1225  * gpgme_wait accepts a new argument STATUS to return the error status
1226    of the operation on the context.  Its definition is closer to
1227    waitpid() now than before.
1228
1229  * The LENGTH argument to gpgme_data_new_from_filepart changed its
1230    type from off_t to the unsigned size_t.
1231
1232  * The R_HD argument to the GpgmePassphraseCb type changed its type
1233    from void* to void**.
1234
1235  * New interface gpgme_op_trustlist_end() to match
1236    gpgme_op_keylist_end().
1237
1238  * The CryptPlug modules have been renamed to gpgme-openpgp and
1239    gpgme-smime, and they are installed in pkglibdir by `make install'.
1240
1241  * An idle function can be registered with gpgme_register_idle().
1242
1243  * The GpgSM backend supports key generation with gpgme_op_genkey().
1244
1245  * Interface changes relative to the 0.3.0 release:
1246 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1247 gpgme_data_new_from_filepart    CHANGED: Type of LENGTH is size_t.
1248 GpgmePassphraseCb               CHANGED: Type of R_HD is void **.
1249 gpgme_wait                      CHANGED: New argument STATUS.
1250 gpgme_set_keylist_mode          CHANGED: Type of return value is GpgmeError.
1251                                 The function has a new meaning!
1252 gpgme_get_keylist_mode          NEW
1253 GPGME_KEYLIST_MODE_LOCAL        NEW
1254 GPGME_KEYLIST_MODE_EXTERN       NEW
1255 gpgme_op_trustlist_next         NEW
1256 GpgmeIdleFunc                   NEW
1257 gpgme_register_idle             NEW
1258 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1259
1260 Noteworthy changes in version 0.3.0 (2001-12-19)
1261 ------------------------------------------------
1262  
1263  * New interface gpgme_set_protocol() to set the protocol and thus the
1264    crypto engine to be used by the context.  Currently, the OpenPGP
1265    and the CMS protocols are supported.  They are specified by the new
1266    preprocessor symbols GPGME_PROTOCOL_OpenPGP and GPGME_PROTOCOL_CMS.
1267    A new context uses the OpenPGP engine by default.
1268
1269  * gpgme_get_engine_info() returns information for all crypto engines
1270    compiled into the library.  The XML format has changed.  To
1271    reliably get the version of a crypto engine, the <version> tag
1272    after the appropriate <protocol> tag has to be looked for.
1273
1274  * New interface gpgme_engine_check_version(), obsoleting
1275    gpgme_check_engine().  Check the version of all engines you are
1276    supporting in your software.
1277
1278  * GpgmeKey lists the user ids in the order as they are returned by
1279    GnuPG, first the primary key with index 0, then the sub-user ids.
1280
1281  * New operation gpgme_op_decrypt_verify() to decrypt and verify
1282    signatures simultaneously.
1283
1284  * The new interface gpgme_op_keylist_end() terminates a pending
1285    keylist operation.  A keylist operation is also terminated when
1286    gpgme_op_keylist_next() returns GPGME_EOF.
1287
1288  * GPGME can be compiled without GnuPG being installed (`--with-gpg=PATH'),
1289    cross-compiled, or even compiled without support for GnuPG
1290    (`--without-gpg').
1291
1292  * GPGME can be compiled with support for GpgSM (GnuPG for S/MIME,
1293    `--with-gpgsm=PATH').  It is enabled by default if the `gpgsm' is found
1294    in the path, but it can also be compiled without support for GpgSM
1295    (`--without-gpgsm').
1296
1297  * CryptPlug modules for GPGME are included and can be enabled at
1298    configure time (`--enable-gpgmeplug').  There is one module which
1299    uses the GnuPG engine (`gpgmeplug') and one module which uses the
1300    GpgSM engine (`gpgsmplug').
1301
1302  * Interface changes relative to the latest 0.2.x release:
1303 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1304 gpgme_key_get_as_xml            CHANGED: Sub-user ids reversed in order.
1305 gpgme_key_get_string_attr       CHANGED: User ids reversed in order.
1306 gpgme_key_get_ulong_attr        CHANGED: User ids reversed in order.
1307 gpgme_get_engine_info           CHANGED: New format, extended content.
1308 gpgme_engine_check_version      NEW
1309 gpgme_decrypt_verify_start      NEW
1310 gpgme_decrypt_verify            NEW
1311 gpgme_op_keylist_next           NEW
1312 gpgme_set_protocol              NEW
1313 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1314
1315
1316 Noteworthy changes in version 0.2.3 (2001-09-17)
1317 ------------------------------------------------
1318
1319  * New function gpgme_get_op_info which can be used to get the micalg
1320    parameter needed for MOSS.
1321
1322  * New functions gpgme_get_armor and gpgme_get_textmode.
1323
1324  * The usual bug fixes and some minor functionality improvements.
1325
1326  * Added a simple encryption component for MS-Windows; however the
1327    build procedure might have some problems.
1328
1329
1330 Noteworthy changes in version 0.2.2 (2001-06-12)
1331 ------------------------------------------------
1332  
1333  * Implemented a key cache.
1334
1335  * Fixed a race condition under W32 and some other bug fixes.
1336
1337
1338 Noteworthy changes in version 0.2.1 (2001-04-02)
1339 ------------------------------------------------
1340
1341  * Changed debug output and GPGME_DEBUG variable (gpgme/debug.c)
1342
1343  * Handle GnuPG's new key capabilities output and support revocation
1344    et al. attributes
1345
1346  * Made the W32 support more robust.
1347
1348
1349  Copyright 2001, 2002, 2003, 2004, 2005, 2007, 2008, 2009,
1350            2010 g10 Code GmbH
1351
1352  This file is free software; as a special exception the author gives
1353  unlimited permission to copy and/or distribute it, with or without
1354  modifications, as long as this notice is preserved.
1355
1356  This file is distributed in the hope that it will be useful, but
1357  WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
1358  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.