pki

Documentation

Index

• Constants
• func CommonNameForCertificate(crt *v1alpha1.Certificate) string
• func DNSNamesForCertificate(crt *v1alpha1.Certificate) []string
• func DecodePKCS1PrivateKeyBytes(keyBytes []byte) (*rsa.PrivateKey, error)
• func DecodePrivateKeyBytes(keyBytes []byte) (crypto.Signer, error)
• func DecodeX509CertificateBytes(certBytes []byte) (*x509.Certificate, error)
• func DecodeX509CertificateChainBytes(certBytes []byte) ([]*x509.Certificate, error)
• func EncodeCSR(template *x509.CertificateRequest, key crypto.Signer) ([]byte, error)
• func EncodeECPrivateKey(pk *ecdsa.PrivateKey) ([]byte, error)
• func EncodePKCS1PrivateKey(pk *rsa.PrivateKey) []byte
• func EncodePrivateKey(pk crypto.PrivateKey) ([]byte, error)
• func EncodeX509(cert *x509.Certificate) ([]byte, error)
• func EncodeX509Chain(certs []*x509.Certificate) ([]byte, error)
• func GenerateCSR(issuer v1alpha1.GenericIssuer, crt *v1alpha1.Certificate) (*x509.CertificateRequest, error)
• func GenerateECPrivateKey(keySize int) (*ecdsa.PrivateKey, error)
• func GeneratePrivateKeyForCertificate(crt *v1alpha1.Certificate) (crypto.Signer, error)
• func GenerateRSAPrivateKey(keySize int) (*rsa.PrivateKey, error)
• func GenerateTemplate(issuer v1alpha1.GenericIssuer, crt *v1alpha1.Certificate) (*x509.Certificate, error)
• func OrganizationForCertificate(crt *v1alpha1.Certificate) []string
• func PublicKeyForPrivateKey(pk crypto.PrivateKey) (crypto.PublicKey, error)
• func PublicKeyMatchesCSR(check crypto.PublicKey, csr *x509.CertificateRequest) (bool, error)
• func PublicKeyMatchesCertificate(check crypto.PublicKey, crt *x509.Certificate) (bool, error)
• func SignCertificate(template *x509.Certificate, issuerCert *x509.Certificate, ...) ([]byte, *x509.Certificate, error)
• func SignatureAlgorithm(crt *v1alpha1.Certificate) (x509.PublicKeyAlgorithm, x509.SignatureAlgorithm, error)

Constants

const (
	// MinRSAKeySize is the minimum RSA keysize allowed to be generated by the
	// generator functions in this package.
	MinRSAKeySize = 2048

	// MaxRSAKeySize is the maximum RSA keysize allowed to be generated by the
	// generator functions in this package.
	MaxRSAKeySize = 8192

	// ECCurve256 represents a 256bit ECDSA key.
	ECCurve256 = 256
	// ECCurve384 represents a 384bit ECDSA key.
	ECCurve384 = 384
	// ECCurve521 represents a 521bit ECDSA key.
	ECCurve521 = 521
)

Functions

func CommonNameForCertificate

func CommonNameForCertificate(crt *v1alpha1.Certificate) string

CommonNameForCertificate returns the common name that should be used for the given Certificate resource, by inspecting the CommonName and DNSNames fields.

func DNSNamesForCertificate

func DNSNamesForCertificate(crt *v1alpha1.Certificate) []string

DNSNamesForCertificate returns the DNS names that should be used for the given Certificate resource, by inspecting the CommonName and DNSNames fields.

func DecodePKCS1PrivateKeyBytes

func DecodePKCS1PrivateKeyBytes(keyBytes []byte) (*rsa.PrivateKey, error)

DecodePKCS1PrivateKeyBytes will decode a PEM encoded RSA private key.

func DecodePrivateKeyBytes

func DecodePrivateKeyBytes(keyBytes []byte) (crypto.Signer, error)

DecodePrivateKeyBytes will decode a PEM encoded private key into a crypto.Signer. It supports ECDSA and RSA private keys only. All other types will return err.

func DecodeX509CertificateBytes

func DecodeX509CertificateBytes(certBytes []byte) (*x509.Certificate, error)

DecodeX509CertificateBytes will decode a PEM encoded x509 Certificate.

func DecodeX509CertificateChainBytes

func DecodeX509CertificateChainBytes(certBytes []byte) ([]*x509.Certificate, error)

DecodeX509CertificateChainBytes will decode a PEM encoded x509 Certificate chain.

func EncodeCSR

func EncodeCSR(template *x509.CertificateRequest, key crypto.Signer) ([]byte, error)

EncodeCSR calls x509.CreateCertificateRequest to sign the given CSR template. It returns a DER encoded signed CSR.

func EncodeECPrivateKey

func EncodeECPrivateKey(pk *ecdsa.PrivateKey) ([]byte, error)

