1/*
2 * Copyright (c) 2008-2009,2012-2014 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 * SecTrustServer.h - certificate trust evaluation engine
24 *
25 *
26 */
27
28#ifndef _SECURITY_SECTRUSTSERVER_H_
29#define _SECURITY_SECTRUSTSERVER_H_
30
31#include <CoreFoundation/CFString.h>
32
33#include <Security/SecCertificatePath.h>
34#include <Security/SecTrust.h>
35#include <Security/SecBasePriv.h> /* For errSecWaitForCallback. */
36#include <mach/port.h>
37
38
39__BEGIN_DECLS
40
41
42/* args_in keys. */
43#define kSecTrustCertificatesKey "certificates"
44#define kSecTrustAnchorsKey "anchors"
45#define kSecTrustAnchorsOnlyKey "anchorsOnly"
46#define kSecTrustPoliciesKey "policies"
47#define kSecTrustVerifyDateKey "verifyDate"
48
49/* args_out keys. */
50#define kSecTrustDetailsKey "details"
51#define kSecTrustChainKey "chain"
52#define kSecTrustResultKey "result"
53#define kSecTrustInfoKey "info"
54
55typedef struct SecPathBuilder *SecPathBuilderRef;
56
57/* Completion callback.  You should call SecTrustSessionDestroy from this. */
58typedef void(*SecPathBuilderCompleted)(const void *userData,
59    SecCertificatePathRef chain, CFArrayRef details, CFDictionaryRef info,
60    SecTrustResultType result);
61
62/* Returns a new trust path builder and policy evaluation engine instance. */
63SecPathBuilderRef SecPathBuilderCreate(CFArrayRef certificates,
64    CFArrayRef anchors, bool anchorsOnly, CFArrayRef policies,
65    CFAbsoluteTime verifyTime, CFArrayRef accessGroups,
66    SecPathBuilderCompleted completed, const void *userData);
67
68/* Returns true if it's ok to perform network operations for this builder. */
69bool SecPathBuilderCanAccessNetwork(SecPathBuilderRef builder);
70
71/* Disable or enable network access for this builder if allow is false
72   network access will be disabled. */
73void SecPathBuilderSetCanAccessNetwork(SecPathBuilderRef builder, bool allow);
74
75/* Core of the trust evaluation engine, this will invoke the completed
76   callback and return false if the evaluation completed, or return true if
77   the evaluation is still waiting for some external event (usually the
78   network). */
79bool SecPathBuilderStep(SecPathBuilderRef builder);
80
81/* Return the dispatch queue to be used by this builder. */
82dispatch_queue_t SecPathBuilderGetQueue(SecPathBuilderRef builder);
83
84/* Evaluate trust and call evaluated when done. */
85void SecTrustServerEvaluateBlock(CFArrayRef certificates, CFArrayRef anchors, bool anchorsOnly, CFArrayRef policies, CFAbsoluteTime verifyTime, __unused CFArrayRef accessGroups, void (^evaluated)(SecTrustResultType tr, CFArrayRef details, CFDictionaryRef info, SecCertificatePathRef chain, CFErrorRef error));
86
87/* Synchronously invoke SecTrustServerEvaluateBlock. */
88SecTrustResultType SecTrustServerEvaluate(CFArrayRef certificates, CFArrayRef anchors, bool anchorsOnly, CFArrayRef policies, CFAbsoluteTime verifyTime, __unused CFArrayRef accessGroups, CFArrayRef *details, CFDictionaryRef *info, SecCertificatePathRef *chain, CFErrorRef *error);
89
90void InitializeAnchorTable(void);
91
92__END_DECLS
93
94#endif /* !_SECURITY_SECTRUSTSERVER_H_ */
95