doc/crypto/CMS_add1_recipient_cert.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 CMS_add1_recipient_cert, CMS_add0_recipient_key - add recipients to a CMS enveloped data structure
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/cms.h>
  10
  11  CMS_RecipientInfo *CMS_add1_recipient_cert(CMS_ContentInfo *cms, X509 *recip, unsigned int flags);
  12
  13  CMS_RecipientInfo *CMS_add0_recipient_key(CMS_ContentInfo *cms, int nid, unsigned char *key, size_t keylen, unsigned char *id, size_t idlen, ASN1_GENERALIZEDTIME *date, ASN1_OBJECT *otherTypeId, ASN1_TYPE *otherType);
  14
  15 =head1 DESCRIPTION
  16
  17 CMS_add1_recipient_cert() adds recipient B<recip> to CMS_ContentInfo enveloped
  18 data structure B<cms> as a KeyTransRecipientInfo structure.
  19
  20 CMS_add0_recipient_key() adds symmetric key B<key> of length B<keylen> using
  21 wrapping algorithm B<nid>, identifier B<id> of length B<idlen> and optional
  22 values B<date>, B<otherTypeId> and B<otherType> to CMS_ContentInfo enveloped
  23 data structure B<cms> as a KEKRecipientInfo structure.
  24
  25 The CMS_ContentInfo structure should be obtained from an initial call to
  26 CMS_encrypt() with the flag B<CMS_PARTIAL> set.
  27
  28 =head1 NOTES
  29
  30 The main purpose of this function is to provide finer control over a CMS
  31 enveloped data structure where the simpler CMS_encrypt() function defaults are
  32 not appropriate. For example if one or more KEKRecipientInfo structures
  33 need to be added. New attributes can also be added using the returned
  34 CMS_RecipientInfo structure and the CMS attribute utility functions.
  35
  36 OpenSSL will by default identify recipient certificates using issuer name
  37 and serial number. If B<CMS_USE_KEYID> is set it will use the subject key
  38 identifier value instead. An error occurs if all recipient certificates do not
  39 have a subject key identifier extension.
  40
  41 Currently only AES based key wrapping algorithms are supported for B<nid>,
  42 specifically: NID_id_aes128_wrap, NID_id_aes192_wrap and NID_id_aes256_wrap.
  43 If B<nid> is set to B<NID_undef> then an AES wrap algorithm will be used
  44 consistent with B<keylen>.
  45
  46 =head1 RETURN VALUES
  47
  48 CMS_add1_recipient_cert() and CMS_add0_recipient_key() return an internal
  49 pointer to the CMS_RecipientInfo structure just added or NULL if an error
  50 occurs.
  51
  52 =head1 SEE ALSO
  53
  54 L<ERR_get_error(3)>, L<CMS_decrypt(3)>,
  55 L<CMS_final(3)>,
  56
  57 =head1 COPYRIGHT
  58
  59 Copyright 2008-2016 The OpenSSL Project Authors. All Rights Reserved.
  60
  61 Licensed under the OpenSSL license (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