$NetBSD: CMS_EncryptedData_encrypt.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_EncryptedData_encrypt 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
CMS_EncryptedData_encrypt_ex, CMS_EncryptedData_encrypt \- Create CMS EncryptedData Header "SYNOPSIS" .Vb 1 #include <openssl/cms.h> \& CMS_ContentInfo *CMS_EncryptedData_encrypt_ex(BIO *in, const EVP_CIPHER *cipher, const unsigned char *key, size_t keylen, unsigned int flags, OSSL_LIB_CTX *ctx, const char *propq); \& CMS_ContentInfo *CMS_EncryptedData_encrypt(BIO *in, const EVP_CIPHER *cipher, const unsigned char *key, size_t keylen, unsigned int flags); .Ve Header "DESCRIPTION" \fBCMS_EncryptedData_encrypt_ex() creates a CMS_ContentInfo structure with a type NID_pkcs7_encrypted. in is a BIO containing the data to encrypt using cipher and the encryption key key of size keylen bytes. The library context libctx and the property query propq are used when retrieving algorithms from providers. flags is a set of optional flags.

The flags field supports the options CMS_DETACHED, CMS_STREAM and \fBCMS_PARTIAL. Internally CMS_final() is called unless CMS_STREAM and/or \fBCMS_PARTIAL is specified.

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

The CMS_ContentInfo structure can be freed using CMS_ContentInfo_free\|(3).

\fBCMS_EncryptedData_encrypt() is similar to CMS_EncryptedData_encrypt_ex() but uses default values of NULL for the library context libctx and the property query propq.

Header "RETURN VALUES" If the allocation fails, CMS_EncryptedData_encrypt_ex() and \fBCMS_EncryptedData_encrypt() 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_final\|(3), CMS_EncryptedData_decrypt\|(3) Header "HISTORY" The CMS_EncryptedData_encrypt_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>.