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