Skip to content

Commit

Permalink
Update x509.CertPool equality checks (#2880)
Browse files Browse the repository at this point in the history
Go 1.16 changed the CertPool implementation to employ functions to
lazily acquire certificates. This change effectively breaks
`reflect.DeepEqual` used by our test assertions.

This commit changes the assertions compare certificate subjects instead
of the entire pool. While not the same, it's a close approximation.

See https://go-review.googlesource.com/c/go/+/229917

Signed-off-by: Matthew Sykes <[email protected]>
Signed-off-by: David Enyeart <[email protected]>

Co-authored-by: Matthew Sykes <[email protected]>
  • Loading branch information
denyeart and sykesm authored Aug 30, 2021
1 parent f441ba2 commit 50064c8
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 22 deletions.
6 changes: 5 additions & 1 deletion core/operations/tls_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@ var _ = Describe("TLS", func() {

tlsConfig, err := opsTLS.Config()
Expect(err).NotTo(HaveOccurred())

// https://go-review.googlesource.com/c/go/+/229917
Expect(tlsConfig.ClientCAs.Subjects()).To(Equal(clientCAPool.Subjects()))
tlsConfig.ClientCAs = nil

Expect(tlsConfig).To(Equal(&tls.Config{
Certificates: []tls.Certificate{cert},
CipherSuites: []uint16{
Expand All @@ -69,7 +74,6 @@ var _ = Describe("TLS", func() {
tls.TLS_RSA_WITH_AES_128_GCM_SHA256,
tls.TLS_RSA_WITH_AES_256_GCM_SHA384,
},
ClientCAs: clientCAPool,
ClientAuth: tls.RequireAndVerifyClientCert,
}))
})
Expand Down
29 changes: 8 additions & 21 deletions internal/pkg/comm/creds_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -127,38 +127,25 @@ func TestAddRootCA(t *testing.T) {
t.Parallel()

caPEM, err := ioutil.ReadFile(filepath.Join("testdata", "certs", "Org1-cert.pem"))
if err != nil {
t.Fatalf("failed to read root certificate: %v", err)
}

cert := &x509.Certificate{
EmailAddresses: []string{"[email protected]"},
}
require.NoError(t, err, "failed to read root certificate")

expectedCertPool := x509.NewCertPool()
ok := expectedCertPool.AppendCertsFromPEM(caPEM)
if !ok {
t.Fatalf("failed to create expected certPool")
}
require.True(t, ok, "failed to create expected certPool")

cert := &x509.Certificate{EmailAddresses: []string{"[email protected]"}}
expectedCertPool.AddCert(cert)

certPool := x509.NewCertPool()
ok = certPool.AppendCertsFromPEM(caPEM)
if !ok {
t.Fatalf("failed to create certPool")
}
require.True(t, ok, "failed to create certPool")

tlsConfig := &tls.Config{
ClientCAs: certPool,
}
config := comm.NewTLSConfig(tlsConfig)

assert.Equal(t, config.Config().ClientCAs, certPool)
config := comm.NewTLSConfig(&tls.Config{ClientCAs: certPool})
require.Same(t, config.Config().ClientCAs, certPool)

// https://go-review.googlesource.com/c/go/+/229917
config.AddClientRootCA(cert)

assert.Equal(t, config.Config().ClientCAs, expectedCertPool, "The CertPools should be equal")
require.Equal(t, certPool.Subjects(), expectedCertPool.Subjects(), "subjects in the pool should be equal")
}

func TestSetClientCAs(t *testing.T) {
Expand Down

0 comments on commit 50064c8

Please sign in to comment.