cert-manager/pkg/util/kube/pki.go

/*
Copyright 2019 The Jetstack cert-manager contributors.

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 kube

import (
	"context"
	"crypto"
	"crypto/x509"

	api "k8s.io/api/core/v1"
	corelisters "k8s.io/client-go/listers/core/v1"

	logf "github.com/jetstack/cert-manager/pkg/logs"
	"github.com/jetstack/cert-manager/pkg/util/errors"
	"github.com/jetstack/cert-manager/pkg/util/pki"
)

// SecretTLSKeyRef will decode a PKCS1/SEC1 (in effect, a RSA or ECDSA) private key stored in a
// secret with 'name' in 'namespace'. It will read the private key data from the secret
// entry with name 'keyName'.
func SecretTLSKeyRef(ctx context.Context, secretLister corelisters.SecretLister, namespace, name, keyName string) (crypto.Signer, error) {
	log := logf.FromContext(ctx)
	log = logf.WithRelatedResourceName(log, name, namespace, "Secret")

	secret, err := secretLister.Secrets(namespace).Get(name)
	if err != nil {
		log.Error(err, "failed to retrieve secret")
		return nil, err
	}
	log = logf.WithRelatedResource(log, secret)
	log.V(logf.DebugLevel).Info("got secret resource")

	log = log.WithValues("secret_key", keyName)
	keyBytes, ok := secret.Data[keyName]
	if !ok {
		log.Error(nil, "no data for key in secret")
		return nil, errors.NewInvalidData("no data for %q in secret '%s/%s'", keyName, namespace, name)
	}
	key, err := pki.DecodePrivateKeyBytes(keyBytes)
	if err != nil {
		log.Error(err, "error decoding private key")
		return key, errors.NewInvalidData(err.Error())
	}

	return key, nil
}

// SecretTLSKey will decode a PKCS1/SEC1 (in effect, a RSA or ECDSA) private key stored in a
// secret with 'name' in 'namespace'. It will read the private key data from the secret
// entry with name 'keyName'.
func SecretTLSKey(ctx context.Context, secretLister corelisters.SecretLister, namespace, name string) (crypto.Signer, error) {
	return SecretTLSKeyRef(ctx, secretLister, namespace, name, api.TLSPrivateKeyKey)
}

func SecretTLSCertChain(ctx context.Context, secretLister corelisters.SecretLister, namespace, name string) ([]*x509.Certificate, error) {
	log := logf.FromContext(ctx)
	log = logf.WithRelatedResourceName(log, name, namespace, "Secret")

	secret, err := secretLister.Secrets(namespace).Get(name)
	if err != nil {
		log.Error(err, "failed to retrieve secret")
		return nil, err
	}
	log = logf.WithRelatedResource(log, secret)
	log.V(logf.DebugLevel).Info("got secret resource")

	log = log.WithValues("secret_key", api.TLSCertKey)
	certBytes, ok := secret.Data[api.TLSCertKey]
	if !ok {
		log.Error(nil, "no data for key in secret")
		return nil, errors.NewInvalidData("no data for %q in secret '%s/%s'", api.TLSCertKey, namespace, name)
	}

	log.V(logf.DebugLevel).Info("attempting to decode certificate chain")
	cert, err := pki.DecodeX509CertificateChainBytes(certBytes)
	if err != nil {
		log.Error(err, "error decoding x509 certificate")
		return cert, errors.NewInvalidData(err.Error())
	}

	return cert, nil
}

func SecretTLSKeyPair(ctx context.Context, secretLister corelisters.SecretLister, namespace, name string) ([]*x509.Certificate, crypto.Signer, error) {
	log := logf.FromContext(ctx)
	log = logf.WithRelatedResourceName(log, name, namespace, "Secret")

	secret, err := secretLister.Secrets(namespace).Get(name)
	if err != nil {
		return nil, nil, err
	}
	log = logf.WithRelatedResource(log, secret)

	log = log.WithValues("secret_key", api.TLSPrivateKeyKey)
	keyBytes, ok := secret.Data[api.TLSPrivateKeyKey]
	if !ok {
		log.Error(nil, "no data for key in secret")
		return nil, nil, errors.NewInvalidData("no private key data for %q in secret '%s/%s'", api.TLSPrivateKeyKey, namespace, name)
	}
	key, err := pki.DecodePrivateKeyBytes(keyBytes)
	if err != nil {
		log.Error(err, "error decoding private key")
		return nil, nil, errors.NewInvalidData(err.Error())
	}

	log = log.WithValues("secret_key", api.TLSCertKey)
	certBytes, ok := secret.Data[api.TLSCertKey]
	if !ok {
		log.Error(nil, "no data for key in secret")
		return nil, key, errors.NewInvalidData("no certificate data for %q in secret '%s/%s'", api.TLSCertKey, namespace, name)
	}
	cert, err := pki.DecodeX509CertificateChainBytes(certBytes)
	if err != nil {
		log.Error(err, "error decoding x509 certificate")
		return nil, key, errors.NewInvalidData(err.Error())
	}

	return cert, key, nil
}

func SecretTLSCert(ctx context.Context, secretLister corelisters.SecretLister, namespace, name string) (*x509.Certificate, error) {
	certs, err := SecretTLSCertChain(ctx, secretLister, namespace, name)
	if err != nil {
		return nil, err
	}

	return certs[0], nil
}