-
Notifications
You must be signed in to change notification settings - Fork 27
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support TLS 1.3 in fipstls mode #1121
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,358 @@ | ||
| From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 | ||
| From: qmuntal <[email protected]> | ||
| Date: Tue, 30 Jan 2024 11:40:31 +0100 | ||
| Subject: [PATCH] Support TLS 1.3 in fipstls mode | ||
|
|
||
| --- | ||
| src/crypto/tls/boring.go | 14 +++-- | ||
| src/crypto/tls/boring_test.go | 66 ++++++++++++++++++------ | ||
| src/crypto/tls/cipher_suites.go | 15 ++++-- | ||
| src/crypto/tls/handshake_client.go | 4 +- | ||
| src/crypto/tls/handshake_client_tls13.go | 4 -- | ||
| src/crypto/tls/handshake_server_test.go | 28 ++++++---- | ||
| src/crypto/tls/handshake_server_tls13.go | 7 ++- | ||
| src/crypto/tls/notboring.go | 2 + | ||
| 8 files changed, 98 insertions(+), 42 deletions(-) | ||
|
|
||
| diff --git a/src/crypto/tls/boring.go b/src/crypto/tls/boring.go | ||
| index ecd0f5a7b3e9ed..07f15ab91eefd3 100644 | ||
| --- a/src/crypto/tls/boring.go | ||
| +++ b/src/crypto/tls/boring.go | ||
| @@ -17,14 +17,14 @@ func needFIPS() bool { | ||
|
|
||
| // fipsMinVersion replaces c.minVersion in FIPS-only mode. | ||
| func fipsMinVersion(c *Config) uint16 { | ||
| - // FIPS requires TLS 1.2. | ||
| + // FIPS requires TLS 1.2 or TLS 1.3. | ||
| return VersionTLS12 | ||
| } | ||
|
|
||
| // fipsMaxVersion replaces c.maxVersion in FIPS-only mode. | ||
| func fipsMaxVersion(c *Config) uint16 { | ||
| - // FIPS requires TLS 1.2. | ||
| - return VersionTLS12 | ||
| + // FIPS requires TLS 1.2 or TLS 1.3. | ||
| + return VersionTLS13 | ||
| } | ||
|
|
||
| // default defaultFIPSCurvePreferences is the FIPS-allowed curves, | ||
| @@ -54,8 +54,6 @@ var defaultCipherSuitesFIPS = []uint16{ | ||
| TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, | ||
| TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, | ||
| TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, | ||
| - TLS_RSA_WITH_AES_128_GCM_SHA256, | ||
| - TLS_RSA_WITH_AES_256_GCM_SHA384, | ||
| } | ||
|
|
||
| // fipsCipherSuites replaces c.cipherSuites in FIPS-only mode. | ||
| @@ -75,6 +73,12 @@ func fipsCipherSuites(c *Config) []uint16 { | ||
| return list | ||
| } | ||
|
|
||
| +// defaultCipherSuitesTLS13FIPS are the FIPS-allowed cipher suites for TLS 1.3. | ||
| +var defaultCipherSuitesTLS13FIPS = []uint16{ | ||
| + TLS_AES_128_GCM_SHA256, | ||
| + TLS_AES_256_GCM_SHA384, | ||
| +} | ||
| + | ||
| // fipsSupportedSignatureAlgorithms currently are a subset of | ||
| // defaultSupportedSignatureAlgorithms without Ed25519 and SHA-1. | ||
| var fipsSupportedSignatureAlgorithms = []SignatureScheme{ | ||
| diff --git a/src/crypto/tls/boring_test.go b/src/crypto/tls/boring_test.go | ||
| index 86595e588cf604..2ae19d7b1e745e 100644 | ||
| --- a/src/crypto/tls/boring_test.go | ||
| +++ b/src/crypto/tls/boring_test.go | ||
| @@ -25,6 +25,31 @@ import ( | ||
| "time" | ||
| ) | ||
|
|
||
| +func allCipherSuitesIncludingTLS13() []uint16 { | ||
| + s := allCipherSuites() | ||
| + for _, suite := range cipherSuitesTLS13 { | ||
| + s = append(s, suite.id) | ||
| + } | ||
| + return s | ||
| +} | ||
| + | ||
| +func isTLS13CipherSuite(id uint16) bool { | ||
| + for _, suite := range cipherSuitesTLS13 { | ||
| + if id == suite.id { | ||
| + return true | ||
| + } | ||
| + } | ||
| + return false | ||
| +} | ||
| + | ||
| +func generateKeyShare(group CurveID) keyShare { | ||
| + key, err := generateECDHEKey(rand.Reader, group) | ||
| + if err != nil { | ||
| + panic(err) | ||
| + } | ||
| + return keyShare{group: group, data: key.PublicKey().Bytes()} | ||
| +} | ||
| + | ||
| func TestBoringServerProtocolVersion(t *testing.T) { | ||
| test := func(name string, v uint16, msg string) { | ||
| t.Run(name, func(t *testing.T) { | ||
| @@ -33,8 +58,11 @@ func TestBoringServerProtocolVersion(t *testing.T) { | ||
| clientHello := &clientHelloMsg{ | ||
| vers: v, | ||
| random: make([]byte, 32), | ||
| - cipherSuites: allCipherSuites(), | ||
| + cipherSuites: allCipherSuitesIncludingTLS13(), | ||
| compressionMethods: []uint8{compressionNone}, | ||
| + supportedCurves: defaultCurvePreferences, | ||
| + keyShares: []keyShare{generateKeyShare(CurveP256)}, | ||
| + supportedPoints: []uint8{pointFormatUncompressed}, | ||
| supportedVersions: []uint16{v}, | ||
| } | ||
| testClientHelloFailure(t, serverConfig, clientHello, msg) | ||
| @@ -48,25 +76,25 @@ func TestBoringServerProtocolVersion(t *testing.T) { | ||
|
|
||
| fipstls.Force() | ||
| defer fipstls.Abandon() | ||
| - test("VersionSSL30", VersionSSL30, "client offered only unsupported versions") | ||
| - test("VersionTLS10", VersionTLS10, "client offered only unsupported versions") | ||
| - test("VersionTLS11", VersionTLS11, "client offered only unsupported versions") | ||
| - test("VersionTLS12", VersionTLS12, "") | ||
| - test("VersionTLS13", VersionTLS13, "client offered only unsupported versions") | ||
| + test("VersionSSL30/fipstls", VersionSSL30, "client offered only unsupported versions") | ||
| + test("VersionTLS10/fipstls", VersionTLS10, "client offered only unsupported versions") | ||
| + test("VersionTLS11/fipstls", VersionTLS11, "client offered only unsupported versions") | ||
| + test("VersionTLS12/fipstls", VersionTLS12, "") | ||
| + test("VersionTLS13/fipstls", VersionTLS13, "") | ||
| } | ||
|
|
||
| func isBoringVersion(v uint16) bool { | ||
| - return v == VersionTLS12 | ||
| + return v == VersionTLS12 || v == VersionTLS13 | ||
| } | ||
|
|
||
| func isBoringCipherSuite(id uint16) bool { | ||
| switch id { | ||
| - case TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, | ||
| + case TLS_AES_128_GCM_SHA256, | ||
| + TLS_AES_256_GCM_SHA384, | ||
| + TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, | ||
| TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, | ||
| TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, | ||
| - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, | ||
| - TLS_RSA_WITH_AES_128_GCM_SHA256, | ||
| - TLS_RSA_WITH_AES_256_GCM_SHA384: | ||
| + TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384: | ||
| return true | ||
| } | ||
| return false | ||
| @@ -86,7 +114,7 @@ func isECDSA(id uint16) bool { | ||
| return suite.flags&suiteECSign == suiteECSign | ||
| } | ||
| } | ||
| - panic(fmt.Sprintf("unknown cipher suite %#x", id)) | ||
| + return false // TLS 1.3 cipher suites are not tied to the signature algorithm. | ||
| } | ||
|
|
||
| func isBoringSignatureScheme(alg SignatureScheme) bool { | ||
| @@ -109,10 +137,9 @@ func isBoringSignatureScheme(alg SignatureScheme) bool { | ||
|
|
||
| func TestBoringServerCipherSuites(t *testing.T) { | ||
| serverConfig := testConfig.Clone() | ||
| - serverConfig.CipherSuites = allCipherSuites() | ||
| serverConfig.Certificates = make([]Certificate, 1) | ||
|
|
||
| - for _, id := range allCipherSuites() { | ||
| + for _, id := range allCipherSuitesIncludingTLS13() { | ||
| if isECDSA(id) { | ||
| serverConfig.Certificates[0].Certificate = [][]byte{testECDSACertificate} | ||
| serverConfig.Certificates[0].PrivateKey = testECDSAPrivateKey | ||
| @@ -121,14 +148,19 @@ func TestBoringServerCipherSuites(t *testing.T) { | ||
| serverConfig.Certificates[0].PrivateKey = testRSAPrivateKey | ||
| } | ||
| serverConfig.BuildNameToCertificate() | ||
| - t.Run(fmt.Sprintf("suite=%#x", id), func(t *testing.T) { | ||
| + t.Run(fmt.Sprintf("suite=%#x", CipherSuiteName(id)), func(t *testing.T) { | ||
| clientHello := &clientHelloMsg{ | ||
| vers: VersionTLS12, | ||
| random: make([]byte, 32), | ||
| cipherSuites: []uint16{id}, | ||
| compressionMethods: []uint8{compressionNone}, | ||
| supportedCurves: defaultCurvePreferences, | ||
| + keyShares: []keyShare{generateKeyShare(CurveP256)}, | ||
| supportedPoints: []uint8{pointFormatUncompressed}, | ||
| + supportedVersions: []uint16{VersionTLS12}, | ||
| + } | ||
| + if isTLS13CipherSuite(id) { | ||
| + clientHello.supportedVersions = []uint16{VersionTLS13} | ||
| } | ||
|
|
||
| testClientHello(t, serverConfig, clientHello) | ||
| @@ -160,7 +192,9 @@ func TestBoringServerCurves(t *testing.T) { | ||
| cipherSuites: []uint16{TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256}, | ||
| compressionMethods: []uint8{compressionNone}, | ||
| supportedCurves: []CurveID{curveid}, | ||
| + keyShares: []keyShare{generateKeyShare(curveid)}, | ||
| supportedPoints: []uint8{pointFormatUncompressed}, | ||
| + supportedVersions: []uint16{VersionTLS12}, | ||
| } | ||
|
|
||
| testClientHello(t, serverConfig, clientHello) | ||
| @@ -279,7 +313,7 @@ func TestBoringClientHello(t *testing.T) { | ||
| } | ||
|
|
||
| if !isBoringVersion(hello.vers) { | ||
| - t.Errorf("client vers=%#x, want %#x (TLS 1.2)", hello.vers, VersionTLS12) | ||
| + t.Errorf("client vers=%#x", hello.vers) | ||
| } | ||
| for _, v := range hello.supportedVersions { | ||
| if !isBoringVersion(v) { | ||
| diff --git a/src/crypto/tls/cipher_suites.go b/src/crypto/tls/cipher_suites.go | ||
| index 9079b5a2e3d50d..bda80e81cd5396 100644 | ||
| --- a/src/crypto/tls/cipher_suites.go | ||
| +++ b/src/crypto/tls/cipher_suites.go | ||
| @@ -17,6 +17,7 @@ import ( | ||
| "fmt" | ||
| "hash" | ||
| "internal/cpu" | ||
| + "internal/goexperiment" | ||
| "runtime" | ||
|
|
||
| "golang.org/x/crypto/chacha20poly1305" | ||
| @@ -556,9 +557,17 @@ func aeadAESGCMTLS13(key, nonceMask []byte) aead { | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| - aead, err := cipher.NewGCM(aes) | ||
| - if err != nil { | ||
| - panic(err) | ||
| + var aead cipher.AEAD | ||
| + if boring.Enabled { | ||
| + if goexperiment.BoringCrypto { | ||
| + // TODO: remove this once BoringCrypto supports TLS 1.3. | ||
| + aead, err = cipher.NewGCM(aes) | ||
| + } else { | ||
| + aead, err = boring.NewGCMTLS13(aes) | ||
| + } | ||
| + } else { | ||
| + boring.Unreachable() | ||
| + aead, err = cipher.NewGCM(aes) | ||
| } | ||
|
|
||
| ret := &xorNonceAEAD{aead: aead} | ||
| diff --git a/src/crypto/tls/handshake_client.go b/src/crypto/tls/handshake_client.go | ||
| index e685339c29780a..eafbb221c07a33 100644 | ||
| --- a/src/crypto/tls/handshake_client.go | ||
| +++ b/src/crypto/tls/handshake_client.go | ||
| @@ -139,7 +139,9 @@ func (c *Conn) makeClientHello() (*clientHelloMsg, *ecdh.PrivateKey, error) { | ||
| if len(hello.supportedVersions) == 1 { | ||
| hello.cipherSuites = nil | ||
| } | ||
| - if hasAESGCMHardwareSupport { | ||
| + if needFIPS() { | ||
| + hello.cipherSuites = append(hello.cipherSuites, defaultCipherSuitesTLS13FIPS...) | ||
| + } else if hasAESGCMHardwareSupport { | ||
| hello.cipherSuites = append(hello.cipherSuites, defaultCipherSuitesTLS13...) | ||
| } else { | ||
| hello.cipherSuites = append(hello.cipherSuites, defaultCipherSuitesTLS13NoAES...) | ||
| diff --git a/src/crypto/tls/handshake_client_tls13.go b/src/crypto/tls/handshake_client_tls13.go | ||
| index 2f59f6888c5d81..a84cede1b0b518 100644 | ||
| --- a/src/crypto/tls/handshake_client_tls13.go | ||
| +++ b/src/crypto/tls/handshake_client_tls13.go | ||
| @@ -41,10 +41,6 @@ type clientHandshakeStateTLS13 struct { | ||
| func (hs *clientHandshakeStateTLS13) handshake() error { | ||
| c := hs.c | ||
|
|
||
| - if needFIPS() { | ||
| - return errors.New("tls: internal error: TLS 1.3 reached in FIPS mode") | ||
| - } | ||
| - | ||
| // The server must not select TLS 1.3 in a renegotiation. See RFC 8446, | ||
| // sections 4.1.2 and 4.1.3. | ||
| if c.handshakes > 0 { | ||
| diff --git a/src/crypto/tls/handshake_server_test.go b/src/crypto/tls/handshake_server_test.go | ||
| index 15db760716c3df..c0a86a49841d61 100644 | ||
| --- a/src/crypto/tls/handshake_server_test.go | ||
| +++ b/src/crypto/tls/handshake_server_test.go | ||
| @@ -27,6 +27,7 @@ import ( | ||
| ) | ||
|
|
||
| func testClientHello(t *testing.T, serverConfig *Config, m handshakeMessage) { | ||
| + t.Helper() | ||
| testClientHelloFailure(t, serverConfig, m, "") | ||
| } | ||
|
|
||
| @@ -52,23 +53,32 @@ func testClientHelloFailure(t *testing.T, serverConfig *Config, m handshakeMessa | ||
| ctx := context.Background() | ||
| conn := Server(s, serverConfig) | ||
| ch, err := conn.readClientHello(ctx) | ||
| - hs := serverHandshakeState{ | ||
| - c: conn, | ||
| - ctx: ctx, | ||
| - clientHello: ch, | ||
| - } | ||
| - if err == nil { | ||
| + if err == nil && conn.vers == VersionTLS13 { | ||
| + hs := serverHandshakeStateTLS13{ | ||
| + c: conn, | ||
| + ctx: ctx, | ||
| + clientHello: ch, | ||
| + } | ||
| err = hs.processClientHello() | ||
| - } | ||
| - if err == nil { | ||
| - err = hs.pickCipherSuite() | ||
| + } else if err == nil { | ||
| + hs := serverHandshakeState{ | ||
| + c: conn, | ||
| + ctx: ctx, | ||
| + clientHello: ch, | ||
| + } | ||
| + err = hs.processClientHello() | ||
| + if err == nil { | ||
| + err = hs.pickCipherSuite() | ||
| + } | ||
| } | ||
| s.Close() | ||
| if len(expectedSubStr) == 0 { | ||
| if err != nil && err != io.EOF { | ||
| + t.Helper() | ||
| t.Errorf("Got error: %s; expected to succeed", err) | ||
| } | ||
| } else if err == nil || !strings.Contains(err.Error(), expectedSubStr) { | ||
| + t.Helper() | ||
| t.Errorf("Got error: %v; expected to match substring '%s'", err, expectedSubStr) | ||
| } | ||
| } | ||
| diff --git a/src/crypto/tls/handshake_server_tls13.go b/src/crypto/tls/handshake_server_tls13.go | ||
| index 6c65da0ab04f9f..8234985d1f627a 100644 | ||
| --- a/src/crypto/tls/handshake_server_tls13.go | ||
| +++ b/src/crypto/tls/handshake_server_tls13.go | ||
| @@ -46,10 +46,6 @@ type serverHandshakeStateTLS13 struct { | ||
| func (hs *serverHandshakeStateTLS13) handshake() error { | ||
| c := hs.c | ||
|
|
||
| - if needFIPS() { | ||
| - return errors.New("tls: internal error: TLS 1.3 reached in FIPS mode") | ||
| - } | ||
| - | ||
| // For an overview of the TLS 1.3 handshake, see RFC 8446, Section 2. | ||
| if err := hs.processClientHello(); err != nil { | ||
| return err | ||
| @@ -164,6 +160,9 @@ func (hs *serverHandshakeStateTLS13) processClientHello() error { | ||
| if !hasAESGCMHardwareSupport || !aesgcmPreferred(hs.clientHello.cipherSuites) { | ||
| preferenceList = defaultCipherSuitesTLS13NoAES | ||
| } | ||
| + if needFIPS() { | ||
| + preferenceList = defaultCipherSuitesTLS13FIPS | ||
| + } | ||
| for _, suiteID := range preferenceList { | ||
| hs.suite = mutualCipherSuiteTLS13(hs.clientHello.cipherSuites, suiteID) | ||
| if hs.suite != nil { | ||
| diff --git a/src/crypto/tls/notboring.go b/src/crypto/tls/notboring.go | ||
| index 5a133c9b2f94c7..7625ccb867dd92 100644 | ||
| --- a/src/crypto/tls/notboring.go | ||
| +++ b/src/crypto/tls/notboring.go | ||
| @@ -18,3 +18,5 @@ func fipsCurvePreferences(c *Config) []CurveID { panic("fipsCurvePreferences") } | ||
| func fipsCipherSuites(c *Config) []uint16 { panic("fipsCipherSuites") } | ||
|
|
||
| var fipsSupportedSignatureAlgorithms []SignatureScheme | ||
| + | ||
| +var defaultCipherSuitesTLS13FIPS []uint16 | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the var here,
var defaultFIPSCurvePreferences = []CurveID{CurveP256, CurveP384, CurveP521}, theCurveP521entry is still there--this is good, per golang/go#62372 (comment).(Just taking a note on what's different here vs. the reverted upstream changes.)