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