mirror of
https://github.com/datatheorem/TrustKit.git
synced 2026-05-17 12:50:35 +00:00
Update documentation
This commit is contained in:
@@ -11,6 +11,7 @@ objc: true
|
||||
umbrella_header: "TrustKit/TrustKit.h"
|
||||
framework_root: "./TrustKit"
|
||||
|
||||
readme: "docs/documentation-readme.md"
|
||||
output: "docs/documentation"
|
||||
|
||||
custom_categories:
|
||||
|
||||
@@ -1,18 +1,10 @@
|
||||
# TrustKit Documentation
|
||||
|
||||
TrustKit is an open source framework that makes it easy to deploy SSL public key
|
||||
pinning in any iOS, macOS, tvOS or watchOS App.
|
||||
TrustKit is an open source framework that makes it easy to deploy SSL public key pinning in any iOS, macOS, tvOS or watchOS App.
|
||||
|
||||
This is the API documentation for TrustKit. For an overview of the framework and
|
||||
a more general guide to using it, see the project's page at
|
||||
https://datatheorem.github.io/TrustKit .
|
||||
This is the API documentation for TrustKit. A "Getting Started" guide is available at https://github.com/datatheorem/TrustKit/blob/master/docs/getting-started.md.
|
||||
|
||||
TrustKit requires iOS 7.0, macOS 10.9, tvOS 10.0 or watchOS 3.0 as the minimum
|
||||
deployment target.
|
||||
TrustKit exposes two core classes for enabling SSL pinning in an App:
|
||||
|
||||
Two classes are available enabling SSL pinning in an App:
|
||||
|
||||
* `TrustKit`, for programmatically configuring the global SSL pinning policy within an
|
||||
App.
|
||||
* `TSKPinningValidator`, for manually validating a certificate chain against the App's
|
||||
configured pinning policy.
|
||||
* `TrustKit` for configuring an SSL pinning policy and initializing the framework.
|
||||
* `TSKPinningValidator`, for validating a server's certificate chain against an SSL pinning policy.
|
||||
|
||||
Reference in New Issue
Block a user