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