aboutsummaryrefslogtreecommitdiffstats
path: root/doc/gpgme.texi
diff options
context:
space:
mode:
authorMarcus Brinkmann <[email protected]>2002-02-26 00:08:09 +0000
committerMarcus Brinkmann <[email protected]>2002-02-26 00:08:09 +0000
commitc22974f99f1d91d49f365a375befc4b87ccfc63f (patch)
treed1b6deec1c802e7a7a9dc26907d81afb9947ec02 /doc/gpgme.texi
parent2002-02-25 Marcus Brinkmann <[email protected]> (diff)
downloadgpgme-c22974f99f1d91d49f365a375befc4b87ccfc63f.tar.gz
gpgme-c22974f99f1d91d49f365a375befc4b87ccfc63f.zip
doc/
2002-02-26 Marcus Brinkmann <[email protected]> * gpgme.texi (Encrypting a Plaintext): Document gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start. gpgme/ 2002-02-25 Marcus Brinkmann <[email protected]> * engine.c (_gpgme_engine_op_encrypt_sign): New function. * engine.h (_gpgme_engine_op_encrypt_sign): New prototype. * rungpg.c (_gpgme_append_gpg_args_from_signers): New function. (_gpgme_gpg_op_sign): Use that new function. (_gpgme_gpg_op_encrypt_sign): New function. * rungpg.h (_gpgme_gpg_op_encrypt_sign): New prototype. * gpgme.h (gpgme_op_encrypt_sign_start): New prototype. (gpgme_op_encrypt_sign): Likewise. * Makefile.am (libgpgme_la_SOURCES): Add encrypt-sign.c. * ops.h (_gpgme_encrypt_status_handler): Add prototype. (_gpgme_sign_status_handler): Add prototype. * sign.c (sign_status_handler): Rename to ... (_gpgme_sign_status_handler): ... this and make non-static. * encrypt.c (encrypt_status_handler): Rename to ... (_gpgme_encrypt_status_handler): ... this and make non-static. * encrypt.c (gpgme_op_encrypt_start): Use new status handler name. * sign.c (gpgme_op_sign_start): Likewise. tests/ 2002-02-26 Marcus Brinkmann <[email protected]> * gpg/t-encrypt-sign.c: New file. * gpg/Makefile.am (TESTS): Add t-encrypt-sign.
Diffstat (limited to '')
-rw-r--r--doc/gpgme.texi26
1 files changed, 25 insertions, 1 deletions
diff --git a/doc/gpgme.texi b/doc/gpgme.texi
index 708110c3..2be6170b 100644
--- a/doc/gpgme.texi
+++ b/doc/gpgme.texi
@@ -2201,7 +2201,7 @@ The function @code{gpgme_recipients_enum_close} releases the iterator
@subsubsection Encrypting a Plaintext
@deftypefun GpgmeError gpgme_op_encrypt (@w{GpgmeCtx @var{ctx}}, @w{GpgmeRecipients @var{rset}}, @w{GpgmeData @var{plain}}, @w{GpgmeData @var{cipher}})
-The function @code{gpgme_op_crypt} encrypts the plaintext in the data
+The function @code{gpgme_op_encrypt} encrypts the plaintext in the data
object @var{plain} for the recipients @var{rset} and stores the
ciphertext in the data object @var{cipher}. The type of the
ciphertext created is determined by the @acronym{ASCII} armor and text
@@ -2232,6 +2232,30 @@ recipients.
@end deftypefun
+@deftypefun GpgmeError gpgme_op_encrypt_sign (@w{GpgmeCtx @var{ctx}}, @w{GpgmeRecipients @var{rset}}, @w{GpgmeData @var{plain}}, @w{GpgmeData @var{cipher}})
+The function @code{gpgme_op_encrypt_sign} does a combined encrypt and
+sign operation. It is used like @code{gpgme_op_encrypt}, but the
+ciphertext also contains signatures for the signers listed in
+@var{ctx}.
+
+The combined encrypt and sign operation is currently only available
+for the OpenPGP crypto engine.
+@end deftypefun
+
+@deftypefun GpgmeError gpgme_op_encrypt_sign_start (@w{GpgmeCtx @var{ctx}}, @w{GpgmeRecipients @var{rset}}, @w{GpgmeData @var{plain}}, @w{GpgmeData @var{cipher}})
+The function @code{gpgme_op_encrypt_sign_start} initiates a
+@code{gpgme_op_encrypt_sign} operation. It can be completed by
+calling @code{gpgme_wait} on the context. @xref{Waiting For
+Completion}.
+
+The function returns @code{GPGME_No_Error} if the operation could be
+started successfully, @code{GPGME_Invalid_Value} if @var{ctx},
+@var{rset}, @var{plain} or @var{cipher} is not a valid pointer, and
+@code{GPGME_No_Recipient} if @var{rset} does not contain any valid
+recipients.
+@end deftypefun
+
+
@node Detailed Results
@subsection Detailed Results
@cindex cryptographic operation, detailed results