CMS/SecCmsRecipientInfo.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 SecCmsRecipientInfo.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_SECCMSRECIPIENTINFO_H_
  35 #define _SECURITY_SECCMSRECIPIENTINFO_H_  1
  36
  37 #include <Security/SecCmsBase.h>
  38
  39 __BEGIN_DECLS
  40
  41 #if TARGET_OS_OSX
  42 /*!
  43     @function
  44     @abstract Create a recipientinfo
  45     @discussion We currently do not create KeyAgreement recipientinfos with multiple recipientEncryptedKeys
  46     the certificate is supposed to have been verified by the caller
  47  */
  48 extern SecCmsRecipientInfoRef
  49 SecCmsRecipientInfoCreate(SecCmsMessageRef cmsg, SecCertificateRef cert)
  50     API_AVAILABLE(macos(10.4)) API_UNAVAILABLE(macCatalyst);
  51
  52 #else // !TARGET_OS_OSX
  53
  54 /*!
  55     @function
  56     @abstract Create a recipientinfo
  57     @discussion We currently do not create KeyAgreement recipientinfos with multiple recipientEncryptedKeys
  58                 the certificate is supposed to have been verified by the caller
  59  */
  60 extern SecCmsRecipientInfoRef
  61 SecCmsRecipientInfoCreate(SecCmsEnvelopedDataRef envd, SecCertificateRef cert)
  62     API_AVAILABLE(ios(2.0), tvos(2.0), watchos(1.0)) API_UNAVAILABLE(macCatalyst);
  63 #endif // !TARGET_OS_OSX
  64
  65
  66 #if TARGET_OS_OSX
  67 #pragma clang diagnostic push
  68 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
  69 extern SecCmsRecipientInfoRef
  70 SecCmsRecipientInfoCreateWithSubjKeyID(SecCmsMessageRef cmsg,
  71                                        CSSM_DATA_PTR subjKeyID,
  72                                        SecPublicKeyRef pubKey)
  73     API_AVAILABLE(macos(10.4)) API_UNAVAILABLE(macCatalyst);
  74 #pragma clang diagnostic pop
  75 #else // !TARGET_OS_OSX
  76 extern SecCmsRecipientInfoRef
  77 SecCmsRecipientInfoCreateWithSubjKeyID(SecCmsEnvelopedDataRef envd,
  78                                        const SecAsn1Item *subjKeyID,
  79                                        SecPublicKeyRef pubKey)
  80     API_AVAILABLE(ios(2.0), tvos(2.0), watchos(1.0)) API_UNAVAILABLE(macCatalyst);
  81 #endif // !TARGET_OS_OSX
  82
  83
  84 #if TARGET_OS_OSX
  85 extern SecCmsRecipientInfoRef
  86 SecCmsRecipientInfoCreateWithSubjKeyIDFromCert(SecCmsMessageRef cmsg,
  87                                                SecCertificateRef cert)
  88     API_AVAILABLE(macos(10.4)) API_UNAVAILABLE(macCatalyst);
  89 #else // !TARGET_OS_OSX
  90 extern SecCmsRecipientInfoRef
  91 SecCmsRecipientInfoCreateWithSubjKeyIDFromCert(SecCmsEnvelopedDataRef envd,
  92                                                SecCertificateRef cert)
  93     API_AVAILABLE(ios(2.0), tvos(2.0), watchos(1.0)) API_UNAVAILABLE(macCatalyst);
  94 #endif // !TARGET_OS_OSX
  95
  96
  97 #if TARGET_OS_OSX
  98 extern void
  99 SecCmsRecipientInfoDestroy(SecCmsRecipientInfoRef ri);
 100 #endif
 101
 102 __END_DECLS
 103
 104 #endif /* _SECURITY_SECCMSRECIPIENTINFO_H_ */