2021-10-29 01:04:11 +00:00
|
|
|
//go:build cgo
|
2021-01-27 04:15:57 +00:00
|
|
|
// +build cgo
|
|
|
|
|
|
|
|
package pkcs11
|
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
"crypto"
|
|
|
|
"crypto/elliptic"
|
|
|
|
"crypto/x509"
|
|
|
|
"encoding/hex"
|
|
|
|
"fmt"
|
|
|
|
"math/big"
|
2021-01-29 03:48:08 +00:00
|
|
|
"strconv"
|
2021-02-09 03:16:57 +00:00
|
|
|
"sync"
|
2021-01-27 04:15:57 +00:00
|
|
|
|
|
|
|
"github.com/ThalesIgnite/crypto11"
|
|
|
|
"github.com/pkg/errors"
|
|
|
|
"github.com/smallstep/certificates/kms/apiv1"
|
|
|
|
"github.com/smallstep/certificates/kms/uri"
|
|
|
|
)
|
|
|
|
|
2021-01-29 03:48:08 +00:00
|
|
|
// Scheme is the scheme used in uris.
|
|
|
|
const Scheme = "pkcs11"
|
|
|
|
|
2021-02-12 03:14:15 +00:00
|
|
|
// DefaultRSASize is the number of bits of a new RSA key if no size has been
|
2021-01-27 04:15:57 +00:00
|
|
|
// specified.
|
|
|
|
const DefaultRSASize = 3072
|
|
|
|
|
2021-01-28 04:17:14 +00:00
|
|
|
// P11 defines the methods on crypto11.Context that this package will use. This
|
|
|
|
// interface will be used for unit testing.
|
|
|
|
type P11 interface {
|
|
|
|
FindKeyPair(id, label []byte) (crypto11.Signer, error)
|
|
|
|
FindCertificate(id, label []byte, serial *big.Int) (*x509.Certificate, error)
|
2021-10-29 19:02:24 +00:00
|
|
|
ImportCertificateWithLabel(id, label []byte, certificate *x509.Certificate) error
|
2021-01-28 04:17:14 +00:00
|
|
|
DeleteCertificate(id, label []byte, serial *big.Int) error
|
2021-10-29 01:04:11 +00:00
|
|
|
GenerateRSAKeyPairWithAttributes(public, private crypto11.AttributeSet, bits int) (crypto11.SignerDecrypter, error)
|
2021-06-17 13:06:35 +00:00
|
|
|
GenerateECDSAKeyPairWithAttributes(public, private crypto11.AttributeSet, curve elliptic.Curve) (crypto11.Signer, error)
|
2021-01-28 04:17:14 +00:00
|
|
|
Close() error
|
|
|
|
}
|
|
|
|
|
|
|
|
var p11Configure = func(config *crypto11.Config) (P11, error) {
|
|
|
|
return crypto11.Configure(config)
|
|
|
|
}
|
|
|
|
|
2021-01-27 04:15:57 +00:00
|
|
|
// PKCS11 is the implementation of a KMS using the PKCS #11 standard.
|
|
|
|
type PKCS11 struct {
|
2021-02-09 03:16:57 +00:00
|
|
|
p11 P11
|
|
|
|
closed sync.Once
|
2021-01-27 04:15:57 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// New returns a new PKCS11 KMS.
|
|
|
|
func New(ctx context.Context, opts apiv1.Options) (*PKCS11, error) {
|
|
|
|
var config crypto11.Config
|
|
|
|
if opts.URI != "" {
|
2021-01-29 03:48:08 +00:00
|
|
|
u, err := uri.ParseWithScheme(Scheme, opts.URI)
|
2021-01-27 04:15:57 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2021-01-29 03:48:08 +00:00
|
|
|
|
|
|
|
config.Pin = u.Pin()
|
2021-01-27 04:15:57 +00:00
|
|
|
config.Path = u.Get("module-path")
|
|
|
|
config.TokenLabel = u.Get("token")
|
|
|
|
config.TokenSerial = u.Get("serial")
|
2021-01-29 03:48:08 +00:00
|
|
|
if v := u.Get("slot-id"); v != "" {
|
|
|
|
n, err := strconv.Atoi(v)
|
|
|
|
if err != nil {
|
|
|
|
return nil, errors.Wrap(err, "kms uri 'slot-id' is not valid")
|
|
|
|
}
|
|
|
|
config.SlotNumber = &n
|
|
|
|
}
|
2021-01-27 04:15:57 +00:00
|
|
|
}
|
|
|
|
if config.Pin == "" && opts.Pin != "" {
|
|
|
|
config.Pin = opts.Pin
|
|
|
|
}
|
|
|
|
|
|
|
|
switch {
|
|
|
|
case config.Path == "":
|
|
|
|
return nil, errors.New("kms uri 'module-path' are required")
|
2021-01-29 03:48:08 +00:00
|
|
|
case config.TokenLabel == "" && config.TokenSerial == "" && config.SlotNumber == nil:
|
|
|
|
return nil, errors.New("kms uri 'token', 'serial' or 'slot-id' are required")
|
2021-01-27 04:15:57 +00:00
|
|
|
case config.Pin == "":
|
|
|
|
return nil, errors.New("kms 'pin' cannot be empty")
|
|
|
|
case config.TokenLabel != "" && config.TokenSerial != "":
|
2021-01-29 03:48:08 +00:00
|
|
|
return nil, errors.New("kms uri 'token' and 'serial' are mutually exclusive")
|
|
|
|
case config.TokenLabel != "" && config.SlotNumber != nil:
|
|
|
|
return nil, errors.New("kms uri 'token' and 'slot-id' are mutually exclusive")
|
|
|
|
case config.TokenSerial != "" && config.SlotNumber != nil:
|
|
|
|
return nil, errors.New("kms uri 'serial' and 'slot-id' are mutually exclusive")
|
2021-01-27 04:15:57 +00:00
|
|
|
}
|
|
|
|
|
2021-01-28 04:17:14 +00:00
|
|
|
p11, err := p11Configure(&config)
|
2021-01-27 04:15:57 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, errors.Wrap(err, "error initializing PKCS#11")
|
|
|
|
}
|
|
|
|
|
|
|
|
return &PKCS11{
|
2021-01-28 04:17:14 +00:00
|
|
|
p11: p11,
|
2021-01-27 04:15:57 +00:00
|
|
|
}, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func init() {
|
|
|
|
apiv1.Register(apiv1.PKCS11, func(ctx context.Context, opts apiv1.Options) (apiv1.KeyManager, error) {
|
|
|
|
return New(ctx, opts)
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetPublicKey returns the public key ....
|
|
|
|
func (k *PKCS11) GetPublicKey(req *apiv1.GetPublicKeyRequest) (crypto.PublicKey, error) {
|
|
|
|
if req.Name == "" {
|
|
|
|
return nil, errors.New("getPublicKeyRequest 'name' cannot be empty")
|
|
|
|
}
|
|
|
|
|
2021-01-28 04:17:14 +00:00
|
|
|
signer, err := findSigner(k.p11, req.Name)
|
2021-01-27 04:15:57 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, errors.Wrap(err, "getPublicKey failed")
|
|
|
|
}
|
|
|
|
|
|
|
|
return signer.Public(), nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// CreateKey generates a new key in the PKCS#11 module and returns the public key.
|
|
|
|
func (k *PKCS11) CreateKey(req *apiv1.CreateKeyRequest) (*apiv1.CreateKeyResponse, error) {
|
|
|
|
switch {
|
|
|
|
case req.Name == "":
|
|
|
|
return nil, errors.New("createKeyRequest 'name' cannot be empty")
|
|
|
|
case req.Bits < 0:
|
|
|
|
return nil, errors.New("createKeyRequest 'bits' cannot be negative")
|
|
|
|
}
|
|
|
|
|
2021-01-28 04:17:14 +00:00
|
|
|
signer, err := generateKey(k.p11, req)
|
2021-01-27 04:15:57 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, errors.Wrap(err, "createKey failed")
|
|
|
|
}
|
|
|
|
|
|
|
|
return &apiv1.CreateKeyResponse{
|
|
|
|
Name: req.Name,
|
|
|
|
PublicKey: signer.Public(),
|
|
|
|
CreateSignerRequest: apiv1.CreateSignerRequest{
|
|
|
|
SigningKey: req.Name,
|
|
|
|
},
|
|
|
|
}, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// CreateSigner creates a signer using the key present in the PKCS#11 MODULE signature
|
|
|
|
// slot.
|
|
|
|
func (k *PKCS11) CreateSigner(req *apiv1.CreateSignerRequest) (crypto.Signer, error) {
|
2021-10-08 19:26:01 +00:00
|
|
|
if req.SigningKey == "" {
|
2021-01-27 04:15:57 +00:00
|
|
|
return nil, errors.New("createSignerRequest 'signingKey' cannot be empty")
|
|
|
|
}
|
|
|
|
|
2021-01-28 04:17:14 +00:00
|
|
|
signer, err := findSigner(k.p11, req.SigningKey)
|
2021-01-27 04:15:57 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, errors.Wrap(err, "createSigner failed")
|
|
|
|
}
|
|
|
|
|
|
|
|
return signer, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// LoadCertificate implements kms.CertificateManager and loads a certificate
|
|
|
|
// from the YubiKey.
|
|
|
|
func (k *PKCS11) LoadCertificate(req *apiv1.LoadCertificateRequest) (*x509.Certificate, error) {
|
|
|
|
if req.Name == "" {
|
|
|
|
return nil, errors.New("loadCertificateRequest 'name' cannot be nil")
|
|
|
|
}
|
2021-01-28 04:17:14 +00:00
|
|
|
cert, err := findCertificate(k.p11, req.Name)
|
2021-01-27 04:15:57 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, errors.Wrap(err, "loadCertificate failed")
|
|
|
|
}
|
|
|
|
return cert, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// StoreCertificate implements kms.CertificateManager and stores a certificate
|
|
|
|
// in the YubiKey.
|
|
|
|
func (k *PKCS11) StoreCertificate(req *apiv1.StoreCertificateRequest) error {
|
|
|
|
switch {
|
|
|
|
case req.Name == "":
|
|
|
|
return errors.New("storeCertificateRequest 'name' cannot be empty")
|
|
|
|
case req.Certificate == nil:
|
|
|
|
return errors.New("storeCertificateRequest 'Certificate' cannot be nil")
|
|
|
|
}
|
|
|
|
|
|
|
|
id, object, err := parseObject(req.Name)
|
|
|
|
if err != nil {
|
|
|
|
return errors.Wrap(err, "storeCertificate failed")
|
|
|
|
}
|
|
|
|
|
2021-10-29 01:04:11 +00:00
|
|
|
// Enforce the use of both id and labels. This is not strictly necessary in
|
|
|
|
// PKCS #11, but it's a good practice.
|
|
|
|
if len(id) == 0 || len(object) == 0 {
|
|
|
|
return errors.Errorf("key with uri %s is not valid, id and object are required", req.Name)
|
|
|
|
}
|
|
|
|
|
2021-01-29 03:48:08 +00:00
|
|
|
cert, err := k.p11.FindCertificate(id, object, nil)
|
|
|
|
if err != nil {
|
|
|
|
return errors.Wrap(err, "storeCertificate failed")
|
|
|
|
}
|
|
|
|
if cert != nil {
|
|
|
|
return errors.Wrap(apiv1.ErrAlreadyExists{
|
|
|
|
Message: req.Name + " already exists",
|
|
|
|
}, "storeCertificate failed")
|
|
|
|
}
|
|
|
|
|
2021-10-29 19:02:24 +00:00
|
|
|
if err := k.p11.ImportCertificateWithLabel(id, object, req.Certificate); err != nil {
|
2021-10-29 01:04:11 +00:00
|
|
|
return errors.Wrap(err, "storeCertificate failed")
|
2021-06-17 13:23:22 +00:00
|
|
|
}
|
|
|
|
|
2021-10-29 01:04:11 +00:00
|
|
|
return nil
|
2021-06-17 13:23:22 +00:00
|
|
|
}
|
|
|
|
|
2021-01-27 04:15:57 +00:00
|
|
|
// DeleteKey is a utility function to delete a key given an uri.
|
2021-10-08 19:26:01 +00:00
|
|
|
func (k *PKCS11) DeleteKey(u string) error {
|
|
|
|
id, object, err := parseObject(u)
|
2021-01-27 04:15:57 +00:00
|
|
|
if err != nil {
|
|
|
|
return errors.Wrap(err, "deleteKey failed")
|
|
|
|
}
|
2021-01-28 04:17:14 +00:00
|
|
|
signer, err := k.p11.FindKeyPair(id, object)
|
2021-01-27 04:15:57 +00:00
|
|
|
if err != nil {
|
|
|
|
return errors.Wrap(err, "deleteKey failed")
|
|
|
|
}
|
|
|
|
if signer == nil {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
if err := signer.Delete(); err != nil {
|
|
|
|
return errors.Wrap(err, "deleteKey failed")
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// DeleteCertificate is a utility function to delete a certificate given an uri.
|
2021-10-08 19:26:01 +00:00
|
|
|
func (k *PKCS11) DeleteCertificate(u string) error {
|
|
|
|
id, object, err := parseObject(u)
|
2021-01-27 04:15:57 +00:00
|
|
|
if err != nil {
|
|
|
|
return errors.Wrap(err, "deleteCertificate failed")
|
|
|
|
}
|
2021-01-28 04:17:14 +00:00
|
|
|
if err := k.p11.DeleteCertificate(id, object, nil); err != nil {
|
2021-01-27 04:15:57 +00:00
|
|
|
return errors.Wrap(err, "deleteCertificate failed")
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// Close releases the connection to the PKCS#11 module.
|
2021-02-09 03:16:57 +00:00
|
|
|
func (k *PKCS11) Close() (err error) {
|
|
|
|
k.closed.Do(func() {
|
|
|
|
err = errors.Wrap(k.p11.Close(), "error closing pkcs#11 context")
|
|
|
|
})
|
|
|
|
return
|
2021-01-27 04:15:57 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func toByte(s string) []byte {
|
|
|
|
if s == "" {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
return []byte(s)
|
|
|
|
}
|
|
|
|
|
2021-01-28 04:17:14 +00:00
|
|
|
func parseObject(rawuri string) ([]byte, []byte, error) {
|
2021-01-29 03:48:08 +00:00
|
|
|
u, err := uri.ParseWithScheme(Scheme, rawuri)
|
2021-01-28 04:17:14 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, nil, err
|
|
|
|
}
|
2021-02-01 22:17:39 +00:00
|
|
|
id := u.GetEncoded("id")
|
2021-01-28 04:17:14 +00:00
|
|
|
object := u.Get("object")
|
|
|
|
if len(id) == 0 && object == "" {
|
|
|
|
return nil, nil, errors.Errorf("key with uri %s is not valid, id or object are required", rawuri)
|
|
|
|
}
|
|
|
|
|
|
|
|
return id, toByte(object), nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func generateKey(ctx P11, req *apiv1.CreateKeyRequest) (crypto11.Signer, error) {
|
2021-01-27 04:15:57 +00:00
|
|
|
id, object, err := parseObject(req.Name)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2021-02-04 20:53:08 +00:00
|
|
|
|
2021-01-27 04:15:57 +00:00
|
|
|
signer, err := ctx.FindKeyPair(id, object)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
if signer != nil {
|
2021-01-28 04:17:14 +00:00
|
|
|
return nil, apiv1.ErrAlreadyExists{
|
|
|
|
Message: req.Name + " already exists",
|
|
|
|
}
|
2021-01-27 04:15:57 +00:00
|
|
|
}
|
|
|
|
|
2021-02-04 20:53:08 +00:00
|
|
|
// Enforce the use of both id and labels. This is not strictly necessary in
|
|
|
|
// PKCS #11, but it's a good practice.
|
|
|
|
if len(id) == 0 || len(object) == 0 {
|
|
|
|
return nil, errors.Errorf("key with uri %s is not valid, id and object are required", req.Name)
|
|
|
|
}
|
|
|
|
|
2021-10-29 01:04:11 +00:00
|
|
|
// Create template for public and private keys
|
|
|
|
public, err := crypto11.NewAttributeSetWithIDAndLabel(id, object)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
private := public.Copy()
|
|
|
|
if req.Extractable {
|
2021-10-29 01:11:42 +00:00
|
|
|
private.Set(crypto11.CkaExtractable, true)
|
2021-10-29 01:04:11 +00:00
|
|
|
}
|
|
|
|
|
2021-01-27 04:15:57 +00:00
|
|
|
bits := req.Bits
|
|
|
|
if bits == 0 {
|
|
|
|
bits = DefaultRSASize
|
|
|
|
}
|
|
|
|
|
|
|
|
switch req.SignatureAlgorithm {
|
|
|
|
case apiv1.UnspecifiedSignAlgorithm:
|
2021-10-29 01:04:11 +00:00
|
|
|
return ctx.GenerateECDSAKeyPairWithAttributes(public, private, elliptic.P256())
|
2021-01-27 04:15:57 +00:00
|
|
|
case apiv1.SHA256WithRSA, apiv1.SHA384WithRSA, apiv1.SHA512WithRSA:
|
2021-10-29 01:04:11 +00:00
|
|
|
return ctx.GenerateRSAKeyPairWithAttributes(public, private, bits)
|
2021-01-27 04:15:57 +00:00
|
|
|
case apiv1.SHA256WithRSAPSS, apiv1.SHA384WithRSAPSS, apiv1.SHA512WithRSAPSS:
|
2021-10-29 01:04:11 +00:00
|
|
|
return ctx.GenerateRSAKeyPairWithAttributes(public, private, bits)
|
2021-01-27 04:15:57 +00:00
|
|
|
case apiv1.ECDSAWithSHA256:
|
2021-10-29 01:04:11 +00:00
|
|
|
return ctx.GenerateECDSAKeyPairWithAttributes(public, private, elliptic.P256())
|
2021-01-27 04:15:57 +00:00
|
|
|
case apiv1.ECDSAWithSHA384:
|
2021-10-29 01:04:11 +00:00
|
|
|
return ctx.GenerateECDSAKeyPairWithAttributes(public, private, elliptic.P384())
|
2021-01-27 04:15:57 +00:00
|
|
|
case apiv1.ECDSAWithSHA512:
|
2021-10-29 01:04:11 +00:00
|
|
|
return ctx.GenerateECDSAKeyPairWithAttributes(public, private, elliptic.P521())
|
2021-01-27 04:15:57 +00:00
|
|
|
case apiv1.PureEd25519:
|
|
|
|
return nil, fmt.Errorf("signature algorithm %s is not supported", req.SignatureAlgorithm)
|
|
|
|
default:
|
|
|
|
return nil, fmt.Errorf("signature algorithm %s is not supported", req.SignatureAlgorithm)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-01-28 04:17:14 +00:00
|
|
|
func findSigner(ctx P11, rawuri string) (crypto11.Signer, error) {
|
2021-01-27 04:15:57 +00:00
|
|
|
id, object, err := parseObject(rawuri)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
signer, err := ctx.FindKeyPair(id, object)
|
|
|
|
if err != nil {
|
|
|
|
return nil, errors.Wrapf(err, "error finding key with uri %s", rawuri)
|
|
|
|
}
|
|
|
|
if signer == nil {
|
|
|
|
return nil, errors.Errorf("key with uri %s not found", rawuri)
|
|
|
|
}
|
|
|
|
return signer, nil
|
|
|
|
}
|
|
|
|
|
2021-01-28 04:17:14 +00:00
|
|
|
func findCertificate(ctx P11, rawuri string) (*x509.Certificate, error) {
|
2021-01-29 03:48:08 +00:00
|
|
|
u, err := uri.ParseWithScheme(Scheme, rawuri)
|
2021-01-27 04:15:57 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2021-02-01 22:17:39 +00:00
|
|
|
id, object, serial := u.GetEncoded("id"), u.Get("object"), u.Get("serial")
|
2021-01-27 04:15:57 +00:00
|
|
|
if len(id) == 0 && object == "" && serial == "" {
|
|
|
|
return nil, errors.Errorf("key with uri %s is not valid, id, object or serial are required", rawuri)
|
|
|
|
}
|
|
|
|
|
|
|
|
var serialNumber *big.Int
|
|
|
|
if serial != "" {
|
|
|
|
b, err := hex.DecodeString(serial)
|
|
|
|
if err != nil {
|
|
|
|
return nil, errors.Errorf("key with uri %s is not valid, failed to decode serial", rawuri)
|
|
|
|
}
|
|
|
|
serialNumber = new(big.Int).SetBytes(b)
|
|
|
|
}
|
|
|
|
|
|
|
|
cert, err := ctx.FindCertificate(id, toByte(object), serialNumber)
|
|
|
|
if err != nil {
|
|
|
|
return nil, errors.Wrapf(err, "error finding certificate with uri %s", rawuri)
|
|
|
|
}
|
|
|
|
if cert == nil {
|
|
|
|
return nil, errors.Errorf("certificate with uri %s not found", rawuri)
|
|
|
|
}
|
2021-01-29 03:53:25 +00:00
|
|
|
return cert, nil
|
2021-01-27 04:15:57 +00:00
|
|
|
}
|