doc/
[gpgme.git] / NEWS
1 Noteworthy changes in version 0.4.0 (unreleased)
2 ------------------------------------------------
3
4  * New data object interface, which is more flexible and transparent.
5
6 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 GpgmeDataReadCb                 NEW
8 GpgmeDataWriteCb                NEW
9 GpgmeDataSeekCb                 NEW
10 GpgmeDataReleaseCb              NEW
11 GpgmeDataCbs                    NEW
12 gpgme_data_read                 CHANGED: Match read() closely.
13 gpgme_data_write                CHANGED: Match write() closely.
14 gpgme_data_seek                 NEW
15 gpgme_data_from_fd              NEW
16 gpgme_data_from_stream          NEW
17 gpgme_data_from_cbs             NEW
18 gpgme_data_rewind               DEPRECATED: Replaced by gpgme_data_seek().
19 gpgme_data_new_from_read_cb     DEPRECATED: Replaced by gpgme_data_from_cbs().
20 gpgme_data_get_type             REMOVED: No replacement.
21 gpgme_op_verify                 CHANGED: Take different data objects for
22                                 signed text and plain text.
23 gpgme_op_verify_start           CHANGED: See gpgme_op_verify.
24 gpgme_check_engine              REMOVED: Deprecated since 0.3.0.
25 gpgme_op_genkey                 CHANGED: New parameter FPR.
26 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
27
28 Noteworthy changes in version 0.3.11 (2002-09-20)
29 -------------------------------------------------
30         
31  * Bug fixes.
32
33 Noteworthy changes in version 0.3.10 (2002-09-02)
34 -------------------------------------------------
35
36  * Setting the signing keys for the CMS protocol does now work.
37
38  * The signers setting is honoured by gpgme_op_edit.
39
40 Noteworthy changes in version 0.3.9 (2002-08-21)
41 ------------------------------------------------
42
43  * A spec file for creating RPMs has been added.
44
45  * An experimental interface to GnuPG's --edit-key functionality is
46    introduced, see gpgme_op_edit.
47
48  * The new gpgme_import_ext function provides a convenient access to
49    the number of processed keys.
50
51  * Interface changes relative to the 0.3.8 release:
52 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
53 GpgmeStatusCode                 NEW
54 GpgmeEditCb                     NEW
55 gpgme_op_edit_start             NEW
56 gpgme_op_edit                   NEW
57 gpgme_op_import_ext             NEW
58 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
59
60 Noteworthy changes in version 0.3.8 (2002-06-25)
61 ------------------------------------------------
62
63  * It is possible to use an outside event loop for the I/O to the
64    crypto engine by setting the I/O callbacks with gpgme_set_io_cbs.
65
66  * Interface changes relative to the 0.3.6 release:
67 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
68 GpgmeIOCb                       NEW
69 GpgmeRegisterIOCb               NEW
70 GpgmeRemoveIOCb                 NEW
71 GpgmeEventIO                    NEW
72 GpgmeEventIOCb                  NEW
73 struct GpgmeIOCbs               NEW
74 gpgme_set_io_cbs                NEW
75 gpgme_get_io_cbs                NEW
76 GPGME_ATTR_ERRTOK               NEW
77 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
78
79 Noteworthy changes in version 0.3.7 (2002-06-04)
80 ------------------------------------------------
81
82  * GPGME_ATTR_OTRUST is implemented now.
83
84  * A first step toward thread safeness has been achieved, see the
85    documentation for details.  Supported thread libraries are pthread
86    and Pth.
87
88 Noteworthy changes in version 0.3.6 (2002-05-03)
89 ------------------------------------------------
90
91  * All error output of the gpgsm backend is send to the bit bucket.
92
93  * The signature verification functions are extended.  Instead of
94    always returning GPGME_SIG_STATUS_GOOD, the functions new codes for
95    expired signatures.  2 new functions may be used to retrieve more
96    detailed information like the signature expiration time and a
97    validity information of the key without an extra key looking.
98
99  * The current passphrase callback and progress meter callback can be
100    retrieved with the new functions gpgme_get_passphrase_cb and
101    gpgme_get_progress_cb respectively.
102
103  * Interface changes relative to the 0.3.5 release:
104 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
105 gpgme_get_passphrase_cb         NEW
106 gpgme_get_progress_cb           NEW
107 GpgmeDataEncoding               NEW
108 gpgme_data_set_encoding         NEW
109 gpgme_data_get_encoding         NEW
110 GPGME_SIG_STAT_GOOD_EXP         NEW
111 GPGME_SIG_STAT_GOOD_EXPKEY      NEW
112 gpgme_op_verify                 CHANGED: Returns more status codes.
113 GPGME_ATTR_SIG_STATUS           NEW
114 gpgme_get_sig_string_attr       NEW
115 gpgme_get_sig_ulong_attr        NEW
116 gpgme_get_protocol              NEW
117 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
118
119 Noteworthy changes in version 0.3.5 (2002-04-01)
120 ------------------------------------------------
121
122  * gpgme_op_encrypt can be called with RECIPIENTS being 0.  In this
123    case, symmetric encryption is performed.  Note that this requires a
124    passphrase from the user.
125
126  * More information is returned for X.509 certificates.
127
128  * Interface changes relative to the 0.3.4 release:
129 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
130 gpgme_op_encrypt                EXTENDED: Symmetric encryption possible
131 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
132
133 Noteworthy changes in version 0.3.4 (2002-03-04)
134 ------------------------------------------------
135
136  * gpgme_op_encrypt does now fail with GPGME_Invalid_Recipients if
137    some recipients have been invalid, whereas earlier versions
138    succeeded in this case.  The plaintext is still encrypted for all valid
139    recipients, so the application might take this error as a hint that
140    the ciphertext is not usable for all requested recipients.
141    Information about invalid recipients is available with gpgme_get_op_info.
142
143  * gpgme_op_verify now allows to pass an uninitialized data object as
144    its plaintext argument to check for normal and cleartext
145    signatures.  The plaintext is then returned in the data object.
146
147  * New interfaces gpgme_set_include_certs and gpgme_get_include_certs
148    to set and get the number of certifications to include in S/MIME
149    signed messages.
150
151  * New interfaces gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start
152    to encrypt and sign a message in a combined operation.
153
154  * New interface gpgme_op_keylist_ext_start to search for multiple patterns.
155
156  * gpgme_key_get_ulong_attr supports the GPGME_ATTR_EXPIRE attribute.
157
158  * Interface changes relative to the 0.3.3 release:
159 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
160 gpgme_op_encrypt                CHANGED: Can fail with GPGME_Invalid_Recipients
161 gpgme_op_verify                 EXTENDED: Accepts uninitialized text argument
162 gpgme_key_get_ulong_attr        EXTENDED: Supports GPGME_ATTR_EXPIRE
163 gpgme_set_include_certs         NEW
164 gpgme_get_include_certs         NEW
165 gpgme_op_encrypt_sign           NEW
166 gpgme_op_encrypt_sign_start     NEW
167 gpgme_op_keylist_ext_start      NEW
168 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
169
170 Noteworthy changes in version 0.3.3 (2002-02-12)
171 ------------------------------------------------
172
173  * Fix the Makefile in jnlib.
174
175  * Fix the test suite (hopefully).  It should clean up all its state
176    with `make check' now.
177
178
179 Noteworthy changes in version 0.3.2 (2002-02-10)
180 ------------------------------------------------
181
182  * Remove erroneous dependency on libgcrypt in jnlib.
183
184
185 Noteworthy changes in version 0.3.1 (2002-02-09)
186 ------------------------------------------------
187
188  * There is a Texinfo manual documenting the API.
189
190  * The gpgme_set_keylist_mode function returns an error, and changed
191    its meaning.  It is no longer usable to select between normal and
192    fast mode (newer versions of GnuPG will always be fast), but
193    selects between local keyring, remote keyserver, or both.
194    For this, two new macros are defined, GPGME_KEYLIST_MODE_LOCAL
195    and GPGME_KEYLIST_MODE_EXTERN.  To make it possible to modify the
196    current setting, a fucntion gpgme_get_keylist_mode was added to
197    retrieve the current mode.
198
199  * gpgme_wait accepts a new argument STATUS to return the error status
200    of the operation on the context.  Its definition is closer to
201    waitpid() now than before.
202
203  * The LENGTH argument to gpgme_data_new_from_filepart changed its
204    type from off_t to the unsigned size_t.
205
206  * The R_HD argument to the GpgmePassphraseCb type changed its type
207    from void* to void**.
208
209  * New interface gpgme_op_trustlist_end() to match
210    gpgme_op_keylist_end().
211
212  * The CryptPlug modules have been renamed to gpgme-openpgp and
213    gpgme-smime, and they are installed in pkglibdir by `make install'.
214
215  * An idle function can be registered with gpgme_register_idle().
216
217  * The GpgSM backend supports key generation with gpgme_op_genkey().
218
219  * Interface changes relative to the 0.3.0 release:
220 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221 gpgme_data_new_from_filepart    CHANGED: Type of LENGTH is size_t.
222 GpgmePassphraseCb               CHANGED: Type of R_HD is void **.
223 gpgme_wait                      CHANGED: New argument STATUS.
224 gpgme_set_keylist_mode          CHANGED: Type of return value is GpgmeError.
225                                 The function has a new meaning!
226 gpgme_get_keylist_mode          NEW
227 GPGME_KEYLIST_MODE_LOCAL        NEW
228 GPGME_KEYLIST_MODE_EXTERN       NEW
229 gpgme_op_trustlist_next         NEW
230 GpgmeIdleFunc                   NEW
231 gpgme_register_idle             NEW
232 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
233
234 Noteworthy changes in version 0.3.0 (2001-12-19)
235 ------------------------------------------------
236  
237  * New interface gpgme_set_protocol() to set the protocol and thus the
238    crypto engine to be used by the context.  Currently, the OpenPGP
239    and the CMS protocols are supported.  They are specified by the new
240    preprocessor symbols GPGME_PROTOCOL_OpenPGP and GPGME_PROTOCOL_CMS.
241    A new context uses the OpenPGP engine by default.
242
243  * gpgme_get_engine_info() returns information for all crypto engines
244    compiled into the library.  The XML format has changed.  To
245    reliably get the version of a crypto engine, the <version> tag
246    after the appropriate <protocol> tag has to be looked for.
247
248  * New interface gpgme_engine_check_version(), obsoleting
249    gpgme_check_engine().  Check the version of all engines you are
250    supporting in your software.
251
252  * GpgmeKey lists the user ids in the order as they are returned by
253    GnuPG, first the primary key with index 0, then the sub-user ids.
254
255  * New operation gpgme_op_decrypt_verify() to decrypt and verify
256    signatures simultaneously.
257
258  * The new interface gpgme_op_keylist_end() terminates a pending
259    keylist operation.  A keylist operation is also terminated when
260    gpgme_op_keylist_next() returns GPGME_EOF.
261
262  * GPGME can be compiled without GnuPG being installed (`--with-gpg=PATH'),
263    cross-compiled, or even compiled without support for GnuPG
264    (`--without-gpg').
265
266  * GPGME can be compiled with support for GpgSM (GnuPG for S/MIME,
267    `--with-gpgsm=PATH').  It is enabled by default if the `gpgsm' is found
268    in the path, but it can also be compiled without support for GpgSM
269    (`--without-gpgsm').
270
271  * CryptPlug modules for GPGME are included and can be enabled at
272    configure time (`--enable-gpgmeplug').  There is one module which
273    uses the GnuPG engine (`gpgmeplug') and one module which uses the
274    GpgSM engine (`gpgsmplug').
275
276  * Interface changes relative to the latest 0.2.x release:
277 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
278 gpgme_key_get_as_xml            CHANGED: Sub-user ids reversed in order.
279 gpgme_key_get_string_attr       CHANGED: User ids reversed in order.
280 gpgme_key_get_ulong_attr        CHANGED: User ids reversed in order.
281 gpgme_get_engine_info           CHANGED: New format, extended content.
282 gpgme_engine_check_version      NEW
283 gpgme_decrypt_verify_start      NEW
284 gpgme_decrypt_verify            NEW
285 gpgme_op_keylist_next           NEW
286 gpgme_set_protocol              NEW
287 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
288
289
290 Noteworthy changes in version 0.2.3 (2001-09-17)
291 ------------------------------------------------
292
293  * New function gpgme_get_op_info which can be used to get the micalg
294    parameter needed for MOSS.
295
296  * New functions gpgme_get_armor and gpgme_get_textmode.
297
298  * The usual bug fixes and some minor functionality improvements.
299
300  * Added a simple encryption component for MS-Windows; however the
301    build procedure might have some problems.
302
303
304 Noteworthy changes in version 0.2.2 (2001-06-12)
305 ------------------------------------------------
306  
307  * Implemented a key cache.
308
309  * Fixed a race condition under W32 and some other bug fixes.
310
311
312 Noteworthy changes in version 0.2.1 (2001-04-02)
313 ------------------------------------------------
314
315  * Changed debug output and GPGME_DEBUG variable (gpgme/debug.c)
316
317  * Handle GnuPG's new key capabilities output and support revocation
318    et al. attributes
319
320  * Made the W32 support more robust.
321
322
323  Copyright 2001, 2002 g10 Code GmbH
324
325  This file is free software; as a special exception the author gives
326  unlimited permission to copy and/or distribute it, with or without
327  modifications, as long as this notice is preserved.
328
329  This file is distributed in the hope that it will be useful, but
330  WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
331  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.