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 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
|
package x509util
import (
"crypto"
"crypto/rand"
"crypto/rsa"
"crypto/sha1"
"crypto/x509"
"crypto/x509/pkix"
"encoding/asn1"
"encoding/pem"
"math/big"
"net"
"net/url"
"strings"
"time"
"github.com/pkg/errors"
"github.com/smallstep/cli/crypto/keys"
"github.com/smallstep/cli/crypto/pemutil"
"github.com/smallstep/cli/utils"
)
// Cribbed directly from golang src crypto/x509/x509.go
var (
oidExtSubjectKeyID = asn1.ObjectIdentifier([]int{2, 5, 29, 14})
oidExtKeyUsage = asn1.ObjectIdentifier([]int{2, 5, 29, 15})
oidExtExtendedKeyUsage = asn1.ObjectIdentifier([]int{2, 5, 29, 37})
oidExtAuthorityKeyID = asn1.ObjectIdentifier([]int{2, 5, 29, 35})
oidExtBasicConstraints = asn1.ObjectIdentifier([]int{2, 5, 29, 19})
oidExtSubjectAltName = asn1.ObjectIdentifier([]int{2, 5, 29, 17})
oidExtCertificatePolicies = asn1.ObjectIdentifier([]int{2, 5, 29, 32})
oidExtNameConstraints = asn1.ObjectIdentifier([]int{2, 5, 29, 30})
oidExtCRLDistributionPoints = asn1.ObjectIdentifier([]int{2, 5, 29, 31})
oidExtAuthorityInfoAccess = asn1.ObjectIdentifier([]int{1, 3, 6, 1, 5, 5, 7, 1, 1})
oidStdExtHashMap = map[string]struct{}{}
emptyStruct struct{}
)
func init() {
oidStdExtHashMap[oidExtSubjectKeyID.String()] = emptyStruct
oidStdExtHashMap[oidExtKeyUsage.String()] = emptyStruct
oidStdExtHashMap[oidExtExtendedKeyUsage.String()] = emptyStruct
oidStdExtHashMap[oidExtAuthorityKeyID.String()] = emptyStruct
oidStdExtHashMap[oidExtBasicConstraints.String()] = emptyStruct
oidStdExtHashMap[oidExtSubjectAltName.String()] = emptyStruct
oidStdExtHashMap[oidExtCertificatePolicies.String()] = emptyStruct
oidStdExtHashMap[oidExtNameConstraints.String()] = emptyStruct
oidStdExtHashMap[oidExtCRLDistributionPoints.String()] = emptyStruct
oidStdExtHashMap[oidExtAuthorityInfoAccess.String()] = emptyStruct
}
var (
// DefaultCertValidity is the minimum validity of an end-entity (not root or intermediate) certificate.
DefaultCertValidity = 24 * time.Hour
// DefaultTLSMinVersion default minimum version of TLS.
DefaultTLSMinVersion = TLSVersion(1.2)
// DefaultTLSMaxVersion default maximum version of TLS.
DefaultTLSMaxVersion = TLSVersion(1.2)
// DefaultTLSRenegotiation default TLS connection renegotiation policy.
DefaultTLSRenegotiation = false // Never regnegotiate.
// DefaultTLSCipherSuites specifies default step ciphersuite(s).
DefaultTLSCipherSuites = CipherSuites{
"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305",
"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256",
}
// ApprovedTLSCipherSuites smallstep approved ciphersuites.
ApprovedTLSCipherSuites = CipherSuites{
"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA",
"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256",
"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256",
"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA",
"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384",
"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305",
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA",
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256",
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA",
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305",
}
// oidExtensionCTPoison is the OID for the certificate transparency poison
// extension defined in RFC6962.
oidExtensionCTPoison = asn1.ObjectIdentifier{1, 3, 6, 1, 4, 1, 11129, 2, 4, 3}
)
// Profile is an interface that certificate profiles (e.g. leaf,
// intermediate, root) must implement.
type Profile interface {
Issuer() *x509.Certificate
Subject() *x509.Certificate
SubjectPrivateKey() interface{}
SubjectPublicKey() interface{}
SetIssuer(*x509.Certificate)
SetSubject(*x509.Certificate)
SetSubjectPrivateKey(interface{})
SetSubjectPublicKey(interface{})
SetIssuerPrivateKey(interface{})
CreateCertificate() ([]byte, error)
GenerateKeyPair(string, string, int) error
DefaultDuration() time.Duration
CreateWriteCertificate(crtOut, keyOut, pass string) ([]byte, error)
AddExtension(pkix.Extension)
RemoveExtension(asn1.ObjectIdentifier)
}
type base struct {
iss *x509.Certificate
sub *x509.Certificate
ext []pkix.Extension
subPub interface{}
subPriv interface{}
issPriv interface{}
}
// WithOption is a modifier function on base.
type WithOption func(Profile) error
// GenerateKeyPair returns a Profile modifier that generates a public/private
// key pair for a profile.
func GenerateKeyPair(kty, crv string, size int) WithOption {
return func(p Profile) error {
return p.GenerateKeyPair(kty, crv, size)
}
}
// GenerateDefaultKeyPair generates a new public/private key pair using the
// default values and sets them in the given profile.
func GenerateDefaultKeyPair(p Profile) error {
pub, priv, err := keys.GenerateDefaultKeyPair()
if err != nil {
return err
}
p.SetSubjectPublicKey(pub)
p.SetSubjectPrivateKey(priv)
return nil
}
// WithPublicKey returns a Profile modifier that sets the public key for a profile.
func WithPublicKey(pub interface{}) WithOption {
return func(p Profile) error {
p.SetSubjectPublicKey(pub)
return nil
}
}
// WithSubject returns a Profile modifier that sets the Subject for a x509
// Certificate.
func WithSubject(sub pkix.Name) WithOption {
return func(p Profile) error {
crt := p.Subject()
crt.Subject = sub
return nil
}
}
// WithIssuer returns a Profile modifier that sets the Subject for a x509
// Certificate.
func WithIssuer(iss pkix.Name) WithOption {
return func(p Profile) error {
crt := p.Subject()
crt.Issuer = iss
return nil
}
}
// WithNotBeforeAfterDuration returns a Profile modifier that sets the
// `NotBefore` and `NotAfter` attributes of the subject x509 Certificate.
func WithNotBeforeAfterDuration(nb, na time.Time, d time.Duration) WithOption {
return func(p Profile) error {
crt := p.Subject()
now := time.Now()
if nb.IsZero() {
nb = now
}
if na.IsZero() {
if d == 0 {
na = nb.Add(p.DefaultDuration())
} else {
na = nb.Add(d)
}
}
crt.NotBefore = nb
crt.NotAfter = na
return nil
}
}
func appendIfMissingString(slice []string, s string) []string {
for _, e := range slice {
if e == s {
return slice
}
}
return append(slice, s)
}
func appendIfMissingIP(ips []net.IP, ip net.IP) []net.IP {
for _, e := range ips {
if ip.Equal(e) {
return ips
}
}
return append(ips, ip)
}
// WithDNSNames returns a Profile modifier which sets the DNS Names
// that will be bound to the subject alternative name extension of the Certificate.
func WithDNSNames(dns []string) WithOption {
return func(p Profile) error {
crt := p.Subject()
crt.DNSNames = dns
return nil
}
}
// WithIPAddresses returns a Profile modifier which sets the IP Addresses
// that will be bound to the subject alternative name extension of the Certificate.
func WithIPAddresses(ips []net.IP) WithOption {
return func(p Profile) error {
crt := p.Subject()
crt.IPAddresses = ips
return nil
}
}
// WithEmailAddresses returns a Profile modifier which sets the Email Addresses
// that will be bound to the subject alternative name extension of the Certificate.
func WithEmailAddresses(emails []string) WithOption {
return func(p Profile) error {
crt := p.Subject()
crt.EmailAddresses = emails
return nil
}
}
// WithURIs returns a Profile modifier which sets the URIs
// that will be bound to the subject alternative name extension of the Certificate.
func WithURIs(uris []*url.URL) WithOption {
return func(p Profile) error {
crt := p.Subject()
crt.URIs = uris
return nil
}
}
// WithSANs returns a profile modifier which set the dnsNames, emailAddresses,
// ipAddresses, and URIs attributes of the Certificate.
func WithSANs(sans []string) WithOption {
return func(p Profile) error {
dnsNames, ips, emails, uris := SplitSANs(sans)
cert := p.Subject()
cert.DNSNames = dnsNames
cert.IPAddresses = ips
cert.EmailAddresses = emails
cert.URIs = uris
return nil
}
}
// WithHosts returns a Profile modifier which sets the DNS Names and IP Addresses
// that will be bound to the subject Certificate.
//
// `hosts` should be a comma separated string of DNS Names and IP Addresses.
// e.g. `127.0.0.1,internal.smallstep.com,blog.smallstep.com,1.1.1.1`.
func WithHosts(hosts string) WithOption {
return func(p Profile) error {
hostsL := strings.Split(hosts, ",")
crt := p.Subject()
for _, h := range hostsL {
if h == "" {
continue
} else if ip := net.ParseIP(h); ip != nil {
crt.IPAddresses = appendIfMissingIP(crt.IPAddresses, ip)
} else {
crt.DNSNames = appendIfMissingString(crt.DNSNames, h)
}
}
return nil
}
}
// WithCTPoison returns a Profile modifier that adds the CT poison extension
// defined in RFC6962.
func WithCTPoison() WithOption {
return func(p Profile) error {
crt := p.Subject()
crt.ExtraExtensions = append(crt.ExtraExtensions, pkix.Extension{
Id: oidExtensionCTPoison,
Critical: true,
Value: asn1.NullBytes,
})
return nil
}
}
// newProfile initializes the given profile.
//
// If the public/private key pair of the subject identity are not set by
// the optional modifiers then a pair will be generated using sane defaults.
func newProfile(p Profile, sub, iss *x509.Certificate, issPriv crypto.PrivateKey, withOps ...WithOption) (Profile, error) {
if p == nil {
return nil, errors.New("profile cannot be nil")
}
if sub == nil {
return nil, errors.New("subject certificate cannot be nil")
}
if iss == nil {
return nil, errors.New("issuing certificate cannot be nil")
}
p.SetSubject(sub)
p.SetIssuer(iss)
p.SetIssuerPrivateKey(issPriv)
for _, op := range withOps {
if err := op(p); err != nil {
return nil, err
}
}
if p.SubjectPublicKey() == nil {
if err := GenerateDefaultKeyPair(p); err != nil {
return nil, err
}
}
if sub.SubjectKeyId == nil {
id, err := generateSubjectKeyID(p.SubjectPublicKey())
if err != nil {
return nil, err
}
sub.SubjectKeyId = id
}
if sub.SerialNumber == nil {
serialNumberLimit := new(big.Int).Lsh(big.NewInt(1), 128)
sn, err := rand.Int(rand.Reader, serialNumberLimit)
if err != nil {
return nil, errors.Wrapf(err, "Failed to generate serial number for "+
"certificate with common name '%s'", sub.Subject.CommonName)
}
sub.SerialNumber = sn
}
return p, nil
}
func (b *base) Issuer() *x509.Certificate {
return b.iss
}
func (b *base) Subject() *x509.Certificate {
return b.sub
}
func (b *base) SubjectPrivateKey() interface{} {
return b.subPriv
}
func (b *base) SubjectPublicKey() interface{} {
return b.subPub
}
func (b *base) SetIssuer(iss *x509.Certificate) {
b.iss = iss
}
func (b *base) SetSubject(sub *x509.Certificate) {
b.sub = sub
}
func (b *base) SetSubjectPrivateKey(priv interface{}) {
b.subPriv = priv
}
func (b *base) SetIssuerPrivateKey(priv interface{}) {
b.issPriv = priv
}
func (b *base) SetSubjectPublicKey(pub interface{}) {
b.subPub = pub
}
func (b *base) AddExtension(ext pkix.Extension) {
b.ext = append(b.ext, ext)
}
func (b *base) RemoveExtension(oid asn1.ObjectIdentifier) {
for i, ext := range b.ext {
if ext.Id.Equal(oid) {
b.ext = append(b.ext[:i], b.ext[i+1:]...)
break
}
}
if b.sub != nil {
for i, ext := range b.sub.ExtraExtensions {
if ext.Id.Equal(oid) {
b.sub.ExtraExtensions = append(b.sub.ExtraExtensions[:i], b.sub.ExtraExtensions[i+1:]...)
break
}
}
}
}
func (b *base) DefaultDuration() time.Duration {
return DefaultCertValidity
}
func (b *base) GenerateKeyPair(kty, crv string, size int) error {
pub, priv, err := keys.GenerateKeyPair(kty, crv, size)
if err != nil {
return err
}
b.SetSubjectPublicKey(pub)
b.SetSubjectPrivateKey(priv)
return nil
}
func (b *base) GenerateDefaultKeyPair() error {
pub, priv, err := keys.GenerateDefaultKeyPair()
if err != nil {
return err
}
b.SetSubjectPublicKey(pub)
b.SetSubjectPrivateKey(priv)
return nil
}
// CreateCertificate creates an x509 Certificate using the configuration stored
// in the profile.
func (b *base) CreateCertificate() ([]byte, error) {
pub := b.SubjectPublicKey()
if pub == nil {
return nil, errors.Errorf("Profile does not have subject public key. Need to call 'profile.GenerateKeyPair(...)' or use setters to populate keys")
}
if b.issPriv == nil {
return nil, errors.Errorf("Profile does not have issuer private key. Use setters to populate this field.")
}
sub := b.Subject()
iss := b.Issuer()
if len(b.ext) > 0 {
sub.ExtraExtensions = append(sub.ExtraExtensions, b.ext...)
}
// Remove KeyEncipherment and DataEncipherment for non-rsa keys.
// See:
// https://github.com/golang/go/issues/36499
// https://tools.ietf.org/html/draft-ietf-lamps-5480-ku-clarifications-02
if _, ok := pub.(*rsa.PublicKey); !ok {
sub.KeyUsage &= ^x509.KeyUsageKeyEncipherment
sub.KeyUsage &= ^x509.KeyUsageDataEncipherment
}
// Only keep those extensions that are not considered standard x509 Ext as
// defined in RFC 5280 4.2.1. The x509/crypto lib applies extra (often
// necessary) logic when converting x509 templates to certificates -- but
// that logic is superseded by extensions in the ExtraExtensions list, which
// are copied to the certificate verbatim.
var exts []pkix.Extension
for _, ext := range sub.ExtraExtensions {
if _, ok := oidStdExtHashMap[ext.Id.String()]; !ok {
exts = append(exts, ext)
}
}
sub.ExtraExtensions = exts
bytes, err := x509.CreateCertificate(rand.Reader, sub, iss, pub, b.issPriv)
return bytes, errors.WithStack(err)
}
// Create Certificate from profile and write the certificate and private key
// to disk.
func (b *base) CreateWriteCertificate(crtOut, keyOut, pass string) ([]byte, error) {
crtBytes, err := b.CreateCertificate()
if err != nil {
return nil, errors.WithStack(err)
}
if err = utils.WriteFile(crtOut, pem.EncodeToMemory(&pem.Block{
Type: "CERTIFICATE",
Bytes: crtBytes,
}), 0600); err != nil {
return nil, errors.WithStack(err)
}
_, err = pemutil.Serialize(b.SubjectPrivateKey(),
pemutil.WithPassword([]byte(pass)), pemutil.ToFile(keyOut, 0600))
if err != nil {
return nil, errors.WithStack(err)
}
return crtBytes, nil
}
// subjectPublicKeyInfo is a PKIX public key structure defined in RFC 5280.
type subjectPublicKeyInfo struct {
Algorithm pkix.AlgorithmIdentifier
SubjectPublicKey asn1.BitString
}
// generateSubjectKeyID generates the key identifier according the the RFC 5280
// section 4.2.1.2.
//
// The keyIdentifier is composed of the 160-bit SHA-1 hash of the value of the
// BIT STRING subjectPublicKey (excluding the tag, length, and number of unused
// bits).
func generateSubjectKeyID(pub crypto.PublicKey) ([]byte, error) {
b, err := x509.MarshalPKIXPublicKey(pub)
if err != nil {
return nil, errors.Wrap(err, "error marshaling public key")
}
var info subjectPublicKeyInfo
if _, err = asn1.Unmarshal(b, &info); err != nil {
return nil, errors.Wrap(err, "error unmarshaling public key")
}
hash := sha1.Sum(info.SubjectPublicKey.Bytes)
return hash[:], nil
}
|