Skip to content

Commit

Permalink
Emphasize in the documentation that TSKSupportedAlgorithm is deprecated
Browse files Browse the repository at this point in the history
  • Loading branch information
@nabla-c0d3
nabla-c0d3 committed Sep 26, 2018
1 parent 9aa46b7 commit 3e9476d
Show file tree
Hide file tree
Showing 7 changed files with 35 additions and 23 deletions.
6 changes: 5 additions & 1 deletion TrustKit/TSKTrustKitConfig.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@ FOUNDATION_EXPORT const TSKDomainConfigurationKey kTSKPublicKeyHashes;


/**
DEPRECATED since 1.6.0: this configuration key is no longer needed.
An array of `TSKSupportedAlgorithm` constants to specify the public key algorithms for the
keys to be pinned.
Expand Down Expand Up @@ -206,10 +208,12 @@ FOUNDATION_EXPORT const TSKDomainConfigurationKey kTSKDisableDefaultReportUri;
FOUNDATION_EXPORT const TSKDomainConfigurationKey kTSKExpirationDate;


#pragma mark Supported Public Key Algorithm Keys
#pragma mark DEPRECATED - Supported Public Key Algorithm Keys


/**
DEPRECATED since 1.6.0: this configuration key is no longer needed.
A public key algorithm supported by TrustKit for generating the SSL pin for a certificate.
*/
typedef NSString *TSKSupportedAlgorithm __deprecated_msg("Starting with TrustKit 1.6.0, key algorithms no longer need to be specified; remove TSKSupportedAlgorithm from your configuration.");
Expand Down
12 changes: 7 additions & 5 deletions docs/documentation/Other Constants.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,9 @@ <h3 class="section-name">Domain-Specific Configuration Keys - Required</h3>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>An array of <code><a href="Other Type Definitions.html#/c:TSKTrustKitConfig.h@T@TSKSupportedAlgorithm">TSKSupportedAlgorithm</a></code> constants to specify the public key algorithms for the
<p>DEPRECATED since 1.6.0: this configuration key is no longer needed.</p>

<p>An array of <code><a href="Other Type Definitions.html#/c:TSKTrustKitConfig.h@T@TSKSupportedAlgorithm">TSKSupportedAlgorithm</a></code> constants to specify the public key algorithms for the
keys to be pinned.</p>

<p>TrustKit requires this information in order to compute SSL pins when validating a server&rsquo;s
Expand Down Expand Up @@ -264,10 +266,10 @@ <h4>Declaration</h4>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Supported%20Public%20Key%20Algorithm%20Keys"></a>
<a name="//apple_ref/objc/Section/Supported Public Key Algorithm Keys" class="dashAnchor"></a>
<a href="#/Supported%20Public%20Key%20Algorithm%20Keys">
<h3 class="section-name">Supported Public Key Algorithm Keys</h3>
<a name="/DEPRECATED%20-%20Supported%20Public%20Key%20Algorithm%20Keys"></a>
<a name="//apple_ref/objc/Section/DEPRECATED - Supported Public Key Algorithm Keys" class="dashAnchor"></a>
<a href="#/DEPRECATED%20-%20Supported%20Public%20Key%20Algorithm%20Keys">
<h3 class="section-name">DEPRECATED - Supported Public Key Algorithm Keys</h3>
</a>
</div>
<ul class="item-container">
Expand Down
12 changes: 7 additions & 5 deletions docs/documentation/Other Type Definitions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -179,10 +179,10 @@ <h1>Other Type Definitions</h1>
<div class="section-content">
<div class="task-group">
<div class="task-name-container">
<a name="/Supported%20Public%20Key%20Algorithm%20Keys"></a>
<a name="//apple_ref/objc/Section/Supported Public Key Algorithm Keys" class="dashAnchor"></a>
<a href="#/Supported%20Public%20Key%20Algorithm%20Keys">
<h3 class="section-name">Supported Public Key Algorithm Keys</h3>
<a name="/DEPRECATED%20-%20Supported%20Public%20Key%20Algorithm%20Keys"></a>
<a name="//apple_ref/objc/Section/DEPRECATED - Supported Public Key Algorithm Keys" class="dashAnchor"></a>
<a href="#/DEPRECATED%20-%20Supported%20Public%20Key%20Algorithm%20Keys">
<h3 class="section-name">DEPRECATED - Supported Public Key Algorithm Keys</h3>
</a>
</div>
<ul class="item-container">
Expand All @@ -199,7 +199,9 @@ <h3 class="section-name">Supported Public Key Algorithm Keys</h3>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A public key algorithm supported by TrustKit for generating the SSL pin for a certificate.</p>
<p>DEPRECATED since 1.6.0: this configuration key is no longer needed.</p>

