ServerTrustEvaluation.swift 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625
  1. //
  2. // ServerTrustPolicy.swift
  3. //
  4. // Copyright (c) 2014-2016 Alamofire Software Foundation (http://alamofire.org/)
  5. //
  6. // Permission is hereby granted, free of charge, to any person obtaining a copy
  7. // of this software and associated documentation files (the "Software"), to deal
  8. // in the Software without restriction, including without limitation the rights
  9. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10. // copies of the Software, and to permit persons to whom the Software is
  11. // furnished to do so, subject to the following conditions:
  12. //
  13. // The above copyright notice and this permission notice shall be included in
  14. // all copies or substantial portions of the Software.
  15. //
  16. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22. // THE SOFTWARE.
  23. //
  24. import Foundation
  25. /// Responsible for managing the mapping of `ServerTrustEvaluating` values to given hosts.
  26. open class ServerTrustManager {
  27. /// Determines whether all hosts for this `ServerTrustManager` must be evaluated. `true` by default.
  28. public let allHostsMustBeEvaluated: Bool
  29. /// The dictionary of policies mapped to a particular host.
  30. public let evaluators: [String: ServerTrustEvaluating]
  31. /// Initializes the `ServerTrustManager` instance with the given evaluators.
  32. ///
  33. /// Since different servers and web services can have different leaf certificates, intermediate and even root
  34. /// certificates, it is important to have the flexibility to specify evaluation policies on a per host basis. This
  35. /// allows for scenarios such as using default evaluation for host1, certificate pinning for host2, public key
  36. /// pinning for host3 and disabling evaluation for host4.
  37. ///
  38. /// - Parameters:
  39. /// - allHostsMustBeEvaluated: The value determining whether all hosts for this instance must be evaluated. `true`
  40. /// by default.
  41. /// - evaluators: A dictionary of evaluators mapped to hosts.
  42. public init(allHostsMustBeEvaluated: Bool = true, evaluators: [String: ServerTrustEvaluating]) {
  43. self.allHostsMustBeEvaluated = allHostsMustBeEvaluated
  44. self.evaluators = evaluators
  45. }
  46. #if !(os(Linux) || os(Windows))
  47. /// Returns the `ServerTrustEvaluating` value for the given host, if one is set.
  48. ///
  49. /// By default, this method will return the policy that perfectly matches the given host. Subclasses could override
  50. /// this method and implement more complex mapping implementations such as wildcards.
  51. ///
  52. /// - Parameter host: The host to use when searching for a matching policy.
  53. ///
  54. /// - Returns: The `ServerTrustEvaluating` value for the given host if found, `nil` otherwise.
  55. /// - Throws: `AFError.serverTrustEvaluationFailed` if `allHostsMustBeEvaluated` is `true` and no matching
  56. /// evaluators are found.
  57. open func serverTrustEvaluator(forHost host: String) throws -> ServerTrustEvaluating? {
  58. guard let evaluator = evaluators[host] else {
  59. if allHostsMustBeEvaluated {
  60. throw AFError.serverTrustEvaluationFailed(reason: .noRequiredEvaluator(host: host))
  61. }
  62. return nil
  63. }
  64. return evaluator
  65. }
  66. #endif
  67. }
  68. /// A protocol describing the API used to evaluate server trusts.
  69. public protocol ServerTrustEvaluating {
  70. #if os(Linux) || os(Windows)
  71. // Implement this once Linux/Windows has API for evaluating server trusts.
  72. #else
  73. /// Evaluates the given `SecTrust` value for the given `host`.
  74. ///
  75. /// - Parameters:
  76. /// - trust: The `SecTrust` value to evaluate.
  77. /// - host: The host for which to evaluate the `SecTrust` value.
  78. ///
  79. /// - Returns: A `Bool` indicating whether the evaluator considers the `SecTrust` value valid for `host`.
  80. func evaluate(_ trust: SecTrust, forHost host: String) throws
  81. #endif
  82. }
  83. // MARK: - Server Trust Evaluators
  84. #if !(os(Linux) || os(Windows))
  85. /// An evaluator which uses the default server trust evaluation while allowing you to control whether to validate the
  86. /// host provided by the challenge. Applications are encouraged to always validate the host in production environments
  87. /// to guarantee the validity of the server's certificate chain.
  88. public final class DefaultTrustEvaluator: ServerTrustEvaluating {
  89. private let validateHost: Bool
  90. /// Creates a `DefaultTrustEvaluator`.
  91. ///
  92. /// - Parameter validateHost: Determines whether or not the evaluator should validate the host. `true` by default.
  93. public init(validateHost: Bool = true) {
  94. self.validateHost = validateHost
  95. }
  96. public func evaluate(_ trust: SecTrust, forHost host: String) throws {
  97. if validateHost {
  98. try trust.af.performValidation(forHost: host)
  99. }
  100. try trust.af.performDefaultValidation(forHost: host)
  101. }
  102. }
  103. /// An evaluator which Uses the default and revoked server trust evaluations allowing you to control whether to validate
  104. /// the host provided by the challenge as well as specify the revocation flags for testing for revoked certificates.
  105. /// Apple platforms did not start testing for revoked certificates automatically until iOS 10.1, macOS 10.12 and tvOS
  106. /// 10.1 which is demonstrated in our TLS tests. Applications are encouraged to always validate the host in production
  107. /// environments to guarantee the validity of the server's certificate chain.
  108. public final class RevocationTrustEvaluator: ServerTrustEvaluating {
  109. /// Represents the options to be use when evaluating the status of a certificate.
  110. /// Only Revocation Policy Constants are valid, and can be found in [Apple's documentation](https://developer.apple.com/documentation/security/certificate_key_and_trust_services/policies/1563600-revocation_policy_constants).
  111. public struct Options: OptionSet {
  112. /// Perform revocation checking using the CRL (Certification Revocation List) method.
  113. public static let crl = Options(rawValue: kSecRevocationCRLMethod)
  114. /// Consult only locally cached replies; do not use network access.
  115. public static let networkAccessDisabled = Options(rawValue: kSecRevocationNetworkAccessDisabled)
  116. /// Perform revocation checking using OCSP (Online Certificate Status Protocol).
  117. public static let ocsp = Options(rawValue: kSecRevocationOCSPMethod)
  118. /// Prefer CRL revocation checking over OCSP; by default, OCSP is preferred.
  119. public static let preferCRL = Options(rawValue: kSecRevocationPreferCRL)
  120. /// Require a positive response to pass the policy. If the flag is not set, revocation checking is done on a
  121. /// "best attempt" basis, where failure to reach the server is not considered fatal.
  122. public static let requirePositiveResponse = Options(rawValue: kSecRevocationRequirePositiveResponse)
  123. /// Perform either OCSP or CRL checking. The checking is performed according to the method(s) specified in the
  124. /// certificate and the value of `preferCRL`.
  125. public static let any = Options(rawValue: kSecRevocationUseAnyAvailableMethod)
  126. /// The raw value of the option.
  127. public let rawValue: CFOptionFlags
  128. /// Creates an `Options` value with the given `CFOptionFlags`.
  129. ///
  130. /// - Parameter rawValue: The `CFOptionFlags` value to initialize with.
  131. public init(rawValue: CFOptionFlags) {
  132. self.rawValue = rawValue
  133. }
  134. }
  135. private let performDefaultValidation: Bool
  136. private let validateHost: Bool
  137. private let options: Options
  138. /// Creates a `RevocationTrustEvaluator`.
  139. ///
  140. /// - Note: Default and host validation will fail when using this evaluator with self-signed certificates. Use
  141. /// `PinnedCertificatesTrustEvaluator` if you need to use self-signed certificates.
  142. ///
  143. /// - Parameters:
  144. /// - performDefaultValidation: Determines whether default validation should be performed in addition to
  145. /// evaluating the pinned certificates. `true` by default.
  146. /// - validateHost: Determines whether or not the evaluator should validate the host, in addition
  147. /// to performing the default evaluation, even if `performDefaultValidation` is
  148. /// `false`. `true` by default.
  149. /// - options: The `Options` to use to check the revocation status of the certificate. `.any`
  150. /// by default.
  151. public init(performDefaultValidation: Bool = true, validateHost: Bool = true, options: Options = .any) {
  152. self.performDefaultValidation = performDefaultValidation
  153. self.validateHost = validateHost
  154. self.options = options
  155. }
  156. public func evaluate(_ trust: SecTrust, forHost host: String) throws {
  157. if performDefaultValidation {
  158. try trust.af.performDefaultValidation(forHost: host)
  159. }
  160. if validateHost {
  161. try trust.af.performValidation(forHost: host)
  162. }
  163. if #available(iOS 12, macOS 10.14, tvOS 12, watchOS 5, *) {
  164. try trust.af.evaluate(afterApplying: SecPolicy.af.revocation(options: options))
  165. } else {
  166. try trust.af.validate(policy: SecPolicy.af.revocation(options: options)) { status, result in
  167. AFError.serverTrustEvaluationFailed(reason: .revocationCheckFailed(output: .init(host, trust, status, result), options: options))
  168. }
  169. }
  170. }
  171. }
  172. /// Uses the pinned certificates to validate the server trust. The server trust is considered valid if one of the pinned
  173. /// certificates match one of the server certificates. By validating both the certificate chain and host, certificate
  174. /// pinning provides a very secure form of server trust validation mitigating most, if not all, MITM attacks.
  175. /// Applications are encouraged to always validate the host and require a valid certificate chain in production
  176. /// environments.
  177. public final class PinnedCertificatesTrustEvaluator: ServerTrustEvaluating {
  178. private let certificates: [SecCertificate]
  179. private let acceptSelfSignedCertificates: Bool
  180. private let performDefaultValidation: Bool
  181. private let validateHost: Bool
  182. /// Creates a `PinnedCertificatesTrustEvaluator`.
  183. ///
  184. /// - Parameters:
  185. /// - certificates: The certificates to use to evaluate the trust. All `cer`, `crt`, and `der`
  186. /// certificates in `Bundle.main` by default.
  187. /// - acceptSelfSignedCertificates: Adds the provided certificates as anchors for the trust evaluation, allowing
  188. /// self-signed certificates to pass. `false` by default. THIS SETTING SHOULD BE
  189. /// FALSE IN PRODUCTION!
  190. /// - performDefaultValidation: Determines whether default validation should be performed in addition to
  191. /// evaluating the pinned certificates. `true` by default.
  192. /// - validateHost: Determines whether or not the evaluator should validate the host, in addition
  193. /// to performing the default evaluation, even if `performDefaultValidation` is
  194. /// `false`. `true` by default.
  195. public init(certificates: [SecCertificate] = Bundle.main.af.certificates,
  196. acceptSelfSignedCertificates: Bool = false,
  197. performDefaultValidation: Bool = true,
  198. validateHost: Bool = true)
  199. {
  200. self.certificates = certificates
  201. self.acceptSelfSignedCertificates = acceptSelfSignedCertificates
  202. self.performDefaultValidation = performDefaultValidation
  203. self.validateHost = validateHost
  204. }
  205. public func evaluate(_ trust: SecTrust, forHost host: String) throws {
  206. guard !certificates.isEmpty else {
  207. throw AFError.serverTrustEvaluationFailed(reason: .noCertificatesFound)
  208. }
  209. if acceptSelfSignedCertificates {
  210. try trust.af.setAnchorCertificates(certificates)
  211. }
  212. if performDefaultValidation {
  213. try trust.af.performDefaultValidation(forHost: host)
  214. }
  215. if validateHost {
  216. try trust.af.performValidation(forHost: host)
  217. }
  218. let serverCertificatesData = Set(trust.af.certificateData)
  219. let pinnedCertificatesData = Set(certificates.af.data)
  220. let pinnedCertificatesInServerData = !serverCertificatesData.isDisjoint(with: pinnedCertificatesData)
  221. if !pinnedCertificatesInServerData {
  222. throw AFError.serverTrustEvaluationFailed(reason: .certificatePinningFailed(host: host,
  223. trust: trust,
  224. pinnedCertificates: certificates,
  225. serverCertificates: trust.af.certificates))
  226. }
  227. }
  228. }
  229. /// Uses the pinned public keys to validate the server trust. The server trust is considered valid if one of the pinned
  230. /// public keys match one of the server certificate public keys. By validating both the certificate chain and host,
  231. /// public key pinning provides a very secure form of server trust validation mitigating most, if not all, MITM attacks.
  232. /// Applications are encouraged to always validate the host and require a valid certificate chain in production
  233. /// environments.
  234. public final class PublicKeysTrustEvaluator: ServerTrustEvaluating {
  235. private let keys: [SecKey]
  236. private let performDefaultValidation: Bool
  237. private let validateHost: Bool
  238. /// Creates a `PublicKeysTrustEvaluator`.
  239. ///
  240. /// - Note: Default and host validation will fail when using this evaluator with self-signed certificates. Use
  241. /// `PinnedCertificatesTrustEvaluator` if you need to use self-signed certificates.
  242. ///
  243. /// - Parameters:
  244. /// - keys: The `SecKey`s to use to validate public keys. Defaults to the public keys of all
  245. /// certificates included in the main bundle.
  246. /// - performDefaultValidation: Determines whether default validation should be performed in addition to
  247. /// evaluating the pinned certificates. `true` by default.
  248. /// - validateHost: Determines whether or not the evaluator should validate the host, in addition to
  249. /// performing the default evaluation, even if `performDefaultValidation` is `false`.
  250. /// `true` by default.
  251. public init(keys: [SecKey] = Bundle.main.af.publicKeys,
  252. performDefaultValidation: Bool = true,
  253. validateHost: Bool = true)
  254. {
  255. self.keys = keys
  256. self.performDefaultValidation = performDefaultValidation
  257. self.validateHost = validateHost
  258. }
  259. public func evaluate(_ trust: SecTrust, forHost host: String) throws {
  260. guard !keys.isEmpty else {
  261. throw AFError.serverTrustEvaluationFailed(reason: .noPublicKeysFound)
  262. }
  263. if performDefaultValidation {
  264. try trust.af.performDefaultValidation(forHost: host)
  265. }
  266. if validateHost {
  267. try trust.af.performValidation(forHost: host)
  268. }
  269. let pinnedKeysInServerKeys: Bool = {
  270. for serverPublicKey in trust.af.publicKeys {
  271. for pinnedPublicKey in keys {
  272. if serverPublicKey == pinnedPublicKey {
  273. return true
  274. }
  275. }
  276. }
  277. return false
  278. }()
  279. if !pinnedKeysInServerKeys {
  280. throw AFError.serverTrustEvaluationFailed(reason: .publicKeyPinningFailed(host: host,
  281. trust: trust,
  282. pinnedKeys: keys,
  283. serverKeys: trust.af.publicKeys))
  284. }
  285. }
  286. }
  287. /// Uses the provided evaluators to validate the server trust. The trust is only considered valid if all of the
  288. /// evaluators consider it valid.
  289. public final class CompositeTrustEvaluator: ServerTrustEvaluating {
  290. private let evaluators: [ServerTrustEvaluating]
  291. /// Creates a `CompositeTrustEvaluator`.
  292. ///
  293. /// - Parameter evaluators: The `ServerTrustEvaluating` values used to evaluate the server trust.
  294. public init(evaluators: [ServerTrustEvaluating]) {
  295. self.evaluators = evaluators
  296. }
  297. public func evaluate(_ trust: SecTrust, forHost host: String) throws {
  298. try evaluators.evaluate(trust, forHost: host)
  299. }
  300. }
  301. /// Disables all evaluation which in turn will always consider any server trust as valid.
  302. ///
  303. /// - Note: Instead of disabling server trust evaluation, it's a better idea to configure systems to properly trust test
  304. /// certificates, as outlined in [this Apple tech note](https://developer.apple.com/library/archive/qa/qa1948/_index.html).
  305. ///
  306. /// **THIS EVALUATOR SHOULD NEVER BE USED IN PRODUCTION!**
  307. @available(*, deprecated, renamed: "DisabledTrustEvaluator", message: "DisabledEvaluator has been renamed DisabledTrustEvaluator.")
  308. public typealias DisabledEvaluator = DisabledTrustEvaluator
  309. /// Disables all evaluation which in turn will always consider any server trust as valid.
  310. ///
  311. ///
  312. /// - Note: Instead of disabling server trust evaluation, it's a better idea to configure systems to properly trust test
  313. /// certificates, as outlined in [this Apple tech note](https://developer.apple.com/library/archive/qa/qa1948/_index.html).
  314. ///
  315. /// **THIS EVALUATOR SHOULD NEVER BE USED IN PRODUCTION!**
  316. public final class DisabledTrustEvaluator: ServerTrustEvaluating {
  317. /// Creates an instance.
  318. public init() {}
  319. public func evaluate(_: SecTrust, forHost _: String) throws {}
  320. }
  321. // MARK: - Extensions
  322. public extension Array where Element == ServerTrustEvaluating {
  323. #if os(Linux) || os(Windows)
  324. // Add this same convenience method for Linux/Windows.
  325. #else
  326. /// Evaluates the given `SecTrust` value for the given `host`.
  327. ///
  328. /// - Parameters:
  329. /// - trust: The `SecTrust` value to evaluate.
  330. /// - host: The host for which to evaluate the `SecTrust` value.
  331. ///
  332. /// - Returns: Whether or not the evaluator considers the `SecTrust` value valid for `host`.
  333. func evaluate(_ trust: SecTrust, forHost host: String) throws {
  334. for evaluator in self {
  335. try evaluator.evaluate(trust, forHost: host)
  336. }
  337. }
  338. #endif
  339. }
  340. extension Bundle: AlamofireExtended {}
  341. public extension AlamofireExtension where ExtendedType: Bundle {
  342. /// Returns all valid `cer`, `crt`, and `der` certificates in the bundle.
  343. var certificates: [SecCertificate] {
  344. paths(forResourcesOfTypes: [".cer", ".CER", ".crt", ".CRT", ".der", ".DER"]).compactMap { path in
  345. guard
  346. let certificateData = try? Data(contentsOf: URL(fileURLWithPath: path)) as CFData,
  347. let certificate = SecCertificateCreateWithData(nil, certificateData) else { return nil }
  348. return certificate
  349. }
  350. }
  351. /// Returns all public keys for the valid certificates in the bundle.
  352. var publicKeys: [SecKey] {
  353. certificates.af.publicKeys
  354. }
  355. /// Returns all pathnames for the resources identified by the provided file extensions.
  356. ///
  357. /// - Parameter types: The filename extensions locate.
  358. ///
  359. /// - Returns: All pathnames for the given filename extensions.
  360. func paths(forResourcesOfTypes types: [String]) -> [String] {
  361. Array(Set(types.flatMap { type.paths(forResourcesOfType: $0, inDirectory: nil) }))
  362. }
  363. }
  364. extension SecTrust: AlamofireExtended {}
  365. public extension AlamofireExtension where ExtendedType == SecTrust {
  366. /// Evaluates `self` after applying the `SecPolicy` value provided.
  367. ///
  368. /// - Parameter policy: The `SecPolicy` to apply to `self` before evaluation.
  369. ///
  370. /// - Throws: Any `Error` from applying the `SecPolicy` or from evaluation.
  371. @available(iOS 12, macOS 10.14, tvOS 12, watchOS 5, *)
  372. func evaluate(afterApplying policy: SecPolicy) throws {
  373. try apply(policy: policy).af.evaluate()
  374. }
  375. /// Attempts to validate `self` using the `SecPolicy` provided and transforming any error produced using the closure passed.
  376. ///
  377. /// - Parameters:
  378. /// - policy: The `SecPolicy` used to evaluate `self`.
  379. /// - errorProducer: The closure used transform the failed `OSStatus` and `SecTrustResultType`.
  380. /// - Throws: Any `Error` from applying the `policy`, or the result of `errorProducer` if validation fails.
  381. @available(iOS, introduced: 10, deprecated: 12, renamed: "evaluate(afterApplying:)")
  382. @available(macOS, introduced: 10.12, deprecated: 10.14, renamed: "evaluate(afterApplying:)")
  383. @available(tvOS, introduced: 10, deprecated: 12, renamed: "evaluate(afterApplying:)")
  384. @available(watchOS, introduced: 3, deprecated: 5, renamed: "evaluate(afterApplying:)")
  385. func validate(policy: SecPolicy, errorProducer: (_ status: OSStatus, _ result: SecTrustResultType) -> Error) throws {
  386. try apply(policy: policy).af.validate(errorProducer: errorProducer)
  387. }
  388. /// Applies a `SecPolicy` to `self`, throwing if it fails.
  389. ///
  390. /// - Parameter policy: The `SecPolicy`.
  391. ///
  392. /// - Returns: `self`, with the policy applied.
  393. /// - Throws: An `AFError.serverTrustEvaluationFailed` instance with a `.policyApplicationFailed` reason.
  394. func apply(policy: SecPolicy) throws -> SecTrust {
  395. let status = SecTrustSetPolicies(type, policy)
  396. guard status.af.isSuccess else {
  397. throw AFError.serverTrustEvaluationFailed(reason: .policyApplicationFailed(trust: type,
  398. policy: policy,
  399. status: status))
  400. }
  401. return type
  402. }
  403. /// Evaluate `self`, throwing an `Error` if evaluation fails.
  404. ///
  405. /// - Throws: `AFError.serverTrustEvaluationFailed` with reason `.trustValidationFailed` and associated error from
  406. /// the underlying evaluation.
  407. @available(iOS 12, macOS 10.14, tvOS 12, watchOS 5, *)
  408. func evaluate() throws {
  409. var error: CFError?
  410. let evaluationSucceeded = SecTrustEvaluateWithError(type, &error)
  411. if !evaluationSucceeded {
  412. throw AFError.serverTrustEvaluationFailed(reason: .trustEvaluationFailed(error: error))
  413. }
  414. }
  415. /// Validate `self`, passing any failure values through `errorProducer`.
  416. ///
  417. /// - Parameter errorProducer: The closure used to transform the failed `OSStatus` and `SecTrustResultType` into an
  418. /// `Error`.
  419. /// - Throws: The `Error` produced by the `errorProducer` closure.
  420. @available(iOS, introduced: 10, deprecated: 12, renamed: "evaluate()")
  421. @available(macOS, introduced: 10.12, deprecated: 10.14, renamed: "evaluate()")
  422. @available(tvOS, introduced: 10, deprecated: 12, renamed: "evaluate()")
  423. @available(watchOS, introduced: 3, deprecated: 5, renamed: "evaluate()")
  424. func validate(errorProducer: (_ status: OSStatus, _ result: SecTrustResultType) -> Error) throws {
  425. var result = SecTrustResultType.invalid
  426. let status = SecTrustEvaluate(type, &result)
  427. guard status.af.isSuccess, result.af.isSuccess else {
  428. throw errorProducer(status, result)
  429. }
  430. }
  431. /// Sets a custom certificate chain on `self`, allowing full validation of a self-signed certificate and its chain.
  432. ///
  433. /// - Parameter certificates: The `SecCertificate`s to add to the chain.
  434. /// - Throws: Any error produced when applying the new certificate chain.
  435. func setAnchorCertificates(_ certificates: [SecCertificate]) throws {
  436. // Add additional anchor certificates.
  437. let status = SecTrustSetAnchorCertificates(type, certificates as CFArray)
  438. guard status.af.isSuccess else {
  439. throw AFError.serverTrustEvaluationFailed(reason: .settingAnchorCertificatesFailed(status: status,
  440. certificates: certificates))
  441. }
  442. // Trust only the set anchor certs.
  443. let onlyStatus = SecTrustSetAnchorCertificatesOnly(type, true)
  444. guard onlyStatus.af.isSuccess else {
  445. throw AFError.serverTrustEvaluationFailed(reason: .settingAnchorCertificatesFailed(status: onlyStatus,
  446. certificates: certificates))
  447. }
  448. }
  449. /// The public keys contained in `self`.
  450. var publicKeys: [SecKey] {
  451. certificates.af.publicKeys
  452. }
  453. /// The `SecCertificate`s contained i `self`.
  454. var certificates: [SecCertificate] {
  455. (0..<SecTrustGetCertificateCount(type)).compactMap { index in
  456. SecTrustGetCertificateAtIndex(type, index)
  457. }
  458. }
  459. /// The `Data` values for all certificates contained in `self`.
  460. var certificateData: [Data] {
  461. certificates.af.data
  462. }
  463. /// Validates `self` after applying `SecPolicy.af.default`. This evaluation does not validate the hostname.
  464. ///
  465. /// - Parameter host: The hostname, used only in the error output if validation fails.
  466. /// - Throws: An `AFError.serverTrustEvaluationFailed` instance with a `.defaultEvaluationFailed` reason.
  467. func performDefaultValidation(forHost host: String) throws {
  468. if #available(iOS 12, macOS 10.14, tvOS 12, watchOS 5, *) {
  469. try evaluate(afterApplying: SecPolicy.af.default)
  470. } else {
  471. try validate(policy: SecPolicy.af.default) { status, result in
  472. AFError.serverTrustEvaluationFailed(reason: .defaultEvaluationFailed(output: .init(host, type, status, result)))
  473. }
  474. }
  475. }
  476. /// Validates `self` after applying `SecPolicy.af.hostname(host)`, which performs the default validation as well as
  477. /// hostname validation.
  478. ///
  479. /// - Parameter host: The hostname to use in the validation.
  480. /// - Throws: An `AFError.serverTrustEvaluationFailed` instance with a `.defaultEvaluationFailed` reason.
  481. func performValidation(forHost host: String) throws {
  482. if #available(iOS 12, macOS 10.14, tvOS 12, watchOS 5, *) {
  483. try evaluate(afterApplying: SecPolicy.af.hostname(host))
  484. } else {
  485. try validate(policy: SecPolicy.af.hostname(host)) { status, result in
  486. AFError.serverTrustEvaluationFailed(reason: .hostValidationFailed(output: .init(host, type, status, result)))
  487. }
  488. }
  489. }
  490. }
  491. extension SecPolicy: AlamofireExtended {}
  492. public extension AlamofireExtension where ExtendedType == SecPolicy {
  493. /// Creates a `SecPolicy` instance which will validate server certificates but not require a host name match.
  494. static let `default` = SecPolicyCreateSSL(true, nil)
  495. /// Creates a `SecPolicy` instance which will validate server certificates and much match the provided hostname.
  496. ///
  497. /// - Parameter hostname: The hostname to validate against.
  498. ///
  499. /// - Returns: The `SecPolicy`.
  500. static func hostname(_ hostname: String) -> SecPolicy {
  501. SecPolicyCreateSSL(true, hostname as CFString)
  502. }
  503. /// Creates a `SecPolicy` which checks the revocation of certificates.
  504. ///
  505. /// - Parameter options: The `RevocationTrustEvaluator.Options` for evaluation.
  506. ///
  507. /// - Returns: The `SecPolicy`.
  508. /// - Throws: An `AFError.serverTrustEvaluationFailed` error with reason `.revocationPolicyCreationFailed`
  509. /// if the policy cannot be created.
  510. static func revocation(options: RevocationTrustEvaluator.Options) throws -> SecPolicy {
  511. guard let policy = SecPolicyCreateRevocation(options.rawValue) else {
  512. throw AFError.serverTrustEvaluationFailed(reason: .revocationPolicyCreationFailed)
  513. }
  514. return policy
  515. }
  516. }
  517. extension Array: AlamofireExtended {}
  518. public extension AlamofireExtension where ExtendedType == [SecCertificate] {
  519. /// All `Data` values for the contained `SecCertificate`s.
  520. var data: [Data] {
  521. type.map { SecCertificateCopyData($0) as Data }
  522. }
  523. /// All public `SecKey` values for the contained `SecCertificate`s.
  524. var publicKeys: [SecKey] {
  525. type.compactMap { $0.af.publicKey }
  526. }
  527. }
  528. extension SecCertificate: AlamofireExtended {}
  529. public extension AlamofireExtension where ExtendedType == SecCertificate {
  530. /// The public key for `self`, if it can be extracted.
  531. var publicKey: SecKey? {
  532. let policy = SecPolicyCreateBasicX509()
  533. var trust: SecTrust?
  534. let trustCreationStatus = SecTrustCreateWithCertificates(type, policy, &trust)
  535. guard let createdTrust = trust, trustCreationStatus == errSecSuccess else { return nil }
  536. return SecTrustCopyPublicKey(createdTrust)
  537. }
  538. }
  539. extension OSStatus: AlamofireExtended {}
  540. public extension AlamofireExtension where ExtendedType == OSStatus {
  541. /// Returns whether `self` is `errSecSuccess`.
  542. var isSuccess: Bool { type == errSecSuccess }
  543. }
  544. extension SecTrustResultType: AlamofireExtended {}
  545. public extension AlamofireExtension where ExtendedType == SecTrustResultType {
  546. /// Returns whether `self is `.unspecified` or `.proceed`.
  547. var isSuccess: Bool {
  548. type == .unspecified || type == .proceed
  549. }
  550. }
  551. #endif