ServerTrustPolicy.html 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>ServerTrustPolicy Enumeration Reference</title>
  5. <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
  6. <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
  7. <meta charset="utf-8">
  8. <script src="../js/jquery.min.js" defer></script>
  9. <script src="../js/jazzy.js" defer></script>
  10. <script src="../js/lunr.min.js" defer></script>
  11. <script src="../js/typeahead.jquery.js" defer></script>
  12. <script src="../js/jazzy.search.js" defer></script>
  13. </head>
  14. <body>
  15. <a name="//apple_ref/swift/Enum/ServerTrustPolicy" class="dashAnchor"></a>
  16. <a title="ServerTrustPolicy Enumeration Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="../index.html">
  20. Alamofire Docs
  21. </a>
  22. (87% documented)
  23. </p>
  24. <p class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </p>
  29. <p class="header-col header-col--secondary">
  30. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  31. <img class="header-icon" src="../img/gh.png"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. <p class="header-col header-col--secondary">
  36. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
  37. <img class="header-icon" src="../img/dash.png"/>
  38. Install in Dash
  39. </a>
  40. </p>
  41. </header>
  42. <p class="breadcrumbs">
  43. <a class="breadcrumb" href="../index.html">Alamofire Reference</a>
  44. <img class="carat" src="../img/carat.png" />
  45. ServerTrustPolicy Enumeration Reference
  46. </p>
  47. <div class="content-wrapper">
  48. <nav class="navigation">
  49. <ul class="nav-groups">
  50. <li class="nav-group-name">
  51. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  52. <ul class="nav-group-tasks">
  53. <li class="nav-group-task">
  54. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/DownloadRequest/DownloadOptions.html">– DownloadOptions</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/Request/ValidationResult.html">– ValidationResult</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/ServerTrustPolicyManager.html">ServerTrustPolicyManager</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/SessionManager.html">SessionManager</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/SessionManager/MultipartFormDataEncodingResult.html">– MultipartFormDataEncodingResult</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/TaskDelegate.html">TaskDelegate</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  100. </li>
  101. </ul>
  102. </li>
  103. <li class="nav-group-name">
  104. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  105. <ul class="nav-group-tasks">
  106. <li class="nav-group-task">
  107. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  108. </li>
  109. <li class="nav-group-task">
  110. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  111. </li>
  112. <li class="nav-group-task">
  113. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  114. </li>
  115. <li class="nav-group-task">
  116. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  117. </li>
  118. <li class="nav-group-task">
  119. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  120. </li>
  121. <li class="nav-group-task">
  122. <a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a>
  123. </li>
  124. <li class="nav-group-task">
  125. <a class="nav-group-task-link" href="../Enums/Result.html">Result</a>
  126. </li>
  127. <li class="nav-group-task">
  128. <a class="nav-group-task-link" href="../Enums/ServerTrustPolicy.html">ServerTrustPolicy</a>
  129. </li>
  130. </ul>
  131. </li>
  132. <li class="nav-group-name">
  133. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  134. <ul class="nav-group-tasks">
  135. <li class="nav-group-task">
  136. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  137. </li>
  138. <li class="nav-group-task">
  139. <a class="nav-group-task-link" href="../Extensions/Notification/Name.html">– Name</a>
  140. </li>
  141. <li class="nav-group-task">
  142. <a class="nav-group-task-link" href="../Extensions/Notification/Key.html">– Key</a>
  143. </li>
  144. <li class="nav-group-task">
  145. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  146. </li>
  147. <li class="nav-group-task">
  148. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  149. </li>
  150. <li class="nav-group-task">
  151. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  152. </li>
  153. <li class="nav-group-task">
  154. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  155. </li>
  156. </ul>
  157. </li>
  158. <li class="nav-group-name">
  159. <a class="nav-group-name-link" href="../Functions.html">Functions</a>
  160. <ul class="nav-group-tasks">
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiSbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headers10Foundation3URLV011destinationO0_AD0C7OptionsV7optionstAU_So15HTTPURLResponseCtcSg2totF">download(_:method:parameters:encoding:headers:to:)</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationH0_AD0C7OptionsV7optionstAH_So15HTTPURLResponseCtcSg2totF">download(_:to:)</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestC10Foundation4DataV12resumingWith_AE3URLV011destinationI0_AD0C7OptionsV7optionstAJ_So15HTTPURLResponseCtcSg2totF">download(resumingWith:to:)</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headerstF">request(_:method:parameters:encoding:headers:)</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSo10NetServiceC4with_tF">stream(with:)</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSS12withHostName_Si4porttF">stream(withHostName:port:)</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headersyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a>
  205. </li>
  206. <li class="nav-group-task">
  207. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA21URLRequestConvertible_p4withyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:with:encodingCompletion:)</a>
  208. </li>
  209. </ul>
  210. </li>
  211. <li class="nav-group-name">
  212. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  213. <ul class="nav-group-tasks">
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  216. </li>
  217. <li class="nav-group-task">
  218. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  219. </li>
  220. <li class="nav-group-task">
  221. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  222. </li>
  223. <li class="nav-group-task">
  224. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  225. </li>
  226. <li class="nav-group-task">
  227. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  228. </li>
  229. <li class="nav-group-task">
  230. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  231. </li>
  232. <li class="nav-group-task">
  233. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  234. </li>
  235. </ul>
  236. </li>
  237. <li class="nav-group-name">
  238. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  239. <ul class="nav-group-tasks">
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Structs/DataResponseSerializer.html">DataResponseSerializer</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Structs/DefaultDataResponse.html">DefaultDataResponse</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Structs/DefaultDownloadResponse.html">DefaultDownloadResponse</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  254. </li>
  255. <li class="nav-group-task">
  256. <a class="nav-group-task-link" href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a>
  257. </li>
  258. <li class="nav-group-task">
  259. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  260. </li>
  261. <li class="nav-group-task">
  262. <a class="nav-group-task-link" href="../Structs/PropertyListEncoding.html">PropertyListEncoding</a>
  263. </li>
  264. <li class="nav-group-task">
  265. <a class="nav-group-task-link" href="../Structs/Timeline.html">Timeline</a>
  266. </li>
  267. <li class="nav-group-task">
  268. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  269. </li>
  270. <li class="nav-group-task">
  271. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  272. </li>
  273. </ul>
  274. </li>
  275. <li class="nav-group-name">
  276. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  277. <ul class="nav-group-tasks">
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a>
  286. </li>
  287. </ul>
  288. </li>
  289. </ul>
  290. </nav>
  291. <article class="main-content">
  292. <section class="section">
  293. <div class="section-content">
  294. <h1>ServerTrustPolicy</h1>
  295. <div class="declaration">
  296. <div class="language">
  297. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ServerTrustPolicy</span></code></pre>
  298. </div>
  299. </div>
  300. <p>The <code>ServerTrustPolicy</code> evaluates the server trust generally provided by an <code>NSURLAuthenticationChallenge</code> when
  301. connecting to a server over a secure HTTPS connection. The policy configuration then evaluates the server trust
  302. with a given set of criteria to determine whether the server trust is valid and the connection should be made.</p>
  303. <p>Using pinned certificates or public keys for evaluation helps prevent man-in-the-middle (MITM) attacks and other
  304. vulnerabilities. Applications dealing with sensitive customer data or financial information are strongly encouraged
  305. to route all communication over an HTTPS connection with pinning enabled.</p>
  306. <ul>
  307. <li><p>performDefaultEvaluation: Uses the default server trust evaluation while allowing you to control whether to
  308. validate the host provided by the challenge. Applications are encouraged to always
  309. validate the host in production environments to guarantee the validity of the server&rsquo;s
  310. certificate chain.</p></li>
  311. <li><p>performRevokedEvaluation: Uses the default and revoked server trust evaluations allowing you to control whether to
  312. validate the host provided by the challenge as well as specify the revocation flags for
  313. testing for revoked certificates. Apple platforms did not start testing for revoked
  314. certificates automatically until iOS 10.1, macOS 10.12 and tvOS 10.1 which is
  315. demonstrated in our TLS tests. Applications are encouraged to always validate the host
  316. in production environments to guarantee the validity of the server&rsquo;s certificate chain.</p></li>
  317. <li><p>pinCertificates: Uses the pinned certificates to validate the server trust. The server trust is
  318. considered valid if one of the pinned certificates match one of the server certificates.
  319. By validating both the certificate chain and host, certificate pinning provides a very
  320. secure form of server trust validation mitigating most, if not all, MITM attacks.
  321. Applications are encouraged to always validate the host and require a valid certificate
  322. chain in production environments.</p></li>
  323. <li><p>pinPublicKeys: Uses the pinned public keys to validate the server trust. The server trust is considered
  324. valid if one of the pinned public keys match one of the server certificate public keys.
  325. By validating both the certificate chain and host, public key pinning provides a very
  326. secure form of server trust validation mitigating most, if not all, MITM attacks.
  327. Applications are encouraged to always validate the host and require a valid certificate
  328. chain in production environments.</p></li>
  329. <li><p>disableEvaluation: Disables all evaluation which in turn will always consider any server trust as valid.</p></li>
  330. <li><p>customEvaluation: Uses the associated closure to evaluate the validity of the server trust.</p></li>
  331. </ul>
  332. </div>
  333. </section>
  334. <section class="section">
  335. <div class="section-content">
  336. <div class="task-group">
  337. <ul class="item-container">
  338. <li class="item">
  339. <div>
  340. <code>
  341. <a name="/s:9Alamofire17ServerTrustPolicyO24performDefaultEvaluationACSb12validateHost_tcACmF"></a>
  342. <a name="//apple_ref/swift/Element/performDefaultEvaluation" class="dashAnchor"></a>
  343. <a class="token" href="#/s:9Alamofire17ServerTrustPolicyO24performDefaultEvaluationACSb12validateHost_tcACmF">performDefaultEvaluation</a>
  344. </code>
  345. </div>
  346. <div class="height-container">
  347. <div class="pointer-container"></div>
  348. <section class="section">
  349. <div class="pointer"></div>
  350. <div class="abstract">
  351. <p>Undocumented</p>
  352. </div>
  353. <div class="declaration">
  354. <h4>Declaration</h4>
  355. <div class="language">
  356. <p class="aside-title">Swift</p>
  357. <pre class="highlight"><code><span class="k">case</span> <span class="nf">performDefaultEvaluation</span><span class="p">(</span><span class="nv">validateHost</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>
  358. </div>
  359. </div>
  360. </section>
  361. </div>
  362. </li>
  363. </ul>
  364. </div>
  365. <div class="task-group">
  366. <ul class="item-container">
  367. <li class="item">
  368. <div>
  369. <code>
  370. <a name="/s:9Alamofire17ServerTrustPolicyO24performRevokedEvaluationACSb12validateHost_Su15revocationFlagstcACmF"></a>
  371. <a name="//apple_ref/swift/Element/performRevokedEvaluation" class="dashAnchor"></a>
  372. <a class="token" href="#/s:9Alamofire17ServerTrustPolicyO24performRevokedEvaluationACSb12validateHost_Su15revocationFlagstcACmF">performRevokedEvaluation</a>
  373. </code>
  374. </div>
  375. <div class="height-container">
  376. <div class="pointer-container"></div>
  377. <section class="section">
  378. <div class="pointer"></div>
  379. <div class="abstract">
  380. <p>Undocumented</p>
  381. </div>
  382. <div class="declaration">
  383. <h4>Declaration</h4>
  384. <div class="language">
  385. <p class="aside-title">Swift</p>
  386. <pre class="highlight"><code><span class="k">case</span> <span class="nf">performRevokedEvaluation</span><span class="p">(</span><span class="nv">validateHost</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">revocationFlags</span><span class="p">:</span> <span class="kt">CFOptionFlags</span><span class="p">)</span></code></pre>
  387. </div>
  388. </div>
  389. </section>
  390. </div>
  391. </li>
  392. </ul>
  393. </div>
  394. <div class="task-group">
  395. <ul class="item-container">
  396. <li class="item">
  397. <div>
  398. <code>
  399. <a name="/s:9Alamofire17ServerTrustPolicyO15pinCertificatesACSaySo14SecCertificateCG12certificates_Sb08validateH5ChainSb0J4HosttcACmF"></a>
  400. <a name="//apple_ref/swift/Element/pinCertificates" class="dashAnchor"></a>
  401. <a class="token" href="#/s:9Alamofire17ServerTrustPolicyO15pinCertificatesACSaySo14SecCertificateCG12certificates_Sb08validateH5ChainSb0J4HosttcACmF">pinCertificates</a>
  402. </code>
  403. </div>
  404. <div class="height-container">
  405. <div class="pointer-container"></div>
  406. <section class="section">
  407. <div class="pointer"></div>
  408. <div class="abstract">
  409. <p>Undocumented</p>
  410. </div>
  411. <div class="declaration">
  412. <h4>Declaration</h4>
  413. <div class="language">
  414. <p class="aside-title">Swift</p>
  415. <pre class="highlight"><code><span class="k">case</span> <span class="nf">pinCertificates</span><span class="p">(</span><span class="nv">certificates</span><span class="p">:</span> <span class="p">[</span><span class="kt">SecCertificate</span><span class="p">],</span> <span class="nv">validateCertificateChain</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">validateHost</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>
  416. </div>
  417. </div>
  418. </section>
  419. </div>
  420. </li>
  421. </ul>
  422. </div>
  423. <div class="task-group">
  424. <ul class="item-container">
  425. <li class="item">
  426. <div>
  427. <code>
  428. <a name="/s:9Alamofire17ServerTrustPolicyO13pinPublicKeysACSaySo6SecKeyCG06publicG0_Sb24validateCertificateChainSb0K4HosttcACmF"></a>
  429. <a name="//apple_ref/swift/Element/pinPublicKeys" class="dashAnchor"></a>
  430. <a class="token" href="#/s:9Alamofire17ServerTrustPolicyO13pinPublicKeysACSaySo6SecKeyCG06publicG0_Sb24validateCertificateChainSb0K4HosttcACmF">pinPublicKeys</a>
  431. </code>
  432. </div>
  433. <div class="height-container">
  434. <div class="pointer-container"></div>
  435. <section class="section">
  436. <div class="pointer"></div>
  437. <div class="abstract">
  438. <p>Undocumented</p>
  439. </div>
  440. <div class="declaration">
  441. <h4>Declaration</h4>
  442. <div class="language">
  443. <p class="aside-title">Swift</p>
  444. <pre class="highlight"><code><span class="k">case</span> <span class="nf">pinPublicKeys</span><span class="p">(</span><span class="nv">publicKeys</span><span class="p">:</span> <span class="p">[</span><span class="kt">SecKey</span><span class="p">],</span> <span class="nv">validateCertificateChain</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">validateHost</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>
  445. </div>
  446. </div>
  447. </section>
  448. </div>
  449. </li>
  450. </ul>
  451. </div>
  452. <div class="task-group">
  453. <ul class="item-container">
  454. <li class="item">
  455. <div>
  456. <code>
  457. <a name="/s:9Alamofire17ServerTrustPolicyO17disableEvaluationA2CmF"></a>
  458. <a name="//apple_ref/swift/Element/disableEvaluation" class="dashAnchor"></a>
  459. <a class="token" href="#/s:9Alamofire17ServerTrustPolicyO17disableEvaluationA2CmF">disableEvaluation</a>
  460. </code>
  461. </div>
  462. <div class="height-container">
  463. <div class="pointer-container"></div>
  464. <section class="section">
  465. <div class="pointer"></div>
  466. <div class="abstract">
  467. <p>Undocumented</p>
  468. </div>
  469. <div class="declaration">
  470. <h4>Declaration</h4>
  471. <div class="language">
  472. <p class="aside-title">Swift</p>
  473. <pre class="highlight"><code><span class="k">case</span> <span class="n">disableEvaluation</span></code></pre>
  474. </div>
  475. </div>
  476. </section>
  477. </div>
  478. </li>
  479. </ul>
  480. </div>
  481. <div class="task-group">
  482. <ul class="item-container">
  483. <li class="item">
  484. <div>
  485. <code>
  486. <a name="/s:9Alamofire17ServerTrustPolicyO16customEvaluationACSbSo03SecC0C_SStccACmF"></a>
  487. <a name="//apple_ref/swift/Element/customEvaluation" class="dashAnchor"></a>
  488. <a class="token" href="#/s:9Alamofire17ServerTrustPolicyO16customEvaluationACSbSo03SecC0C_SStccACmF">customEvaluation</a>
  489. </code>
  490. </div>
  491. <div class="height-container">
  492. <div class="pointer-container"></div>
  493. <section class="section">
  494. <div class="pointer"></div>
  495. <div class="abstract">
  496. <p>Undocumented</p>
  497. </div>
  498. <div class="declaration">
  499. <h4>Declaration</h4>
  500. <div class="language">
  501. <p class="aside-title">Swift</p>
  502. <pre class="highlight"><code><span class="k">case</span> <span class="nf">customEvaluation</span><span class="p">((</span><span class="n">_</span> <span class="nv">serverTrust</span><span class="p">:</span> <span class="kt">SecTrust</span><span class="p">,</span> <span class="n">_</span> <span class="nv">host</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>
  503. </div>
  504. </div>
  505. </section>
  506. </div>
  507. </li>
  508. </ul>
  509. </div>
  510. <div class="task-group">
  511. <div class="task-name-container">
  512. <a name="/Bundle%20Location"></a>
  513. <a name="//apple_ref/swift/Section/Bundle Location" class="dashAnchor"></a>
  514. <a href="#/Bundle%20Location">
  515. <h3 class="section-name">Bundle Location</h3>
  516. </a>
  517. </div>
  518. <ul class="item-container">
  519. <li class="item">
  520. <div>
  521. <code>
  522. <a name="/s:9Alamofire17ServerTrustPolicyO12certificatesSaySo14SecCertificateCGSo6BundleC2in_tFZ"></a>
  523. <a name="//apple_ref/swift/Method/certificates(in:)" class="dashAnchor"></a>
  524. <a class="token" href="#/s:9Alamofire17ServerTrustPolicyO12certificatesSaySo14SecCertificateCGSo6BundleC2in_tFZ">certificates(in:)</a>
  525. </code>
  526. </div>
  527. <div class="height-container">
  528. <div class="pointer-container"></div>
  529. <section class="section">
  530. <div class="pointer"></div>
  531. <div class="abstract">
  532. <p>Returns all certificates within the given bundle with a <code>.cer</code> file extension.</p>
  533. </div>
  534. <div class="declaration">
  535. <h4>Declaration</h4>
  536. <div class="language">
  537. <p class="aside-title">Swift</p>
  538. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">certificates</span><span class="p">(</span><span class="k">in</span> <span class="nv">bundle</span><span class="p">:</span> <span class="kt">Bundle</span> <span class="o">=</span> <span class="kt">Bundle</span><span class="o">.</span><span class="n">main</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt">SecCertificate</span><span class="p">]</span></code></pre>
  539. </div>
  540. </div>
  541. <div>
  542. <h4>Parameters</h4>
  543. <table class="graybox">
  544. <tbody>
  545. <tr>
  546. <td>
  547. <code>
  548. <em>bundle</em>
  549. </code>
  550. </td>
  551. <td>
  552. <div>
  553. <p>The bundle to search for all <code>.cer</code> files.</p>
  554. </div>
  555. </td>
  556. </tr>
  557. </tbody>
  558. </table>
  559. </div>
  560. <div>
  561. <h4>Return Value</h4>
  562. <p>All certificates within the given bundle.</p>
  563. </div>
  564. </section>
  565. </div>
  566. </li>
  567. <li class="item">
  568. <div>
  569. <code>
  570. <a name="/s:9Alamofire17ServerTrustPolicyO10publicKeysSaySo6SecKeyCGSo6BundleC2in_tFZ"></a>
  571. <a name="//apple_ref/swift/Method/publicKeys(in:)" class="dashAnchor"></a>
  572. <a class="token" href="#/s:9Alamofire17ServerTrustPolicyO10publicKeysSaySo6SecKeyCGSo6BundleC2in_tFZ">publicKeys(in:)</a>
  573. </code>
  574. </div>
  575. <div class="height-container">
  576. <div class="pointer-container"></div>
  577. <section class="section">
  578. <div class="pointer"></div>
  579. <div class="abstract">
  580. <p>Returns all public keys within the given bundle with a <code>.cer</code> file extension.</p>
  581. </div>
  582. <div class="declaration">
  583. <h4>Declaration</h4>
  584. <div class="language">
  585. <p class="aside-title">Swift</p>
  586. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">publicKeys</span><span class="p">(</span><span class="k">in</span> <span class="nv">bundle</span><span class="p">:</span> <span class="kt">Bundle</span> <span class="o">=</span> <span class="kt">Bundle</span><span class="o">.</span><span class="n">main</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt">SecKey</span><span class="p">]</span></code></pre>
  587. </div>
  588. </div>
  589. <div>
  590. <h4>Parameters</h4>
  591. <table class="graybox">
  592. <tbody>
  593. <tr>
  594. <td>
  595. <code>
  596. <em>bundle</em>
  597. </code>
  598. </td>
  599. <td>
  600. <div>
  601. <p>The bundle to search for all <code>*.cer</code> files.</p>
  602. </div>
  603. </td>
  604. </tr>
  605. </tbody>
  606. </table>
  607. </div>
  608. <div>
  609. <h4>Return Value</h4>
  610. <p>All public keys within the given bundle.</p>
  611. </div>
  612. </section>
  613. </div>
  614. </li>
  615. </ul>
  616. </div>
  617. <div class="task-group">
  618. <div class="task-name-container">
  619. <a name="/Evaluation"></a>
  620. <a name="//apple_ref/swift/Section/Evaluation" class="dashAnchor"></a>
  621. <a href="#/Evaluation">
  622. <h3 class="section-name">Evaluation</h3>
  623. </a>
  624. </div>
  625. <ul class="item-container">
  626. <li class="item">
  627. <div>
  628. <code>
  629. <a name="/s:9Alamofire17ServerTrustPolicyO8evaluateSbSo03SecC0C_SS7forHosttF"></a>
  630. <a name="//apple_ref/swift/Method/evaluate(_:forHost:)" class="dashAnchor"></a>
  631. <a class="token" href="#/s:9Alamofire17ServerTrustPolicyO8evaluateSbSo03SecC0C_SS7forHosttF">evaluate(_:forHost:)</a>
  632. </code>
  633. </div>
  634. <div class="height-container">
  635. <div class="pointer-container"></div>
  636. <section class="section">
  637. <div class="pointer"></div>
  638. <div class="abstract">
  639. <p>Evaluates whether the server trust is valid for the given host.</p>
  640. </div>
  641. <div class="declaration">
  642. <h4>Declaration</h4>
  643. <div class="language">
  644. <p class="aside-title">Swift</p>
  645. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">evaluate</span><span class="p">(</span><span class="n">_</span> <span class="nv">serverTrust</span><span class="p">:</span> <span class="kt">SecTrust</span><span class="p">,</span> <span class="n">forHost</span> <span class="nv">host</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
  646. </div>
  647. </div>
  648. <div>
  649. <h4>Parameters</h4>
  650. <table class="graybox">
  651. <tbody>
  652. <tr>
  653. <td>
  654. <code>
  655. <em>serverTrust</em>
  656. </code>
  657. </td>
  658. <td>
  659. <div>
  660. <p>The server trust to evaluate.</p>
  661. </div>
  662. </td>
  663. </tr>
  664. <tr>
  665. <td>
  666. <code>
  667. <em>host</em>
  668. </code>
  669. </td>
  670. <td>
  671. <div>
  672. <p>The host of the challenge protection space.</p>
  673. </div>
  674. </td>
  675. </tr>
  676. </tbody>
  677. </table>
  678. </div>
  679. <div>
  680. <h4>Return Value</h4>
  681. <p>Whether the server trust is valid.</p>
  682. </div>
  683. </section>
  684. </div>
  685. </li>
  686. </ul>
  687. </div>
  688. </div>
  689. </section>
  690. </article>
  691. </div>
  692. <section class="footer">
  693. <p>&copy; 2017 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2017-12-03)</p>
  694. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  695. </section>
  696. </body>
  697. </div>
  698. </html>