CMS/SecCmsEncryptedData.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_SECCMSENCRYPTEDDATA_H_
  35 #define _SECURITY_SECCMSENCRYPTEDDATA_H_  1
  36
  37 #include <Security/SecCmsBase.h>
  38
  39 __BEGIN_DECLS
  40
  41 /*!
  42     @function
  43     @abstract Create an empty EncryptedData object.
  44     @param algorithm Specifies the bulk encryption algorithm to use.
  45     @param keysize is the key size.
  46     @discussion An error results in a return value of NULL and an error set.
  47                 (Retrieve specific errors via PORT_GetError()/XP_GetError().)
  48  */
  49 extern SecCmsEncryptedDataRef
  50 SecCmsEncryptedDataCreate(SecCmsMessageRef cmsg, SECOidTag algorithm, int keysize);
  51
  52 /*!
  53     @function
  54     @abstract Destroy an encryptedData object.
  55  */
  56 extern void
  57 SecCmsEncryptedDataDestroy(SecCmsEncryptedDataRef encd);
  58
  59 /*!
  60     @function
  61     @abstract Return pointer to an EncryptedData object's contentInfo.
  62  */
  63 extern SecCmsContentInfoRef
  64 SecCmsEncryptedDataGetContentInfo(SecCmsEncryptedDataRef encd);
  65
  66 __END_DECLS
  67
  68 #endif /* _SECURITY_SECCMSENCRYPTEDDATA_H_ */