Skip to content

Commit 66cfda0

Browse files
authored
Add DocC extension page to provide curation for TLSConfiguration (#532)
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 66cfda0

File tree

1 file changed

+56
-0
lines changed

1 file changed

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

0 commit comments

Comments
 (0)