diff options
author | Ingo Klöcker <[email protected]> | 2023-01-19 11:08:35 +0000 |
---|---|---|
committer | Ingo Klöcker <[email protected]> | 2023-01-19 11:08:35 +0000 |
commit | 4c872b674189d84d936d6c5cbe18b27c90c162e0 (patch) | |
tree | a82b8b02333b1c0c824d38ed114f454cb42ea053 /doc | |
parent | core: Support usage of gpgtar for creating an encrypted signed archive (diff) | |
download | gpgme-4c872b674189d84d936d6c5cbe18b27c90c162e0.tar.gz gpgme-4c872b674189d84d936d6c5cbe18b27c90c162e0.zip |
doc: Update NEWS and API documentation
--
GnuPG-bug-id: 6342
Diffstat (limited to 'doc')
-rw-r--r-- | doc/gpgme.texi | 27 |
1 files changed, 27 insertions, 0 deletions
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 |