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