libsecurity_smime/lib/SecCmsContentInfo.h

   1 /*
   2  *  Copyright (c) 2004,2008,2010 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 SecCmsContentInfo.h
  26     @Copyright (c) 2004,2008,2010 Apple Inc. All Rights Reserved.
  27
  28     @availability 10.4 and later
  29     @abstract Interfaces of the CMS implementation.
  30     @discussion The functions here implement functions for creating and
  31                 accessing ContentInfo objects that are part of Cryptographic
  32                 Message Syntax (CMS) objects as described in rfc3369.
  33  */
  34
  35 #ifndef _SECURITY_SECCMSCONTENTINFO_H_
  36 #define _SECURITY_SECCMSCONTENTINFO_H_  1
  37
  38 #include <Security/SecCmsBase.h>
  39 #include <CoreFoundation/CFData.h>
  40
  41
  42 #if defined(__cplusplus)
  43 extern "C" {
  44 #endif
  45
  46
  47 /*! @functiongroup ContentInfo accessors */
  48 /*!
  49     @function
  50     @abstract Get content's contentInfo (if it exists).
  51     @param cinfo A ContentInfo object of which we want to get the child contentInfo.
  52     @result The child ContentInfo object, or NULL if there is none.
  53     @discussion This function requires a ContentInfo object which is usually created by decoding and SecCmsMessage using a SecCmsDecoder.
  54     @availability 10.4 and later
  55  */
  56 extern SecCmsContentInfoRef
  57 SecCmsContentInfoGetChildContentInfo(SecCmsContentInfoRef cinfo);
  58
  59 /*!
  60     @function
  61     @abstract Get pointer to inner content
  62     @discussion needs to be casted...
  63  */
  64 extern void *
  65 SecCmsContentInfoGetContent(SecCmsContentInfoRef cinfo);
  66
  67 /*!
  68     @function
  69     @abstract Get pointer to innermost content
  70     @discussion This is typically only called by SecCmsMessageGetContent().
  71  */
  72 extern const SecAsn1Item *
  73 SecCmsContentInfoGetInnerContent(SecCmsContentInfoRef cinfo);
  74
  75 /*!
  76     @function
  77     @abstract Find out and return the inner content type.
  78  */
  79 extern SECOidTag
  80 SecCmsContentInfoGetContentTypeTag(SecCmsContentInfoRef cinfo);
  81
  82 /*!
  83     @function
  84     @abstract Find out and return the inner content type.
  85     @discussion Caches pointer to lookup result for future reference.
  86  */
  87 extern SecAsn1Oid *
  88 SecCmsContentInfoGetContentTypeOID(SecCmsContentInfoRef cinfo);
  89
  90 /*!
  91     @function
  92     @abstract Find out and return the content encryption algorithm tag.
  93  */
  94 extern SECOidTag
  95 SecCmsContentInfoGetContentEncAlgTag(SecCmsContentInfoRef cinfo);
  96
  97 /*!
  98     @function
  99     @abstract Find out and return the content encryption algorithm.
 100     @discussion Caches pointer to lookup result for future reference.
 101  */
 102 extern SECAlgorithmID *
 103 SecCmsContentInfoGetContentEncAlg(SecCmsContentInfoRef cinfo);
 104
 105
 106 /*! @functiongroup Message construction */
 107 /*!
 108     @function
 109     @abstract Set a ContentInfos content to a Data
 110     @param cinfo A ContentInfo object of which we want set the content.
 111     @param data A CFDataRef or NULL if data will be provided during SecCmsEncoderUpdate calls.
 112     @param detached True if the content is to be deattched from the CMS message rather than included within it.
 113     @result A result code. See "SecCmsBase.h" for possible results.
 114     @discussion This function requires a ContentInfo object which can be made by creating a SecCmsMessage object.
 115     @availability 10.4 and later
 116  */
 117 extern OSStatus
 118 SecCmsContentInfoSetContentData(SecCmsContentInfoRef cinfo, CFDataRef data, Boolean detached);
 119
 120 /*!
 121     @function
 122     @abstract Set a ContentInfos content to a SignedData.
 123     @param cinfo A ContentInfo object of which we want set the content.
 124     @param sigd A SignedData object to set as the content of the cinfo object.
 125     @result A result code. See "SecCmsBase.h" for possible results.
 126     @discussion This function requires a ContentInfo object which can be made by creating a SecCmsMessage object and a SignedData which can be made by calling SecCmsSignedDataCreate().  If the call succeeds the passed in SignedData object will be owned by the reciever.  The Message object of the SignedData object must be the same as cmsg.
 127     @availability 10.4 and later
 128  */
 129 extern OSStatus
 130 SecCmsContentInfoSetContentSignedData(SecCmsContentInfoRef cinfo, SecCmsSignedDataRef sigd);
 131
 132 /*!
 133     @function
 134     @abstract Set a ContentInfos content to a EnvelopedData.
 135     @param cinfo A ContentInfo object of which we want set the content.
 136     @param envd A EnvelopedData object to set as the content of the cinfo object.
 137     @result A result code. See "SecCmsBase.h" for possible results.
 138     @discussion This function requires a ContentInfo object which can be made by creating a SecCmsMessage object and a EnvelopedData which can be made by calling SecCmsEnvelopedDataCreate().  If the call succeeds the passed in EnvelopedData object will be owned by the reciever.  The Message object of the EnvelopedData object must be the same as cmsg.
 139     @availability 10.4 and later
 140  */
 141 extern OSStatus
 142 SecCmsContentInfoSetContentEnvelopedData(SecCmsContentInfoRef cinfo, SecCmsEnvelopedDataRef envd);
 143
 144 /*!
 145     @function
 146     @abstract Set a ContentInfos content to a DigestedData.
 147     @param cinfo A ContentInfo object of which we want set the content.
 148     @param digd A DigestedData object to set as the content of the cinfo object.
 149     @result A result code. See "SecCmsBase.h" for possible results.
 150     @discussion This function requires a ContentInfo object which can be made by creating a SecCmsMessage object and a DigestedData which can be made by calling SecCmsDigestedDataCreate().  If the call succeeds the passed in DigestedData object will be owned by the reciever.  The Message object of the DigestedData object must be the same as cmsg.
 151     @availability 10.4 and later
 152  */
 153 extern OSStatus
 154 SecCmsContentInfoSetContentDigestedData(SecCmsContentInfoRef cinfo, SecCmsDigestedDataRef digd);
 155
 156 /*!
 157     @function
 158     @abstract Set a ContentInfos content to a EncryptedData.
 159     @param cinfo A ContentInfo object of which we want set the content.
 160     @param encd A EncryptedData object to set as the content of the cinfo object.
 161     @result A result code. See "SecCmsBase.h" for possible results.
 162     @discussion This function requires a ContentInfo object which can be made by creating a SecCmsMessage object and a EncryptedData which can be made by calling SecCmsEncryptedDataCreate().  If the call succeeds the passed in EncryptedData object will be owned by the reciever.  The Message object of the EncryptedData object must be the same as cmsg.
 163     @availability 10.4 and later
 164  */
 165 extern OSStatus
 166 SecCmsContentInfoSetContentEncryptedData(SecCmsContentInfoRef cinfo, SecCmsEncryptedDataRef encd);
 167
 168 OSStatus
 169 SecCmsContentInfoSetContentOther(SecCmsContentInfoRef cinfo, SecAsn1Item *data, Boolean detached, const SecAsn1Oid *eContentType);
 170
 171 /*!
 172     @function
 173  */
 174 extern OSStatus
 175 SecCmsContentInfoSetContentEncAlg(SecCmsContentInfoRef cinfo,
 176                                     SECOidTag bulkalgtag, const SecAsn1Item *parameters, int keysize);
 177
 178 /*!
 179     @function
 180  */
 181 extern OSStatus
 182 SecCmsContentInfoSetContentEncAlgID(SecCmsContentInfoRef cinfo,
 183                                     SECAlgorithmID *algid, int keysize);
 184
 185 /*!
 186     @function
 187  */
 188 extern void
 189 SecCmsContentInfoSetBulkKey(SecCmsContentInfoRef cinfo, SecSymmetricKeyRef bulkkey);
 190
 191 /*!
 192     @function
 193  */
 194 extern SecSymmetricKeyRef
 195 SecCmsContentInfoGetBulkKey(SecCmsContentInfoRef cinfo);
 196
 197 /*!
 198     @function
 199  */
 200 extern int
 201 SecCmsContentInfoGetBulkKeySize(SecCmsContentInfoRef cinfo);
 202
 203
 204 #if defined(__cplusplus)
 205 }
 206 #endif
 207
 208 #endif /* _SECURITY_SECCMSCONTENTINFO_H_ */