| commit | author | age | ||
| 6e1425 | 1 | // AFSecurityPolicy.h |
| 633752 | 2 | // Copyright (c) 2011–2016 Alamofire Software Foundation ( http://alamofire.org/ ) |
| 6e1425 | 3 | // |
| H | 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 | ||
| 633752 | 39 | @interface AFSecurityPolicy : NSObject <NSSecureCoding, NSCopying> |
| 6e1425 | 40 | |
| H | 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 | /** | |
| 633752 | 47 | The certificates used to evaluate server trust according to the SSL pinning mode. |
| L | 48 | |
| 49 | Note that if pinning is enabled, `evaluateServerTrust:forDomain:` will return true if any pinned certificate matches. | |
| bf3f86 | 50 | |
| L | 51 | @see policyWithPinningMode:withPinnedCertificates: |
| 6e1425 | 52 | */ |
| 633752 | 53 | @property (nonatomic, strong, nullable) NSSet <NSData *> *pinnedCertificates; |
| 6e1425 | 54 | |
| H | 55 | /** |
| 56 | Whether or not to trust servers with an invalid or expired SSL certificates. Defaults to `NO`. | |
| 57 | */ | |
| 58 | @property (nonatomic, assign) BOOL allowInvalidCertificates; | |
| 59 | ||
| 60 | /** | |
| 61 | Whether or not to validate the domain name in the certificate's CN field. Defaults to `YES`. | |
| 62 | */ | |
| 63 | @property (nonatomic, assign) BOOL validatesDomainName; | |
| 633752 | 64 | |
| L | 65 | ///----------------------------------------- |
| 66 | /// @name Getting Certificates from the Bundle | |
| 67 | ///----------------------------------------- | |
| 68 | ||
| 69 | /** | |
| 70 | Returns any certificates included in the bundle. If you are using AFNetworking as an embedded framework, you must use this method to find the certificates you have included in your app bundle, and use them when creating your security policy by calling `policyWithPinningMode:withPinnedCertificates`. | |
| 71 | ||
| 72 | @return The certificates included in the given bundle. | |
| 73 | */ | |
| 74 | + (NSSet <NSData *> *)certificatesInBundle:(NSBundle *)bundle; | |
| 6e1425 | 75 | |
| H | 76 | ///----------------------------------------- |
| 77 | /// @name Getting Specific Security Policies | |
| 78 | ///----------------------------------------- | |
| 79 | ||
| 80 | /** | |
| 81 | 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. | |
| 82 | ||
| 83 | @return The default security policy. | |
| 84 | */ | |
| 85 | + (instancetype)defaultPolicy; | |
| 86 | ||
| 87 | ///--------------------- | |
| 88 | /// @name Initialization | |
| 89 | ///--------------------- | |
| 90 | ||
| 91 | /** | |
| 92 | Creates and returns a security policy with the specified pinning mode. | |
| bf3f86 | 93 | |
| L | 94 | Certificates with the `.cer` extension found in the main bundle will be pinned. If you want more control over which certificates are pinned, please use `policyWithPinningMode:withPinnedCertificates:` instead. |
| 6e1425 | 95 | |
| H | 96 | @param pinningMode The SSL pinning mode. |
| 97 | ||
| 98 | @return A new security policy. | |
| bf3f86 | 99 | |
| L | 100 | @see -policyWithPinningMode:withPinnedCertificates: |
| 6e1425 | 101 | */ |
| H | 102 | + (instancetype)policyWithPinningMode:(AFSSLPinningMode)pinningMode; |
| 103 | ||
| 633752 | 104 | /** |
| L | 105 | Creates and returns a security policy with the specified pinning mode. |
| 106 | ||
| 107 | @param pinningMode The SSL pinning mode. | |
| 108 | @param pinnedCertificates The certificates to pin against. | |
| 109 | ||
| 110 | @return A new security policy. | |
| bf3f86 | 111 | |
| L | 112 | @see +certificatesInBundle: |
| 113 | @see -pinnedCertificates | |
| 114 | */ | |
| 633752 | 115 | + (instancetype)policyWithPinningMode:(AFSSLPinningMode)pinningMode withPinnedCertificates:(NSSet <NSData *> *)pinnedCertificates; |
| L | 116 | |
| 6e1425 | 117 | ///------------------------------ |
| H | 118 | /// @name Evaluating Server Trust |
| 119 | ///------------------------------ | |
| 120 | ||
| 121 | /** | |
| 122 | Whether or not the specified server trust should be accepted, based on the security policy. | |
| 123 | ||
| 124 | This method should be used when responding to an authentication challenge from a server. | |
| 125 | ||
| 126 | @param serverTrust The X.509 certificate trust of the server. | |
| 127 | @param domain The domain of serverTrust. If `nil`, the domain will not be validated. | |
| 128 | ||
| 129 | @return Whether or not to trust the server. | |
| 130 | */ | |
| 131 | - (BOOL)evaluateServerTrust:(SecTrustRef)serverTrust | |
| 132 | forDomain:(nullable NSString *)domain; | |
| 133 | ||
| 134 | @end | |
| 135 | ||
| 136 | NS_ASSUME_NONNULL_END | |
| 137 | ||
| 138 | ///---------------- | |
| 139 | /// @name Constants | |
| 140 | ///---------------- | |
| 141 | ||
| 142 | /** | |
| 143 | ## SSL Pinning Modes | |
| 144 | ||
| 145 | The following constants are provided by `AFSSLPinningMode` as possible SSL pinning modes. | |
| 146 | ||
| 147 | enum { | |
| 148 | AFSSLPinningModeNone, | |
| 149 | AFSSLPinningModePublicKey, | |
| 150 | AFSSLPinningModeCertificate, | |
| 151 | } | |
| 152 | ||
| 153 | `AFSSLPinningModeNone` | |
| 154 | Do not used pinned certificates to validate servers. | |
| 155 | ||
| 156 | `AFSSLPinningModePublicKey` | |
| 157 | Validate host certificates against public keys of pinned certificates. | |
| 158 | ||
| 159 | `AFSSLPinningModeCertificate` | |
| 160 | Validate host certificates against pinned certificates. | |
| 161 | */ | |
