Skip to content

Commit 777917f

Browse files
committed
Add DocC extension page to provide curation for TLSConfiguration
Motivation: When viewing the documentation, deprecated methods clutter up available options, sometimes below, making those options hard to find for a developer working out how to add or create a TLSConfiguration. Modifications: Adds a DocC extension file (markdown format) the provides curation (organization of the symbols) to order by task and ideally usefulness, with deprecated methods pushed downward. Result: The documentation at https://swiftpackageindex.com/apple/swift-nio-ssl/main/documentation/niossl/tlsconfiguration (and future releases) will include this organization and be easier to read through for developers.
1 parent e5f59ae commit 777917f

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# ``TLSConfiguration``
2+
3+
## Topics
4+
5+
### Creating a TLS configuration
6+
7+
- ``clientDefault``
8+
- ``makeClientConfiguration()``
9+
- ``makePreSharedKeyConfiguration()``
10+
- ``makeServerConfiguration(certificateChain:privateKey:)``
11+
12+
### Inspecting a configuration
13+
14+
- ``cipherSuites``
15+
- ``verifySignatureAlgorithms``
16+
- ``signingSignatureAlgorithms``
17+
- ``cipherSuiteValues``
18+
19+
- ``minimumTLSVersion``
20+
- ``maximumTLSVersion``
21+
- ``certificateVerification``
22+
- ``trustRoots``
23+
- ``certificateChain``
24+
- ``privateKey``
25+
- ``applicationProtocols``
26+
- ``shutdownTimeout``
27+
- ``keyLogCallback``
28+
- ``renegotiationSupport``
29+
30+
- ``additionalTrustRoots``
31+
- ``curves``
32+
- ``sendCANameList``
33+
- ``sslContextCallback``
34+
35+
### Inspecting pre-shared key configurations
36+
37+
- ``pskClientProvider``
38+
- ``pskHint``
39+
- ``pskServerProvider``
40+
- ``pskClientCallback``
41+
- ``pskServerCallback``
42+
43+
### Comparing and Hashing TLS configurations
44+
45+
- ``bestEffortEquals(_:)``
46+
- ``bestEffortHash(into:)``
47+
48+
### Deprecated initializers
49+
50+
- ``forClient(cipherSuites:minimumTLSVersion:maximumTLSVersion:certificateVerification:trustRoots:certificateChain:privateKey:applicationProtocols:shutdownTimeout:keyLogCallback:)``
51+
- ``forClient(cipherSuites:minimumTLSVersion:maximumTLSVersion:certificateVerification:trustRoots:certificateChain:privateKey:applicationProtocols:shutdownTimeout:keyLogCallback:renegotiationSupport:)``
52+
- ``forClient(cipherSuites:verifySignatureAlgorithms:signingSignatureAlgorithms:minimumTLSVersion:maximumTLSVersion:certificateVerification:trustRoots:certificateChain:privateKey:applicationProtocols:shutdownTimeout:keyLogCallback:renegotiationSupport:)``
53+
- ``forClient(cipherSuites:verifySignatureAlgorithms:signingSignatureAlgorithms:minimumTLSVersion:maximumTLSVersion:certificateVerification:trustRoots:certificateChain:privateKey:applicationProtocols:shutdownTimeout:keyLogCallback:renegotiationSupport:additionalTrustRoots:)-(String,_,_,_,_,_,_,_,_,_,_,_,_,_)``
54+
55+
- ``forClient(cipherSuites:verifySignatureAlgorithms:signingSignatureAlgorithms:minimumTLSVersion:maximumTLSVersion:certificateVerification:trustRoots:certificateChain:privateKey:applicationProtocols:shutdownTimeout:keyLogCallback:renegotiationSupport:additionalTrustRoots:)-([NIOTLSCipher],_,_,_,_,_,_,_,_,_,_,_,_,_)``
56+
57+
- ``forServer(certificateChain:privateKey:cipherSuites:minimumTLSVersion:maximumTLSVersion:certificateVerification:trustRoots:applicationProtocols:shutdownTimeout:keyLogCallback:)``
58+
- ``forServer(certificateChain:privateKey:cipherSuites:verifySignatureAlgorithms:signingSignatureAlgorithms:minimumTLSVersion:maximumTLSVersion:certificateVerification:trustRoots:applicationProtocols:shutdownTimeout:keyLogCallback:)``
59+
60+
- ``forServer(certificateChain:privateKey:cipherSuites:verifySignatureAlgorithms:signingSignatureAlgorithms:minimumTLSVersion:maximumTLSVersion:certificateVerification:trustRoots:applicationProtocols:shutdownTimeout:keyLogCallback:additionalTrustRoots:)-(_,_,String,_,_,_,_,_,_,_,_,_,_)``
61+
- ``forServer(certificateChain:privateKey:cipherSuites:verifySignatureAlgorithms:signingSignatureAlgorithms:minimumTLSVersion:maximumTLSVersion:certificateVerification:trustRoots:applicationProtocols:shutdownTimeout:keyLogCallback:additionalTrustRoots:)-(_,_,[NIOTLSCipher],_,_,_,_,_,_,_,_,_,_)``

0 commit comments

Comments
 (0)