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