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