diff options
Diffstat (limited to 'upstream/debian-unstable/man3/CMS_EncryptedData_decrypt.3ssl')
| -rw-r--r-- | upstream/debian-unstable/man3/CMS_EncryptedData_decrypt.3ssl | 33 |
1 files changed, 26 insertions, 7 deletions
diff --git a/upstream/debian-unstable/man3/CMS_EncryptedData_decrypt.3ssl b/upstream/debian-unstable/man3/CMS_EncryptedData_decrypt.3ssl index ea6d7e64..d702759b 100644 --- a/upstream/debian-unstable/man3/CMS_EncryptedData_decrypt.3ssl +++ b/upstream/debian-unstable/man3/CMS_EncryptedData_decrypt.3ssl @@ -55,14 +55,14 @@ .\" ======================================================================== .\" .IX Title "CMS_ENCRYPTEDDATA_DECRYPT 3SSL" -.TH CMS_ENCRYPTEDDATA_DECRYPT 3SSL 2024-02-03 3.1.5 OpenSSL +.TH CMS_ENCRYPTEDDATA_DECRYPT 3SSL 2024-04-04 3.2.2-dev OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME -CMS_EncryptedData_decrypt -\&\- Decrypt CMS EncryptedData +CMS_EncryptedData_decrypt, CMS_EnvelopedData_decrypt +\&\- Decrypt CMS EncryptedData or EnvelopedData .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 @@ -71,6 +71,11 @@ CMS_EncryptedData_decrypt \& int CMS_EncryptedData_decrypt(CMS_ContentInfo *cms, \& const unsigned char *key, size_t keylen, \& BIO *dcont, BIO *out, unsigned int flags); +\& +\& BIO *CMS_EnvelopedData_decrypt(CMS_EnvelopedData *env, BIO *detached_data, +\& EVP_PKEY *pkey, X509 *cert, +\& ASN1_OCTET_STRING *secret, unsigned int flags, +\& OSSL_LIB_CTX *libctx, const char *propq); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" @@ -85,16 +90,30 @@ The following flags can be passed in the \fIflags\fR parameter. If the \fBCMS_TEXT\fR flag is set MIME headers for type \f(CW\*(C`text/plain\*(C'\fR are deleted from the content. If the content is not of type \f(CW\*(C`text/plain\*(C'\fR then an error is returned. +.PP +\&\fBCMS_EnvelopedData_decrypt()\fR decrypts, similarly to \fBCMS_decrypt\fR\|(3), +a CMS EnvelopedData object \fIenv\fR using the symmetric key \fIsecret\fR if it +is not NULL, otherwise the private key of the recipient \fIpkey\fR. +If \fIpkey\fR is given, it is recommended to provide also the associated +certificate in \fIcert\fR \- see \fBCMS_decrypt\fR\|(3) and the NOTES on \fIcert\fR there. +The optional parameters \fIflags\fR and \fIdcont\fR are used as described above. +The optional parameters library context \fIlibctx\fR and property query \fIpropq\fR +are used when retrieving algorithms from providers. .SH "RETURN VALUES" .IX Header "RETURN VALUES" -\&\fBCMS_EncryptedData_decrypt()\fR returns 0 if an error occurred otherwise it -returns 1. +\&\fBCMS_EncryptedData_decrypt()\fR returns 0 if an error occurred otherwise returns 1. +.PP +\&\fBCMS_EnvelopedData_decrypt()\fR returns NULL if an error occurred, +otherwise a BIO containing the decypted content. .SH "SEE ALSO" .IX Header "SEE ALSO" -\&\fBERR_get_error\fR\|(3), \fBCMS_EncryptedData_encrypt\fR\|(3) +\&\fBERR_get_error\fR\|(3), \fBCMS_EncryptedData_encrypt\fR\|(3), \fBCMS_decrypt\fR\|(3) +.SH HISTORY +.IX Header "HISTORY" +\&\fBCMS_EnvelopedData_decrypt()\fR was added in OpenSSL 3.2. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2020\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2020 The OpenSSL Project Authors. All Rights Reserved. .PP Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy |