1 Noteworthy changes in version 0.4.6 (2004-04-06)
2 ------------------------------------------------
7 Noteworthy changes in version 0.4.5 (2004-03-07)
8 ------------------------------------------------
10 * GPGME is now compiled with LFS (large file support) by default.
11 This means that _all_ programs using GPGME must be compiled with
12 LFS support enabled by default. You can do this easily with
13 autoconf, by using the AC_SYS_LARGEFILE macro. Or you can do this
14 without autoconf by defining the preprocessor symbol
15 _FILE_OFFSET_BITS to 64 (by passing the -D_FILE_OFFSET_BITS=64 to
16 the C compiler command line, or by defining this preprocessor
17 symbol before including any system header files). For more
18 details, read the section on LFS in the manual.
20 Up to now, it was undocumented that GPGME was not using LFS.
21 But the public interfaces use off_t, and file descriptors are
22 exchanged between the application and GPGME. This was an oversight,
23 and bound to cause troubles in the future.
25 Writing GPGME as a dual mode library that seamlessly supports LFS
26 while keeping backwards compatibility is possible, but does not
27 solve the problem: Many applications already expect GPGME to have
28 LFS (they are compiled with off_t being a 64bit value). This is true
29 in particular for the popular Gtk+ and Qt programs.
31 So, although this is an ABI (but not an API) break, we will not
32 change the library version to reflect that. Because the interfaces
33 affected are probably not used yet in any GPGME 0.4 based
34 application, we don't expect any real failures from this change.
35 In fact, applications already using LFS will have some subtle bugs
38 However, if you encounter an application using GPGME 0.4.x that
39 does _not_ use LFS by default (off_t is a 32bit value), _and_
40 uses at least one of the functions gpgme_data_seek,
41 gpgme_data_new_from_filepart, or a gpgme_data_seek_cb_t with
42 gpgme_data_new_from_cbs, then indeed this library will be ABI
43 incompatible with the program. As said above, we don't believe
44 such a program exists. If we are in error, then you have two
45 options: As a quick hack, you can configure GPGME with the
46 --disable-largefile option. This will revert the change, and GPGME
47 will not use LFS. However, GPGME will be incompatible with
48 programs that expect GPGME to use LFS. All applications are
49 required to use LFS when using GPGME, so this is only good as a
50 temporary local work-around.
52 The other option is to change the versioning of the library and
53 recompile all applications. We have reserved a special version of
54 the library for that, so you can do that without expecting a
55 version clash in the future. Furthermore, everyone who does this
56 will agree on the version to use (this is important for
57 distribution makers). Read the comment in configure.ac (before
58 LIBGPGME_LT_AGE) if you want to do this. Please don't do this
59 blindly: As stated above, we think it is unlikely this measure is
60 needed. Still, it is there if necessary. If in doubt, contact us
61 and we will give our advise for your specific situation.
63 * New key listing mode GPGME_KEYLIST_MODE_VALIDATE for validation of
66 * New interface gpgme_cancel() that can be used to cancel
67 asynchronous operations.
69 * Interface changes relative to the 0.4.4 release:
70 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71 gpgme_data_seek_cb_t CHANGED: off_t is now a largefile type.
72 gpgme_data_seek CHANGED: off_t is now a largefile type.
73 gpgme_data_new_from_filepart CHANGED: off_t is now a largefile type.
74 GPGME_KEYLIST_MODE_VALIDATE NEW
76 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
78 Noteworthy changes in version 0.4.4 (2004-01-12)
79 ------------------------------------------------
81 * The member "class" in gpgme_key_sig_t and gpgme_new_signature_t has
82 been renamed to "sig_class", to avoid clash with C++ compilers. In
83 the C API, the old name "class" has been preserved for backwards
84 compatibility, but is deprecated.
86 * Interface changes relative to the 0.4.3 release:
87 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
88 gpgme_key_sig_t CHANGED: class deprecated, use new sig_class.
89 gpgme_new_signature_t CHANGED: class deprecated, use new sig_class.
90 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92 Noteworthy changes in version 0.4.3 (2003-10-06)
93 ------------------------------------------------
95 * libgpgme should not be used for threaded programs anymore. This
96 never worked reliably in all cases, because you had to
97 be careful about the linking order and libtool wouldn't do that for
98 you automatically. Instead, now you have to link against
99 libgpgme-pthread for applications using pthread and libgpgme-pth for
100 applications using GNU Pth.
102 The old code for automagically detecting the thread library is
103 still part of libgpgme, but it is DEPRECATED.
105 * There are new automake macros AM_PATH_GPGME_PTH and
106 AM_PATH_GPGME_PTHREAD, which support checking for thread-enabled
107 versions of GPGME. They define GPGME_PTH_CFLAGS, GPGME_PTH_LIBS,
108 GPGME_PTHREAD_CFLAGS and GPGME_PTHREAD_LIBS respectively. These
109 variables of course also include the configuration for the thread
110 package itself. Alternatively, use libtool.
112 * gpgme_strerror_r as a thread safe variant of gpgme_strerror was
115 * gpgme-config doesn't support setting the prefix or exec prefix
116 anymore. I don't think it ever worked correctly, and it seems to
119 * gpgme_get_key fails with GPG_ERR_AMBIGUOUS_NAME if the key ID
120 provided was not unique, instead returning the first matching key.
122 * gpgme_key_t and gpgme_subkey_t have a new field, can_authenticate,
123 that indicates if the key can be used for authentication.
125 * gpgme_signature_t's status field is now correctly set to an error
126 with error code GPG_ERR_NO_PUBKEY if public key is not found.
128 * gpgme_new_signature_t's class field is now an unsigned int, rather
129 than an unsigned long (the old class field is preserved for
130 backwards compatibility).
132 * A new function gpgme_set_locale() is provided to allow configuring
133 the locale for the crypto backend. This is necessary for text
134 terminals so that programs like the pinentry can be started with
135 the right locale settings for the terminal the application is running
136 on, in case the terminal has different settings than the system
137 default (for example, if it is a remote terminal). You are highly
138 recommended to call the following functions directly after
143 setlocale (LC_ALL, "");
144 gpgme_set_locale (NULL, LC_CTYPE, setlocale (LC_CTYPE, NULL));
145 gpgme_set_locale (NULL, LC_MESSAGES, setlocale (LC_MESSAGES, NULL));
147 GPGME can not do this for you, as setlocale is not thread safe, and
148 there is no alternative.
150 * The signal action for SIGPIPE is now set to SIG_IGN by
151 gpgme_check_version, instead the first time a crypto engine is
152 started (which is not well defined).
154 * In the output of gpgme_hash_algo_name, change RMD160 to RIPEMD160,
155 TIGER to TIGER192, CRC32-RFC1510 to CRC32RFC1510, and CRC24-RFC2440
156 to CRC24RFC2440. For now, these strings can be used as the MIC
157 parameter for PGP/MIME (if appropriately modified).
159 * Interface changes relative to the 0.4.2 release:
160 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
162 gpgme_get_key CHANGED: Fails correctly if key ID not unique.
163 gpgme_key_t EXTENDED: New field can_authenticate.
164 gpgme_subkey_t EXTENDED: New field can_authenticate.
165 gpgme_new_signature_t CHANGED: New type for class field.
167 gpgme_hash_algo_name CHANGED: Slight adjustment of algo names.
168 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
170 Noteworthy changes in version 0.4.2 (2003-07-30)
171 ------------------------------------------------
173 * Allow gpg-error to be in non-standard place when linking the test suite.
175 * Configure will fail now if gpg-error can not be found.
177 * Fixed initialized memory backed data objects for writing, which
178 caused the test program to crash (but only on Mac OS, surprisingly).
180 * Eliminate use of C99 constructs.
182 * Small improvements to the manual.
185 Noteworthy changes in version 0.4.1 (2003-06-06)
186 ------------------------------------------------
188 This is the release that 0.4.0 should have been. There are many
189 interface changes, please see below for the details. The changes are
190 sometimes the result of new functionality, but more often express a
191 paradigm shift. Others are an overdue cleanup to get GPGME in line
192 with the GNU coding standards and to make the interface more
193 self-consistent. Here is an overview on the changes:
195 All types have been renamed to conform to the GNU coding standards,
196 most of the time by keeping the whole name in lowercase and inserting
197 underscores between words.
199 All operations consistently only accept input parameters in their
200 invocation function, and return only an error code directly. Further
201 information about the result of the operation has to be retrieved
202 afterwards by calling one of the result functions. This unifies the
203 synchronous and the asynchronous interface.
205 The error values have been completely replaced by a more
206 sophisticated model that allows GPGME to transparently and accurately
207 report all errors from the other GnuPG components, irregardless of
208 process boundaries. This is achieved by using the library
209 libgpg-errors, which is shared by all GnuPG components. This library
210 is now required for GPGME.
212 The results of all operations are now provided by pointers to C
213 structs rather than by XML structs or in other ways.
215 Objects which used to be opaque (for example a key) are now pointers
216 to accessible structs, so no accessor functions are necessary.
218 Backward compatibility is provided where it was possible without too
219 much effort and did not collide with the overall sanitization effort.
220 However, this is only for ease of transition. NO DEPRECATED FUNCTION
221 OR DATA TYPE IS CONSIDERED A PART OF THE API OR ABI AND WILL BE
222 DROPPED IN THE FUTURE WITHOUT CHANGING THE SONAME OF THE LIBRARY.
223 Recommendations how to replace deprecated or removed functionality
224 can be found within the description of each change.
226 What follows are all changes to the interface and behaviour of GPGME
229 * If gpgme.h is included in sources compiled by GCC 3.1 or later,
230 deprecated attributes will warn about use of obsolete functions and
231 type definitions. You can suppress these warnings by passing
232 -Wno-deprecated-declarations to the gcc command.
234 * The following types have been renamed. The old types are still
235 available as aliases, but they are deprecated now:
238 GpgmeData gpgme_data_t
239 GpgmeError gpgme_error_t
240 GpgmeDataEncoding gpgme_data_encoding_t
241 GpgmeSigStat gpgme_sig_stat_t
242 GpgmeSigMode gpgme_sig_mode_t
243 GpgmeAttr gpgme_attr_t
244 GpgmeValidity gpgme_validity_t
245 GpgmeProtocol gpgme_protocol_t
247 GpgmePassphraseCb gpgme_passphrase_cb_t
248 GpgmeProgressCb gpgme_progress_cb_t
249 GpgmeIOCb gpgme_io_cb_t
250 GpgmeRegisterIOCb gpgme_register_io_cb_t
251 GpgmeRemoveIOCb gpgme_remove_io_cb_t
252 GpgmeEventIO gpgme_event_io_t
253 GpgmeEventIOCb gpgme_event_io_cb_t
254 GpgmeIOCbs gpgme_io_cbs
255 GpgmeDataReadCb gpgme_data_read_cb_t
256 GpgmeDataWriteCb gpgme_data_write_cb_t
257 GpgmeDataSeekCb gpgme_data_seek_cb_t
258 GpgmeDataReleaseCb gpgme_data_release_cb_t
259 GpgmeDataCbs gpgme_data_cbs_t
260 GpgmeTrustItem gpgme_trust_item_t
261 GpgmeStatusCode gpgme_status_code_t
263 * gpgme_error_t is now identical to gpg_error_t, the error type
264 provided by libgpg-error. More about using libgpg-error with GPGME
265 can be found in the manual. All error symbols have been removed!
267 * All functions and types in libgpg-error have been wrapped in GPGME.
268 The new types are gpgme_err_code_t and gpgme_err_source_t. The new
269 functions are gpgme_err_code, gpgme_err_source, gpgme_error,
270 gpgme_err_make, gpgme_error_from_errno, gpgme_err_make_from_errno,
271 gpgme_err_code_from_errno, gpgme_err_code_to_errno,
274 * GPGME_ATTR_IS_SECRET is not anymore representable as a string.
276 * GnuPG 1.2.2 is required. The progress callback is now also invoked
277 for encrypt, sign, encrypt-sign, decrypt, verify, and
278 decrypt-verify operations. For verify operations on detached
279 signatures, the progress callback is invoked for both the detached
280 signature and the plaintext message, though.
282 * gpgme_passphrase_cb_t has been changed to not provide a complete
283 description, but the UID hint, passphrase info and a flag
284 indicating if this is a repeated attempt individually, so the user
285 can compose his own description from this information.
287 The passphrase is not returned as a C string, but must be written
288 to a file descriptor directly. This allows for secure passphrase
291 The return type has been changed to gpgme_error_t value. This
292 allowed to remove the gpgme_cancel function; just return
293 the error code GPG_ERR_CANCELED in the passphrase callback directly.
295 * gpgme_edit_cb_t has been changed to take a file descriptor argument.
296 The user is expected to write the response to the file descriptor,
297 followed by a newline.
299 * The recipients interface has been removed. Instead, you use
300 NULL-terminated lists of keys for specifying the recipients of an
301 encryption operation. Use the new encryption flag
302 GPGME_ENCRYPT_ALWAYS_TRUST if you want to override the validity of
303 the keys (but note that in general this is not a good idea).
305 This change has been made to the prototypes of gpgme_op_encrypt,
306 gpgme_op_encrypt_start, gpgme_op_encrypt_sign and
307 gpgme_op_encrypt_sign_start.
309 The export interface has been changed to use pattern strings like
310 the keylist interface. Thus, new functions gpgme_op_export_ext and
311 gpgme_op_export_ext_start have been added as well. Now the
312 prototypes of gpgme_op_export_start and gpgme_op_export finally
315 * gpgme_op_verify and gpgme_op_decrypt_verify don't return a status
316 summary anymore. Use gpgme_get_sig_status to retrieve the individual
319 * gpgme_io_cb_t changed from a void function to a function returning
320 a gpgme_error_t value. However, it will always return 0, so you
321 can safely ignore the return value.
323 * A new I/O callback event GPGME_EVENT_START has been added. The new
324 requirement is that you must wait until this event until you are
325 allowed to call the I/O callback handlers previously registered for
326 this context operation. Calling I/O callback functions for this
327 context operation before the start event happened is unsafe because
328 it can lead to race conditions in a multi-threaded environment.
330 * The idle function feature has been removed. It was not precisely
331 defined in a multi-threaded environment and is obsoleted by the
332 user I/O callback functions. If you still need a simple way to
333 call something while waiting on one or multiple asynchronous
334 operations to complete, don't set the HANG flag in gpgme_wait (note
335 that this will return to your program more often than the idle
338 * gpgme_wait can return NULL even if hang is true, if an error
339 occurs. In that case *status contains the error code.
341 * gpgme_get_engine_info was radically changed. Instead an XML
342 string, an info structure of the new type gpgme_engine_info_t is
343 returned. This makes it easier and more robust to evaluate the
344 information in an application.
346 * The new function gpgme_get_protocol_name can be used to convert a
347 gpgme_protocol_t value into a string.
349 * The status of a context operation is not checked anymore. Starting
350 a new operation will silently cancel the previous one. Calling a
351 function that requires you to have started an operation before without
352 doing so is undefined.
354 * The FPR argument to gpgme_op_genkey was removed. Instead, use the
355 gpgme_op_genkey_result function to retrieve a gpgme_genkey_result_t
356 pointer to a structure which contains the fingerprint. This also
357 works with gpgme_op_genkey_start. The structure also provides
358 other information about the generated keys.
363 err = gpgme_op_genkey (ctx, NULL, NULL, &fpr);
365 printf ("%s\n", fpr);
369 gpgme_genkey_result_t result;
370 err = gpgme_op_genkey (ctx, NULL, NULL);
373 result = gpgme_op_genkey_result (ctx);
375 printf ("%s\n", result->fpr);
378 * The new gpgme_op_import_result function provides detailed
379 information about the result of an import operation in
380 gpgme_import_result_t and gpgme_import_status_t objects.
381 Thus, the gpgme_op_import_ext variant is deprecated.
383 * The new gpgme_op_sign_result function provides detailed information
384 about the result of a signing operation in gpgme_sign_result_t,
385 gpgme_invalid_key_t and gpgme_new_signature_t objects.
387 * The new gpgme_op_encrypt_result function provides detailed
388 information about the result of an encryption operation in
389 a GpgmeEncryptResult object.
391 * The new gpgme_op_decrypt_result function provides detailed
392 information about the result of a decryption operation in
393 a GpgmeDecryptResult object.
395 * The new gpgme_op_verify_result function provides detailed
396 information about the result of an verify operation in
397 a GpgmeVerifyResult object. Because of this, the GPGME_SIG_STAT_*
398 values, gpgme_get_sig_status, gpgme_get_sig_ulong_attr,
399 gpgme_get_sig_string_attr and gpgme_get_sig_key are now deprecated,
400 and gpgme_get_notation is removed.
402 * GpgmeTrustItem objects have now directly accessible data, so the
403 gpgme_trust_item_get_string_attr and gpgme_trust_item_get_ulong_attr
404 accessor functions are deprecated. Also, reference counting is
405 available through gpgme_trust_item_ref and gpgme_trust_item_unref
406 (the gpgme_trust_item_release alias for the latter is deprecated).
408 * Keys are not cached internally anymore, so the force_update argument
409 to gpgme_get_key has been removed.
411 * GpgmeKey objects have now directly accessible data so the
412 gpgme_key_get_string_attr, gpgme_key_get_ulong_attr,
413 gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
414 functions are deprecated. Also, gpgme_key_release is now
415 deprecated. The gpgme_key_get_as_xml function has been dropped.
417 * Because all interfaces using attributes are deprecated, the
418 GpgmeAttr data type is also deprecated.
420 * The new gpgme_op_keylist_result function provides detailed
421 information about the result of a key listing operation in
422 a GpgmeKeyListResult object.
424 * Now that each function comes with its own result retrieval
425 interface, the generic gpgme_get_op_info interface is not useful
428 * The type and mode of data objects is not available anymore.
430 * Interface changes relative to the 0.4.0 release:
431 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
432 GpgmeCtx DEPRECATED: Use gpgme_ctx_t.
433 GpgmeData DEPRECATED: Use gpgme_data_t.
434 GpgmeError DEPRECATED: Use gpgme_error_t.
435 GpgmeDataEncoding DEPRECATED: Use gpgme_data_encoding_t.
436 GpgmeSigStat DEPRECATED: Use gpgme_sig_stat_t.
437 GpgmeSigMode DEPRECATED: Use gpgme_sig_mode_t.
438 GpgmeAttr DEPRECATED: Use gpgme_attr_t.
439 GpgmeValidity DEPRECATED: Use gpgme_validity_t.
440 GpgmeProtocol DEPRECATED: Use gpgme_protocol_t.
441 GpgmeKey DEPRECATED: Use gpgme_key_t.
442 GpgmePassphraseCb DEPRECATED: Use gpgme_passphrase_cb_t.
443 GpgmeProgressCb DEPRECATED: Use gpgme_progress_cb_t.
444 GpgmeIOCb DEPRECATED: Use gpgme_io_cb_t.
445 GpgmeRegisterIOCb DEPRECATED: Use gpgme_register_io_cb_t.
446 GpgmeRemoveIOCb DEPRECATED: Use gpgme_remove_io_cb_t.
447 GpgmeEventIO DEPRECATED: Use gpgme_event_io_t.
448 GpgmeEventIOCb DEPRECATED: Use gpgme_event_io_cb_t.
449 GpgmeIOCbs DEPRECATED: Use gpgme_io_cbs.
450 GpgmeDataReadCb DEPRECATED: Use gpgme_data_read_cb_t.
451 GpgmeDataWriteCb DEPRECATED: Use gpgme_data_write_cb_t.
452 GpgmeDataSeekCb DEPRECATED: Use gpgme_data_seek_cb_t.
453 GpgmeDataReleaseCb DEPRECATED: Use gpgme_data_release_cb_t.
454 GpgmeDataCbs DEPRECATED: Use gpgme_data_cbs_t.
455 GpgmeTrustItem DEPRECATED: Use gpgme_trust_item_t.
456 GpgmeStatusCode DEPRECATED: Use gpgme_status_code_t.
459 gpgme_recipients_t NEW
461 gpgme_data_encoding_t NEW
468 gpgme_passphrase_cb_t NEW
469 gpgme_progress_cb_t NEW
471 gpgme_register_io_cb_t NEW
472 gpgme_remove_io_cb_t NEW
474 gpgme_event_io_cb_t NEW
476 gpgme_data_read_cb_t NEW
477 gpgme_data_write_cb_t NEW
478 gpgme_data_seek_cb_t NEW
479 gpgme_data_release_cb_t NEW
481 gpgme_trust_item_t NEW
482 gpgme_status_code_t NEW
483 GPGME_{some error code} REMOVED! Use GPG_ERR_* from libgpg-error.
485 gpgme_err_source_t NEW
490 gpgme_error_from_errno NEW
491 gpgme_err_make_from_errno NEW
492 gpgme_err_code_from_errno NEW
493 gpgme_err_code_to_errno NEW
495 gpgme_io_cb_t CHANGED: Return type from void to GpgmeError.
496 gpgme_event_io_t CHANGED: New event type (all numbers changed).
497 gpgme_passphrase_cb_t CHANGED: Desc decomposed, write directly to FD.
498 gpgme_edit_cb_t CHANGED: Write directly to FD.
499 gpgme_key_get_string_attr CHANGED: Don't handle GPGME_ATTR_IS_SECRET.
500 gpgme_op_verify CHANGED: Drop R_STAT argument.
501 gpgme_op_decrypt_verify CHANGED: Drop R_STAT argument.
502 gpgme_wait CHANGED: Can return NULL even if hang is true.
503 GpgmeIdleFunc REMOVED
504 gpgme_register_idle REMOVED
505 GpgmeRecipients REMOVED
506 gpgme_recipients_new REMOVED
507 gpgme_recipients_release REMOVED
508 gpgme_recipients_add_name REMOVED
509 gpgme_recipients_add_name_with_validity REMOVED
510 gpgme_recipients_count REMOVED
511 gpgme_recipients_enum_open REMOVED
512 gpgme_recipients_enum_read REMOVED
513 gpgme_recipients_enum_close REMOVED
514 gpgme_encrypt_flags_t NEW
515 GPGME_ENCRYPT_ALWAYS_TRUST NEW
516 gpgme_op_encrypt CHANGED: Recipients passed as gpgme_key_t[].
517 gpgme_op_encrypt_start CHANGED: Recipients passed as gpgme_key_t[].
518 gpgme_op_encrypt_sign CHANGED: Recipients passed as gpgme_key_t[].
519 gpgme_op_encrypt_sign_start CHANGED: Recipients passed as gpgme_key_t[].
520 gpgme_op_export_start CHANGED: User IDs passed as patterns.
521 gpgme_op_export CHANGED: User IDs passed as patterns.
522 gpgme_op_export_ext_start NEW
523 gpgme_op_export_ext NEW
524 gpgme_keylist_mode_t NEW
526 gpgme_engine_info_t NEW
527 gpgme_get_engine_info CHANGED: Return info structure instead XML.
528 gpgme_get_protocol_name NEW
529 gpgme_cancel REMOVED: Return error in callback directly.
530 gpgme_op_genkey CHANGED: FPR argument dropped.
531 gpgme_op_genkey_result NEW
532 gpgme_genkey_result_t NEW
533 gpgme_op_import_ext DEPRECATED: Use gpgme_op_import_result.
534 gpgme_op_import_result NEW
535 gpgme_import_status_t NEW
536 gpgme_import_result_t NEW
537 gpgme_pubkey_algo_t NEW
538 gpgme_hash_algo_t NEW
539 gpgme_invalid_key_t NEW
540 gpgme_new_signature_t NEW
541 gpgme_sign_result_t NEW
542 gpgme_op_sign_result NEW
543 gpgme_pubkey_algo_name NEW
544 gpgme_hash_algo_name NEW
545 gpgme_encrypt_result_t NEW
546 gpgme_op_encrypt_result NEW
547 gpgme_decrypt_result_t NEW
548 gpgme_op_decrypt_result NEW
549 gpgme_verify_result_t NEW
550 gpgme_op_verify_result NEW
551 gpgme_get_notation REMOVED: Access verify result directly instead.
552 gpgme_get_sig_key DEPRECATED: Use gpgme_get_key with fingerprint.
553 gpgme_get_sig_ulong_attr DEPRECATED: Use verify result directly.
554 gpgme_get_sig_string_attr DEPRECATED: Use verify result directly.
555 GPGME_SIG_STAT_* DEPRECATED: Use error value in sig status.
556 gpgme_get_sig_status DEPRECATED: Use verify result directly.
557 gpgme_trust_item_t CHANGED: Now has user accessible data members.
558 gpgme_trust_item_ref NEW
559 gpgme_trust_item_unref NEW
560 gpgme_trust_item_release DEPRECATED: Use gpgme_trust_item_unref.
561 gpgme_trust_item_get_string_attr DEPRECATED
562 gpgme_trust_item_get_ulong_attr DEPRECATED
563 gpgme_get_key CHANGED: Removed force_update argument.
567 gpgme_key_t CHANGED: Now has user accessible data members.
568 gpgme_key_get_string_attr DEPRECATED
569 gpgme_key_get_ulong_attr DEPRECATED
570 gpgme_key_sig_get_string_attr DEPRECATED
571 gpgme_key_sig_get_ulong_attr DEPRECATED
572 gpgme_key_get_as_xml REMOVED
573 gpgme_key_list_result_t NEW
574 gpgme_op_keylist_result NEW
575 gpgme_get_op_info REMOVED
576 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
578 Noteworthy changes in version 0.4.0 (2002-12-23)
579 ------------------------------------------------
581 * Key generation returns the fingerprint of the generated key.
583 * New convenience function gpgme_get_key.
585 * Supports signatures of user IDs in keys via the new
586 GPGME_KEYLIST_MODE_SIGS keylist mode and the
587 gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
588 interfaces. The XML info about a key also includes the signatures
591 * New data object interface, which is more flexible and transparent.
593 * Interface changes relative to the 0.3.9 release:
594 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
598 GpgmeDataReleaseCb NEW
600 gpgme_data_read CHANGED: Match read() closely.
601 gpgme_data_write CHANGED: Match write() closely.
603 gpgme_data_new_from_fd NEW
604 gpgme_data_new_from_stream NEW
605 gpgme_data_new_from_cbs NEW
606 gpgme_data_rewind DEPRECATED: Replaced by gpgme_data_seek().
607 gpgme_data_new_from_read_cb DEPRECATED: Replaced by gpgme_data_from_cbs().
608 gpgme_data_get_type REMOVED: No replacement.
609 gpgme_op_verify CHANGED: Take different data objects for
610 signed text and plain text.
611 gpgme_op_verify_start CHANGED: See gpgme_op_verify.
612 gpgme_check_engine REMOVED: Deprecated since 0.3.0.
613 gpgme_op_genkey CHANGED: New parameter FPR.
614 GPGME_KEYLIST_MODE_SIGS NEW
615 gpgme_key_sig_get_string_attr NEW
616 gpgme_key_sig_get_ulong_attr NEW
618 GPGME_ATTR_SIG_CLASS NEW
619 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
621 Noteworthy changes in version 0.3.15 (2003-02-18)
622 -------------------------------------------------
624 * The progress status is sent via the progress callbacks in
627 * Bug fix for signing operations with explicit signer settings for
630 Noteworthy changes in version 0.3.14 (2002-12-04)
631 -------------------------------------------------
633 * GPGME-Plug is now in its own package "cryptplug".
635 * Workaround for a setlocale problem. Fixed a segv related to not
636 correctly as closed marked file descriptors.
638 Noteworthy changes in version 0.3.13 (2002-11-20)
639 -------------------------------------------------
641 * Release due to changes in gpgmeplug.
643 Noteworthy changes in version 0.3.12 (2002-10-15)
644 -------------------------------------------------
646 * Fixed some bux with key listings.
648 * The development has been branched to clean up some API issues.
649 This 0.3 series will be kept for compatibility reasons; so do don't
652 Noteworthy changes in version 0.3.11 (2002-09-20)
653 -------------------------------------------------
657 Noteworthy changes in version 0.3.10 (2002-09-02)
658 -------------------------------------------------
660 * Setting the signing keys for the CMS protocol does now work.
662 * The signers setting is honoured by gpgme_op_edit.
664 Noteworthy changes in version 0.3.9 (2002-08-21)
665 ------------------------------------------------
667 * A spec file for creating RPMs has been added.
669 * An experimental interface to GnuPG's --edit-key functionality is
670 introduced, see gpgme_op_edit.
672 * The new gpgme_import_ext function provides a convenient access to
673 the number of processed keys.
675 * Interface changes relative to the 0.3.8 release:
676 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
679 gpgme_op_edit_start NEW
681 gpgme_op_import_ext NEW
682 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
684 Noteworthy changes in version 0.3.8 (2002-06-25)
685 ------------------------------------------------
687 * It is possible to use an outside event loop for the I/O to the
688 crypto engine by setting the I/O callbacks with gpgme_set_io_cbs.
690 * Interface changes relative to the 0.3.6 release:
691 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
693 GpgmeRegisterIOCb NEW
697 struct GpgmeIOCbs NEW
700 GPGME_ATTR_ERRTOK NEW
701 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
703 Noteworthy changes in version 0.3.7 (2002-06-04)
704 ------------------------------------------------
706 * GPGME_ATTR_OTRUST is implemented now.
708 * A first step toward thread safeness has been achieved, see the
709 documentation for details. Supported thread libraries are pthread
712 Noteworthy changes in version 0.3.6 (2002-05-03)
713 ------------------------------------------------
715 * All error output of the gpgsm backend is send to the bit bucket.
717 * The signature verification functions are extended. Instead of
718 always returning GPGME_SIG_STATUS_GOOD, the functions new codes for
719 expired signatures. 2 new functions may be used to retrieve more
720 detailed information like the signature expiration time and a
721 validity information of the key without an extra key looking.
723 * The current passphrase callback and progress meter callback can be
724 retrieved with the new functions gpgme_get_passphrase_cb and
725 gpgme_get_progress_cb respectively.
727 * Interface changes relative to the 0.3.5 release:
728 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
729 gpgme_get_passphrase_cb NEW
730 gpgme_get_progress_cb NEW
731 GpgmeDataEncoding NEW
732 gpgme_data_set_encoding NEW
733 gpgme_data_get_encoding NEW
734 GPGME_SIG_STAT_GOOD_EXP NEW
735 GPGME_SIG_STAT_GOOD_EXPKEY NEW
736 gpgme_op_verify CHANGED: Returns more status codes.
737 GPGME_ATTR_SIG_STATUS NEW
738 gpgme_get_sig_string_attr NEW
739 gpgme_get_sig_ulong_attr NEW
740 gpgme_get_protocol NEW
741 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
743 Noteworthy changes in version 0.3.5 (2002-04-01)
744 ------------------------------------------------
746 * gpgme_op_encrypt can be called with RECIPIENTS being 0. In this
747 case, symmetric encryption is performed. Note that this requires a
748 passphrase from the user.
750 * More information is returned for X.509 certificates.
752 * Interface changes relative to the 0.3.4 release:
753 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
754 gpgme_op_encrypt EXTENDED: Symmetric encryption possible
755 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
757 Noteworthy changes in version 0.3.4 (2002-03-04)
758 ------------------------------------------------
760 * gpgme_op_encrypt does now fail with GPGME_Invalid_Recipients if
761 some recipients have been invalid, whereas earlier versions
762 succeeded in this case. The plaintext is still encrypted for all valid
763 recipients, so the application might take this error as a hint that
764 the ciphertext is not usable for all requested recipients.
765 Information about invalid recipients is available with gpgme_get_op_info.
767 * gpgme_op_verify now allows to pass an uninitialized data object as
768 its plaintext argument to check for normal and cleartext
769 signatures. The plaintext is then returned in the data object.
771 * New interfaces gpgme_set_include_certs and gpgme_get_include_certs
772 to set and get the number of certifications to include in S/MIME
775 * New interfaces gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start
776 to encrypt and sign a message in a combined operation.
778 * New interface gpgme_op_keylist_ext_start to search for multiple patterns.
780 * gpgme_key_get_ulong_attr supports the GPGME_ATTR_EXPIRE attribute.
782 * Interface changes relative to the 0.3.3 release:
783 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
784 gpgme_op_encrypt CHANGED: Can fail with GPGME_Invalid_Recipients
785 gpgme_op_verify EXTENDED: Accepts uninitialized text argument
786 gpgme_key_get_ulong_attr EXTENDED: Supports GPGME_ATTR_EXPIRE
787 gpgme_set_include_certs NEW
788 gpgme_get_include_certs NEW
789 gpgme_op_encrypt_sign NEW
790 gpgme_op_encrypt_sign_start NEW
791 gpgme_op_keylist_ext_start NEW
792 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
794 Noteworthy changes in version 0.3.3 (2002-02-12)
795 ------------------------------------------------
797 * Fix the Makefile in jnlib.
799 * Fix the test suite (hopefully). It should clean up all its state
800 with `make check' now.
803 Noteworthy changes in version 0.3.2 (2002-02-10)
804 ------------------------------------------------
806 * Remove erroneous dependency on libgcrypt in jnlib.
809 Noteworthy changes in version 0.3.1 (2002-02-09)
810 ------------------------------------------------
812 * There is a Texinfo manual documenting the API.
814 * The gpgme_set_keylist_mode function returns an error, and changed
815 its meaning. It is no longer usable to select between normal and
816 fast mode (newer versions of GnuPG will always be fast), but
817 selects between local keyring, remote keyserver, or both.
818 For this, two new macros are defined, GPGME_KEYLIST_MODE_LOCAL
819 and GPGME_KEYLIST_MODE_EXTERN. To make it possible to modify the
820 current setting, a fucntion gpgme_get_keylist_mode was added to
821 retrieve the current mode.
823 * gpgme_wait accepts a new argument STATUS to return the error status
824 of the operation on the context. Its definition is closer to
825 waitpid() now than before.
827 * The LENGTH argument to gpgme_data_new_from_filepart changed its
828 type from off_t to the unsigned size_t.
830 * The R_HD argument to the GpgmePassphraseCb type changed its type
831 from void* to void**.
833 * New interface gpgme_op_trustlist_end() to match
834 gpgme_op_keylist_end().
836 * The CryptPlug modules have been renamed to gpgme-openpgp and
837 gpgme-smime, and they are installed in pkglibdir by `make install'.
839 * An idle function can be registered with gpgme_register_idle().
841 * The GpgSM backend supports key generation with gpgme_op_genkey().
843 * Interface changes relative to the 0.3.0 release:
844 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
845 gpgme_data_new_from_filepart CHANGED: Type of LENGTH is size_t.
846 GpgmePassphraseCb CHANGED: Type of R_HD is void **.
847 gpgme_wait CHANGED: New argument STATUS.
848 gpgme_set_keylist_mode CHANGED: Type of return value is GpgmeError.
849 The function has a new meaning!
850 gpgme_get_keylist_mode NEW
851 GPGME_KEYLIST_MODE_LOCAL NEW
852 GPGME_KEYLIST_MODE_EXTERN NEW
853 gpgme_op_trustlist_next NEW
855 gpgme_register_idle NEW
856 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
858 Noteworthy changes in version 0.3.0 (2001-12-19)
859 ------------------------------------------------
861 * New interface gpgme_set_protocol() to set the protocol and thus the
862 crypto engine to be used by the context. Currently, the OpenPGP
863 and the CMS protocols are supported. They are specified by the new
864 preprocessor symbols GPGME_PROTOCOL_OpenPGP and GPGME_PROTOCOL_CMS.
865 A new context uses the OpenPGP engine by default.
867 * gpgme_get_engine_info() returns information for all crypto engines
868 compiled into the library. The XML format has changed. To
869 reliably get the version of a crypto engine, the <version> tag
870 after the appropriate <protocol> tag has to be looked for.
872 * New interface gpgme_engine_check_version(), obsoleting
873 gpgme_check_engine(). Check the version of all engines you are
874 supporting in your software.
876 * GpgmeKey lists the user ids in the order as they are returned by
877 GnuPG, first the primary key with index 0, then the sub-user ids.
879 * New operation gpgme_op_decrypt_verify() to decrypt and verify
880 signatures simultaneously.
882 * The new interface gpgme_op_keylist_end() terminates a pending
883 keylist operation. A keylist operation is also terminated when
884 gpgme_op_keylist_next() returns GPGME_EOF.
886 * GPGME can be compiled without GnuPG being installed (`--with-gpg=PATH'),
887 cross-compiled, or even compiled without support for GnuPG
890 * GPGME can be compiled with support for GpgSM (GnuPG for S/MIME,
891 `--with-gpgsm=PATH'). It is enabled by default if the `gpgsm' is found
892 in the path, but it can also be compiled without support for GpgSM
895 * CryptPlug modules for GPGME are included and can be enabled at
896 configure time (`--enable-gpgmeplug'). There is one module which
897 uses the GnuPG engine (`gpgmeplug') and one module which uses the
898 GpgSM engine (`gpgsmplug').
900 * Interface changes relative to the latest 0.2.x release:
901 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
902 gpgme_key_get_as_xml CHANGED: Sub-user ids reversed in order.
903 gpgme_key_get_string_attr CHANGED: User ids reversed in order.
904 gpgme_key_get_ulong_attr CHANGED: User ids reversed in order.
905 gpgme_get_engine_info CHANGED: New format, extended content.
906 gpgme_engine_check_version NEW
907 gpgme_decrypt_verify_start NEW
908 gpgme_decrypt_verify NEW
909 gpgme_op_keylist_next NEW
910 gpgme_set_protocol NEW
911 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
914 Noteworthy changes in version 0.2.3 (2001-09-17)
915 ------------------------------------------------
917 * New function gpgme_get_op_info which can be used to get the micalg
918 parameter needed for MOSS.
920 * New functions gpgme_get_armor and gpgme_get_textmode.
922 * The usual bug fixes and some minor functionality improvements.
924 * Added a simple encryption component for MS-Windows; however the
925 build procedure might have some problems.
928 Noteworthy changes in version 0.2.2 (2001-06-12)
929 ------------------------------------------------
931 * Implemented a key cache.
933 * Fixed a race condition under W32 and some other bug fixes.
936 Noteworthy changes in version 0.2.1 (2001-04-02)
937 ------------------------------------------------
939 * Changed debug output and GPGME_DEBUG variable (gpgme/debug.c)
941 * Handle GnuPG's new key capabilities output and support revocation
944 * Made the W32 support more robust.
947 Copyright 2001, 2002, 2003, 2004 g10 Code GmbH
949 This file is free software; as a special exception the author gives
950 unlimited permission to copy and/or distribute it, with or without
951 modifications, as long as this notice is preserved.
953 This file is distributed in the hope that it will be useful, but
954 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
955 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.