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