doc/man3/CMS_EnvelopedData_create.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 CMS_EnvelopedData_create_with_libctx, CMS_EnvelopedData_create
   6 - Create CMS envelope
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/cms.h>
  11
  12  CMS_ContentInfo *CMS_EnvelopedData_create_with_libctx(const EVP_CIPHER *cipher,
  13                                                        OPENSSL_CTX *libctx,
  14                                                        const char *propq);
  15  CMS_ContentInfo *CMS_EnvelopedData_create(const EVP_CIPHER *cipher);
  16
  17 =head1 DESCRIPTION
  18
  19 CMS_EnvelopedData_create_with_libctx() creates a B<CMS_ContentInfo> structure with
  20 a type B<NID_pkcs7_enveloped>. I<cipher> is the symmetric cipher to use. The
  21 library context I<libctx> and the property query I<propq> are used when
  22 retrieving algorithms from providers.
  23
  24 The algorithm passed in the I<cipher> parameter must support ASN1 encoding of
  25 its parameters.
  26
  27 The recipients can be added later using L<CMS_add1_recipient_cert(3)> or
  28 L<CMS_add0_recipient_key(3)>.
  29
  30 The B<CMS_ContentInfo> structure needs to be finalized using L<CMS_final(3)>
  31 and then freed using L<CMS_ContentInfo_free(3)>.
  32
  33 CMS_EnvelopedData_create() is similar to CMS_EnvelopedData_create_with_libctx()
  34 but uses default values of NULL for the library context I<libctx> and the
  35 property query I<propq>.
  36
  37 =head1 NOTES
  38
  39 Although CMS_EnvelopedData_create() allocates a new B<CMS_ContentInfo>
  40 structure it is usually not used in applications. The wrappers
  41 L<CMS_encrypt(3)> and L<CMS_decrypt(3)> are often used instead.
  42
  43 =head1 RETURN VALUES
  44
  45 If the allocation fails, CMS_EnvelopedData_create() returns NULL and sets
  46 an error code that can be obtained by L<ERR_get_error(3)>.
  47 Otherwise it returns a pointer to the newly allocated structure.
  48
  49 =head1 SEE ALSO
  50
  51 L<ERR_get_error(3)>, L<CMS_encrypt(3)>, L<CMS_decrypt(3)>, L<CMS_final(3)>
  52
  53 head1 HISTORY
  54
  55 The CMS_EnvelopedData_create_with_libctx() method was added in OpenSSL 3.0.
  56
  57 =head1 COPYRIGHT
  58
  59 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
  60
  61 Licensed under the Apache License 2.0 (the "License").  You may not use
  62 this file except in compliance with the License.  You can obtain a copy
  63 in the file LICENSE in the source distribution or at
  64 L<https://www.openssl.org/source/license.html>.
  65
  66 =cut