view | history | commit | commitdiff
Wuyx
2017-01-04 0ba5a82e9ec833aa36729dfbad7deffbf3ea05c6
commit | author | age
6e1425 1 // AFSecurityPolicy.h
H 2 // Copyright (c) 2011–2015 Alamofire Software Foundation (http://alamofire.org/)
3 //
4 // Permission is hereby granted, free of charge, to any person obtaining a copy
5 // of this software and associated documentation files (the "Software"), to deal
6 // in the Software without restriction, including without limitation the rights
7 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 // copies of the Software, and to permit persons to whom the Software is
9 // furnished to do so, subject to the following conditions:
10 //
11 // The above copyright notice and this permission notice shall be included in
12 // all copies or substantial portions of the Software.
13 //
14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 // THE SOFTWARE.
21
22 #import <Foundation/Foundation.h>
23 #import <Security/Security.h>
24
25 typedef NS_ENUM(NSUInteger, AFSSLPinningMode) {
26     AFSSLPinningModeNone,
27     AFSSLPinningModePublicKey,
28     AFSSLPinningModeCertificate,
29 };
30
31 /**
32  `AFSecurityPolicy` evaluates server trust against pinned X.509 certificates and public keys over secure connections.
33
34  Adding pinned SSL certificates to your app helps prevent man-in-the-middle attacks and other vulnerabilities. Applications dealing with sensitive customer data or financial information are strongly encouraged to route all communication over an HTTPS connection with SSL pinning configured and enabled.
35  */
36
37 NS_ASSUME_NONNULL_BEGIN
38
39 @interface AFSecurityPolicy : NSObject
40
41 /**
42  The criteria by which server trust should be evaluated against the pinned SSL certificates. Defaults to `AFSSLPinningModeNone`.
43  */
44 @property (readonly, nonatomic, assign) AFSSLPinningMode SSLPinningMode;
45
46 /**
47  The certificates used to evaluate server trust according to the SSL pinning mode. By default, this property is set to any (`.cer`) certificates included in the app bundle. Note that if you create an array with duplicate certificates, the duplicate certificates will be removed. Note that if pinning is enabled, `evaluateServerTrust:forDomain:` will return true if any pinned certificate matches.
48  */
49 @property (nonatomic, strong, nullable) NSArray *pinnedCertificates;
50
51 /**
52  Whether or not to trust servers with an invalid or expired SSL certificates. Defaults to `NO`.
53  */
54 @property (nonatomic, assign) BOOL allowInvalidCertificates;
55
56 /**
57  Whether or not to validate the domain name in the certificate's CN field. Defaults to `YES`.
58  */
59 @property (nonatomic, assign) BOOL validatesDomainName;
60
61 ///-----------------------------------------
62 /// @name Getting Specific Security Policies
63 ///-----------------------------------------
64
65 /**
66  Returns the shared default security policy, which does not allow invalid certificates, validates domain name, and does not validate against pinned certificates or public keys.
67
68  @return The default security policy.
69  */
70 + (instancetype)defaultPolicy;
71
72 ///---------------------
73 /// @name Initialization
74 ///---------------------
75
76 /**
77  Creates and returns a security policy with the specified pinning mode.
78
79  @param pinningMode The SSL pinning mode.
80
81  @return A new security policy.
82  */
83 + (instancetype)policyWithPinningMode:(AFSSLPinningMode)pinningMode;
84
85 ///------------------------------
86 /// @name Evaluating Server Trust
87 ///------------------------------
88
89 /**
90  Whether or not the specified server trust should be accepted, based on the security policy.
91
92  This method should be used when responding to an authentication challenge from a server.
93
94  @param serverTrust The X.509 certificate trust of the server.
95
96  @return Whether or not to trust the server.
97
98  @warning This method has been deprecated in favor of `-evaluateServerTrust:forDomain:`.
99  */
100 - (BOOL)evaluateServerTrust:(SecTrustRef)serverTrust DEPRECATED_ATTRIBUTE;
101
102 /**
103  Whether or not the specified server trust should be accepted, based on the security policy.
104
105  This method should be used when responding to an authentication challenge from a server.
106
107  @param serverTrust The X.509 certificate trust of the server.
108  @param domain The domain of serverTrust. If `nil`, the domain will not be validated.
109
110  @return Whether or not to trust the server.
111  */
112 - (BOOL)evaluateServerTrust:(SecTrustRef)serverTrust
113                   forDomain:(nullable NSString *)domain;
114
115 @end
116
117 NS_ASSUME_NONNULL_END
118
119 ///----------------
120 /// @name Constants
121 ///----------------
122
123 /**
124  ## SSL Pinning Modes
125
126  The following constants are provided by `AFSSLPinningMode` as possible SSL pinning modes.
127
128  enum {
129  AFSSLPinningModeNone,
130  AFSSLPinningModePublicKey,
131  AFSSLPinningModeCertificate,
132  }
133
134  `AFSSLPinningModeNone`
135  Do not used pinned certificates to validate servers.
136
137  `AFSSLPinningModePublicKey`
138  Validate host certificates against public keys of pinned certificates.
139
140  `AFSSLPinningModeCertificate`
141  Validate host certificates against pinned certificates.
142 */