From 4c872b674189d84d936d6c5cbe18b27c90c162e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ingo=20Kl=C3=B6cker?= Date: Thu, 19 Jan 2023 12:08:35 +0100 Subject: [PATCH] doc: Update NEWS and API documentation -- GnuPG-bug-id: 6342 --- NEWS | 8 ++++++++ doc/gpgme.texi | 27 +++++++++++++++++++++++++++ 2 files changed, 35 insertions(+) diff --git a/NEWS b/NEWS index b5fb0a73..3ccb371f 100644 --- a/NEWS +++ b/NEWS @@ -5,6 +5,12 @@ Noteworthy changes in version 1.18.1 (unreleased) * Optionally, build QGpgME for Qt 6 + * Support component "gpgtar-name" in gpgme_get_dirinfo. [T6342] + + * Extended gpgme_op_encrypt*, gpgme_op_encrypt_sign*, and + gpgme_op_sign* to allow creating an encrypted and/or signed + archive. [T6342] + * cpp: Handle error when trying to sign expired keys. [T6155] * cpp, qt: Fix building with C++11. [T6141] @@ -24,6 +30,8 @@ Noteworthy changes in version 1.18.1 (unreleased) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ gpgme_get_ctx_flag EXTENDED: New flag 'no-auto-check-trustdb'. gpgme_set_ctx_flag EXTENDED: New flag 'no-auto-check-trustdb'. + GPGME_ENCRYPT_ARCHIVE NEW. + GPGME_SIG_MODE_ARCHIVE NEW. cpp: GpgGenCardKeyInteractor::Curve NEW. cpp: GpgGenCardKeyInteractor::setCurve NEW. qt: ListAllKeysJob::Option NEW. diff --git a/doc/gpgme.texi b/doc/gpgme.texi index 2532f800..8b6106af 100644 --- a/doc/gpgme.texi +++ b/doc/gpgme.texi @@ -6238,6 +6238,13 @@ A detached signature is made. @item GPGME_SIG_MODE_CLEAR A clear text signature is made. The @acronym{ASCII} armor and text mode settings of the context are ignored. + +@item GPGME_SIG_MODE_ARCHIVE +@since{1.19.0} + +A signed archive is created from the given files and directories. This +feature is currently only supported for the OpenPGP crypto engine. + @end table @end deftp @@ -6249,6 +6256,12 @@ the data object @var{plain} and returns it in the data object specified for @var{sig}), the text mode attributes set for the context @var{ctx} and the requested signature mode @var{mode}. +If signature mode @code(GPGME_SIG_MODE_ARCHIVE) is requested, then a +signed archive is created from the files and directories given as +NUL-separated list in the data object @var{plain} and returned in the +data object @var{sig}. The paths of the files and directories have to +be given as paths relative to the current working directory. + After the operation completed successfully, the result can be retrieved with @code{gpgme_op_sign_result}. @@ -6420,6 +6433,12 @@ ciphertext created is determined by the @acronym{ASCII} armor (or, if that is not set, by the encoding specified for @var{cipher}) and the text mode attributes set for the context @var{ctx}. +If the flag @code(GPGME_ENCRYPT_ARCHIVE) is set, then an encrypted +archive is created from the files and directories given as NUL-separated +list in the data object @var{plain} and returned in the data object +@var{cipher}. The paths of the files and directories have to +be given as paths relative to the current working directory. + @var{recp} must be a @code{NULL}-terminated array of keys. The user must keep references for all keys during the whole duration of the call (but see @code{gpgme_op_encrypt_start} for the requirements with @@ -6495,6 +6514,14 @@ of now the key must be specified using the @var{recpstring} argument of the extended encrypt functions. This feature is currently only supported for the OpenPGP crypto engine. +@item GPGME_ENCRYPT_ARCHIVE +@since{1.19.0} + +The @code{GPGME_ENCRYPT_ARCHIVE} symbol specifies that the input is a +NUL-separated list of file paths and directory paths that shall be +encrypted into an archive. This feature is currently only supported +for the OpenPGP crypto engine. + @end table If @code{GPG_ERR_UNUSABLE_PUBKEY} is returned, some recipients in