mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Michael SnowdenandAlex Shtin
6a56810303
## What changed? <!-- Describe what has changed in this PR --> We have some TLS tests which rely on test certificate files. These were generated manually, but they expired in 2024. To fix this, I regenerated the certs with an expiry 100 years from now. It took me a long time to understand these files, how they are generated, and what they're used for, so I also added some documentation for them. ## Why? <!-- Tell your future self why have you made these changes --> Main was broken because of this: https://buildkite.com/temporal/temporal-public/builds/14148#018ccbd3-2735-4334-b038-125b69a37259/130-282 ## How did you test it? <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> - I verified that the constant "data" variables in the test were actually just the inlined contents of the testdata files by running the contents through a base64 encoder and verifying that the output was equal - I didn't modify the behavior of the tests at all other than that ## Potential risks <!-- Assuming the worst case, what can be broken when deploying this change to production? --> ## Is hotfix candidate? <!-- Is this PR a hotfix candidate or does it require a notification to be sent to the broader community? (Yes/No) -->
358 lines
9.4 KiB
Go
358 lines
9.4 KiB
Go
// The MIT License
|
|
//
|
|
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
|
|
//
|
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
package auth
|
|
|
|
import (
|
|
"crypto/tls"
|
|
"crypto/x509"
|
|
"encoding/base64"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"os"
|
|
"testing"
|
|
|
|
"github.com/golang/mock/gomock"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
var validBase64CaData, invalidBase64CaData, validBase64Certificate, invalidBase64Certificate, validBase64Key, invalidBase64Key string
|
|
|
|
func readFile(path string) string {
|
|
file, err := os.Open("testdata/" + path)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
defer func() {
|
|
if err := file.Close(); err != nil {
|
|
panic(err)
|
|
}
|
|
}()
|
|
data, err := io.ReadAll(file)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
return base64.StdEncoding.EncodeToString(data)
|
|
}
|
|
|
|
func init() {
|
|
validBase64CaData = readFile("ca.crt")
|
|
invalidBase64CaData = readFile("invalid_ca.crt")
|
|
validBase64Certificate = readFile("localhost.crt")
|
|
invalidBase64Certificate = readFile("invalid_localhost.crt")
|
|
validBase64Key = readFile("localhost.key")
|
|
invalidBase64Key = readFile("invalid_localhost.key")
|
|
}
|
|
|
|
// test if the input is valid
|
|
func Test_NewTLSConfig(t *testing.T) {
|
|
tests := map[string]struct {
|
|
cfg *TLS
|
|
cfgErr string
|
|
}{
|
|
"emptyConfig": {
|
|
cfg: &TLS{},
|
|
},
|
|
"caData_good": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
CaData: validBase64CaData,
|
|
},
|
|
},
|
|
"caData_badBase64": {
|
|
cfg: &TLS{Enabled: true, CaData: "this isn't base64"},
|
|
cfgErr: "illegal base64 data at input byte",
|
|
},
|
|
"caData_badPEM": {
|
|
cfg: &TLS{Enabled: true, CaData: "dGhpcyBpc24ndCBhIFBFTSBjZXJ0"},
|
|
cfgErr: "unable to parse certs as PEM",
|
|
},
|
|
"clientCert_badbase64cert": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
CertData: "this ain't base64",
|
|
KeyData: validBase64Key,
|
|
},
|
|
cfgErr: "illegal base64 data at input byte",
|
|
},
|
|
"clientCert_badbase64key": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
CertData: validBase64Certificate,
|
|
KeyData: "this ain't base64",
|
|
},
|
|
cfgErr: "illegal base64 data at input byte",
|
|
},
|
|
"clientCert_missingprivatekey": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
CertData: validBase64Certificate,
|
|
KeyData: "",
|
|
},
|
|
cfgErr: "unable to config TLS: cert or key is missing",
|
|
},
|
|
"clientCert_duplicate_cert": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
CertData: validBase64Certificate,
|
|
CertFile: "/a/b/c",
|
|
},
|
|
cfgErr: "only one of certData or certFile properties should be specified",
|
|
},
|
|
"clientCert_duplicate_key": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
KeyData: validBase64Key,
|
|
KeyFile: "/a/b/c",
|
|
},
|
|
cfgErr: "only one of keyData or keyFile properties should be specified",
|
|
},
|
|
"clientCert_duplicate_ca": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
CaData: validBase64CaData,
|
|
CaFile: "/a/b/c",
|
|
},
|
|
cfgErr: "only one of caData or caFile properties should be specified",
|
|
},
|
|
}
|
|
|
|
for name, tc := range tests {
|
|
t.Run(name, func(t *testing.T) {
|
|
ctrl := gomock.NewController(t)
|
|
_, err := NewTLSConfig(tc.cfg)
|
|
if tc.cfgErr != "" {
|
|
assert.ErrorContains(t, err, tc.cfgErr)
|
|
} else {
|
|
assert.NoError(t, err)
|
|
}
|
|
|
|
ctrl.Finish()
|
|
})
|
|
}
|
|
}
|
|
|
|
func Test_ConnectToTLSServerWithCA(t *testing.T) {
|
|
// setup server
|
|
h := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
fmt.Fprintln(w, "Hello World")
|
|
})
|
|
ts := httptest.NewUnstartedServer(h)
|
|
certBytes, err := os.ReadFile("./testdata/localhost.crt")
|
|
if err != nil {
|
|
panic(fmt.Errorf("unable to decode certificate %w", err))
|
|
}
|
|
keyBytes, err := os.ReadFile("./testdata/localhost.key")
|
|
if err != nil {
|
|
panic(fmt.Errorf("unable to decode key %w", err))
|
|
}
|
|
cert, err := tls.X509KeyPair(certBytes, keyBytes)
|
|
if err != nil {
|
|
panic(fmt.Errorf("unable to load certificate %w", err))
|
|
}
|
|
ts.TLS = &tls.Config{
|
|
Certificates: []tls.Certificate{cert},
|
|
}
|
|
ts.StartTLS()
|
|
|
|
tests := map[string]struct {
|
|
cfg *TLS
|
|
connectionErr string
|
|
}{
|
|
"caData_good": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
CaData: validBase64CaData,
|
|
},
|
|
},
|
|
"caData_signedByWrongCA": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
EnableHostVerification: true,
|
|
CaData: invalidBase64CaData,
|
|
},
|
|
connectionErr: "x509: certificate signed by unknown authority",
|
|
},
|
|
"caData_signedByWrongCAButNotEnableHostVerification": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
EnableHostVerification: false,
|
|
CaData: invalidBase64CaData,
|
|
},
|
|
},
|
|
"caFile_good": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
EnableHostVerification: true,
|
|
CaFile: "testdata/ca.crt",
|
|
},
|
|
},
|
|
"caFile_signedByWrongCA": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
EnableHostVerification: true,
|
|
CaFile: "testdata/invalid_ca.crt",
|
|
},
|
|
connectionErr: "x509: certificate signed by unknown authority",
|
|
},
|
|
"caFile_signedByWrongCANotEnableHostVerification": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
EnableHostVerification: false,
|
|
CaFile: "testdata/invalid_ca.crt",
|
|
},
|
|
},
|
|
"certData_good": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
EnableHostVerification: true,
|
|
CaData: validBase64Certificate,
|
|
},
|
|
},
|
|
}
|
|
|
|
for name, tc := range tests {
|
|
t.Run(name, func(t *testing.T) {
|
|
ctrl := gomock.NewController(t)
|
|
tlsConfig, err := NewTLSConfig(tc.cfg)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
cl := &http.Client{Transport: &http.Transport{TLSClientConfig: tlsConfig}}
|
|
resp, err := cl.Get(ts.URL)
|
|
if tc.connectionErr != "" {
|
|
assert.ErrorContains(t, err, tc.connectionErr)
|
|
} else {
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, 200, resp.StatusCode)
|
|
}
|
|
|
|
ctrl.Finish()
|
|
})
|
|
}
|
|
}
|
|
|
|
func Test_ConnectToTLSServerWithClientCertificate(t *testing.T) {
|
|
// setup server
|
|
h := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
fmt.Fprintln(w, "Hello World")
|
|
})
|
|
ts := httptest.NewUnstartedServer(h)
|
|
certBytes, err := os.ReadFile("./testdata/localhost.crt")
|
|
if err != nil {
|
|
panic(fmt.Errorf("unable to decode certificate %w", err))
|
|
}
|
|
keyBytes, err := os.ReadFile("./testdata/localhost.key")
|
|
if err != nil {
|
|
panic(fmt.Errorf("unable to decode key %w", err))
|
|
}
|
|
cert, err := tls.X509KeyPair(certBytes, keyBytes)
|
|
if err != nil {
|
|
panic(fmt.Errorf("unable to load certificate %w", err))
|
|
}
|
|
caBytes, _ := os.ReadFile("testdata/ca.crt")
|
|
caCertPool := x509.NewCertPool()
|
|
caCertPool.AppendCertsFromPEM(caBytes)
|
|
ts.TLS = &tls.Config{
|
|
ClientCAs: caCertPool,
|
|
Certificates: []tls.Certificate{cert},
|
|
ClientAuth: tls.RequireAndVerifyClientCert,
|
|
}
|
|
ts.StartTLS()
|
|
|
|
tests := map[string]struct {
|
|
cfg *TLS
|
|
connectionErr string
|
|
}{
|
|
"clientData_good": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
EnableHostVerification: true,
|
|
CaData: validBase64CaData,
|
|
CertData: validBase64Certificate,
|
|
KeyData: validBase64Key,
|
|
},
|
|
},
|
|
"clientData_certNotProvided": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
EnableHostVerification: true,
|
|
CaData: validBase64CaData,
|
|
},
|
|
connectionErr: "certificate required",
|
|
},
|
|
"clientData_certInvalid": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
EnableHostVerification: true,
|
|
CaData: validBase64CaData,
|
|
CertData: invalidBase64Certificate,
|
|
KeyData: invalidBase64Key,
|
|
},
|
|
connectionErr: "certificate required",
|
|
},
|
|
"certFile_good": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
EnableHostVerification: true,
|
|
CaData: validBase64CaData,
|
|
CertFile: "testdata/localhost.crt",
|
|
KeyFile: "testdata/localhost.key",
|
|
},
|
|
},
|
|
"clientFile_certInvalid": {
|
|
cfg: &TLS{
|
|
Enabled: true,
|
|
EnableHostVerification: true,
|
|
CaData: validBase64CaData,
|
|
CertFile: "testdata/invalid_localhost.crt",
|
|
KeyFile: "testdata/invalid_localhost.key",
|
|
},
|
|
connectionErr: "certificate required",
|
|
},
|
|
}
|
|
|
|
for name, tc := range tests {
|
|
t.Run(name, func(t *testing.T) {
|
|
ctrl := gomock.NewController(t)
|
|
tlsConfig, err := NewTLSConfig(tc.cfg)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
cl := &http.Client{Transport: &http.Transport{TLSClientConfig: tlsConfig}}
|
|
resp, err := cl.Get(ts.URL)
|
|
if tc.connectionErr != "" {
|
|
assert.ErrorContains(t, err, tc.connectionErr)
|
|
} else {
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, 200, resp.StatusCode)
|
|
}
|
|
|
|
ctrl.Finish()
|
|
})
|
|
}
|
|
}
|