diff options
author | Shane Lontis <shane.lontis@oracle.com> | 2020-07-25 18:04:55 +1000 |
---|---|---|
committer | Shane Lontis <shane.lontis@oracle.com> | 2020-08-09 17:34:52 +1000 |
commit | c1669f41eab0e2d9a8c2498718d06b4cd48a9890 (patch) | |
tree | 00e024f0935dfa0c93e2f833e69b14bb77a819e4 /doc/man3/CMS_encrypt.pod | |
parent | 82a7b2fb001e2ff50389d0894c276880b3bad336 (diff) |
Add libctx support to CMS.
-Public CMS methods that create a CMS_ContentInfo object now have variants that also add a libctx and propq.
This includes CMS_ContentInfo_new_with_libctx(), CMS_sign_with_libctx(), CMS_data_create_with_libctx(),
CMS_digest_create_with_libctx(), CMS_EncryptedData_encrypt_with_libctx(), CMS_EnvelopedData_create_with_libctx().
-Added CMS_ReceiptRequest_create0_with_libctx().
-Added SMIME_read_CMS_ex() so that a new CMS_ContentInfo object (created using CMS_ContentInfo_new_with_libctx()) can
be passed to the read.
-d2i_CMS_bio() has been modified so that after it loads the CMS_ContentInfo() it then resolves any subobjects that require
the libctx/propq (such as objects containing X509 certificates).
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/11884)
Diffstat (limited to 'doc/man3/CMS_encrypt.pod')
-rw-r--r-- | doc/man3/CMS_encrypt.pod | 26 |
1 files changed, 19 insertions, 7 deletions
diff --git a/doc/man3/CMS_encrypt.pod b/doc/man3/CMS_encrypt.pod index 1bc9fd041d..211ec18d36 100644 --- a/doc/man3/CMS_encrypt.pod +++ b/doc/man3/CMS_encrypt.pod @@ -2,20 +2,26 @@ =head1 NAME -CMS_encrypt - create a CMS envelopedData structure +CMS_encrypt_with_libctx, CMS_encrypt - create a CMS envelopedData structure =head1 SYNOPSIS #include <openssl/cms.h> + CMS_ContentInfo *CMS_encrypt_with_libctx(STACK_OF(X509) *certs, + BIO *in, const EVP_CIPHER *cipher, + unsigned int flags, + OPENSSL_CTX *libctx, const char *propq); CMS_ContentInfo *CMS_encrypt(STACK_OF(X509) *certs, BIO *in, const EVP_CIPHER *cipher, unsigned int flags); =head1 DESCRIPTION -CMS_encrypt() creates and returns a CMS EnvelopedData structure. B<certs> -is a list of recipient certificates. B<in> is the content to be encrypted. -B<cipher> is the symmetric cipher to use. B<flags> is an optional set of flags. +CMS_encrypt_with_libctx() creates and returns a CMS EnvelopedData structure. +I<certs> is a list of recipient certificates. I<in> is the content to be +encrypted. I<cipher> is the symmetric cipher to use. I<flags> is an optional set +of flags. The library context I<libctx> and the property query I<propq> are used +internally when retrieving algorithms from providers. Only certificates carrying RSA, Diffie-Hellman or EC keys are supported by this function. @@ -75,10 +81,14 @@ and CMS_add0_recipient_key(). The parameter B<certs> may be NULL if B<CMS_PARTIAL> is set and recipients added later using CMS_add1_recipient_cert() or CMS_add0_recipient_key(). +CMS_encrypt() is similar to CMS_encrypt_with_libctx() but uses default values of +NULL for the library context I<libctx> and the property query I<propq>. + =head1 RETURN VALUES -CMS_encrypt() returns either a CMS_ContentInfo structure or NULL if an error -occurred. The error can be obtained from ERR_get_error(3). +CMS_encrypt_with_libctx() and CMS_encrypt() return either a CMS_ContentInfo +structure or NULL if an error occurred. The error can be obtained from +ERR_get_error(3). =head1 SEE ALSO @@ -86,11 +96,13 @@ L<ERR_get_error(3)>, L<CMS_decrypt(3)> =head1 HISTORY +The function CMS_encrypt_with_libctx() was added in OpenSSL 3.0. + The B<CMS_STREAM> flag was first supported in OpenSSL 1.0.0. =head1 COPYRIGHT -Copyright 2008-2018 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2008-2020 The OpenSSL Project Authors. All Rights Reserved. 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 |