CMS/SecCmsEnvelopedData.h

   1 /*
   2  *  Copyright (c) 2004-2018 Apple Inc. All Rights Reserved.
   3  *
   4  *  @APPLE_LICENSE_HEADER_START@
   5  *
   6  *  This file contains Original Code and/or Modifications of Original Code
   7  *  as defined in and that are subject to the Apple Public Source License
   8  *  Version 2.0 (the 'License'). You may not use this file except in
   9  *  compliance with the License. Please obtain a copy of the License at
  10  *  http://www.opensource.apple.com/apsl/ and read it before using this
  11  *  file.
  12  *
  13  *  The Original Code and all software distributed under the License are
  14  *  distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  *  EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  *  INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  *  FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  *  Please see the License for the specific language governing rights and
  19  *  limitations under the License.
  20  *
  21  *  @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 /*!
  25     @header SecCmsEnvelopedData.h
  26
  27     @availability 10.4 and later
  28     @abstract Interfaces of the CMS implementation.
  29     @discussion The functions here implement functions for encoding
  30                 and decoding Cryptographic Message Syntax (CMS) objects
  31                 as described in rfc3369.
  32  */
  33
  34 #ifndef _SECURITY_SECCMSENVELOPEDDATA_H_
  35 #define _SECURITY_SECCMSENVELOPEDDATA_H_  1
  36
  37 #include <Security/SecCmsBase.h>
  38
  39 __BEGIN_DECLS
  40
  41 /*!
  42      @function
  43      @abstract Create an enveloped data message.
  44  */
  45 extern SecCmsEnvelopedDataRef
  46 SecCmsEnvelopedDataCreate(SecCmsMessageRef cmsg, SECOidTag algorithm, int keysize);
  47
  48 /*!
  49     @function
  50     @abstract Destroy an enveloped data message.
  51  */
  52 extern void
  53 SecCmsEnvelopedDataDestroy(SecCmsEnvelopedDataRef edp);
  54
  55 /*!
  56     @function
  57     @abstract Return pointer to this envelopedData's contentinfo.
  58  */
  59 extern SecCmsContentInfoRef
  60 SecCmsEnvelopedDataGetContentInfo(SecCmsEnvelopedDataRef envd);
  61
  62 #if TARGET_OS_OSX
  63 /*!
  64  @function
  65  @abstract Add a recipientinfo to the enveloped data msg.
  66  @discussion Rip must be created on the same pool as edp - this is not enforced, though.
  67  */
  68 extern OSStatus
  69 SecCmsEnvelopedDataAddRecipient(SecCmsEnvelopedDataRef edp, SecCmsRecipientInfoRef rip);
  70 #endif
  71
  72 __END_DECLS
  73
  74 #endif /* _SECURITY_SECCMSENVELOPEDDATA_H_ */