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