2 * Copyright (c) 2008-2009,2012-2014 Apple Inc. All Rights Reserved.
4 * @APPLE_LICENSE_HEADER_START@
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
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.
21 * @APPLE_LICENSE_HEADER_END@
23 * SecTrustServer.h - certificate trust evaluation engine
28 #ifndef _SECURITY_SECTRUSTSERVER_H_
29 #define _SECURITY_SECTRUSTSERVER_H_
31 #include <CoreFoundation/CFString.h>
33 #include <Security/SecCertificatePath.h>
34 #include <Security/SecTrust.h>
35 #include <Security/SecBasePriv.h> /* For errSecWaitForCallback. */
36 #include <mach/port.h>
41 typedef struct SecPathBuilder
*SecPathBuilderRef
;
43 /* Completion callback. You should call SecTrustSessionDestroy from this. */
44 typedef void(*SecPathBuilderCompleted
)(const void *userData
,
45 SecCertificatePathRef chain
, CFArrayRef details
, CFDictionaryRef info
,
46 SecTrustResultType result
);
48 /* Returns a new trust path builder and policy evaluation engine instance. */
49 SecPathBuilderRef
SecPathBuilderCreate(CFDataRef clientAuditToken
,
50 CFArrayRef certificates
, CFArrayRef anchors
, bool anchorsOnly
,
51 bool keychainsAllowed
, CFArrayRef policies
, CFArrayRef ocspResponse
,
52 CFArrayRef signedCertificateTimestamps
, CFArrayRef trustedLogs
,
53 CFAbsoluteTime verifyTime
, CFArrayRef accessGroups
,
54 SecPathBuilderCompleted completed
, const void *userData
);
56 /* Returns true if it's ok to perform network operations for this builder. */
57 bool SecPathBuilderCanAccessNetwork(SecPathBuilderRef builder
);
59 /* Disable or enable network access for this builder if allow is false
60 network access will be disabled. */
61 void SecPathBuilderSetCanAccessNetwork(SecPathBuilderRef builder
, bool allow
);
63 /* Get the stapled SCTs */
64 CFArrayRef
SecPathBuilderCopySignedCertificateTimestamps(SecPathBuilderRef builder
);
65 CFArrayRef
SecPathBuilderCopyOCSPResponses(SecPathBuilderRef builder
);
66 CFArrayRef
SecPathBuilderCopyTrustedLogs(SecPathBuilderRef builder
);
68 /* Core of the trust evaluation engine, this will invoke the completed
69 callback and return false if the evaluation completed, or return true if
70 the evaluation is still waiting for some external event (usually the
72 bool SecPathBuilderStep(SecPathBuilderRef builder
);
74 /* Return the dispatch queue to be used by this builder. */
75 dispatch_queue_t
SecPathBuilderGetQueue(SecPathBuilderRef builder
);
77 /* Return the client audit token associated with this path builder,
78 which caller must release, or NULL if there is no external client. */
79 CFDataRef
SecPathBuilderCopyClientAuditToken(SecPathBuilderRef builder
);
81 /* Evaluate trust and call evaluated when done. */
82 void SecTrustServerEvaluateBlock(CFDataRef clientAuditToken
, CFArrayRef certificates
, CFArrayRef anchors
, bool anchorsOnly
, bool keychainsAllowed
, CFArrayRef policies
, CFArrayRef responses
, CFArrayRef SCTs
, CFArrayRef trustedLogs
, CFAbsoluteTime verifyTime
, __unused CFArrayRef accessGroups
, void (^evaluated
)(SecTrustResultType tr
, CFArrayRef details
, CFDictionaryRef info
, SecCertificatePathRef chain
, CFErrorRef error
));
84 /* Synchronously invoke SecTrustServerEvaluateBlock. */
85 SecTrustResultType
SecTrustServerEvaluate(CFArrayRef certificates
, CFArrayRef anchors
, bool anchorsOnly
, bool keychainsAllowed
, CFArrayRef policies
, CFArrayRef responses
, CFArrayRef SCTs
, CFArrayRef trustedLogs
, CFAbsoluteTime verifyTime
, __unused CFArrayRef accessGroups
, CFArrayRef
*details
, CFDictionaryRef
*info
, SecCertificatePathRef
*chain
, CFErrorRef
*error
);
87 void InitializeAnchorTable(void);
89 /* Return the current best chain */
90 SecCertificatePathRef
SecPathBuilderGetBestPath(SecPathBuilderRef builder
);
94 #endif /* !_SECURITY_SECTRUSTSERVER_H_ */