### Motivation
`AnalysedCertificateHostname.init` already refuses to construct a
wildcard matcher when the certificate's first label begins with the IDNA
A-label prefix `xn--` (line 287). The symmetric case is not enforced: a
wildcard SAN whose own first label is plain ASCII can still expand into
a target hostname whose first label begins with `xn--`.
A SAN of the form `*-5wao1o.example.com` will currently match a target
hostname `xn--rksmrgs-5wao1o.example.com` (the IDNA A-label form of
`räksmörgås.example.com`). Both OpenSSL's `equal_wildcard` and CPython's
`ssl._dnsname_match` reject that case explicitly; this library accepts
it.
Verified by copying `AnalysedCertificateHostname` verbatim from `main`
into a standalone executable and running:
```
[OK ] Sanity: wildcard matches normal subdomain
cert SAN: *.example.com
target: foo.example.com
expected: true got: true
[OK ] Sanity: wildcard does NOT match different parent
cert SAN: *.example.com
target: foo.evil.com
expected: false got: false
[OK ] Sanity: cert that IS an A-label wildcard rejected at parse
cert SAN: xn--*.example.com
target: xn--anything.example.com
expected: false got: false
[BROKEN ] VULN: partial wildcard expansion produces A-label target
cert SAN: *-5wao1o.example.com
target: xn--rksmrgs-5wao1o.example.com
expected: false got: true
```
After the patch in this PR the BROKEN case becomes OK.
### Modifications
In `validMatchForName`, after splitting the target around its first
period, return `false` if the target's first label begins with `xn--`.
Mirrors the existing cert-side check at line 287 and the
`caseInsensitiveElementsEqual(asciiIDNAIdentifier)` idiom already in use
in this file.
### Result
Wildcard SANs no longer expand into IDNA A-label targets, matching the
behaviour of OpenSSL and CPython. The existing
`testDoesNotMatchIDNALabelWithWildcard` continues to cover the cert-side
variant; the target-side variant is the new case this patch addresses.
---------
Co-authored-by: Cory Benfield <lukasa@apple.com>
SwiftNIO SSL
SwiftNIO SSL is a Swift package that contains an implementation of TLS based on BoringSSL. This package allows users of SwiftNIO to write protocol clients and servers that use TLS to secure data in flight.
The name is inspired primarily by the names of the library this package uses (BoringSSL), and not because we don't know the name of the protocol. We know the protocol is TLS!
To get started, check out the API docs.
Using SwiftNIO SSL
SwiftNIO SSL provides two ChannelHandlers to use to secure a data stream: the NIOSSLClientHandler and the NIOSSLServerHandler. Each of these can be added to a Channel to secure the communications on that channel.
Additionally, we provide a number of low-level primitives for configuring your TLS connections. These will be shown below.
To secure a server connection, you will need a X.509 certificate chain in a file (either PEM or DER, but PEM is far easier), and the associated private key for the leaf certificate. These objects can then be wrapped up in a TLSConfiguration object that is used to initialize the ChannelHandler.
For example:
let configuration = TLSConfiguration.makeServerConfiguration(
certificateChain: try NIOSSLCertificate.fromPEMFile("cert.pem").map { .certificate($0) },
privateKey: try .privateKey(.init(file: "key.pem", format: .pem))
)
let sslContext = try NIOSSLContext(configuration: configuration)
let server = ServerBootstrap(group: group)
.childChannelInitializer { channel in
// important: The handler must be initialized _inside_ the `childChannelInitializer`
let handler = NIOSSLServerHandler(context: sslContext)
[...]
channel.pipeline.syncOperations.addHandler(handler)
[...]
}
For clients, it is a bit simpler as there is no need to have a certificate chain or private key (though clients may have these things). Setup for clients may be done like this:
let configuration = TLSConfiguration.makeClientConfiguration()
let sslContext = try NIOSSLContext(configuration: configuration)
let client = ClientBootstrap(group: group)
.channelInitializer { channel in
// important: The handler must be initialized _inside_ the `channelInitializer`
let handler = try NIOSSLClientHandler(context: sslContext)
[...]
channel.pipeline.syncOperations.addHandler(handler)
[...]
}
The most recent versions of SwiftNIO SSL support Swift 5.7 and newer. The minimum Swift version supported by SwiftNIO SSL releases are detailed below:
| SwiftNIO SSL | Minimum Swift Version |
|---|---|
2.0.0 ..< 2.14.0 |
5.0 |
2.14.0 ..< 2.19.0 |
5.2 |
2.19.0 ..< 2.23.0 |
5.4 |
2.23.0 ..< 2.23.2 |
5.5.2 |
2.23.2 ..< 2.26.0 |
5.6 |
2.26.0 ..< 2.27.0 |
5.7 |
2.27.0 ..< 2.29.3 |
5.8 |
2.29.3 ..< 2.31.0 |
5.9 |
2.31.0 ..< 2.35.0 |
5.10 |
2.35.0 ..< 2.37.0 |
6.0 |
2.37.0 ..< |
6.1 |