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