]> Cypherpunks.ru repositories - gostls13.git/commitdiff
[release-branch.go1.21] crypto/tls: add GODEBUG to control max RSA key size
authorRoland Shoemaker <roland@golang.org>
Wed, 9 Aug 2023 01:25:59 +0000 (18:25 -0700)
committerGopher Robot <gobot@golang.org>
Wed, 16 Aug 2023 17:16:32 +0000 (17:16 +0000)
Add a new GODEBUG setting, tlsmaxrsasize, which allows controlling the
maximum RSA key size we will accept during TLS handshakes.

Fixes #61967

Change-Id: I52f060be132014d219f4cd438f59990011a35c96
Reviewed-on: https://go-review.googlesource.com/c/go/+/517495
Auto-Submit: Roland Shoemaker <roland@golang.org>
Reviewed-by: Russ Cox <rsc@golang.org>
Run-TryBot: Roland Shoemaker <roland@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-on: https://go-review.googlesource.com/c/go/+/518535
Auto-Submit: Dmitri Shuralyov <dmitshur@google.com>

doc/godebug.md
src/crypto/tls/conn.go
src/crypto/tls/handshake_client.go
src/crypto/tls/handshake_client_test.go
src/crypto/tls/handshake_server.go
src/internal/godebugs/table.go
src/runtime/metrics/doc.go

