doc/man3/CMS_EnvelopedData_create.pod

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