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