<p>A public key algorithm supported by TrustKit for generating the SSL pin for a certificate.</p>

</div>
<div class="declaration">
Expand Down
12 changes: 7 additions & 5 deletions docs/documentation/docsets/TrustKit.docset/Contents/Resources/Documents/Other Constants.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,9 @@ <h3 class="section-name">Domain-Specific Configuration Keys - Required</h3>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>An array of <code><a href="Other Type Definitions.html#/c:TSKTrustKitConfig.h@T@TSKSupportedAlgorithm">TSKSupportedAlgorithm</a></code> constants to specify the public key algorithms for the
<p>DEPRECATED since 1.6.0: this configuration key is no longer needed.</p>

<p>An array of <code><a href="Other Type Definitions.html#/c:TSKTrustKitConfig.h@T@TSKSupportedAlgorithm">TSKSupportedAlgorithm</a></code> constants to specify the public key algorithms for the
keys to be pinned.</p>

<p>TrustKit requires this information in order to compute SSL pins when validating a server&rsquo;s
Expand Down Expand Up @@ -264,10 +266,10 @@ <h4>Declaration</h4>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Supported%20Public%20Key%20Algorithm%20Keys"></a>
<a name="//apple_ref/objc/Section/Supported Public Key Algorithm Keys" class="dashAnchor"></a>
<a href="#/Supported%20Public%20Key%20Algorithm%20Keys">
<h3 class="section-name">Supported Public Key Algorithm Keys</h3>
<a name="/DEPRECATED%20-%20Supported%20Public%20Key%20Algorithm%20Keys"></a>
<a name="//apple_ref/objc/Section/DEPRECATED - Supported Public Key Algorithm Keys" class="dashAnchor"></a>
<a href="#/DEPRECATED%20-%20Supported%20Public%20Key%20Algorithm%20Keys">
<h3 class="section-name">DEPRECATED - Supported Public Key Algorithm Keys</h3>
</a>
</div>
<ul class="item-container">
Expand Down
12 changes: 7 additions & 5 deletions ...entation/docsets/TrustKit.docset/Contents/Resources/Documents/Other Type Definitions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -179,10 +179,10 @@ <h1>Other Type Definitions</h1>
<div class="section-content">
<div class="task-group">
<div class="task-name-container">
<a name="/Supported%20Public%20Key%20Algorithm%20Keys"></a>
<a name="//apple_ref/objc/Section/Supported Public Key Algorithm Keys" class="dashAnchor"></a>
<a href="#/Supported%20Public%20Key%20Algorithm%20Keys">
<h3 class="section-name">Supported Public Key Algorithm Keys</h3>
<a name="/DEPRECATED%20-%20Supported%20Public%20Key%20Algorithm%20Keys"></a>
<a name="//apple_ref/objc/Section/DEPRECATED - Supported Public Key Algorithm Keys" class="dashAnchor"></a>
<a href="#/DEPRECATED%20-%20Supported%20Public%20Key%20Algorithm%20Keys">
<h3 class="section-name">DEPRECATED - Supported Public Key Algorithm Keys</h3>
</a>
</div>
<ul class="item-container">
Expand All @@ -199,7 +199,9 @@ <h3 class="section-name">Supported Public Key Algorithm Keys</h3>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A public key algorithm supported by TrustKit for generating the SSL pin for a certificate.</p>
<p>DEPRECATED since 1.6.0: this configuration key is no longer needed.</p>

<p>A public key algorithm supported by TrustKit for generating the SSL pin for a certificate.</p>

</div>
<div class="declaration">
Expand Down
Loading

0 comments on commit 3e9476d

Please sign in to comment.