EncodeECPrivateKey will marshal an ECDSA private key into x509 PEM format.

func EncodePKCS1PrivateKey

func EncodePKCS1PrivateKey(pk *rsa.PrivateKey) []byte

EncodePKCS1PrivateKey will marshal a RSA private key into x509 PEM format.

func EncodePrivateKey

func EncodePrivateKey(pk crypto.PrivateKey) ([]byte, error)

EncodePrivateKey will encode a given crypto.PrivateKey by first inspecting the type of key provided. It only supports encoding RSA or ECDSA keys.

func EncodeX509

func EncodeX509(cert *x509.Certificate) ([]byte, error)

EncodeX509 will encode a *x509.Certificate into PEM format.

func EncodeX509Chain

func EncodeX509Chain(certs []*x509.Certificate) ([]byte, error)

EncodeX509Chain will encode an *x509.Certificate chain into PEM format.

func GenerateCSR

func GenerateCSR(issuer v1alpha1.GenericIssuer, crt *v1alpha1.Certificate) (*x509.CertificateRequest, error)

GenerateCSR will generate a new *x509.CertificateRequest template to be used by issuers that utilise CSRs to obtain Certificates. The CSR will not be signed, and should be passed to either EncodeCSR or to the x509.CreateCertificateRequest function.

func GenerateECPrivateKey

func GenerateECPrivateKey(keySize int) (*ecdsa.PrivateKey, error)

GenerateECPrivateKey will generate an ECDSA private key of the given size. It can be used to generate 256, 384 and 521 sized keys.

func GeneratePrivateKeyForCertificate

func GeneratePrivateKeyForCertificate(crt *v1alpha1.Certificate) (crypto.Signer, error)

GeneratePrivateKeyForCertificate will generate a private key suitable for the provided cert-manager Certificate resource, taking into account the parameters on the provided resource. The returned key will either be RSA or ECDSA.

func GenerateRSAPrivateKey

func GenerateRSAPrivateKey(keySize int) (*rsa.PrivateKey, error)

GenerateRSAPrivateKey will generate a RSA private key of the given size. It places restrictions on the minimum and maximum RSA keysize.

func GenerateTemplate

func GenerateTemplate(issuer v1alpha1.GenericIssuer, crt *v1alpha1.Certificate) (*x509.Certificate, error)

GenerateTemplate will create a x509.Certificate for the given Certificate resource. This should create a Certificate template that is equivalent to the CertificateRequest generated by GenerateCSR. The PublicKey field must be populated by the caller.

func OrganizationForCertificate

func OrganizationForCertificate(crt *v1alpha1.Certificate) []string

OrganizationForCertificate will return the Organization to set for the Certificate resource. If an Organization is not specifically set, a default will be used.

func PublicKeyForPrivateKey

func PublicKeyForPrivateKey(pk crypto.PrivateKey) (crypto.PublicKey, error)

PublicKeyForPrivateKey will return the crypto.PublicKey for the given crypto.PrivateKey. It only supports RSA and ECDSA keys.

func PublicKeyMatchesCSR

func PublicKeyMatchesCSR(check crypto.PublicKey, csr *x509.CertificateRequest) (bool, error)

PublicKeyMatchesCSR can be used to verify the given public key is the correct counter-part to the given x509 CertificateRequest. It will return false and no error if the public key is *not* valid for the given CertificateRequest. It will return true if the public key *is* valid for the given CertificateRequest. It will return an error if either of the passed parameters are of an unrecognised type (i.e. non RSA/ECDSA)

func PublicKeyMatchesCertificate

func PublicKeyMatchesCertificate(check crypto.PublicKey, crt *x509.Certificate) (bool, error)

PublicKeyMatchesCertificate can be used to verify the given public key is the correct counter-part to the given x509 Certificate. It will return false and no error if the public key is *not* valid for the given Certificate. It will return true if the public key *is* valid for the given Certificate. It will return an error if either of the passed parameters are of an unrecognised type (i.e. non RSA/ECDSA)

func SignCertificate

func SignCertificate(template *x509.Certificate, issuerCert *x509.Certificate, publicKey crypto.PublicKey, signerKey interface{}) ([]byte, *x509.Certificate, error)

SignCertificate returns a signed x509.Certificate object for the given *v1alpha1.Certificate crt. publicKey is the public key of the signee, and signerKey is the private key of the signer. It returns a PEM encoded copy of the Certificate as well as a *x509.Certificate which can be used for reading the encoded values.

func SignatureAlgorithm

func SignatureAlgorithm(crt *v1alpha1.Certificate) (x509.PublicKeyAlgorithm, x509.SignatureAlgorithm, error)

SignatureAlgorithm will determine the appropriate signature algorithm for the given certificate. Adapted from https://github.com/cloudflare/cfssl/blob/master/csr/csr.go#L102