package issuance import ( "bytes" "crypto" "crypto/ecdsa" "crypto/rand" "crypto/rsa" "crypto/x509" "crypto/x509/pkix" "encoding/asn1" "errors" "fmt" "math/big" "sync" "time" ct "github.com/google/certificate-transparency-go" cttls "github.com/google/certificate-transparency-go/tls" ctx509 "github.com/google/certificate-transparency-go/x509" "github.com/jmhodges/clock" "github.com/zmap/zlint/v3/lint" "github.com/letsencrypt/boulder/config" "github.com/letsencrypt/boulder/precert" ) // ProfileConfig describes the certificate issuance constraints for all issuers. type ProfileConfig struct { AllowMustStaple bool AllowCTPoison bool AllowSCTList bool AllowCommonName bool MaxValidityPeriod config.Duration MaxValidityBackdate config.Duration // Deprecated: we do not respect this field. Policies []PolicyConfig `validate:"-"` } // PolicyConfig describes a policy type PolicyConfig struct { OID string `validate:"required"` } // Profile is the validated structure created by reading in ProfileConfigs and IssuerConfigs type Profile struct { allowMustStaple bool allowCTPoison bool allowSCTList bool allowCommonName bool maxBackdate time.Duration maxValidity time.Duration lints lint.Registry } // NewProfile converts the profile config and lint registry into a usable profile. func NewProfile(profileConfig ProfileConfig, lints lint.Registry) (*Profile, error) { sp := &Profile{ allowMustStaple: profileConfig.AllowMustStaple, allowCTPoison: profileConfig.AllowCTPoison, allowSCTList: profileConfig.AllowSCTList, allowCommonName: profileConfig.AllowCommonName, maxBackdate: profileConfig.MaxValidityBackdate.Duration, maxValidity: profileConfig.MaxValidityPeriod.Duration, lints: lints, } return sp, nil } // requestValid verifies the passed IssuanceRequest against the profile. If the // request doesn't match the signing profile an error is returned. func (i *Issuer) requestValid(clk clock.Clock, prof *Profile, req *IssuanceRequest) error { switch req.PublicKey.(type) { case *rsa.PublicKey, *ecdsa.PublicKey: default: return errors.New("unsupported public key type") } if len(req.precertDER) == 0 && !i.active { return errors.New("inactive issuer cannot issue precert") } if len(req.SubjectKeyId) != 20 { return errors.New("unexpected subject key ID length") } if !prof.allowMustStaple && req.IncludeMustStaple { return errors.New("must-staple extension cannot be included") } if !prof.allowCTPoison && req.IncludeCTPoison { return errors.New("ct poison extension cannot be included") } if !prof.allowSCTList && req.sctList != nil { return errors.New("sct list extension cannot be included") } if req.IncludeCTPoison && req.sctList != nil { return errors.New("cannot include both ct poison and sct list extensions") } if !prof.allowCommonName && req.CommonName != "" { return errors.New("common name cannot be included") } // The validity period is calculated inclusive of the whole second represented // by the notAfter timestamp. validity := req.NotAfter.Add(time.Second).Sub(req.NotBefore) if validity <= 0 { return errors.New("NotAfter must be after NotBefore") } if validity > prof.maxValidity { return fmt.Errorf("validity period is more than the maximum allowed period (%s>%s)", validity, prof.maxValidity) } backdatedBy := clk.Now().Sub(req.NotBefore) if backdatedBy > prof.maxBackdate { return fmt.Errorf("NotBefore is backdated more than the maximum allowed period (%s>%s)", backdatedBy, prof.maxBackdate) } if backdatedBy < 0 { return errors.New("NotBefore is in the future") } // We use 19 here because a 20-byte serial could produce >20 octets when // encoded in ASN.1. That happens when the first byte is >0x80. See // https://letsencrypt.org/docs/a-warm-welcome-to-asn1-and-der/#integer-encoding if len(req.Serial) > 19 || len(req.Serial) < 9 { return errors.New("serial must be between 9 and 19 bytes") } return nil } func (i *Issuer) generateTemplate() *x509.Certificate { template := &x509.Certificate{ SignatureAlgorithm: i.sigAlg, ExtKeyUsage: []x509.ExtKeyUsage{ x509.ExtKeyUsageServerAuth, x509.ExtKeyUsageClientAuth, }, OCSPServer: []string{i.ocspURL}, IssuingCertificateURL: []string{i.issuerURL}, BasicConstraintsValid: true, // Baseline Requirements, Section 7.1.6.1: domain-validated PolicyIdentifiers: []asn1.ObjectIdentifier{{2, 23, 140, 1, 2, 1}}, } // TODO(#7294): Use i.crlURLBase and a shard calculation to create a // crlDistributionPoint. return template } var ctPoisonExt = pkix.Extension{ // OID for CT poison, RFC 6962 (was never assigned a proper id-pe- name) Id: asn1.ObjectIdentifier{1, 3, 6, 1, 4, 1, 11129, 2, 4, 3}, Value: asn1.NullBytes, Critical: true, } // OID for SCT list, RFC 6962 (was never assigned a proper id-pe- name) var sctListOID = asn1.ObjectIdentifier{1, 3, 6, 1, 4, 1, 11129, 2, 4, 2} func generateSCTListExt(scts []ct.SignedCertificateTimestamp) (pkix.Extension, error) { list := ctx509.SignedCertificateTimestampList{} for _, sct := range scts { sctBytes, err := cttls.Marshal(sct) if err != nil { return pkix.Extension{}, err } list.SCTList = append(list.SCTList, ctx509.SerializedSCT{Val: sctBytes}) } listBytes, err := cttls.Marshal(list) if err != nil { return pkix.Extension{}, err } extBytes, err := asn1.Marshal(listBytes) if err != nil { return pkix.Extension{}, err } return pkix.Extension{ Id: sctListOID, Value: extBytes, }, nil } var mustStapleExt = pkix.Extension{ // RFC 7633: id-pe-tlsfeature OBJECT IDENTIFIER ::= { id-pe 24 } Id: asn1.ObjectIdentifier{1, 3, 6, 1, 5, 5, 7, 1, 24}, // ASN.1 encoding of: // SEQUENCE // INTEGER 5 // where "5" is the status_request feature (RFC 6066) Value: []byte{0x30, 0x03, 0x02, 0x01, 0x05}, } // IssuanceRequest describes a certificate issuance request type IssuanceRequest struct { PublicKey crypto.PublicKey SubjectKeyId []byte Serial []byte NotBefore time.Time NotAfter time.Time CommonName string DNSNames []string IncludeMustStaple bool IncludeCTPoison bool // sctList is a list of SCTs to include in a final certificate. // If it is non-empty, PrecertDER must also be non-empty. sctList []ct.SignedCertificateTimestamp // precertDER is the encoded bytes of the precertificate that a // final certificate is expected to correspond to. If it is non-empty, // SCTList must also be non-empty. precertDER []byte } // An issuanceToken represents an assertion that Issuer.Lint has generated // a linting certificate for a given input and run the linter over it with no // errors. The token may be redeemed (at most once) to sign a certificate or // precertificate with the same Issuer's private key, containing the same // contents that were linted. type issuanceToken struct { mu sync.Mutex template *x509.Certificate pubKey any // A pointer to the issuer that created this token. This token may only // be redeemed by the same issuer. issuer *Issuer } // Prepare combines the given profile and request with the Issuer's information // to create a template certificate. It then generates a linting certificate // from that template and runs the linter over it. If successful, returns both // the linting certificate (which can be stored) and an issuanceToken. The // issuanceToken can be used to sign a matching certificate with this Issuer's // private key. func (i *Issuer) Prepare(prof *Profile, req *IssuanceRequest) ([]byte, *issuanceToken, error) { // check request is valid according to the issuance profile err := i.requestValid(i.clk, prof, req) if err != nil { return nil, nil, err } // generate template from the issuer's data template := i.generateTemplate() // populate template from the issuance request template.NotBefore, template.NotAfter = req.NotBefore, req.NotAfter template.SerialNumber = big.NewInt(0).SetBytes(req.Serial) if req.CommonName != "" { template.Subject.CommonName = req.CommonName } template.DNSNames = req.DNSNames switch req.PublicKey.(type) { case *rsa.PublicKey: template.KeyUsage = x509.KeyUsageDigitalSignature | x509.KeyUsageKeyEncipherment case *ecdsa.PublicKey: template.KeyUsage = x509.KeyUsageDigitalSignature } template.SubjectKeyId = req.SubjectKeyId if req.IncludeCTPoison { template.ExtraExtensions = append(template.ExtraExtensions, ctPoisonExt) } else if len(req.sctList) > 0 { if len(req.precertDER) == 0 { return nil, nil, errors.New("inconsistent request contains sctList but no precertDER") } sctListExt, err := generateSCTListExt(req.sctList) if err != nil { return nil, nil, err } template.ExtraExtensions = append(template.ExtraExtensions, sctListExt) } else { return nil, nil, errors.New("invalid request contains neither sctList nor precertDER") } if req.IncludeMustStaple { template.ExtraExtensions = append(template.ExtraExtensions, mustStapleExt) } // check that the tbsCertificate is properly formed by signing it // with a throwaway key and then linting it using zlint lintCertBytes, err := i.Linter.Check(template, req.PublicKey, prof.lints) if err != nil { return nil, nil, fmt.Errorf("tbsCertificate linting failed: %w", err) } if len(req.precertDER) > 0 { err = precert.Correspond(req.precertDER, lintCertBytes) if err != nil { return nil, nil, fmt.Errorf("precert does not correspond to linted final cert: %w", err) } } token := &issuanceToken{sync.Mutex{}, template, req.PublicKey, i} return lintCertBytes, token, nil } // Issue performs a real issuance using an issuanceToken resulting from a // previous call to Prepare(). Call this at most once per token. Calls after // the first will receive an error. func (i *Issuer) Issue(token *issuanceToken) ([]byte, error) { if token == nil { return nil, errors.New("nil issuanceToken") } token.mu.Lock() defer token.mu.Unlock() if token.template == nil { return nil, errors.New("issuance token already redeemed") } template := token.template token.template = nil if token.issuer != i { return nil, errors.New("tried to redeem issuance token with the wrong issuer") } return x509.CreateCertificate(rand.Reader, template, i.Cert.Certificate, token.pubKey, i.Signer) } // ContainsMustStaple returns true if the provided set of extensions includes // an entry whose OID and value both match the expected values for the OCSP // Must-Staple (a.k.a. id-pe-tlsFeature) extension. func ContainsMustStaple(extensions []pkix.Extension) bool { for _, ext := range extensions { if ext.Id.Equal(mustStapleExt.Id) && bytes.Equal(ext.Value, mustStapleExt.Value) { return true } } return false } // containsCTPoison returns true if the provided set of extensions includes // an entry whose OID and value both match the expected values for the CT // Poison extension. func containsCTPoison(extensions []pkix.Extension) bool { for _, ext := range extensions { if ext.Id.Equal(ctPoisonExt.Id) && bytes.Equal(ext.Value, asn1.NullBytes) { return true } } return false } // RequestFromPrecert constructs a final certificate IssuanceRequest matching // the provided precertificate. It returns an error if the precertificate doesn't // contain the CT poison extension. func RequestFromPrecert(precert *x509.Certificate, scts []ct.SignedCertificateTimestamp) (*IssuanceRequest, error) { if !containsCTPoison(precert.Extensions) { return nil, errors.New("provided certificate doesn't contain the CT poison extension") } return &IssuanceRequest{ PublicKey: precert.PublicKey, SubjectKeyId: precert.SubjectKeyId, Serial: precert.SerialNumber.Bytes(), NotBefore: precert.NotBefore, NotAfter: precert.NotAfter, CommonName: precert.Subject.CommonName, DNSNames: precert.DNSNames, IncludeMustStaple: ContainsMustStaple(precert.Extensions), sctList: scts, precertDER: precert.Raw, }, nil }