1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
|
package client
import (
"crypto"
"crypto/tls"
"crypto/x509"
"encoding/json"
"encoding/pem"
"errors"
"net/http"
"net/http/httptest"
"net/url"
"os"
"path/filepath"
goruntime "runtime"
"testing"
"time"
"github.com/go-openapi/runtime"
"github.com/go-openapi/strfmt"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestRuntimeTLSOptions(t *testing.T) {
fixtures := newTLSFixtures(t)
t.Run("with TLSAuthConfig configured with files", func(t *testing.T) {
opts := TLSClientOptions{
CA: fixtures.RSA.CAFile,
Key: fixtures.RSA.KeyFile,
Certificate: fixtures.RSA.CertFile,
ServerName: fixtures.Subject,
}
cfg, err := TLSClientAuth(opts)
require.NoError(t, err)
require.NotNil(t, cfg)
assert.Len(t, cfg.Certificates, 1)
assert.NotNil(t, cfg.RootCAs)
assert.Equal(t, fixtures.Subject, cfg.ServerName)
})
t.Run("with loaded TLS material", func(t *testing.T) {
t.Run("with TLSConfig from loaded RSA key/cert pair", func(t *testing.T) {
opts := TLSClientOptions{
LoadedKey: fixtures.RSA.LoadedKey,
LoadedCertificate: fixtures.RSA.LoadedCert,
}
cfg, err := TLSClientAuth(opts)
require.NoError(t, err)
require.NotNil(t, cfg)
assert.Len(t, cfg.Certificates, 1)
})
t.Run("with TLSAuthConfig configured with loaded TLS Elliptic Curve key/certificate", func(t *testing.T) {
opts := TLSClientOptions{
LoadedKey: fixtures.ECDSA.LoadedKey,
LoadedCertificate: fixtures.ECDSA.LoadedCert,
}
cfg, err := TLSClientAuth(opts)
require.NoError(t, err)
require.NotNil(t, cfg)
assert.Len(t, cfg.Certificates, 1)
})
t.Run("with TLSAuthConfig configured with loaded Certificate Authority", func(t *testing.T) {
opts := TLSClientOptions{
LoadedCA: fixtures.RSA.LoadedCA,
}
cfg, err := TLSClientAuth(opts)
require.NoError(t, err)
require.NotNil(t, cfg)
assert.NotNil(t, cfg.RootCAs)
})
t.Run("with TLSAuthConfig configured with loaded CA pool", func(t *testing.T) {
pool := x509.NewCertPool()
pool.AddCert(fixtures.RSA.LoadedCA)
opts := TLSClientOptions{
LoadedCAPool: pool,
}
cfg, err := TLSClientAuth(opts)
require.NoError(t, err)
require.NotNil(t, cfg)
require.NotNil(t, cfg.RootCAs)
require.Equal(t, pool, cfg.RootCAs)
})
t.Run("with TLSAuthConfig configured with loaded CA and CA pool", func(t *testing.T) {
pool := systemCAPool(t)
opts := TLSClientOptions{
LoadedCAPool: pool,
LoadedCA: fixtures.RSA.LoadedCA,
}
cfg, err := TLSClientAuth(opts)
require.NoError(t, err)
require.NotNil(t, cfg)
require.NotNil(t, cfg.RootCAs)
// verify that the CA cert is indeed valid against the configured pool.
// NOTE: fixtures may be expired certs, but may validate with a fixed date in the past.
chains, err := fixtures.RSA.LoadedCA.Verify(x509.VerifyOptions{
Roots: cfg.RootCAs,
CurrentTime: time.Date(2017, 1, 1, 1, 1, 1, 1, time.UTC),
})
require.NoError(t, err)
require.NotEmpty(t, chains)
})
t.Run("with TLSAuthConfig with VerifyPeer option", func(t *testing.T) {
verify := func(_ [][]byte, _ [][]*x509.Certificate) error {
return nil
}
opts := TLSClientOptions{
InsecureSkipVerify: true,
VerifyPeerCertificate: verify,
}
cfg, err := TLSClientAuth(opts)
require.NoError(t, err)
require.NotNil(t, cfg)
assert.True(t, cfg.InsecureSkipVerify)
assert.NotNil(t, cfg.VerifyPeerCertificate)
})
})
}
func TestRuntimeManualCertificateValidation(t *testing.T) {
// test manual verification of server certificates
// against root certificate on client side.
//
// The client compares the received cert against the root cert,
// explicitly omitting DNSName check.
fixtures := newTLSFixtures(t)
result := []task{
{false, "task 1 content", 1},
{false, "task 2 content", 2},
}
host, clean := testTLSServer(t, fixtures, result)
t.Cleanup(clean)
var certVerifyCalled bool
client := testTLSClient(t, fixtures, &certVerifyCalled)
rt := NewWithClient(host, "/", []string{schemeHTTPS}, client)
var received []task
operation := &runtime.ClientOperation{
ID: "getTasks",
Method: http.MethodGet,
PathPattern: "/",
Params: runtime.ClientRequestWriterFunc(func(_ runtime.ClientRequest, _ strfmt.Registry) error {
return nil
}),
Reader: runtime.ClientResponseReaderFunc(func(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error) {
if response.Code() == http.StatusOK {
if e := consumer.Consume(response.Body(), &received); e != nil {
return nil, e
}
return result, nil
}
return nil, errors.New("generic error")
}),
}
resp, err := rt.Submit(operation)
require.NoError(t, err)
require.NotEmpty(t, resp)
assert.IsType(t, []task{}, resp)
assert.Truef(t, certVerifyCalled, "the client cert verification has not been called")
assert.EqualValues(t, result, received)
}
func testTLSServer(t testing.TB, fixtures *tlsFixtures, expectedResult []task) (string, func()) {
server := httptest.NewUnstartedServer(http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
rw.Header().Add(runtime.HeaderContentType, runtime.JSONMime)
rw.WriteHeader(http.StatusOK)
jsongen := json.NewEncoder(rw)
require.NoError(t, jsongen.Encode(expectedResult))
}))
// create server tls config
serverCACertPool := x509.NewCertPool()
serverCACertPool.AddCert(fixtures.Server.LoadedCA)
// load server certs
serverCert, err := tls.LoadX509KeyPair(
fixtures.Server.CertFile,
fixtures.Server.KeyFile,
)
require.NoError(t, err)
server.TLS = &tls.Config{
RootCAs: serverCACertPool,
MinVersion: tls.VersionTLS12,
Certificates: []tls.Certificate{serverCert},
}
require.NoError(t, err)
server.StartTLS()
testURL, err := url.Parse(server.URL)
require.NoError(t, err)
return testURL.Host, server.Close
}
func testTLSClient(t testing.TB, fixtures *tlsFixtures, verifyCalled *bool) *http.Client {
client, err := TLSClient(TLSClientOptions{
InsecureSkipVerify: true,
VerifyPeerCertificate: func(rawCerts [][]byte, _ [][]*x509.Certificate) error {
*verifyCalled = true
caCertPool := x509.NewCertPool()
caCertPool.AddCert(fixtures.RSA.LoadedCA)
opts := x509.VerifyOptions{
Roots: caCertPool,
CurrentTime: time.Date(2017, time.July, 1, 1, 1, 1, 1, time.UTC),
}
cert, e := x509.ParseCertificate(rawCerts[0])
if e != nil {
return e
}
_, e = cert.Verify(opts)
return e
},
})
require.NoError(t, err)
return client
}
type (
tlsFixtures struct {
RSA tlsFixture
ECDSA tlsFixture
Server tlsFixture
Subject string
}
tlsFixture struct {
LoadedCA *x509.Certificate
LoadedCert *x509.Certificate
LoadedKey crypto.PrivateKey
CAFile string
KeyFile string
CertFile string
}
)
// newTLSFixtures loads TLS material for testing
func newTLSFixtures(t testing.TB) *tlsFixtures {
const subject = "somewhere"
certFixturesDir := filepath.Join("..", "fixtures", "certs")
keyFile := filepath.Join(certFixturesDir, "myclient.key")
keyPem, err := os.ReadFile(keyFile)
require.NoError(t, err)
keyDer, _ := pem.Decode(keyPem)
require.NotNil(t, keyDer)
key, err := x509.ParsePKCS1PrivateKey(keyDer.Bytes)
require.NoError(t, err)
certFile := filepath.Join(certFixturesDir, "myclient.crt")
certPem, err := os.ReadFile(certFile)
require.NoError(t, err)
certDer, _ := pem.Decode(certPem)
require.NotNil(t, certDer)
cert, err := x509.ParseCertificate(certDer.Bytes)
require.NoError(t, err)
eccKeyFile := filepath.Join(certFixturesDir, "myclient-ecc.key")
eckeyPem, err := os.ReadFile(eccKeyFile)
require.NoError(t, err)
_, remainder := pem.Decode(eckeyPem)
ecKeyDer, _ := pem.Decode(remainder)
require.NotNil(t, ecKeyDer)
ecKey, err := x509.ParseECPrivateKey(ecKeyDer.Bytes)
require.NoError(t, err)
eccCertFile := filepath.Join(certFixturesDir, "myclient-ecc.crt")
ecCertPem, err := os.ReadFile(eccCertFile)
require.NoError(t, err)
ecCertDer, _ := pem.Decode(ecCertPem)
require.NotNil(t, ecCertDer)
ecCert, err := x509.ParseCertificate(ecCertDer.Bytes)
require.NoError(t, err)
caFile := filepath.Join(certFixturesDir, "myCA.crt")
caPem, err := os.ReadFile(caFile)
require.NoError(t, err)
caBlock, _ := pem.Decode(caPem)
require.NotNil(t, caBlock)
caCert, err := x509.ParseCertificate(caBlock.Bytes)
require.NoError(t, err)
serverKeyFile := filepath.Join(certFixturesDir, "mycert1.key")
serverKeyPem, err := os.ReadFile(serverKeyFile)
require.NoError(t, err)
serverKeyDer, _ := pem.Decode(serverKeyPem)
require.NotNil(t, serverKeyDer)
serverKey, err := x509.ParsePKCS1PrivateKey(serverKeyDer.Bytes)
require.NoError(t, err)
serverCertFile := filepath.Join(certFixturesDir, "mycert1.crt")
serverCertPem, err := os.ReadFile(serverCertFile)
require.NoError(t, err)
serverCertDer, _ := pem.Decode(serverCertPem)
require.NotNil(t, serverCertDer)
serverCert, err := x509.ParseCertificate(serverCertDer.Bytes)
require.NoError(t, err)
return &tlsFixtures{
Subject: subject,
RSA: tlsFixture{
CAFile: caFile,
KeyFile: keyFile,
CertFile: certFile,
LoadedCA: caCert,
LoadedKey: key,
LoadedCert: cert,
},
ECDSA: tlsFixture{
KeyFile: eccKeyFile,
CertFile: eccCertFile,
LoadedKey: ecKey,
LoadedCert: ecCert,
},
Server: tlsFixture{
KeyFile: serverKeyFile,
CertFile: serverCertFile,
LoadedCA: caCert,
LoadedKey: serverKey,
LoadedCert: serverCert,
},
}
}
func systemCAPool(t testing.TB) *x509.CertPool {
if goruntime.GOOS == "windows" {
// Windows doesn't have the system cert pool.
return x509.NewCertPool()
}
pool, err := x509.SystemCertPool()
require.NoError(t, err)
return pool
}
|