GpgFrontend/gpgme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Update NEWS and API documentation

Browse Source 
--

GnuPG-bug-id: 6342
This commit is contained in:
Ingo Klöcker 2023-01-25 12:17:05 +01:00
parent 5b79b32397
commit ab7146aa61
No known key found for this signature in database
GPG Key ID: F5A5D1692277A1E9
2 changed files with 66 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
NEWS
View File

@ -11,8 +11,8 @@ Noteworthy changes in version 1.18.1 (unreleased)
gpgme_op_sign* to allow creating an encrypted and/or signed gpgme_op_sign* to allow creating an encrypted and/or signed
archive. [T6342] archive. [T6342]
* Extended gpgme_op_decrypt* and gpgme_op_decrypt_verify* to allow * Extended gpgme_op_decrypt*, gpgme_op_decrypt_verify*, and gpgme_op_verify*
extracting an encrypted and/or signed archive. [T6342] to allow extracting an encrypted and/or signed archive. [T6342]
* cpp: Handle error when trying to sign expired keys. [T6155] * cpp: Handle error when trying to sign expired keys. [T6155]
@ -36,6 +36,10 @@ Noteworthy changes in version 1.18.1 (unreleased)
GPGME_DECRYPT_ARCHIVE NEW. GPGME_DECRYPT_ARCHIVE NEW.
GPGME_ENCRYPT_ARCHIVE NEW. GPGME_ENCRYPT_ARCHIVE NEW.
GPGME_SIG_MODE_ARCHIVE NEW. GPGME_SIG_MODE_ARCHIVE NEW.
GPGME_VERIFY_ARCHIVE NEW.
gpgme_verify_flags_t NEW.
gpgme_op_verify_ext_start NEW.
gpgme_op_verify_ext NEW.
cpp: GpgGenCardKeyInteractor::Curve NEW. cpp: GpgGenCardKeyInteractor::Curve NEW.
cpp: GpgGenCardKeyInteractor::setCurve NEW. cpp: GpgGenCardKeyInteractor::setCurve NEW.
qt: ListAllKeysJob::Option NEW. qt: ListAllKeysJob::Option NEW.

66
doc/gpgme.texi
View File

@ -5589,12 +5589,6 @@ The function @code{gpgme_op_decrypt} decrypts the ciphertext in the
data object @var{cipher} and stores it into the data object data object @var{cipher} and stores it into the data object
@var{plain}. @var{plain}.
If the flag @code(GPGME_DECRYPT_ARCHIVE) is set, then an encrypted
archive in the data object @var{cipher} is decrypted and extracted.
The content of the archive is extracted into a directory named
@code{GPGARCH_n_} (where @code{n} is a number) or into the directory
set with @code{gpgme_data_set_file_name} for the data object @var{plain}.
The function returns the error code @code{GPG_ERR_NO_ERROR} if the The function returns the error code @code{GPG_ERR_NO_ERROR} if the
ciphertext could be decrypted successfully, @code{GPG_ERR_INV_VALUE} ciphertext could be decrypted successfully, @code{GPG_ERR_INV_VALUE}
if @var{ctx}, @var{cipher} or @var{plain} is not a valid pointer, if @var{ctx}, @var{cipher} or @var{plain} is not a valid pointer,
@ -5628,6 +5622,12 @@ The function @code{gpgme_op_decrypt_ext} is the same as
@code{gpgme_op_decrypt} but has an additional argument @code{gpgme_op_decrypt} but has an additional argument
@var{flags}. If @var{flags} is 0 both function behave identically. @var{flags}. If @var{flags} is 0 both function behave identically.
If the flag @code(GPGME_DECRYPT_ARCHIVE) is set, then an encrypted
archive in the data object @var{cipher} is decrypted and extracted.
The content of the archive is extracted into a directory named
@code{GPGARCH_n_} (where @code{n} is a number) or into the directory
set with @code{gpgme_data_set_file_name} for the data object @var{plain}.
The value in @var{flags} is a bitwise-or combination of one or The value in @var{flags} is a bitwise-or combination of one or
multiple of the following bit values: multiple of the following bit values:
@ -5824,6 +5824,60 @@ operation could be started successfully, @code{GPG_ERR_INV_VALUE} if
any data to verify. any data to verify.
@end deftypefun @end deftypefun
@deftypefun gpgme_error_t gpgme_op_verify_ext ( @
@w{gpgme_ctx_t @var{ctx}}, @
@w{gpgme_verify_flags_t @var{flags}}, @
@w{gpgme_data_t @var{sig}}, @
@w{gpgme_data_t @var{signed_text}}, @
@w{gpgme_data_t @var{plain}})
The function @code{gpgme_op_verify_ext} is the same as
@code{gpgme_op_verify} but has an additional argument
@var{flags}. If @var{flags} is 0 both function behave identically.
If the flag @code(GPGME_VERIFY_ARCHIVE) is set, then a signed archive
in the data object @var{sig} is verified and extracted. The content of
the archive is extracted into a directory named @code{GPGARCH_n_}
(where @code{n} is a number) or into the directory set with
@code{gpgme_data_set_file_name} for the data object @var{plain}.
The value in @var{flags} is a bitwise-or combination of one or
multiple of the following bit values:
@table @code
@item GPGME_VERIFY_ARCHIVE
@since{1.19.0}
The @code{GPGME_VERIFY_ARCHIVE} symbol specifies that the input is a
signed archive that shall be verified and extracted. This feature
is currently only supported for the OpenPGP crypto engine.
@end table
The function returns the error codes as descriped for
@code{gpgme_op_decrypt} respective @code{gpgme_op_encrypt}.
@end deftypefun
@deftypefun gpgme_error_t gpgme_op_verify_ext_start ( @
@w{gpgme_ctx_t @var{ctx}}, @
@w{gpgme_verify_flags_t @var{flags}}, @
@w{gpgme_data_t @var{sig}}, @
@w{gpgme_data_t @var{signed_text}}, @
@w{gpgme_data_t @var{plain}})
The function @code{gpgme_op_verify_ext_start} initiates a
@code{gpgme_op_verify_ext} operation. It can be completed by calling
@code{gpgme_wait} on the context. @xref{Waiting For Completion}.
The function returns the error code @code{GPG_ERR_NO_ERROR} if the
operation could be started successfully, @code{GPG_ERR_INV_VALUE} if
@var{ctx}, @var{sig} or @var{plain} is not a valid pointer, and
@code{GPG_ERR_NO_DATA} if @var{sig} or @var{plain} does not contain
any data to verify.
@end deftypefun
@deftp {Data type} {gpgme_sig_notation_t} @deftp {Data type} {gpgme_sig_notation_t}
This is a pointer to a structure used to store a part of the result of This is a pointer to a structure used to store a part of the result of
a @code{gpgme_op_verify} operation. The structure contains the a @code{gpgme_op_verify} operation. The structure contains the