$NetBSD: CMS_EnvelopedData_create.3,v 1.5 2024/09/08 13:08:17 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "CMS_EnvelopedData_create 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
CMS_EnvelopedData_create_ex, CMS_EnvelopedData_create, CMS_AuthEnvelopedData_create, CMS_AuthEnvelopedData_create_ex \- Create CMS envelope Header "SYNOPSIS" .Vb 1 #include <openssl/cms.h> \& CMS_ContentInfo * CMS_EnvelopedData_create_ex(const EVP_CIPHER *cipher, OSSL_LIB_CTX *libctx, const char *propq); CMS_ContentInfo *CMS_EnvelopedData_create(const EVP_CIPHER *cipher); \& CMS_ContentInfo * CMS_AuthEnvelopedData_create_ex(const EVP_CIPHER *cipher, OSSL_LIB_CTX *libctx, const char *propq); CMS_ContentInfo *CMS_AuthEnvelopedData_create(const EVP_CIPHER *cipher); .Ve Header "DESCRIPTION" \fBCMS_EnvelopedData_create_ex() creates a CMS_ContentInfo structure with a type NID_pkcs7_enveloped. cipher is the symmetric cipher to use. The library context libctx and the property query propq are used when retrieving algorithms from providers.

\fBCMS_AuthEnvelopedData_create_ex() creates a CMS_ContentInfo structure with a type NID_id_smime_ct_authEnvelopedData. cipher is the symmetric AEAD cipher to use. Currently only AES variants with GCM mode are supported. The library context libctx and the property query propq are used when retrieving algorithms from providers.

The algorithm passed in the cipher parameter must support ASN1 encoding of its parameters.

The recipients can be added later using CMS_add1_recipient_cert\|(3) or \fBCMS_add0_recipient_key\|(3).

The CMS_ContentInfo structure needs to be finalized using CMS_final\|(3) and then freed using CMS_ContentInfo_free\|(3).

\fBCMS_EnvelopedData_create() and CMS_AuthEnvelopedData_create are similar to \fBCMS_EnvelopedData_create_ex() and \fBCMS_AuthEnvelopedData_create_ex() but use default values of NULL for the library context libctx and the property query propq.

Header "NOTES" Although CMS_EnvelopedData_create() and CMS_AuthEnvelopedData_create() allocate a new CMS_ContentInfo structure, they are not usually used in applications. The wrappers CMS_encrypt\|(3) and CMS_decrypt\|(3) are often used instead. Header "RETURN VALUES" If the allocation fails, CMS_EnvelopedData_create() and \fBCMS_AuthEnvelopedData_create() return NULL and set an error code that can be obtained by ERR_get_error\|(3). Otherwise they return a pointer to the newly allocated structure. Header "SEE ALSO" \fBERR_get_error\|(3), CMS_encrypt\|(3), CMS_decrypt\|(3), CMS_final\|(3) Header "HISTORY" The CMS_EnvelopedData_create_ex() method was added in OpenSSL 3.0. Header "COPYRIGHT" Copyright 2020-2021 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 in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.