mirror of
https://github.com/datatheorem/TrustKit.git
synced 2026-05-17 12:50:35 +00:00
Alban Diquet
1 line
14 KiB
JSON
1 line
14 KiB
JSON
{"Other Type Definitions.html#/c:TSKTrustKitConfig.h@T@TSKSupportedAlgorithm":{"name":"TSKSupportedAlgorithm","abstract":"<p>DEPRECATED since 1.6.0: this configuration key is no longer needed.</p>"},"Other Constants.html#/c:@TrustKitVersion":{"name":"TrustKitVersion","abstract":"<p>The version of TrustKit, such as <q>1.4.0</q>.</p>"},"Other Constants.html#/c:@kTSKPublicKeyAlgorithms":{"name":"kTSKPublicKeyAlgorithms","abstract":"<p>DEPRECATED since 1.6.0: this configuration key is no longer needed.</p>"},"Other Constants.html#/c:@kTSKAlgorithmRsa2048":{"name":"kTSKAlgorithmRsa2048","abstract":"<p>RSA 2048.</p>"},"Other Constants.html#/c:@kTSKAlgorithmRsa4096":{"name":"kTSKAlgorithmRsa4096","abstract":"<p>RSA 4096.</p>"},"Other Constants.html#/c:@kTSKAlgorithmEcDsaSecp256r1":{"name":"kTSKAlgorithmEcDsaSecp256r1","abstract":"<p>ECDSA with secp256r1 curve.</p>"},"Other Constants.html#/c:@kTSKAlgorithmEcDsaSecp384r1":{"name":"kTSKAlgorithmEcDsaSecp384r1","abstract":"<p>ECDSA with secp384r1 curve.</p>"},"Domain Configuration Keys.html#/c:TSKTrustKitConfig.h@T@TSKDomainConfigurationKey":{"name":"TSKDomainConfigurationKey","abstract":"<p>A domain-specific configuration key (to defined for a domain under the <code><a href=\"36f8f5912051ae747ef441d6511ca4cbGlobal Configuration Keys.html#/c:@kTSKPinnedDomains\">kTSKPinnedDomains</a></code>"},"Domain Configuration Keys.html#/c:@kTSKPublicKeyHashes":{"name":"kTSKPublicKeyHashes","abstract":"<p>An array of SSL pins, where each pin is the base64-encoded SHA-256 hash of a certificate’s"},"Domain Configuration Keys.html#/c:@kTSKEnforcePinning":{"name":"kTSKEnforcePinning","abstract":"<p>A boolean. If set to <code>NO</code>, TrustKit will not block SSL connections that caused a pin or"},"Domain Configuration Keys.html#/c:@kTSKIncludeSubdomains":{"name":"kTSKIncludeSubdomains","abstract":"<p>A boolean. If set to <code>YES</code>, also pin all the subdomains of the specified domain; default"},"Domain Configuration Keys.html#/c:@kTSKExcludeSubdomainFromParentPolicy":{"name":"kTSKExcludeSubdomainFromParentPolicy","abstract":"<p>A boolean. If set to <code>YES</code>, TrustKit will not pin this specific domain if <code><a href=\"36f8f5912051ae747ef441d6511ca4cbDomain Configuration Keys.html#/c:@kTSKIncludeSubdomains\">kTSKIncludeSubdomains</a></code>"},"Domain Configuration Keys.html#/c:@kTSKReportUris":{"name":"kTSKReportUris","abstract":"<p>An array of URLs to which pin validation failures should be reported.</p>"},"Domain Configuration Keys.html#/c:@kTSKDisableDefaultReportUri":{"name":"kTSKDisableDefaultReportUri","abstract":"<p>A boolean. If set to <code>YES</code>, the default report URL for sending pin failure reports will"},"Domain Configuration Keys.html#/c:@kTSKExpirationDate":{"name":"kTSKExpirationDate","abstract":"<p>A string containing the date, in yyyy-MM-dd format, on which the domain’s configured SSL"},"Global Configuration Keys.html#/c:TSKTrustKitConfig.h@T@TSKGlobalConfigurationKey":{"name":"TSKGlobalConfigurationKey","abstract":"<p>A global, App-wide configuration key that can be set in the pinning policy.</p>"},"Global Configuration Keys.html#/c:@kTSKSwizzleNetworkDelegates":{"name":"kTSKSwizzleNetworkDelegates","abstract":"<p>A boolean. If set to <code>YES</code>, TrustKit will perform method swizzling on the App’s"},"Global Configuration Keys.html#/c:@kTSKPinnedDomains":{"name":"kTSKPinnedDomains","abstract":"<p>A dictionary with domains (such as <em><a href=\"http://www.domain.com\">www.domain.com</a></em>) as keys and dictionaries as values.</p>"},"Global Configuration Keys.html#/c:@kTSKIgnorePinningForUserDefinedTrustAnchors":{"name":"kTSKIgnorePinningForUserDefinedTrustAnchors","abstract":"<p>A boolean. If set to <code>YES</code>, pinning validation will be skipped if the server’s certificate"},"Enums/TSKTrustEvaluationResult.html#/c:@E@TSKTrustEvaluationResult@TSKTrustEvaluationSuccess":{"name":"TSKTrustEvaluationSuccess","abstract":"<p>The server trust was succesfully evaluated and contained at least one of the configured pins.</p>","parent_name":"TSKTrustEvaluationResult"},"Enums/TSKTrustEvaluationResult.html#/c:@E@TSKTrustEvaluationResult@TSKTrustEvaluationFailedNoMatchingPin":{"name":"TSKTrustEvaluationFailedNoMatchingPin","abstract":"<p>The server trust was succesfully evaluated but did not contain any of the configured pins.</p>","parent_name":"TSKTrustEvaluationResult"},"Enums/TSKTrustEvaluationResult.html#/c:@E@TSKTrustEvaluationResult@TSKTrustEvaluationFailedInvalidCertificateChain":{"name":"TSKTrustEvaluationFailedInvalidCertificateChain","abstract":"<p>The server trust’s evaluation failed: the server’s certificate chain is not trusted.</p>","parent_name":"TSKTrustEvaluationResult"},"Enums/TSKTrustEvaluationResult.html#/c:@E@TSKTrustEvaluationResult@TSKTrustEvaluationErrorInvalidParameters":{"name":"TSKTrustEvaluationErrorInvalidParameters","abstract":"<p>The server trust could not be evaluated due to invalid parameters.</p>","parent_name":"TSKTrustEvaluationResult"},"Enums/TSKTrustEvaluationResult.html#/c:@E@TSKTrustEvaluationResult@TSKTrustEvaluationFailedUserDefinedTrustAnchor":{"name":"TSKTrustEvaluationFailedUserDefinedTrustAnchor","abstract":"<p>The server trust was succesfully evaluated but did not contain any of the configured pins. However, the certificate chain terminates at a user-defined trust anchor (ie. a custom/private CA that was manually added to the macOS trust store). Only available on macOS.</p>","parent_name":"TSKTrustEvaluationResult"},"Enums/TSKTrustEvaluationResult.html#/c:@E@TSKTrustEvaluationResult@TSKTrustEvaluationErrorCouldNotGenerateSpkiHash":{"name":"TSKTrustEvaluationErrorCouldNotGenerateSpkiHash","abstract":"<p>The server trust could not be evaluated due to an error when trying to generate the certificate’s subject public key info hash. On iOS 9 or below, this could be caused by a Keychain failure when trying to extract the certificate’s public key bytes.</p>","parent_name":"TSKTrustEvaluationResult"},"Classes/TSKPinningValidatorResult.html#/c:objc(cs)TSKPinningValidatorResult(py)serverHostname":{"name":"serverHostname","abstract":"<p>The hostname of the server SSL pinning validation was performed against.</p>","parent_name":"TSKPinningValidatorResult"},"Classes/TSKPinningValidatorResult.html#/c:objc(cs)TSKPinningValidatorResult(py)evaluationResult":{"name":"evaluationResult","abstract":"<p>The result of validating the server’s certificate chain against the set of SSL pins configured for","parent_name":"TSKPinningValidatorResult"},"Classes/TSKPinningValidatorResult.html#/c:objc(cs)TSKPinningValidatorResult(py)finalTrustDecision":{"name":"finalTrustDecision","abstract":"<p>The trust decision returned for this connection, which describes whether the connection should be blocked","parent_name":"TSKPinningValidatorResult"},"Classes/TSKPinningValidatorResult.html#/c:objc(cs)TSKPinningValidatorResult(py)validationDuration":{"name":"validationDuration","abstract":"<p>The time it took for the SSL pinning validation to be performed.</p>","parent_name":"TSKPinningValidatorResult"},"Classes/TSKPinningValidatorResult.html#/c:objc(cs)TSKPinningValidatorResult(py)certificateChain":{"name":"certificateChain","abstract":"<p>The certificate chain sent by the server when establishing the connection as PEM-formatted certificates.</p>","parent_name":"TSKPinningValidatorResult"},"Setting up a Validation Callback.html#/c:TSKPinningValidatorCallback.h@T@TSKPinningValidatorCallback":{"name":"TSKPinningValidatorCallback","abstract":"<p>A block that can be set in a <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/TrustKit.html\">TrustKit</a></code> instance to be invoked for every request that is going through"},"Classes/TSKPinningValidatorResult.html":{"name":"TSKPinningValidatorResult","abstract":"<p>A <code>TSKPinningValidatorResult</code> instance contains all the details regarding a pinning validation"},"Setting up a Validation Callback.html#/c:TSKPinningValidatorCallback.h@T@TKSDomainPinningPolicy":{"name":"TKSDomainPinningPolicy","abstract":"<p>The pinning policy set for a specific hostname.</p>"},"Enums/TSKTrustEvaluationResult.html":{"name":"TSKTrustEvaluationResult","abstract":"<p>Possible return values when verifying a server’s identity against a set of pins.</p>"},"Enums/TSKTrustDecision.html#/c:@E@TSKTrustDecision@TSKTrustDecisionShouldAllowConnection":{"name":"TSKTrustDecisionShouldAllowConnection","abstract":"<p>Based on the server’s certificate chain and the configured pinning policy for this domain, the SSL connection should be allowed.","parent_name":"TSKTrustDecision"},"Enums/TSKTrustDecision.html#/c:@E@TSKTrustDecision@TSKTrustDecisionShouldBlockConnection":{"name":"TSKTrustDecisionShouldBlockConnection","abstract":"<p>Based on the server’s certificate chain and the configured pinning policy for this domain, the SSL connection should be blocked.","parent_name":"TSKTrustDecision"},"Enums/TSKTrustDecision.html#/c:@E@TSKTrustDecision@TSKTrustDecisionDomainNotPinned":{"name":"TSKTrustDecisionDomainNotPinned","abstract":"<p>No pinning policy was configured for this domain and TrustKit did not validate the server’s identity.","parent_name":"TSKTrustDecision"},"Classes/TSKPinningValidator.html#/c:objc(cs)TSKPinningValidator(im)handleChallenge:completionHandler:":{"name":"-handleChallenge:completionHandler:","abstract":"<p>Helper method for handling authentication challenges received within a <code>NSURLSessionDelegate</code>, <code>NSURLSessionTaskDelegate</code> or <code>WKNavigationDelegate</code>.</p>","parent_name":"TSKPinningValidator"},"Classes/TSKPinningValidator.html#/c:objc(cs)TSKPinningValidator(im)evaluateTrust:forHostname:":{"name":"-evaluateTrust:forHostname:","abstract":"<p>Evaluate the supplied server trust against the SSL pinning policy previously configured. If the validation fails, a pin failure report will be sent.</p>","parent_name":"TSKPinningValidator"},"Classes/TSKPinningValidator.html":{"name":"TSKPinningValidator","abstract":"<p>A <code>TSKPinningValidator</code> instance can be used to verify a server’s identity against an SSL pinning policy.</p>"},"Enums/TSKTrustDecision.html":{"name":"TSKTrustDecision","abstract":"<p>Possible return values when verifying a server’s identity against an SSL pinning policy.</p>"},"Classes/TrustKit.html#/c:objc(cs)TrustKit(cm)initSharedInstanceWithConfiguration:":{"name":"+initSharedInstanceWithConfiguration:","abstract":"<p>See <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/TrustKit.html#/c:objc(cs)TrustKit(cm)initSharedInstanceWithConfiguration:sharedContainerIdentifier:\">+initSharedInstanceWithConfiguration:sharedContainerIdentifier:</a></code></p>","parent_name":"TrustKit"},"Classes/TrustKit.html#/c:objc(cs)TrustKit(cm)initSharedInstanceWithConfiguration:sharedContainerIdentifier:":{"name":"+initSharedInstanceWithConfiguration:sharedContainerIdentifier:","abstract":"<p>Initialize the global TrustKit singleton with the supplied pinning policy.</p>","parent_name":"TrustKit"},"Classes/TrustKit.html#/c:objc(cs)TrustKit(cm)sharedInstance":{"name":"+sharedInstance","abstract":"<p>Retrieve the global TrustKit singleton instance. Raises an exception if <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/TrustKit.html#/c:objc(cs)TrustKit(cm)initSharedInstanceWithConfiguration:\">+initSharedInstanceWithConfiguration:</a></code>","parent_name":"TrustKit"},"Classes/TrustKit.html#/c:objc(cs)TrustKit(py)pinningValidator":{"name":"pinningValidator","abstract":"<p>Retrieve the validator instance conforming to the pinning policy of this TrustKit instance.</p>","parent_name":"TrustKit"},"Classes/TrustKit.html#/c:objc(cs)TrustKit(py)pinningValidatorCallback":{"name":"pinningValidatorCallback","abstract":"<p>Register a block to be invoked for every request that is going through TrustKit’s pinning","parent_name":"TrustKit"},"Classes/TrustKit.html#/c:objc(cs)TrustKit(py)pinningValidatorCallbackQueue":{"name":"pinningValidatorCallbackQueue","abstract":"<p>Queue on which to invoke the <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/TrustKit.html#/c:objc(cs)TrustKit(py)pinningValidatorCallback\">pinningValidatorCallback</a></code>; default value is the main queue.</p>","parent_name":"TrustKit"},"Classes/TrustKit.html#/c:objc(cs)TrustKit(im)initWithConfiguration:":{"name":"-initWithConfiguration:","abstract":"<p>See <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/TrustKit.html#/c:objc(cs)TrustKit(im)initWithConfiguration:sharedContainerIdentifier:\">-initWithConfiguration:sharedContainerIdentifier:</a></code></p>","parent_name":"TrustKit"},"Classes/TrustKit.html#/c:objc(cs)TrustKit(im)initWithConfiguration:sharedContainerIdentifier:":{"name":"-initWithConfiguration:sharedContainerIdentifier:","abstract":"<p>Initialize a local TrustKit instance with the supplied SSL pinning policy configuration.</p>","parent_name":"TrustKit"},"Classes/TrustKit.html#/c:objc(cs)TrustKit(cm)setLoggerBlock:":{"name":"+setLoggerBlock:","abstract":"<p>Set the global logger.</p>","parent_name":"TrustKit"},"Classes/TrustKit.html":{"name":"TrustKit","abstract":"<p><code>TrustKit</code> is the main class for configuring an SSL pinning policy within an App.</p>"},"Initalizing TrustKit.html":{"name":"Initalizing TrustKit"},"Implementing Pinning Validation.html":{"name":"Implementing Pinning Validation"},"Setting up a Validation Callback.html":{"name":"Setting up a Validation Callback"},"Global Configuration Keys.html":{"name":"Global Configuration Keys"},"Domain Configuration Keys.html":{"name":"Domain Configuration Keys"},"Other Constants.html":{"name":"Other Constants","abstract":"<p>The following constants are available globally.</p>"},"Other Type Definitions.html":{"name":"Other Type Definitions","abstract":"<p>The following type definitions are available globally.</p>"}} |