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