1 Noteworthy changes in version 1.1.0 (unreleased)
2 ------------------------------------------------
4 * You can now configure the backend engine file name and home
5 directory to be used, as default and per context.
7 * Previousy, GPGME would use a default "include certs" of 1. This
8 has been changed. Now GPGME will use the crypto backend engines
9 default unless you set the value with gpgme_set_include_certs()
10 explicitely. A new macro GPGME_INCLUDE_CERTS_DEFAULT can be used
11 as a value to explicitely request the new default behaviour.
13 Because the default changes, this is a slight change of the API
14 semantics. We consider it to be a bug fix.
16 * Information about the recipients of an encrypted text is now
17 available at decryption time.
19 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 gpgme_set_engine_info NEW
21 gpgme_ctx_get_engine_info NEW
22 gpgme_ctx_set_engine_info NEW
23 gpgme_set_include_certs CHANGED DEFAULT
24 GPGME_INCLUDE_CERTS_DEFAULT NEW
26 gpgme_decrypt_result_t EXTENDED: New field recipients.
27 gpgme_verify_result_t EXTENDED: New fields pubkey_algo, hash_algo.
28 GPGME_STATUS_SIG_SUBPACKET NEW
29 GPGME_STATUS_NEED_PASSPHRASE_PIN NEW
30 GPGME_STATUS_SC_OP_FAILURE NEW
31 GPGME_STATUS_SC_OP_SUCCESS NEW
32 GPGME_STATUS_CARDCTRL NEW
33 GPGME_STATUS_BACKUP_KEY_CREATED NEW
34 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37 Noteworthy changes in version 1.0.2 (2004-12-28)
38 ------------------------------------------------
40 * Changed the license of the library to the GNU Lesser General Public
41 License (LGPL), version 2.1 or later.
44 Noteworthy changes in version 1.0.1 (2004-10-22)
45 ------------------------------------------------
50 Noteworthy changes in version 1.0.0 (2004-09-30)
51 ------------------------------------------------
53 * Version 1.0.0! We are proud to present you with a thoroughly
54 tested and stable version of the GPGME library. A big Thank You!
55 to all the people who made this possible.
57 The development will be branched into a stable 1.x.y series and the
60 * The gpgme.m4 macro supports checking the API version. Just prepend
61 it to the required version string, separated by a colon. For
62 example, this release has the version "1:1.0.0". The last release
63 to which this version is (mostly) ABI compatible is "1:0.4.2",
64 which is the default required version.
67 Noteworthy changes in version 0.9.0 (2004-06-08)
68 ------------------------------------------------
70 * The type gpgme_key_t has now a new field keylist_mode that contains
71 the keylist mode that was active at the time the key was retrieved.
73 * The type gpgme_decrypt_result_t has a new field "wrong_key_usage"
74 that contains a flag indicating that the key should not have been
77 * Verifying a signature of a revoked key gives the correct result now
78 (GPG_ERR_CERT_REVOKED error code).
80 * Clarified that the error code GPG_ERR_NO_DATA from the decrypt &
81 verify operations still allows you to look at the signature
84 * Clarified that patterns in keylisting operations have an upper
85 limit, and thus are not suited to list many keys at once by their
86 fingerprint. Also improve the error message if the pattern is too
87 long for the CMS protocol to handle.
89 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90 gpgme_key_t EXTENDED: New field keylist_mode.
91 gpgme_decrypt_result_t EXTENDED: New field wrong_key_usage.
92 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
95 Noteworthy changes in version 0.4.7 (2004-04-29)
96 ------------------------------------------------
98 * Correctly initialize the fields expired, revoked, invalid, and
99 disabled in the gpgme_key_t structures.
101 * A bug fix: The flag wrong_key_usage of gpgme_signature_t was
102 accidently of type int instead unsigned int.
104 * Interface changes relative to the 0.4.5 release:
105 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106 gpgme_signature_t CHANGED: wrong_key_usage is unsigned int now.
107 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
109 Noteworthy changes in version 0.4.6 (2004-04-06)
110 ------------------------------------------------
115 Noteworthy changes in version 0.4.5 (2004-03-07)
116 ------------------------------------------------
118 * GPGME is now compiled with LFS (large file support) by default.
119 This means that _all_ programs using GPGME must be compiled with
120 LFS support enabled by default. You can do this easily with
121 autoconf, by using the AC_SYS_LARGEFILE macro. Or you can do this
122 without autoconf by defining the preprocessor symbol
123 _FILE_OFFSET_BITS to 64 (by passing the -D_FILE_OFFSET_BITS=64 to
124 the C compiler command line, or by defining this preprocessor
125 symbol before including any system header files). For more
126 details, read the section on LFS in the manual.
128 Up to now, it was undocumented that GPGME was not using LFS.
129 But the public interfaces use off_t, and file descriptors are
130 exchanged between the application and GPGME. This was an oversight,
131 and bound to cause troubles in the future.
133 Writing GPGME as a dual mode library that seamlessly supports LFS
134 while keeping backwards compatibility is possible, but does not
135 solve the problem: Many applications already expect GPGME to have
136 LFS (they are compiled with off_t being a 64bit value). This is true
137 in particular for the popular Gtk+ and Qt programs.
139 So, although this is an ABI (but not an API) break, we will not
140 change the library version to reflect that. Because the interfaces
141 affected are probably not used yet in any GPGME 0.4 based
142 application, we don't expect any real failures from this change.
143 In fact, applications already using LFS will have some subtle bugs
146 However, if you encounter an application using GPGME 0.4.x that
147 does _not_ use LFS by default (off_t is a 32bit value), _and_
148 uses at least one of the functions gpgme_data_seek,
149 gpgme_data_new_from_filepart, or a gpgme_data_seek_cb_t with
150 gpgme_data_new_from_cbs, then indeed this library will be ABI
151 incompatible with the program. As said above, we don't believe
152 such a program exists. If we are in error, then you have two
153 options: As a quick hack, you can configure GPGME with the
154 --disable-largefile option. This will revert the change, and GPGME
155 will not use LFS. However, GPGME will be incompatible with
156 programs that expect GPGME to use LFS. All applications are
157 required to use LFS when using GPGME, so this is only good as a
158 temporary local work-around.
160 The other option is to change the versioning of the library and
161 recompile all applications. We have reserved a special version of
162 the library for that, so you can do that without expecting a
163 version clash in the future. Furthermore, everyone who does this
164 will agree on the version to use (this is important for
165 distribution makers). Read the comment in configure.ac (before
166 LIBGPGME_LT_AGE) if you want to do this. Please don't do this
167 blindly: As stated above, we think it is unlikely this measure is
168 needed. Still, it is there if necessary. If in doubt, contact us
169 and we will give our advise for your specific situation.
171 * New key listing mode GPGME_KEYLIST_MODE_VALIDATE for validation of
174 * New interface gpgme_cancel() that can be used to cancel
175 asynchronous operations.
177 * Interface changes relative to the 0.4.4 release:
178 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
179 gpgme_data_seek_cb_t CHANGED: off_t is now a largefile type.
180 gpgme_data_seek CHANGED: off_t is now a largefile type.
181 gpgme_data_new_from_filepart CHANGED: off_t is now a largefile type.
182 GPGME_KEYLIST_MODE_VALIDATE NEW
184 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
186 Noteworthy changes in version 0.4.4 (2004-01-12)
187 ------------------------------------------------
189 * The member "class" in gpgme_key_sig_t and gpgme_new_signature_t has
190 been renamed to "sig_class", to avoid clash with C++ compilers. In
191 the C API, the old name "class" has been preserved for backwards
192 compatibility, but is deprecated.
194 * Interface changes relative to the 0.4.3 release:
195 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
196 gpgme_key_sig_t CHANGED: class deprecated, use new sig_class.
197 gpgme_new_signature_t CHANGED: class deprecated, use new sig_class.
198 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
200 Noteworthy changes in version 0.4.3 (2003-10-06)
201 ------------------------------------------------
203 * libgpgme should not be used for threaded programs anymore. This
204 never worked reliably in all cases, because you had to
205 be careful about the linking order and libtool wouldn't do that for
206 you automatically. Instead, now you have to link against
207 libgpgme-pthread for applications using pthread and libgpgme-pth for
208 applications using GNU Pth.
210 The old code for automagically detecting the thread library is
211 still part of libgpgme, but it is DEPRECATED.
213 * There are new automake macros AM_PATH_GPGME_PTH and
214 AM_PATH_GPGME_PTHREAD, which support checking for thread-enabled
215 versions of GPGME. They define GPGME_PTH_CFLAGS, GPGME_PTH_LIBS,
216 GPGME_PTHREAD_CFLAGS and GPGME_PTHREAD_LIBS respectively. These
217 variables of course also include the configuration for the thread
218 package itself. Alternatively, use libtool.
220 * gpgme_strerror_r as a thread safe variant of gpgme_strerror was
223 * gpgme-config doesn't support setting the prefix or exec prefix
224 anymore. I don't think it ever worked correctly, and it seems to
227 * gpgme_get_key fails with GPG_ERR_AMBIGUOUS_NAME if the key ID
228 provided was not unique, instead returning the first matching key.
230 * gpgme_key_t and gpgme_subkey_t have a new field, can_authenticate,
231 that indicates if the key can be used for authentication.
233 * gpgme_signature_t's status field is now correctly set to an error
234 with error code GPG_ERR_NO_PUBKEY if public key is not found.
236 * gpgme_new_signature_t's class field is now an unsigned int, rather
237 than an unsigned long (the old class field is preserved for
238 backwards compatibility).
240 * A new function gpgme_set_locale() is provided to allow configuring
241 the locale for the crypto backend. This is necessary for text
242 terminals so that programs like the pinentry can be started with
243 the right locale settings for the terminal the application is running
244 on, in case the terminal has different settings than the system
245 default (for example, if it is a remote terminal). You are highly
246 recommended to call the following functions directly after
251 setlocale (LC_ALL, "");
252 gpgme_set_locale (NULL, LC_CTYPE, setlocale (LC_CTYPE, NULL));
253 gpgme_set_locale (NULL, LC_MESSAGES, setlocale (LC_MESSAGES, NULL));
255 GPGME can not do this for you, as setlocale is not thread safe, and
256 there is no alternative.
258 * The signal action for SIGPIPE is now set to SIG_IGN by
259 gpgme_check_version, instead the first time a crypto engine is
260 started (which is not well defined).
262 * In the output of gpgme_hash_algo_name, change RMD160 to RIPEMD160,
263 TIGER to TIGER192, CRC32-RFC1510 to CRC32RFC1510, and CRC24-RFC2440
264 to CRC24RFC2440. For now, these strings can be used as the MIC
265 parameter for PGP/MIME (if appropriately modified).
267 * Interface changes relative to the 0.4.2 release:
268 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
270 gpgme_get_key CHANGED: Fails correctly if key ID not unique.
271 gpgme_key_t EXTENDED: New field can_authenticate.
272 gpgme_subkey_t EXTENDED: New field can_authenticate.
273 gpgme_new_signature_t CHANGED: New type for class field.
275 gpgme_hash_algo_name CHANGED: Slight adjustment of algo names.
276 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
278 Noteworthy changes in version 0.4.2 (2003-07-30)
279 ------------------------------------------------
281 * Allow gpg-error to be in non-standard place when linking the test suite.
283 * Configure will fail now if gpg-error can not be found.
285 * Fixed initialized memory backed data objects for writing, which
286 caused the test program to crash (but only on Mac OS, surprisingly).
288 * Eliminate use of C99 constructs.
290 * Small improvements to the manual.
293 Noteworthy changes in version 0.4.1 (2003-06-06)
294 ------------------------------------------------
296 This is the release that 0.4.0 should have been. There are many
297 interface changes, please see below for the details. The changes are
298 sometimes the result of new functionality, but more often express a
299 paradigm shift. Others are an overdue cleanup to get GPGME in line
300 with the GNU coding standards and to make the interface more
301 self-consistent. Here is an overview on the changes:
303 All types have been renamed to conform to the GNU coding standards,
304 most of the time by keeping the whole name in lowercase and inserting
305 underscores between words.
307 All operations consistently only accept input parameters in their
308 invocation function, and return only an error code directly. Further
309 information about the result of the operation has to be retrieved
310 afterwards by calling one of the result functions. This unifies the
311 synchronous and the asynchronous interface.
313 The error values have been completely replaced by a more
314 sophisticated model that allows GPGME to transparently and accurately
315 report all errors from the other GnuPG components, irregardless of
316 process boundaries. This is achieved by using the library
317 libgpg-errors, which is shared by all GnuPG components. This library
318 is now required for GPGME.
320 The results of all operations are now provided by pointers to C
321 structs rather than by XML structs or in other ways.
323 Objects which used to be opaque (for example a key) are now pointers
324 to accessible structs, so no accessor functions are necessary.
326 Backward compatibility is provided where it was possible without too
327 much effort and did not collide with the overall sanitization effort.
328 However, this is only for ease of transition. NO DEPRECATED FUNCTION
329 OR DATA TYPE IS CONSIDERED A PART OF THE API OR ABI AND WILL BE
330 DROPPED IN THE FUTURE WITHOUT CHANGING THE SONAME OF THE LIBRARY.
331 Recommendations how to replace deprecated or removed functionality
332 can be found within the description of each change.
334 What follows are all changes to the interface and behaviour of GPGME
337 * If gpgme.h is included in sources compiled by GCC 3.1 or later,
338 deprecated attributes will warn about use of obsolete functions and
339 type definitions. You can suppress these warnings by passing
340 -Wno-deprecated-declarations to the gcc command.
342 * The following types have been renamed. The old types are still
343 available as aliases, but they are deprecated now:
346 GpgmeData gpgme_data_t
347 GpgmeError gpgme_error_t
348 GpgmeDataEncoding gpgme_data_encoding_t
349 GpgmeSigStat gpgme_sig_stat_t
350 GpgmeSigMode gpgme_sig_mode_t
351 GpgmeAttr gpgme_attr_t
352 GpgmeValidity gpgme_validity_t
353 GpgmeProtocol gpgme_protocol_t
355 GpgmePassphraseCb gpgme_passphrase_cb_t
356 GpgmeProgressCb gpgme_progress_cb_t
357 GpgmeIOCb gpgme_io_cb_t
358 GpgmeRegisterIOCb gpgme_register_io_cb_t
359 GpgmeRemoveIOCb gpgme_remove_io_cb_t
360 GpgmeEventIO gpgme_event_io_t
361 GpgmeEventIOCb gpgme_event_io_cb_t
362 GpgmeIOCbs gpgme_io_cbs
363 GpgmeDataReadCb gpgme_data_read_cb_t
364 GpgmeDataWriteCb gpgme_data_write_cb_t
365 GpgmeDataSeekCb gpgme_data_seek_cb_t
366 GpgmeDataReleaseCb gpgme_data_release_cb_t
367 GpgmeDataCbs gpgme_data_cbs_t
368 GpgmeTrustItem gpgme_trust_item_t
369 GpgmeStatusCode gpgme_status_code_t
371 * gpgme_error_t is now identical to gpg_error_t, the error type
372 provided by libgpg-error. More about using libgpg-error with GPGME
373 can be found in the manual. All error symbols have been removed!
375 * All functions and types in libgpg-error have been wrapped in GPGME.
376 The new types are gpgme_err_code_t and gpgme_err_source_t. The new
377 functions are gpgme_err_code, gpgme_err_source, gpgme_error,
378 gpgme_err_make, gpgme_error_from_errno, gpgme_err_make_from_errno,
379 gpgme_err_code_from_errno, gpgme_err_code_to_errno,
382 * GPGME_ATTR_IS_SECRET is not anymore representable as a string.
384 * GnuPG 1.2.2 is required. The progress callback is now also invoked
385 for encrypt, sign, encrypt-sign, decrypt, verify, and
386 decrypt-verify operations. For verify operations on detached
387 signatures, the progress callback is invoked for both the detached
388 signature and the plaintext message, though.
390 * gpgme_passphrase_cb_t has been changed to not provide a complete
391 description, but the UID hint, passphrase info and a flag
392 indicating if this is a repeated attempt individually, so the user
393 can compose his own description from this information.
395 The passphrase is not returned as a C string, but must be written
396 to a file descriptor directly. This allows for secure passphrase
399 The return type has been changed to gpgme_error_t value. This
400 allowed to remove the gpgme_cancel function; just return
401 the error code GPG_ERR_CANCELED in the passphrase callback directly.
403 * gpgme_edit_cb_t has been changed to take a file descriptor argument.
404 The user is expected to write the response to the file descriptor,
405 followed by a newline.
407 * The recipients interface has been removed. Instead, you use
408 NULL-terminated lists of keys for specifying the recipients of an
409 encryption operation. Use the new encryption flag
410 GPGME_ENCRYPT_ALWAYS_TRUST if you want to override the validity of
411 the keys (but note that in general this is not a good idea).
413 This change has been made to the prototypes of gpgme_op_encrypt,
414 gpgme_op_encrypt_start, gpgme_op_encrypt_sign and
415 gpgme_op_encrypt_sign_start.
417 The export interface has been changed to use pattern strings like
418 the keylist interface. Thus, new functions gpgme_op_export_ext and
419 gpgme_op_export_ext_start have been added as well. Now the
420 prototypes of gpgme_op_export_start and gpgme_op_export finally
423 * gpgme_op_verify and gpgme_op_decrypt_verify don't return a status
424 summary anymore. Use gpgme_get_sig_status to retrieve the individual
427 * gpgme_io_cb_t changed from a void function to a function returning
428 a gpgme_error_t value. However, it will always return 0, so you
429 can safely ignore the return value.
431 * A new I/O callback event GPGME_EVENT_START has been added. The new
432 requirement is that you must wait until this event until you are
433 allowed to call the I/O callback handlers previously registered for
434 this context operation. Calling I/O callback functions for this
435 context operation before the start event happened is unsafe because
436 it can lead to race conditions in a multi-threaded environment.
438 * The idle function feature has been removed. It was not precisely
439 defined in a multi-threaded environment and is obsoleted by the
440 user I/O callback functions. If you still need a simple way to
441 call something while waiting on one or multiple asynchronous
442 operations to complete, don't set the HANG flag in gpgme_wait (note
443 that this will return to your program more often than the idle
446 * gpgme_wait can return NULL even if hang is true, if an error
447 occurs. In that case *status contains the error code.
449 * gpgme_get_engine_info was radically changed. Instead an XML
450 string, an info structure of the new type gpgme_engine_info_t is
451 returned. This makes it easier and more robust to evaluate the
452 information in an application.
454 * The new function gpgme_get_protocol_name can be used to convert a
455 gpgme_protocol_t value into a string.
457 * The status of a context operation is not checked anymore. Starting
458 a new operation will silently cancel the previous one. Calling a
459 function that requires you to have started an operation before without
460 doing so is undefined.
462 * The FPR argument to gpgme_op_genkey was removed. Instead, use the
463 gpgme_op_genkey_result function to retrieve a gpgme_genkey_result_t
464 pointer to a structure which contains the fingerprint. This also
465 works with gpgme_op_genkey_start. The structure also provides
466 other information about the generated keys.
471 err = gpgme_op_genkey (ctx, NULL, NULL, &fpr);
473 printf ("%s\n", fpr);
477 gpgme_genkey_result_t result;
478 err = gpgme_op_genkey (ctx, NULL, NULL);
481 result = gpgme_op_genkey_result (ctx);
483 printf ("%s\n", result->fpr);
486 * The new gpgme_op_import_result function provides detailed
487 information about the result of an import operation in
488 gpgme_import_result_t and gpgme_import_status_t objects.
489 Thus, the gpgme_op_import_ext variant is deprecated.
491 * The new gpgme_op_sign_result function provides detailed information
492 about the result of a signing operation in gpgme_sign_result_t,
493 gpgme_invalid_key_t and gpgme_new_signature_t objects.
495 * The new gpgme_op_encrypt_result function provides detailed
496 information about the result of an encryption operation in
497 a GpgmeEncryptResult object.
499 * The new gpgme_op_decrypt_result function provides detailed
500 information about the result of a decryption operation in
501 a GpgmeDecryptResult object.
503 * The new gpgme_op_verify_result function provides detailed
504 information about the result of an verify operation in
505 a GpgmeVerifyResult object. Because of this, the GPGME_SIG_STAT_*
506 values, gpgme_get_sig_status, gpgme_get_sig_ulong_attr,
507 gpgme_get_sig_string_attr and gpgme_get_sig_key are now deprecated,
508 and gpgme_get_notation is removed.
510 * GpgmeTrustItem objects have now directly accessible data, so the
511 gpgme_trust_item_get_string_attr and gpgme_trust_item_get_ulong_attr
512 accessor functions are deprecated. Also, reference counting is
513 available through gpgme_trust_item_ref and gpgme_trust_item_unref
514 (the gpgme_trust_item_release alias for the latter is deprecated).
516 * Keys are not cached internally anymore, so the force_update argument
517 to gpgme_get_key has been removed.
519 * GpgmeKey objects have now directly accessible data so the
520 gpgme_key_get_string_attr, gpgme_key_get_ulong_attr,
521 gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
522 functions are deprecated. Also, gpgme_key_release is now
523 deprecated. The gpgme_key_get_as_xml function has been dropped.
525 * Because all interfaces using attributes are deprecated, the
526 GpgmeAttr data type is also deprecated.
528 * The new gpgme_op_keylist_result function provides detailed
529 information about the result of a key listing operation in
530 a GpgmeKeyListResult object.
532 * Now that each function comes with its own result retrieval
533 interface, the generic gpgme_get_op_info interface is not useful
536 * The type and mode of data objects is not available anymore.
538 * Interface changes relative to the 0.4.0 release:
539 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
540 GpgmeCtx DEPRECATED: Use gpgme_ctx_t.
541 GpgmeData DEPRECATED: Use gpgme_data_t.
542 GpgmeError DEPRECATED: Use gpgme_error_t.
543 GpgmeDataEncoding DEPRECATED: Use gpgme_data_encoding_t.
544 GpgmeSigStat DEPRECATED: Use gpgme_sig_stat_t.
545 GpgmeSigMode DEPRECATED: Use gpgme_sig_mode_t.
546 GpgmeAttr DEPRECATED: Use gpgme_attr_t.
547 GpgmeValidity DEPRECATED: Use gpgme_validity_t.
548 GpgmeProtocol DEPRECATED: Use gpgme_protocol_t.
549 GpgmeKey DEPRECATED: Use gpgme_key_t.
550 GpgmePassphraseCb DEPRECATED: Use gpgme_passphrase_cb_t.
551 GpgmeProgressCb DEPRECATED: Use gpgme_progress_cb_t.
552 GpgmeIOCb DEPRECATED: Use gpgme_io_cb_t.
553 GpgmeRegisterIOCb DEPRECATED: Use gpgme_register_io_cb_t.
554 GpgmeRemoveIOCb DEPRECATED: Use gpgme_remove_io_cb_t.
555 GpgmeEventIO DEPRECATED: Use gpgme_event_io_t.
556 GpgmeEventIOCb DEPRECATED: Use gpgme_event_io_cb_t.
557 GpgmeIOCbs DEPRECATED: Use gpgme_io_cbs.
558 GpgmeDataReadCb DEPRECATED: Use gpgme_data_read_cb_t.
559 GpgmeDataWriteCb DEPRECATED: Use gpgme_data_write_cb_t.
560 GpgmeDataSeekCb DEPRECATED: Use gpgme_data_seek_cb_t.
561 GpgmeDataReleaseCb DEPRECATED: Use gpgme_data_release_cb_t.
562 GpgmeDataCbs DEPRECATED: Use gpgme_data_cbs_t.
563 GpgmeTrustItem DEPRECATED: Use gpgme_trust_item_t.
564 GpgmeStatusCode DEPRECATED: Use gpgme_status_code_t.
567 gpgme_recipients_t NEW
569 gpgme_data_encoding_t NEW
576 gpgme_passphrase_cb_t NEW
577 gpgme_progress_cb_t NEW
579 gpgme_register_io_cb_t NEW
580 gpgme_remove_io_cb_t NEW
582 gpgme_event_io_cb_t NEW
584 gpgme_data_read_cb_t NEW
585 gpgme_data_write_cb_t NEW
586 gpgme_data_seek_cb_t NEW
587 gpgme_data_release_cb_t NEW
589 gpgme_trust_item_t NEW
590 gpgme_status_code_t NEW
591 GPGME_{some error code} REMOVED! Use GPG_ERR_* from libgpg-error.
593 gpgme_err_source_t NEW
598 gpgme_error_from_errno NEW
599 gpgme_err_make_from_errno NEW
600 gpgme_err_code_from_errno NEW
601 gpgme_err_code_to_errno NEW
603 gpgme_io_cb_t CHANGED: Return type from void to GpgmeError.
604 gpgme_event_io_t CHANGED: New event type (all numbers changed).
605 gpgme_passphrase_cb_t CHANGED: Desc decomposed, write directly to FD.
606 gpgme_edit_cb_t CHANGED: Write directly to FD.
607 gpgme_key_get_string_attr CHANGED: Don't handle GPGME_ATTR_IS_SECRET.
608 gpgme_op_verify CHANGED: Drop R_STAT argument.
609 gpgme_op_decrypt_verify CHANGED: Drop R_STAT argument.
610 gpgme_wait CHANGED: Can return NULL even if hang is true.
611 GpgmeIdleFunc REMOVED
612 gpgme_register_idle REMOVED
613 GpgmeRecipients REMOVED
614 gpgme_recipients_new REMOVED
615 gpgme_recipients_release REMOVED
616 gpgme_recipients_add_name REMOVED
617 gpgme_recipients_add_name_with_validity REMOVED
618 gpgme_recipients_count REMOVED
619 gpgme_recipients_enum_open REMOVED
620 gpgme_recipients_enum_read REMOVED
621 gpgme_recipients_enum_close REMOVED
622 gpgme_encrypt_flags_t NEW
623 GPGME_ENCRYPT_ALWAYS_TRUST NEW
624 gpgme_op_encrypt CHANGED: Recipients passed as gpgme_key_t[].
625 gpgme_op_encrypt_start CHANGED: Recipients passed as gpgme_key_t[].
626 gpgme_op_encrypt_sign CHANGED: Recipients passed as gpgme_key_t[].
627 gpgme_op_encrypt_sign_start CHANGED: Recipients passed as gpgme_key_t[].
628 gpgme_op_export_start CHANGED: User IDs passed as patterns.
629 gpgme_op_export CHANGED: User IDs passed as patterns.
630 gpgme_op_export_ext_start NEW
631 gpgme_op_export_ext NEW
632 gpgme_keylist_mode_t NEW
634 gpgme_engine_info_t NEW
635 gpgme_get_engine_info CHANGED: Return info structure instead XML.
636 gpgme_get_protocol_name NEW
637 gpgme_cancel REMOVED: Return error in callback directly.
638 gpgme_op_genkey CHANGED: FPR argument dropped.
639 gpgme_op_genkey_result NEW
640 gpgme_genkey_result_t NEW
641 gpgme_op_import_ext DEPRECATED: Use gpgme_op_import_result.
642 gpgme_op_import_result NEW
643 gpgme_import_status_t NEW
644 gpgme_import_result_t NEW
645 gpgme_pubkey_algo_t NEW
646 gpgme_hash_algo_t NEW
647 gpgme_invalid_key_t NEW
648 gpgme_new_signature_t NEW
649 gpgme_sign_result_t NEW
650 gpgme_op_sign_result NEW
651 gpgme_pubkey_algo_name NEW
652 gpgme_hash_algo_name NEW
653 gpgme_encrypt_result_t NEW
654 gpgme_op_encrypt_result NEW
655 gpgme_decrypt_result_t NEW
656 gpgme_op_decrypt_result NEW
657 gpgme_verify_result_t NEW
658 gpgme_op_verify_result NEW
659 gpgme_get_notation REMOVED: Access verify result directly instead.
660 gpgme_get_sig_key DEPRECATED: Use gpgme_get_key with fingerprint.
661 gpgme_get_sig_ulong_attr DEPRECATED: Use verify result directly.
662 gpgme_get_sig_string_attr DEPRECATED: Use verify result directly.
663 GPGME_SIG_STAT_* DEPRECATED: Use error value in sig status.
664 gpgme_get_sig_status DEPRECATED: Use verify result directly.
665 gpgme_trust_item_t CHANGED: Now has user accessible data members.
666 gpgme_trust_item_ref NEW
667 gpgme_trust_item_unref NEW
668 gpgme_trust_item_release DEPRECATED: Use gpgme_trust_item_unref.
669 gpgme_trust_item_get_string_attr DEPRECATED
670 gpgme_trust_item_get_ulong_attr DEPRECATED
671 gpgme_get_key CHANGED: Removed force_update argument.
675 gpgme_key_t CHANGED: Now has user accessible data members.
676 gpgme_key_get_string_attr DEPRECATED
677 gpgme_key_get_ulong_attr DEPRECATED
678 gpgme_key_sig_get_string_attr DEPRECATED
679 gpgme_key_sig_get_ulong_attr DEPRECATED
680 gpgme_key_get_as_xml REMOVED
681 gpgme_key_list_result_t NEW
682 gpgme_op_keylist_result NEW
683 gpgme_get_op_info REMOVED
684 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
686 Noteworthy changes in version 0.4.0 (2002-12-23)
687 ------------------------------------------------
689 * Key generation returns the fingerprint of the generated key.
691 * New convenience function gpgme_get_key.
693 * Supports signatures of user IDs in keys via the new
694 GPGME_KEYLIST_MODE_SIGS keylist mode and the
695 gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
696 interfaces. The XML info about a key also includes the signatures
699 * New data object interface, which is more flexible and transparent.
701 * Interface changes relative to the 0.3.9 release:
702 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
706 GpgmeDataReleaseCb NEW
708 gpgme_data_read CHANGED: Match read() closely.
709 gpgme_data_write CHANGED: Match write() closely.
711 gpgme_data_new_from_fd NEW
712 gpgme_data_new_from_stream NEW
713 gpgme_data_new_from_cbs NEW
714 gpgme_data_rewind DEPRECATED: Replaced by gpgme_data_seek().
715 gpgme_data_new_from_read_cb DEPRECATED: Replaced by gpgme_data_from_cbs().
716 gpgme_data_get_type REMOVED: No replacement.
717 gpgme_op_verify CHANGED: Take different data objects for
718 signed text and plain text.
719 gpgme_op_verify_start CHANGED: See gpgme_op_verify.
720 gpgme_check_engine REMOVED: Deprecated since 0.3.0.
721 gpgme_op_genkey CHANGED: New parameter FPR.
722 GPGME_KEYLIST_MODE_SIGS NEW
723 gpgme_key_sig_get_string_attr NEW
724 gpgme_key_sig_get_ulong_attr NEW
726 GPGME_ATTR_SIG_CLASS NEW
727 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
729 Noteworthy changes in version 0.3.16 (2003-11-19)
730 -------------------------------------------------
732 * Compatibility fixes for GnuPG 1.9.x
734 Noteworthy changes in version 0.3.15 (2003-02-18)
735 -------------------------------------------------
737 * The progress status is sent via the progress callbacks in
740 * Bug fix for signing operations with explicit signer settings for
743 Noteworthy changes in version 0.3.14 (2002-12-04)
744 -------------------------------------------------
746 * GPGME-Plug is now in its own package "cryptplug".
748 * Workaround for a setlocale problem. Fixed a segv related to not
749 correctly as closed marked file descriptors.
751 Noteworthy changes in version 0.3.13 (2002-11-20)
752 -------------------------------------------------
754 * Release due to changes in gpgmeplug.
756 Noteworthy changes in version 0.3.12 (2002-10-15)
757 -------------------------------------------------
759 * Fixed some bux with key listings.
761 * The development has been branched to clean up some API issues.
762 This 0.3 series will be kept for compatibility reasons; so do don't
765 Noteworthy changes in version 0.3.11 (2002-09-20)
766 -------------------------------------------------
770 Noteworthy changes in version 0.3.10 (2002-09-02)
771 -------------------------------------------------
773 * Setting the signing keys for the CMS protocol does now work.
775 * The signers setting is honoured by gpgme_op_edit.
777 Noteworthy changes in version 0.3.9 (2002-08-21)
778 ------------------------------------------------
780 * A spec file for creating RPMs has been added.
782 * An experimental interface to GnuPG's --edit-key functionality is
783 introduced, see gpgme_op_edit.
785 * The new gpgme_import_ext function provides a convenient access to
786 the number of processed keys.
788 * Interface changes relative to the 0.3.8 release:
789 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
792 gpgme_op_edit_start NEW
794 gpgme_op_import_ext NEW
795 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
797 Noteworthy changes in version 0.3.8 (2002-06-25)
798 ------------------------------------------------
800 * It is possible to use an outside event loop for the I/O to the
801 crypto engine by setting the I/O callbacks with gpgme_set_io_cbs.
803 * Interface changes relative to the 0.3.6 release:
804 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
806 GpgmeRegisterIOCb NEW
810 struct GpgmeIOCbs NEW
813 GPGME_ATTR_ERRTOK NEW
814 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
816 Noteworthy changes in version 0.3.7 (2002-06-04)
817 ------------------------------------------------
819 * GPGME_ATTR_OTRUST is implemented now.
821 * A first step toward thread safeness has been achieved, see the
822 documentation for details. Supported thread libraries are pthread
825 Noteworthy changes in version 0.3.6 (2002-05-03)
826 ------------------------------------------------
828 * All error output of the gpgsm backend is send to the bit bucket.
830 * The signature verification functions are extended. Instead of
831 always returning GPGME_SIG_STATUS_GOOD, the functions new codes for
832 expired signatures. 2 new functions may be used to retrieve more
833 detailed information like the signature expiration time and a
834 validity information of the key without an extra key looking.
836 * The current passphrase callback and progress meter callback can be
837 retrieved with the new functions gpgme_get_passphrase_cb and
838 gpgme_get_progress_cb respectively.
840 * Interface changes relative to the 0.3.5 release:
841 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
842 gpgme_get_passphrase_cb NEW
843 gpgme_get_progress_cb NEW
844 GpgmeDataEncoding NEW
845 gpgme_data_set_encoding NEW
846 gpgme_data_get_encoding NEW
847 GPGME_SIG_STAT_GOOD_EXP NEW
848 GPGME_SIG_STAT_GOOD_EXPKEY NEW
849 gpgme_op_verify CHANGED: Returns more status codes.
850 GPGME_ATTR_SIG_STATUS NEW
851 gpgme_get_sig_string_attr NEW
852 gpgme_get_sig_ulong_attr NEW
853 gpgme_get_protocol NEW
854 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
856 Noteworthy changes in version 0.3.5 (2002-04-01)
857 ------------------------------------------------
859 * gpgme_op_encrypt can be called with RECIPIENTS being 0. In this
860 case, symmetric encryption is performed. Note that this requires a
861 passphrase from the user.
863 * More information is returned for X.509 certificates.
865 * Interface changes relative to the 0.3.4 release:
866 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
867 gpgme_op_encrypt EXTENDED: Symmetric encryption possible
868 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
870 Noteworthy changes in version 0.3.4 (2002-03-04)
871 ------------------------------------------------
873 * gpgme_op_encrypt does now fail with GPGME_Invalid_Recipients if
874 some recipients have been invalid, whereas earlier versions
875 succeeded in this case. The plaintext is still encrypted for all valid
876 recipients, so the application might take this error as a hint that
877 the ciphertext is not usable for all requested recipients.
878 Information about invalid recipients is available with gpgme_get_op_info.
880 * gpgme_op_verify now allows to pass an uninitialized data object as
881 its plaintext argument to check for normal and cleartext
882 signatures. The plaintext is then returned in the data object.
884 * New interfaces gpgme_set_include_certs and gpgme_get_include_certs
885 to set and get the number of certifications to include in S/MIME
888 * New interfaces gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start
889 to encrypt and sign a message in a combined operation.
891 * New interface gpgme_op_keylist_ext_start to search for multiple patterns.
893 * gpgme_key_get_ulong_attr supports the GPGME_ATTR_EXPIRE attribute.
895 * Interface changes relative to the 0.3.3 release:
896 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
897 gpgme_op_encrypt CHANGED: Can fail with GPGME_Invalid_Recipients
898 gpgme_op_verify EXTENDED: Accepts uninitialized text argument
899 gpgme_key_get_ulong_attr EXTENDED: Supports GPGME_ATTR_EXPIRE
900 gpgme_set_include_certs NEW
901 gpgme_get_include_certs NEW
902 gpgme_op_encrypt_sign NEW
903 gpgme_op_encrypt_sign_start NEW
904 gpgme_op_keylist_ext_start NEW
905 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
907 Noteworthy changes in version 0.3.3 (2002-02-12)
908 ------------------------------------------------
910 * Fix the Makefile in jnlib.
912 * Fix the test suite (hopefully). It should clean up all its state
913 with `make check' now.
916 Noteworthy changes in version 0.3.2 (2002-02-10)
917 ------------------------------------------------
919 * Remove erroneous dependency on libgcrypt in jnlib.
922 Noteworthy changes in version 0.3.1 (2002-02-09)
923 ------------------------------------------------
925 * There is a Texinfo manual documenting the API.
927 * The gpgme_set_keylist_mode function returns an error, and changed
928 its meaning. It is no longer usable to select between normal and
929 fast mode (newer versions of GnuPG will always be fast), but
930 selects between local keyring, remote keyserver, or both.
931 For this, two new macros are defined, GPGME_KEYLIST_MODE_LOCAL
932 and GPGME_KEYLIST_MODE_EXTERN. To make it possible to modify the
933 current setting, a fucntion gpgme_get_keylist_mode was added to
934 retrieve the current mode.
936 * gpgme_wait accepts a new argument STATUS to return the error status
937 of the operation on the context. Its definition is closer to
938 waitpid() now than before.
940 * The LENGTH argument to gpgme_data_new_from_filepart changed its
941 type from off_t to the unsigned size_t.
943 * The R_HD argument to the GpgmePassphraseCb type changed its type
944 from void* to void**.
946 * New interface gpgme_op_trustlist_end() to match
947 gpgme_op_keylist_end().
949 * The CryptPlug modules have been renamed to gpgme-openpgp and
950 gpgme-smime, and they are installed in pkglibdir by `make install'.
952 * An idle function can be registered with gpgme_register_idle().
954 * The GpgSM backend supports key generation with gpgme_op_genkey().
956 * Interface changes relative to the 0.3.0 release:
957 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
958 gpgme_data_new_from_filepart CHANGED: Type of LENGTH is size_t.
959 GpgmePassphraseCb CHANGED: Type of R_HD is void **.
960 gpgme_wait CHANGED: New argument STATUS.
961 gpgme_set_keylist_mode CHANGED: Type of return value is GpgmeError.
962 The function has a new meaning!
963 gpgme_get_keylist_mode NEW
964 GPGME_KEYLIST_MODE_LOCAL NEW
965 GPGME_KEYLIST_MODE_EXTERN NEW
966 gpgme_op_trustlist_next NEW
968 gpgme_register_idle NEW
969 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
971 Noteworthy changes in version 0.3.0 (2001-12-19)
972 ------------------------------------------------
974 * New interface gpgme_set_protocol() to set the protocol and thus the
975 crypto engine to be used by the context. Currently, the OpenPGP
976 and the CMS protocols are supported. They are specified by the new
977 preprocessor symbols GPGME_PROTOCOL_OpenPGP and GPGME_PROTOCOL_CMS.
978 A new context uses the OpenPGP engine by default.
980 * gpgme_get_engine_info() returns information for all crypto engines
981 compiled into the library. The XML format has changed. To
982 reliably get the version of a crypto engine, the <version> tag
983 after the appropriate <protocol> tag has to be looked for.
985 * New interface gpgme_engine_check_version(), obsoleting
986 gpgme_check_engine(). Check the version of all engines you are
987 supporting in your software.
989 * GpgmeKey lists the user ids in the order as they are returned by
990 GnuPG, first the primary key with index 0, then the sub-user ids.
992 * New operation gpgme_op_decrypt_verify() to decrypt and verify
993 signatures simultaneously.
995 * The new interface gpgme_op_keylist_end() terminates a pending
996 keylist operation. A keylist operation is also terminated when
997 gpgme_op_keylist_next() returns GPGME_EOF.
999 * GPGME can be compiled without GnuPG being installed (`--with-gpg=PATH'),
1000 cross-compiled, or even compiled without support for GnuPG
1003 * GPGME can be compiled with support for GpgSM (GnuPG for S/MIME,
1004 `--with-gpgsm=PATH'). It is enabled by default if the `gpgsm' is found
1005 in the path, but it can also be compiled without support for GpgSM
1006 (`--without-gpgsm').
1008 * CryptPlug modules for GPGME are included and can be enabled at
1009 configure time (`--enable-gpgmeplug'). There is one module which
1010 uses the GnuPG engine (`gpgmeplug') and one module which uses the
1011 GpgSM engine (`gpgsmplug').
1013 * Interface changes relative to the latest 0.2.x release:
1014 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1015 gpgme_key_get_as_xml CHANGED: Sub-user ids reversed in order.
1016 gpgme_key_get_string_attr CHANGED: User ids reversed in order.
1017 gpgme_key_get_ulong_attr CHANGED: User ids reversed in order.
1018 gpgme_get_engine_info CHANGED: New format, extended content.
1019 gpgme_engine_check_version NEW
1020 gpgme_decrypt_verify_start NEW
1021 gpgme_decrypt_verify NEW
1022 gpgme_op_keylist_next NEW
1023 gpgme_set_protocol NEW
1024 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1027 Noteworthy changes in version 0.2.3 (2001-09-17)
1028 ------------------------------------------------
1030 * New function gpgme_get_op_info which can be used to get the micalg
1031 parameter needed for MOSS.
1033 * New functions gpgme_get_armor and gpgme_get_textmode.
1035 * The usual bug fixes and some minor functionality improvements.
1037 * Added a simple encryption component for MS-Windows; however the
1038 build procedure might have some problems.
1041 Noteworthy changes in version 0.2.2 (2001-06-12)
1042 ------------------------------------------------
1044 * Implemented a key cache.
1046 * Fixed a race condition under W32 and some other bug fixes.
1049 Noteworthy changes in version 0.2.1 (2001-04-02)
1050 ------------------------------------------------
1052 * Changed debug output and GPGME_DEBUG variable (gpgme/debug.c)
1054 * Handle GnuPG's new key capabilities output and support revocation
1057 * Made the W32 support more robust.
1060 Copyright 2001, 2002, 2003, 2004 g10 Code GmbH
1062 This file is free software; as a special exception the author gives
1063 unlimited permission to copy and/or distribute it, with or without
1064 modifications, as long as this notice is preserved.
1066 This file is distributed in the hope that it will be useful, but
1067 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
1068 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.