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