Skip to content

Commit e8b6f32

Browse files
committed
Revise TransportSecurity documentation
1 parent 6686bbe commit e8b6f32

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

Sources/HTTPServer/NIOHTTPServerConfiguration.swift

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,10 @@ public struct NIOHTTPServerConfiguration: Sendable {
7878

7979
let backing: Backing
8080

81+
/// Configures the server for plaintext HTTP without TLS encryption.
8182
public static let plaintext: Self = Self(backing: .plaintext)
8283

83-
/// Enables TLS.
84+
/// Configures the server for TLS with the provided certificate chain and private key.
8485
/// - Parameters:
8586
/// - certificateChain: The certificate chain to present during negotiation.
8687
/// - privateKey: The private key corresponding to the leaf certificate in `certificateChain`.
@@ -96,14 +97,14 @@ public struct NIOHTTPServerConfiguration: Sendable {
9697
)
9798
}
9899

99-
/// Enables TLS with automatic certificate reloading.
100+
/// Configures the server for TLS with automatic certificate reloading.
100101
/// - Parameters:
101102
/// - certificateReloader: The certificate reloader instance.
102103
public static func tls(certificateReloader: any CertificateReloader) throws -> Self {
103104
Self(backing: .reloadingTLS(certificateReloader: certificateReloader))
104105
}
105106

106-
/// Enables mTLS.
107+
/// Configures the server for mTLS with support for customizing client certificate verification logic.
107108
///
108109
/// - Parameters:
109110
/// - certificateChain: The certificate chain to present during negotiation.
@@ -143,7 +144,8 @@ public struct NIOHTTPServerConfiguration: Sendable {
143144
)
144145
}
145146

146-
/// Enables mTLS with certificate reloading.
147+
/// Configures the server for mTLS with automatic certificate reloading and support for customizing client
148+
/// certificate verification logic.
147149
///
148150
/// - Parameters:
149151
/// - certificateReloader: The certificate reloader instance.

0 commit comments

Comments
 (0)