457 lines
14 KiB
Go
457 lines
14 KiB
Go
/*
|
|
Copyright 2020 The cert-manager Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package pki
|
|
|
|
import (
|
|
"crypto"
|
|
"crypto/ecdsa"
|
|
"crypto/rand"
|
|
"crypto/rsa"
|
|
"crypto/x509"
|
|
"crypto/x509/pkix"
|
|
"encoding/asn1"
|
|
"encoding/pem"
|
|
"reflect"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
v1 "github.com/cert-manager/cert-manager/pkg/apis/certmanager/v1"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func generatePrivateKeyBytes(keyAlgo v1.PrivateKeyAlgorithm, keySize int) ([]byte, error) {
|
|
cert := buildCertificateWithKeyParams(keyAlgo, keySize)
|
|
privateKey, err := GeneratePrivateKeyForCertificate(cert)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return EncodePrivateKey(privateKey, cert.Spec.PrivateKey.Encoding)
|
|
}
|
|
|
|
func generatePKCS8PrivateKey(keyAlgo v1.PrivateKeyAlgorithm, keySize int) ([]byte, error) {
|
|
privateKey, err := GeneratePrivateKeyForCertificate(buildCertificateWithKeyParams(keyAlgo, keySize))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return EncodePKCS8PrivateKey(privateKey)
|
|
}
|
|
|
|
func TestDecodePrivateKeyBytes(t *testing.T) {
|
|
type testT struct {
|
|
name string
|
|
keyBytes []byte
|
|
keyAlgo v1.PrivateKeyAlgorithm
|
|
expectErr bool
|
|
expectErrStr string
|
|
}
|
|
|
|
rsaKeyBytes, err := generatePrivateKeyBytes(v1.RSAKeyAlgorithm, MinRSAKeySize)
|
|
if err != nil {
|
|
t.Errorf("error generating key bytes: %s", err)
|
|
return
|
|
}
|
|
|
|
pkcs8RsaKeyBytes, err := generatePKCS8PrivateKey(v1.RSAKeyAlgorithm, MinRSAKeySize)
|
|
if err != nil {
|
|
t.Errorf("error generating key bytes: %s", err)
|
|
return
|
|
}
|
|
|
|
ecdsaKeyBytes, err := generatePrivateKeyBytes(v1.ECDSAKeyAlgorithm, 256)
|
|
if err != nil {
|
|
t.Errorf("error generating key bytes: %s", err)
|
|
return
|
|
}
|
|
|
|
pkcs8EcdsaKeyBytes, err := generatePKCS8PrivateKey(v1.ECDSAKeyAlgorithm, 256)
|
|
if err != nil {
|
|
t.Errorf("error generating key bytes: %s", err)
|
|
return
|
|
}
|
|
|
|
block := &pem.Block{Type: "BLAH BLAH BLAH", Bytes: []byte("blahblahblah")}
|
|
blahKeyBytes := pem.EncodeToMemory(block)
|
|
|
|
privateKeyBlock := &pem.Block{Type: "PRIVATE KEY", Bytes: []byte("blahblahblah")}
|
|
blahPrivateKeyBytes := pem.EncodeToMemory(privateKeyBlock)
|
|
|
|
invalidKeyBytes := []byte("blah-blah-invalid")
|
|
|
|
tests := []testT{
|
|
{
|
|
name: "decode pem encoded rsa private key bytes",
|
|
keyBytes: rsaKeyBytes,
|
|
keyAlgo: v1.RSAKeyAlgorithm,
|
|
expectErr: false,
|
|
},
|
|
{
|
|
name: "decode pkcs#8 encoded rsa private key bytes",
|
|
keyBytes: pkcs8RsaKeyBytes,
|
|
keyAlgo: v1.RSAKeyAlgorithm,
|
|
expectErr: false,
|
|
},
|
|
{
|
|
name: "decode pem encoded ecdsa private key bytes",
|
|
keyBytes: ecdsaKeyBytes,
|
|
keyAlgo: v1.ECDSAKeyAlgorithm,
|
|
expectErr: false,
|
|
},
|
|
{
|
|
name: "decode pkcs#8 encoded ecdsa private key bytes",
|
|
keyBytes: pkcs8EcdsaKeyBytes,
|
|
keyAlgo: v1.ECDSAKeyAlgorithm,
|
|
expectErr: false,
|
|
},
|
|
{
|
|
name: "fail to decode unknown pem encoded key bytes",
|
|
keyBytes: blahKeyBytes,
|
|
expectErr: true,
|
|
expectErrStr: "unknown private key type",
|
|
},
|
|
{
|
|
name: "fail to decode unknown pkcs#8 encoded key bytes",
|
|
keyBytes: blahPrivateKeyBytes,
|
|
expectErr: true,
|
|
expectErrStr: "error parsing pkcs#8 private key: asn1: structure error:",
|
|
},
|
|
{
|
|
name: "fail to decode unknown not pem encoded key bytes",
|
|
keyBytes: invalidKeyBytes,
|
|
expectErr: true,
|
|
expectErrStr: "error decoding private key PEM block",
|
|
},
|
|
}
|
|
|
|
testFn := func(test testT) func(*testing.T) {
|
|
return func(t *testing.T) {
|
|
privateKey, err := DecodePrivateKeyBytes(test.keyBytes)
|
|
if test.expectErr {
|
|
if err == nil {
|
|
t.Error("expected err, but got no error")
|
|
return
|
|
}
|
|
|
|
if !strings.Contains(err.Error(), test.expectErrStr) {
|
|
t.Errorf("expected err string to match: '%s', got: '%s'", test.expectErrStr, err.Error())
|
|
return
|
|
}
|
|
}
|
|
|
|
if !test.expectErr {
|
|
if err != nil {
|
|
t.Errorf("expected no err, but got '%q'", err)
|
|
return
|
|
}
|
|
|
|
if test.keyAlgo == v1.RSAKeyAlgorithm {
|
|
_, ok := privateKey.(*rsa.PrivateKey)
|
|
if !ok {
|
|
t.Errorf("expected rsa private key, but got %T", privateKey)
|
|
return
|
|
}
|
|
}
|
|
|
|
if test.keyAlgo == v1.ECDSAKeyAlgorithm {
|
|
_, ok := privateKey.(*ecdsa.PrivateKey)
|
|
if !ok {
|
|
t.Errorf("expected ecdsa private key, but got %T", privateKey)
|
|
return
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
for _, test := range tests {
|
|
t.Run(test.name, testFn(test))
|
|
}
|
|
}
|
|
|
|
type testBundle struct {
|
|
cert *x509.Certificate
|
|
pem []byte
|
|
pk crypto.PrivateKey
|
|
}
|
|
|
|
func mustCreateBundle(t *testing.T, issuer *testBundle, name string) *testBundle {
|
|
pk, err := GenerateECPrivateKey(256)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
serialNumber, err := rand.Int(rand.Reader, serialNumberLimit)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
template := &x509.Certificate{
|
|
Version: 3,
|
|
BasicConstraintsValid: true,
|
|
SerialNumber: serialNumber,
|
|
PublicKeyAlgorithm: x509.ECDSA,
|
|
PublicKey: pk.Public(),
|
|
IsCA: true,
|
|
Subject: pkix.Name{
|
|
CommonName: name,
|
|
},
|
|
NotBefore: time.Now(),
|
|
NotAfter: time.Now().Add(time.Minute),
|
|
KeyUsage: x509.KeyUsageKeyEncipherment | x509.KeyUsageDigitalSignature | x509.KeyUsageCertSign,
|
|
}
|
|
|
|
var (
|
|
issuerKey crypto.PrivateKey
|
|
issuerCert *x509.Certificate
|
|
)
|
|
|
|
if issuer == nil {
|
|
// No issuer implies the cert should be self signed
|
|
issuerKey = pk
|
|
issuerCert = template
|
|
} else {
|
|
issuerKey = issuer.pk
|
|
issuerCert = issuer.cert
|
|
}
|
|
|
|
certPEM, cert, err := SignCertificate(template, issuerCert, pk.Public(), issuerKey)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
return &testBundle{pem: certPEM, cert: cert, pk: pk}
|
|
}
|
|
|
|
func joinPEM(first []byte, rest ...[]byte) []byte {
|
|
for _, b := range rest {
|
|
first = append(first, b...)
|
|
}
|
|
|
|
return first
|
|
}
|
|
|
|
func TestParseSingleCertificateChain(t *testing.T) {
|
|
root := mustCreateBundle(t, nil, "root")
|
|
intA1 := mustCreateBundle(t, root, "intA-1")
|
|
intA2 := mustCreateBundle(t, intA1, "intA-2")
|
|
intB1 := mustCreateBundle(t, root, "intB-1")
|
|
intB2 := mustCreateBundle(t, intB1, "intB-2")
|
|
leaf := mustCreateBundle(t, intA2, "leaf")
|
|
leafInterCN := mustCreateBundle(t, intA2, intA2.cert.Subject.CommonName)
|
|
random := mustCreateBundle(t, nil, "random")
|
|
|
|
tests := map[string]struct {
|
|
inputBundle []byte
|
|
expPEMBundle PEMBundle
|
|
expErr bool
|
|
}{
|
|
"if two certificate chain passed in order, should return single ca and certificate": {
|
|
inputBundle: joinPEM(intA1.pem, root.pem),
|
|
expPEMBundle: PEMBundle{ChainPEM: intA1.pem, CAPEM: root.pem},
|
|
expErr: false,
|
|
},
|
|
"if two certificate chain passed with leaf and intermediate, should return both certs in chain with intermediate as CA": {
|
|
inputBundle: joinPEM(leaf.pem, intA2.pem),
|
|
expPEMBundle: PEMBundle{ChainPEM: joinPEM(leaf.pem, intA2.pem), CAPEM: intA2.pem},
|
|
expErr: false,
|
|
},
|
|
"if two certificate chain passed out of order, should return single ca and certificate": {
|
|
inputBundle: joinPEM(root.pem, intA1.pem),
|
|
expPEMBundle: PEMBundle{ChainPEM: intA1.pem, CAPEM: root.pem},
|
|
expErr: false,
|
|
},
|
|
"if 3 certificate chain passed out of order, should return single ca and chain in order": {
|
|
inputBundle: joinPEM(root.pem, intA2.pem, intA1.pem),
|
|
expPEMBundle: PEMBundle{ChainPEM: joinPEM(intA2.pem, intA1.pem), CAPEM: root.pem},
|
|
expErr: false,
|
|
},
|
|
"empty entries should be ignored, and return ca and certificate": {
|
|
inputBundle: joinPEM(root.pem, intA2.pem, []byte("\n#foo\n \n"), intA1.pem),
|
|
expPEMBundle: PEMBundle{ChainPEM: joinPEM(intA2.pem, intA1.pem), CAPEM: root.pem},
|
|
expErr: false,
|
|
},
|
|
"if 4 certificate chain passed in order, should return single ca and chain in order": {
|
|
inputBundle: joinPEM(leaf.pem, intA1.pem, intA2.pem, root.pem),
|
|
expPEMBundle: PEMBundle{ChainPEM: joinPEM(leaf.pem, intA2.pem, intA1.pem), CAPEM: root.pem},
|
|
expErr: false,
|
|
},
|
|
"if certificate chain has two certs with the same CN, shouldn't affect output": {
|
|
// see https://github.com/cert-manager/cert-manager/issues/4142
|
|
inputBundle: joinPEM(leafInterCN.pem, intA1.pem, intA2.pem, root.pem),
|
|
expPEMBundle: PEMBundle{ChainPEM: joinPEM(leafInterCN.pem, intA2.pem, intA1.pem), CAPEM: root.pem},
|
|
expErr: false,
|
|
},
|
|
"if 4 certificate chain passed out of order, should return single ca and chain in order": {
|
|
inputBundle: joinPEM(root.pem, intA1.pem, leaf.pem, intA2.pem),
|
|
expPEMBundle: PEMBundle{ChainPEM: joinPEM(leaf.pem, intA2.pem, intA1.pem), CAPEM: root.pem},
|
|
expErr: false,
|
|
},
|
|
"if 3 certificate chain but has break in the chain, should return error": {
|
|
inputBundle: joinPEM(root.pem, intA1.pem, leaf.pem),
|
|
expPEMBundle: PEMBundle{},
|
|
expErr: true,
|
|
},
|
|
"if 4 certificate chain but also random certificate, should return error": {
|
|
inputBundle: joinPEM(root.pem, intA1.pem, leaf.pem, intA2.pem, random.pem),
|
|
expPEMBundle: PEMBundle{},
|
|
expErr: true,
|
|
},
|
|
"if 6 certificate chain but some are duplicates, duplicates should be removed and return single ca with chain": {
|
|
inputBundle: joinPEM(intA2.pem, intA1.pem, root.pem, leaf.pem, intA1.pem, root.pem),
|
|
expPEMBundle: PEMBundle{ChainPEM: joinPEM(leaf.pem, intA2.pem, intA1.pem), CAPEM: root.pem},
|
|
expErr: false,
|
|
},
|
|
"if 6 certificate chain in different configuration but some are duplicates, duplicates should be removed and return single ca with chain": {
|
|
inputBundle: joinPEM(root.pem, intA1.pem, intA2.pem, leaf.pem, root.pem, intA1.pem),
|
|
expPEMBundle: PEMBundle{ChainPEM: joinPEM(leaf.pem, intA2.pem, intA1.pem), CAPEM: root.pem},
|
|
expErr: false,
|
|
},
|
|
"if certificate chain contains branches, then should error": {
|
|
inputBundle: joinPEM(root.pem, intA1.pem, intA2.pem, intB1.pem, intB2.pem),
|
|
expPEMBundle: PEMBundle{},
|
|
expErr: true,
|
|
},
|
|
"if certificate chain does not have a root ca, should append all intermediates to ChainPEM and use the root-most cert as CAPEM": {
|
|
inputBundle: joinPEM(intA1.pem, intA2.pem, leaf.pem),
|
|
expPEMBundle: PEMBundle{ChainPEM: joinPEM(leaf.pem, intA2.pem, intA1.pem), CAPEM: intA1.pem},
|
|
expErr: false,
|
|
},
|
|
"if only a single leaf certificate was parsed, ChainPEM should contain a single leaf certificate and CAPEM should remain empty": {
|
|
inputBundle: joinPEM(leaf.pem),
|
|
expPEMBundle: PEMBundle{ChainPEM: joinPEM(leaf.pem), CAPEM: nil},
|
|
expErr: false,
|
|
},
|
|
"if only a single intermediate certificate was parsed, ChainPEM should contain a single intermediate certificate and CAPEM should remain empty": {
|
|
inputBundle: joinPEM(intA1.pem),
|
|
expPEMBundle: PEMBundle{ChainPEM: joinPEM(intA1.pem), CAPEM: nil},
|
|
expErr: false,
|
|
},
|
|
"if only a single root certificate was parsed, ChainPEM should contain a single root certificate and CAPEM should also contain that root": {
|
|
inputBundle: joinPEM(root.pem),
|
|
expPEMBundle: PEMBundle{ChainPEM: joinPEM(root.pem), CAPEM: root.pem},
|
|
expErr: false,
|
|
},
|
|
}
|
|
|
|
for name, test := range tests {
|
|
t.Run(name, func(t *testing.T) {
|
|
bundle, err := ParseSingleCertificateChainPEM(test.inputBundle)
|
|
if (err != nil) != test.expErr {
|
|
t.Errorf("unexpected error, exp=%t got=%v",
|
|
test.expErr, err)
|
|
}
|
|
|
|
if !reflect.DeepEqual(bundle, test.expPEMBundle) {
|
|
t.Errorf("unexpected pem bundle, exp=%+s got=%+s",
|
|
test.expPEMBundle, bundle)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestMustParseRDN(t *testing.T) {
|
|
subject := "SERIALNUMBER=42, L=some-locality, ST=some-state-or-province, STREET=some-street, CN=foo-long.com, OU=FooLong, OU=Barq, OU=Baz, OU=Dept., O=Corp., C=US"
|
|
rdnSeq, err := UnmarshalSubjectStringToRDNSequence(subject)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
expectedRdnSeq :=
|
|
pkix.RDNSequence{
|
|
[]pkix.AttributeTypeAndValue{
|
|
{Type: OIDConstants.Country, Value: "US"},
|
|
},
|
|
[]pkix.AttributeTypeAndValue{
|
|
{Type: OIDConstants.Organization, Value: "Corp."},
|
|
},
|
|
[]pkix.AttributeTypeAndValue{
|
|
{Type: OIDConstants.OrganizationalUnit, Value: "Dept."},
|
|
},
|
|
[]pkix.AttributeTypeAndValue{
|
|
{Type: OIDConstants.OrganizationalUnit, Value: "Baz"},
|
|
},
|
|
[]pkix.AttributeTypeAndValue{
|
|
{Type: OIDConstants.OrganizationalUnit, Value: "Barq"},
|
|
},
|
|
[]pkix.AttributeTypeAndValue{
|
|
{Type: OIDConstants.OrganizationalUnit, Value: "FooLong"},
|
|
},
|
|
[]pkix.AttributeTypeAndValue{
|
|
{Type: OIDConstants.CommonName, Value: "foo-long.com"},
|
|
},
|
|
[]pkix.AttributeTypeAndValue{
|
|
{Type: OIDConstants.StreetAddress, Value: "some-street"},
|
|
},
|
|
[]pkix.AttributeTypeAndValue{
|
|
{Type: OIDConstants.Province, Value: "some-state-or-province"},
|
|
},
|
|
[]pkix.AttributeTypeAndValue{
|
|
{Type: OIDConstants.Locality, Value: "some-locality"},
|
|
},
|
|
[]pkix.AttributeTypeAndValue{
|
|
{Type: OIDConstants.SerialNumber, Value: "42"},
|
|
},
|
|
}
|
|
|
|
assert.Equal(t, expectedRdnSeq, rdnSeq)
|
|
}
|
|
|
|
func TestMustKeepOrderInRawDerBytes(t *testing.T) {
|
|
subject := "CN=foo-long.com,OU=FooLong,OU=Barq,OU=Baz,OU=Dept.,O=Corp.,C=US"
|
|
bytes, err := ParseSubjectStringToRawDERBytes(subject)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
var rdnSeq pkix.RDNSequence
|
|
_, err2 := asn1.Unmarshal(bytes, &rdnSeq)
|
|
if err2 != nil {
|
|
t.Fatal(err2)
|
|
}
|
|
|
|
t.Log(bytes)
|
|
|
|
expectedRdnSeq :=
|
|
pkix.RDNSequence{
|
|
[]pkix.AttributeTypeAndValue{
|
|
{Type: OIDConstants.Country, Value: "US"},
|
|
},
|
|
[]pkix.AttributeTypeAndValue{
|
|
{Type: OIDConstants.Organization, Value: "Corp."},
|
|
},
|
|
[]pkix.AttributeTypeAndValue{
|
|
{Type: OIDConstants.OrganizationalUnit, Value: "Dept."},
|
|
},
|
|
[]pkix.AttributeTypeAndValue{
|
|
{Type: OIDConstants.OrganizationalUnit, Value: "Baz"},
|
|
},
|
|
[]pkix.AttributeTypeAndValue{
|
|
{Type: OIDConstants.OrganizationalUnit, Value: "Barq"},
|
|
},
|
|
[]pkix.AttributeTypeAndValue{
|
|
{Type: OIDConstants.OrganizationalUnit, Value: "FooLong"},
|
|
},
|
|
[]pkix.AttributeTypeAndValue{
|
|
{Type: OIDConstants.CommonName, Value: "foo-long.com"},
|
|
},
|
|
}
|
|
|
|
assert.Equal(t, expectedRdnSeq, rdnSeq)
|
|
assert.Equal(t, subject, rdnSeq.String())
|
|
}
|