index 7a6d70e48782ad958135181dc64c551766979e2e..d26555503e0522072b8ed75d7e63801547794c33 100644 (file)
@@ -126,6 +126,14 @@ for example,
 see the [runtime documentation](/pkg/runtime#hdr-Environment_Variables)
 and the [go command documentation](/cmd/go#hdr-Build_and_test_caching).
 
+### Go 1.22
+
+Go 1.22 adds a configurable limit to control the maximum acceptable RSA key size
+that can be used in TLS handshakes, controlled by the [`tlsmaxrsasize`setting](/pkg/crypto/tls#Conn.Handshake).
+The default is tlsmaxrsasize=8192, limiting RSA to 8192-bit keys. To avoid
+denial of service attacks, this setting and default was backported to Go
+1.19.13, Go 1.20.8, and Go 1.21.1.
+
 ### Go 1.21
 
 Go 1.21 made it a run-time error to call `panic` with a nil interface value,
index 8b62dd5bffbba4d52015c406561225486b284333..c04bd48d6a91ba7204faee7567a601d1c2b6eb1b 100644 (file)
@@ -1467,6 +1467,11 @@ func (c *Conn) closeNotify() error {
 //
 // For control over canceling or setting a timeout on a handshake, use
 // HandshakeContext or the Dialer's DialContext method instead.
+//
+// In order to avoid denial of service attacks, the maximum RSA key size allowed
+// in certificates sent by either the TLS server or client is limited to 8192
+// bits. This limit can be overridden by setting tlsmaxrsasize in the GODEBUG
+// environment variable (e.g. GODEBUG=tlsmaxrsasize=4096).
 func (c *Conn) Handshake() error {
        return c.HandshakeContext(context.Background())
 }
index f6911d458f9cbaae28d94b9538996ca210af1acd..4649f36dea6773d0fbe0969ee0dc8cda46b4682c 100644 (file)
@@ -17,8 +17,10 @@ import (
        "errors"
        "fmt"
        "hash"
+       "internal/godebug"
        "io"
        "net"
+       "strconv"
        "strings"
        "time"
 )
@@ -936,9 +938,23 @@ func (hs *clientHandshakeState) sendFinished(out []byte) error {
        return nil
 }
 
-// maxRSAKeySize is the maximum RSA key size in bits that we are willing
+// defaultMaxRSAKeySize is the maximum RSA key size in bits that we are willing
 // to verify the signatures of during a TLS handshake.
-const maxRSAKeySize = 8192
+const defaultMaxRSAKeySize = 8192
+
+var tlsmaxrsasize = godebug.New("tlsmaxrsasize")
+
+func checkKeySize(n int) (max int, ok bool) {
+       if v := tlsmaxrsasize.Value(); v != "" {
+               if max, err := strconv.Atoi(v); err == nil {
+                       if (n <= max) != (n <= defaultMaxRSAKeySize) {
+                               tlsmaxrsasize.IncNonDefault()
+                       }
+                       return max, n <= max
+               }
+       }
+       return defaultMaxRSAKeySize, n <= defaultMaxRSAKeySize
+}
 
 // verifyServerCertificate parses and verifies the provided chain, setting
 // c.verifiedChains and c.peerCertificates or sending the appropriate alert.
@@ -951,9 +967,12 @@ func (c *Conn) verifyServerCertificate(certificates [][]byte) error {
                        c.sendAlert(alertBadCertificate)
                        return errors.New("tls: failed to parse certificate from server: " + err.Error())
                }
-               if cert.cert.PublicKeyAlgorithm == x509.RSA && cert.cert.PublicKey.(*rsa.PublicKey).N.BitLen() > maxRSAKeySize {
-                       c.sendAlert(alertBadCertificate)
-                       return fmt.Errorf("tls: server sent certificate containing RSA key larger than %d bits", maxRSAKeySize)
+               if cert.cert.PublicKeyAlgorithm == x509.RSA {
+                       n := cert.cert.PublicKey.(*rsa.PublicKey).N.BitLen()
+                       if max, ok := checkKeySize(n); !ok {
+                               c.sendAlert(alertBadCertificate)
+                               return fmt.Errorf("tls: server sent certificate containing RSA key larger than %d bits", max)
+                       }
                }
                activeHandles[i] = cert
                certs[i] = cert.cert
index ee9e79afabf3d92b0dfd84037bf88171a6e4216c..a2052ceb70dcf2c51fa52a7e86ac39a5dab1b5ba 100644 (file)
@@ -2783,19 +2783,44 @@ u58=
 -----END CERTIFICATE-----`
 
 func TestHandshakeRSATooBig(t *testing.T) {
-       testCert, _ := pem.Decode([]byte(largeRSAKeyCertPEM))
+       for _, tc := range []struct {
+               name              string
+               godebug           string
+               expectedServerErr string
+               expectedClientErr string
+       }{
+               {
+                       name:              "key too large",
+                       expectedServerErr: "tls: server sent certificate containing RSA key larger than 8192 bits",
+                       expectedClientErr: "tls: client sent certificate containing RSA key larger than 8192 bits",
+               },
+               {
+                       name:    "acceptable key (GODEBUG=tlsmaxrsasize=8193)",
+                       godebug: "tlsmaxrsasize=8193",
+               },
+       } {
+               t.Run(tc.name, func(t *testing.T) {
+                       if tc.godebug != "" {
+                               t.Setenv("GODEBUG", tc.godebug)
+                       }
 
-       c := &Conn{conn: &discardConn{}, config: testConfig.Clone()}
+                       testCert, _ := pem.Decode([]byte(largeRSAKeyCertPEM))
 
-       expectedErr := "tls: server sent certificate containing RSA key larger than 8192 bits"
-       err := c.verifyServerCertificate([][]byte{testCert.Bytes})
-       if err == nil || err.Error() != expectedErr {
-               t.Errorf("Conn.verifyServerCertificate unexpected error: want %q, got %q", expectedErr, err)
-       }
+                       c := &Conn{conn: &discardConn{}, config: testConfig.Clone()}
+
+                       err := c.verifyServerCertificate([][]byte{testCert.Bytes})
+                       if tc.expectedServerErr == "" && err != nil {
+                               t.Errorf("Conn.verifyServerCertificate unexpected error: %s", err)
+                       } else if tc.expectedServerErr != "" && (err == nil || err.Error() != tc.expectedServerErr) {
+                               t.Errorf("Conn.verifyServerCertificate unexpected error: want %q, got %q", tc.expectedServerErr, err)
+                       }
 
-       expectedErr = "tls: client sent certificate containing RSA key larger than 8192 bits"
-       err = c.processCertsFromClient(Certificate{Certificate: [][]byte{testCert.Bytes}})
-       if err == nil || err.Error() != expectedErr {
-               t.Errorf("Conn.processCertsFromClient unexpected error: want %q, got %q", expectedErr, err)
+                       err = c.processCertsFromClient(Certificate{Certificate: [][]byte{testCert.Bytes}})
+                       if tc.expectedClientErr == "" && err != nil {
+                               t.Errorf("Conn.processCertsFromClient unexpected error: %s", err)
+                       } else if tc.expectedClientErr != "" && (err == nil || err.Error() != tc.expectedClientErr) {
+                               t.Errorf("Conn.processCertsFromClient unexpected error: want %q, got %q", tc.expectedClientErr, err)
+                       }
+               })
        }
 }
index 89a16a8967dcb5c738c62aa3dfddc1857fb824ee..996b23b1f523416a30b2c1e1da66bba008fdbb45 100644 (file)
@@ -864,9 +864,12 @@ func (c *Conn) processCertsFromClient(certificate Certificate) error {
                        c.sendAlert(alertBadCertificate)
                        return errors.New("tls: failed to parse client certificate: " + err.Error())
                }
-               if certs[i].PublicKeyAlgorithm == x509.RSA && certs[i].PublicKey.(*rsa.PublicKey).N.BitLen() > maxRSAKeySize {
-                       c.sendAlert(alertBadCertificate)
-                       return fmt.Errorf("tls: client sent certificate containing RSA key larger than %d bits", maxRSAKeySize)
+               if certs[i].PublicKeyAlgorithm == x509.RSA {
+                       n := certs[i].PublicKey.(*rsa.PublicKey).N.BitLen()
+                       if max, ok := checkKeySize(n); !ok {
+                               c.sendAlert(alertBadCertificate)
+                               return fmt.Errorf("tls: client sent certificate containing RSA key larger than %d bits", max)
+                       }
                }
        }
 
index 243f9efce11e14e19663f770fc316d870d2db6a8..b1711d9ef21f8526dfe671ec6809015b557c4b4d 100644 (file)
@@ -42,6 +42,7 @@ var All = []Info{
        {Name: "panicnil", Package: "runtime", Changed: 21, Old: "1"},
        {Name: "randautoseed", Package: "math/rand"},
        {Name: "tarinsecurepath", Package: "archive/tar"},
+       {Name: "tlsmaxrsasize", Package: "crypto/tls"},
        {Name: "x509sha1", Package: "crypto/x509"},
        {Name: "x509usefallbackroots", Package: "crypto/x509"},
        {Name: "zipinsecurepath", Package: "archive/zip"},
index b4d32d135ab5e59690398b72dca5c742cba6add9..55d1f65f42d11ce0090b4c50383d51d82fb3ccfc 100644 (file)
@@ -290,6 +290,10 @@ Below is the full list of supported metrics, ordered lexicographically.
                package due to a non-default GODEBUG=tarinsecurepath=...
                setting.
 
+       /godebug/non-default-behavior/tlsmaxrsasize:events
+               The number of non-default behaviors executed by the crypto/tls
+               package due to a non-default GODEBUG=tlsmaxrsasize=... setting.
+
        /godebug/non-default-behavior/x509sha1:events
                The number of non-default behaviors executed by the crypto/x509
                package due to a non-default GODEBUG=x509sha1=... setting.