1 Noteworthy changes in version 0.4.1 (unreleased)
2 ------------------------------------------------
4 * GPGME_ATTR_IS_SECRET is not anymore representable as a string.
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.
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.
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.
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
28 * gpgme_wait can return NULL even if hang is true, if an error
29 occurs. In that case *status contains the error code.
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.
36 * The new function gpgme_get_protocol_name can be used to convert a
37 GpgmeProtocol value into a string.
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.
44 * The status of a context operation is not checked anymore, so the
45 errors GPGME_Busy and GPGME_No_Request can not occur anymore.
47 * For clarity and better reusability, the error codes
48 GPGME_No_Recipients, GPGME_Invalid_Recipient and
49 GPGME_No_Passphrase have been renamed to GPGME_No_UserID,
50 GPGME_Invalid_UserID and GPGME_Bad_Passphrase resp.
52 * The FPR argument to gpgme_op_genkey was removed. Instead, use the
53 gpgme_op_genkey_result function to retrieve a GpgmeGenKeyResult
54 pointer to a structure which contains the fingerprint. This also
55 works with gpgme_op_genkey. The structure also provides other
56 information about the generated keys.
61 err = gpgme_op_genkey (ctx, NULL, NULL, &fpr);
67 GpgmeGenKeyResult result;
68 err = gpgme_op_genkey (ctx, NULL, NULL);
71 result = gpgme_op_genkey_result (ctx);
73 printf ("%s\n", result->fpr);
76 * The new gpgme_op_import_result function provides detailed
77 information about the result of an import operation in
78 GpgmeImportResult and GpgmeImportStatus objects. Thus, the
79 gpgme_op_import_ext variant is deprecated.
81 * Interface changes relative to the 0.4.0 release:
82 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
83 GpgmeIOCb CHANGED: Return type from void to GpgmeError.
84 GpgmeEventIO CHANGED: New event type (all numbers changed).
85 gpgme_key_get_string_attr CHANGED: Don't handle GPGME_ATTR_IS_SECRET.
86 gpgme_op_verify CHANGED: Drop R_STAT argument.
87 gpgme_op_decrypt_verify CHANGED: Drop R_STAT argument.
88 gpgme_wait CHANGED: Can return NULL even if hang is true.
90 gpgme_register_idle REMOVED
92 gpgme_get_engine_info CHANGED: Return info structure instead XML.
93 gpgme_get_protocol_name NEW
94 GpgmePassphraseCb CHANGED: Return error value, new argument.
95 gpgme_cancel REMOVED: Return error in callback directly.
96 GPGME_Busy DEPRECATED: Not in use.
97 GPGME_No_Request DEPRECATED: Not in use.
98 GPGME_No_Recipients DEPRECATED: Use GPGME_No_UserID.
100 GPGME_Invalid_Recipient DEPRECATED: Use GPGME_Invalid_UserID.
101 GPGME_Invalid_UserID NEW
102 GPGME_No_Passphrase DEPRECATED: Use GPGME_Bad_Passphrase.
103 GPGME_Bad_Passphrase NEW
104 gpgme_op_genkey CHANGED: FPR argument dropped.
105 gpgme_op_genkey_result NEW
106 GpgmeGenKeyResult NEW
107 gpgme_op_import_ext DEPRECATED: Use gpgme_op_import_result.
108 gpgme_op_import_result NEW
109 GpgmeImportStatus NEW
110 GpgmeImportResult NEW
111 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
113 Noteworthy changes in version 0.4.0 (2002-12-23)
114 ------------------------------------------------
116 * Key generation returns the fingerprint of the generated key.
118 * New convenience function gpgme_get_key.
120 * Supports signatures of user IDs in keys via the new
121 GPGME_KEYLIST_MODE_SIGS keylist mode and the
122 gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
123 interfaces. The XML info about a key also includes the signatures
126 * New data object interface, which is more flexible and transparent.
128 * Interface changes relative to the 0.3.9 release:
129 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133 GpgmeDataReleaseCb NEW
135 gpgme_data_read CHANGED: Match read() closely.
136 gpgme_data_write CHANGED: Match write() closely.
138 gpgme_data_new_from_fd NEW
139 gpgme_data_new_from_stream NEW
140 gpgme_data_new_from_cbs NEW
141 gpgme_data_rewind DEPRECATED: Replaced by gpgme_data_seek().
142 gpgme_data_new_from_read_cb DEPRECATED: Replaced by gpgme_data_from_cbs().
143 gpgme_data_get_type REMOVED: No replacement.
144 gpgme_op_verify CHANGED: Take different data objects for
145 signed text and plain text.
146 gpgme_op_verify_start CHANGED: See gpgme_op_verify.
147 gpgme_check_engine REMOVED: Deprecated since 0.3.0.
148 gpgme_op_genkey CHANGED: New parameter FPR.
149 GPGME_KEYLIST_MODE_SIGS NEW
150 gpgme_key_sig_get_string_attr NEW
151 gpgme_key_sig_get_ulong_attr NEW
153 GPGME_ATTR_SIG_CLASS NEW
154 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
156 Noteworthy changes in version 0.3.15 (2003-02-18)
157 -------------------------------------------------
159 * The progress status is sent via the progress callbacks in
162 * Bug fix for signing operations with explicit signer settings for
165 Noteworthy changes in version 0.3.14 (2002-12-04)
166 -------------------------------------------------
168 * GPGME-Plug is now in its own package "cryptplug".
170 * Workaround for a setlocale problem. Fixed a segv related to not
171 correctly as closed marked file descriptors.
173 Noteworthy changes in version 0.3.13 (2002-11-20)
174 -------------------------------------------------
176 * Release due to changes in gpgmeplug.
178 Noteworthy changes in version 0.3.12 (2002-10-15)
179 -------------------------------------------------
181 * Fixed some bux with key listings.
183 * The development has been branched to clean up some API issues.
184 This 0.3 series will be kept for compatibility reasons; so do don't
187 Noteworthy changes in version 0.3.11 (2002-09-20)
188 -------------------------------------------------
192 Noteworthy changes in version 0.3.10 (2002-09-02)
193 -------------------------------------------------
195 * Setting the signing keys for the CMS protocol does now work.
197 * The signers setting is honoured by gpgme_op_edit.
199 Noteworthy changes in version 0.3.9 (2002-08-21)
200 ------------------------------------------------
202 * A spec file for creating RPMs has been added.
204 * An experimental interface to GnuPG's --edit-key functionality is
205 introduced, see gpgme_op_edit.
207 * The new gpgme_import_ext function provides a convenient access to
208 the number of processed keys.
210 * Interface changes relative to the 0.3.8 release:
211 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
214 gpgme_op_edit_start NEW
216 gpgme_op_import_ext NEW
217 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
219 Noteworthy changes in version 0.3.8 (2002-06-25)
220 ------------------------------------------------
222 * It is possible to use an outside event loop for the I/O to the
223 crypto engine by setting the I/O callbacks with gpgme_set_io_cbs.
225 * Interface changes relative to the 0.3.6 release:
226 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
228 GpgmeRegisterIOCb NEW
232 struct GpgmeIOCbs NEW
235 GPGME_ATTR_ERRTOK NEW
236 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
238 Noteworthy changes in version 0.3.7 (2002-06-04)
239 ------------------------------------------------
241 * GPGME_ATTR_OTRUST is implemented now.
243 * A first step toward thread safeness has been achieved, see the
244 documentation for details. Supported thread libraries are pthread
247 Noteworthy changes in version 0.3.6 (2002-05-03)
248 ------------------------------------------------
250 * All error output of the gpgsm backend is send to the bit bucket.
252 * The signature verification functions are extended. Instead of
253 always returning GPGME_SIG_STATUS_GOOD, the functions new codes for
254 expired signatures. 2 new functions may be used to retrieve more
255 detailed information like the signature expiration time and a
256 validity information of the key without an extra key looking.
258 * The current passphrase callback and progress meter callback can be
259 retrieved with the new functions gpgme_get_passphrase_cb and
260 gpgme_get_progress_cb respectively.
262 * Interface changes relative to the 0.3.5 release:
263 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
264 gpgme_get_passphrase_cb NEW
265 gpgme_get_progress_cb NEW
266 GpgmeDataEncoding NEW
267 gpgme_data_set_encoding NEW
268 gpgme_data_get_encoding NEW
269 GPGME_SIG_STAT_GOOD_EXP NEW
270 GPGME_SIG_STAT_GOOD_EXPKEY NEW
271 gpgme_op_verify CHANGED: Returns more status codes.
272 GPGME_ATTR_SIG_STATUS NEW
273 gpgme_get_sig_string_attr NEW
274 gpgme_get_sig_ulong_attr NEW
275 gpgme_get_protocol NEW
276 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
278 Noteworthy changes in version 0.3.5 (2002-04-01)
279 ------------------------------------------------
281 * gpgme_op_encrypt can be called with RECIPIENTS being 0. In this
282 case, symmetric encryption is performed. Note that this requires a
283 passphrase from the user.
285 * More information is returned for X.509 certificates.
287 * Interface changes relative to the 0.3.4 release:
288 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
289 gpgme_op_encrypt EXTENDED: Symmetric encryption possible
290 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
292 Noteworthy changes in version 0.3.4 (2002-03-04)
293 ------------------------------------------------
295 * gpgme_op_encrypt does now fail with GPGME_Invalid_Recipients if
296 some recipients have been invalid, whereas earlier versions
297 succeeded in this case. The plaintext is still encrypted for all valid
298 recipients, so the application might take this error as a hint that
299 the ciphertext is not usable for all requested recipients.
300 Information about invalid recipients is available with gpgme_get_op_info.
302 * gpgme_op_verify now allows to pass an uninitialized data object as
303 its plaintext argument to check for normal and cleartext
304 signatures. The plaintext is then returned in the data object.
306 * New interfaces gpgme_set_include_certs and gpgme_get_include_certs
307 to set and get the number of certifications to include in S/MIME
310 * New interfaces gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start
311 to encrypt and sign a message in a combined operation.
313 * New interface gpgme_op_keylist_ext_start to search for multiple patterns.
315 * gpgme_key_get_ulong_attr supports the GPGME_ATTR_EXPIRE attribute.
317 * Interface changes relative to the 0.3.3 release:
318 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
319 gpgme_op_encrypt CHANGED: Can fail with GPGME_Invalid_Recipients
320 gpgme_op_verify EXTENDED: Accepts uninitialized text argument
321 gpgme_key_get_ulong_attr EXTENDED: Supports GPGME_ATTR_EXPIRE
322 gpgme_set_include_certs NEW
323 gpgme_get_include_certs NEW
324 gpgme_op_encrypt_sign NEW
325 gpgme_op_encrypt_sign_start NEW
326 gpgme_op_keylist_ext_start NEW
327 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
329 Noteworthy changes in version 0.3.3 (2002-02-12)
330 ------------------------------------------------
332 * Fix the Makefile in jnlib.
334 * Fix the test suite (hopefully). It should clean up all its state
335 with `make check' now.
338 Noteworthy changes in version 0.3.2 (2002-02-10)
339 ------------------------------------------------
341 * Remove erroneous dependency on libgcrypt in jnlib.
344 Noteworthy changes in version 0.3.1 (2002-02-09)
345 ------------------------------------------------
347 * There is a Texinfo manual documenting the API.
349 * The gpgme_set_keylist_mode function returns an error, and changed
350 its meaning. It is no longer usable to select between normal and
351 fast mode (newer versions of GnuPG will always be fast), but
352 selects between local keyring, remote keyserver, or both.
353 For this, two new macros are defined, GPGME_KEYLIST_MODE_LOCAL
354 and GPGME_KEYLIST_MODE_EXTERN. To make it possible to modify the
355 current setting, a fucntion gpgme_get_keylist_mode was added to
356 retrieve the current mode.
358 * gpgme_wait accepts a new argument STATUS to return the error status
359 of the operation on the context. Its definition is closer to
360 waitpid() now than before.
362 * The LENGTH argument to gpgme_data_new_from_filepart changed its
363 type from off_t to the unsigned size_t.
365 * The R_HD argument to the GpgmePassphraseCb type changed its type
366 from void* to void**.
368 * New interface gpgme_op_trustlist_end() to match
369 gpgme_op_keylist_end().
371 * The CryptPlug modules have been renamed to gpgme-openpgp and
372 gpgme-smime, and they are installed in pkglibdir by `make install'.
374 * An idle function can be registered with gpgme_register_idle().
376 * The GpgSM backend supports key generation with gpgme_op_genkey().
378 * Interface changes relative to the 0.3.0 release:
379 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
380 gpgme_data_new_from_filepart CHANGED: Type of LENGTH is size_t.
381 GpgmePassphraseCb CHANGED: Type of R_HD is void **.
382 gpgme_wait CHANGED: New argument STATUS.
383 gpgme_set_keylist_mode CHANGED: Type of return value is GpgmeError.
384 The function has a new meaning!
385 gpgme_get_keylist_mode NEW
386 GPGME_KEYLIST_MODE_LOCAL NEW
387 GPGME_KEYLIST_MODE_EXTERN NEW
388 gpgme_op_trustlist_next NEW
390 gpgme_register_idle NEW
391 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
393 Noteworthy changes in version 0.3.0 (2001-12-19)
394 ------------------------------------------------
396 * New interface gpgme_set_protocol() to set the protocol and thus the
397 crypto engine to be used by the context. Currently, the OpenPGP
398 and the CMS protocols are supported. They are specified by the new
399 preprocessor symbols GPGME_PROTOCOL_OpenPGP and GPGME_PROTOCOL_CMS.
400 A new context uses the OpenPGP engine by default.
402 * gpgme_get_engine_info() returns information for all crypto engines
403 compiled into the library. The XML format has changed. To
404 reliably get the version of a crypto engine, the <version> tag
405 after the appropriate <protocol> tag has to be looked for.
407 * New interface gpgme_engine_check_version(), obsoleting
408 gpgme_check_engine(). Check the version of all engines you are
409 supporting in your software.
411 * GpgmeKey lists the user ids in the order as they are returned by
412 GnuPG, first the primary key with index 0, then the sub-user ids.
414 * New operation gpgme_op_decrypt_verify() to decrypt and verify
415 signatures simultaneously.
417 * The new interface gpgme_op_keylist_end() terminates a pending
418 keylist operation. A keylist operation is also terminated when
419 gpgme_op_keylist_next() returns GPGME_EOF.
421 * GPGME can be compiled without GnuPG being installed (`--with-gpg=PATH'),
422 cross-compiled, or even compiled without support for GnuPG
425 * GPGME can be compiled with support for GpgSM (GnuPG for S/MIME,
426 `--with-gpgsm=PATH'). It is enabled by default if the `gpgsm' is found
427 in the path, but it can also be compiled without support for GpgSM
430 * CryptPlug modules for GPGME are included and can be enabled at
431 configure time (`--enable-gpgmeplug'). There is one module which
432 uses the GnuPG engine (`gpgmeplug') and one module which uses the
433 GpgSM engine (`gpgsmplug').
435 * Interface changes relative to the latest 0.2.x release:
436 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
437 gpgme_key_get_as_xml CHANGED: Sub-user ids reversed in order.
438 gpgme_key_get_string_attr CHANGED: User ids reversed in order.
439 gpgme_key_get_ulong_attr CHANGED: User ids reversed in order.
440 gpgme_get_engine_info CHANGED: New format, extended content.
441 gpgme_engine_check_version NEW
442 gpgme_decrypt_verify_start NEW
443 gpgme_decrypt_verify NEW
444 gpgme_op_keylist_next NEW
445 gpgme_set_protocol NEW
446 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
449 Noteworthy changes in version 0.2.3 (2001-09-17)
450 ------------------------------------------------
452 * New function gpgme_get_op_info which can be used to get the micalg
453 parameter needed for MOSS.
455 * New functions gpgme_get_armor and gpgme_get_textmode.
457 * The usual bug fixes and some minor functionality improvements.
459 * Added a simple encryption component for MS-Windows; however the
460 build procedure might have some problems.
463 Noteworthy changes in version 0.2.2 (2001-06-12)
464 ------------------------------------------------
466 * Implemented a key cache.
468 * Fixed a race condition under W32 and some other bug fixes.
471 Noteworthy changes in version 0.2.1 (2001-04-02)
472 ------------------------------------------------
474 * Changed debug output and GPGME_DEBUG variable (gpgme/debug.c)
476 * Handle GnuPG's new key capabilities output and support revocation
479 * Made the W32 support more robust.
482 Copyright 2001, 2002 g10 Code GmbH
484 This file is free software; as a special exception the author gives
485 unlimited permission to copy and/or distribute it, with or without
486 modifications, as long as this notice is preserved.
488 This file is distributed in the hope that it will be useful, but
489 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
490 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.