/ OSX / sec / Security / SecTrustStatusCodes.h
SecTrustStatusCodes.h
 1  /*
 2   * Copyright (c) 2017 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 SecTrustStatusCodes
26  */
27  
28  #ifndef _SECURITY_SECTRUSTSTATUSCODES_H_
29  #define _SECURITY_SECTRUSTSTATUSCODES_H_
30  
31  #include <Security/SecTrust.h>
32  
33  __BEGIN_DECLS
34  
35  /*!
36   @function SecTrustCopyStatusCodes
37   @abstract Returns a malloced array of SInt32 values, with the length in numStatusCodes,
38   for the certificate specified by chain index in the given SecTrustRef.
39   @param trust A reference to a trust object.
40   @param index The index of the certificate whose status codes should be returned.
41   @param numStatusCodes On return, the number of status codes allocated, or 0 if none.
42   @result A pointer to an array of status codes, or NULL if no status codes exist.
43   If the result is non-NULL, the caller must free() this pointer.
44   @discussion This function returns an array of evaluation status codes for a certificate
45   specified by its chain index in a trust reference. If NULL is returned, the certificate
46   has no status codes.
47   */
48  SInt32 *SecTrustCopyStatusCodes(SecTrustRef trust,
49                                  CFIndex index,
50                                  CFIndex *numStatusCodes);
51  __END_DECLS
52  
53  #endif /* !_SECURITY_SECTRUSTSTATUSCODES_H_ */