/ CMS / SecCmsDigestedData.h
SecCmsDigestedData.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 SecCmsDigestedData.h
26  
27      @availability 10.4 and later
28      @abstract Interfaces of the CMS implementation.
29      @discussion The functions here implement functions for creating
30                  and accessing the DigestData content type of a 
31                  Cryptographic Message Syntax (CMS) object
32                  as described in rfc3369.
33   */
34  
35  #ifndef _SECURITY_SECCMSDIGESTEDDATA_H_
36  #define _SECURITY_SECCMSDIGESTEDDATA_H_  1
37  
38  #include <Security/SecCmsBase.h>
39  
40  __BEGIN_DECLS
41  
42  /*!
43      @function
44      @abstract Create a digestedData object (presumably for encoding).
45      @discussion Version will be set by SecCmsDigestedDataEncodeBeforeStart
46                  digestAlg is passed as parameter
47                  contentInfo must be filled by the user
48                  digest will be calculated while encoding
49   */
50  #pragma clang diagnostic push
51  #pragma clang diagnostic ignored "-Wdeprecated-declarations"
52  extern SecCmsDigestedDataRef
53  SecCmsDigestedDataCreate(SecCmsMessageRef cmsg, SECAlgorithmID *digestalg)
54      API_AVAILABLE(macos(10.4), ios(2.0), tvos(2.0), watchos(1.0)) API_UNAVAILABLE(macCatalyst);
55  #pragma clang diagnostic pop
56  
57  /*!
58      @function
59      @abstract Destroy a digestedData object.
60   */
61  extern void
62  SecCmsDigestedDataDestroy(SecCmsDigestedDataRef digd);
63  
64  /*!
65      @function
66      @abstract Return pointer to digestedData object's contentInfo.
67   */
68  extern SecCmsContentInfoRef
69  SecCmsDigestedDataGetContentInfo(SecCmsDigestedDataRef digd);
70  
71  __END_DECLS
72  
73  #endif /* _SECURITY_SECCMSDIGESTEDDATA_H_ */