]> Cypherpunks.ru repositories - gostls13.git/blob - src/crypto/x509/x509.go
c7106553043b15643313f444e9d00708de8b16c8
[gostls13.git] / src / crypto / x509 / x509.go
1 // Copyright 2009 The Go Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style
3 // license that can be found in the LICENSE file.
4
5 // Package x509 implements a subset of the X.509 standard.
6 //
7 // It allows parsing and generating certificates, certificate signing
8 // requests, certificate revocation lists, and encoded public and private keys.
9 // It provides a certificate verifier, complete with a chain builder.
10 //
11 // The package targets the X.509 technical profile defined by the IETF (RFC
12 // 2459/3280/5280), and as further restricted by the CA/Browser Forum Baseline
13 // Requirements. There is minimal support for features outside of these
14 // profiles, as the primary goal of the package is to provide compatibility
15 // with the publicly trusted TLS certificate ecosystem and its policies and
16 // constraints.
17 //
18 // On macOS and Windows, certificate verification is handled by system APIs, but
19 // the package aims to apply consistent validation rules across operating
20 // systems.
21 package x509
22
23 import (
24         "bytes"
25         "crypto"
26         "crypto/ecdh"
27         "crypto/ecdsa"
28         "crypto/ed25519"
29         "crypto/elliptic"
30         "crypto/rsa"
31         "crypto/sha1"
32         "crypto/x509/pkix"
33         "encoding/asn1"
34         "encoding/pem"
35         "errors"
36         "fmt"
37         "internal/godebug"
38         "io"
39         "math/big"
40         "net"
41         "net/url"
42         "strconv"
43         "time"
44         "unicode"
45
46         // Explicitly import these for their crypto.RegisterHash init side-effects.
47         // Keep these as blank imports, even if they're imported above.
48         _ "crypto/sha1"
49         _ "crypto/sha256"
50         _ "crypto/sha512"
51
52         "golang.org/x/crypto/cryptobyte"
53         cryptobyte_asn1 "golang.org/x/crypto/cryptobyte/asn1"
54 )
55
56 // pkixPublicKey reflects a PKIX public key structure. See SubjectPublicKeyInfo
57 // in RFC 3280.
58 type pkixPublicKey struct {
59         Algo      pkix.AlgorithmIdentifier
60         BitString asn1.BitString
61 }
62
63 // ParsePKIXPublicKey parses a public key in PKIX, ASN.1 DER form. The encoded
64 // public key is a SubjectPublicKeyInfo structure (see RFC 5280, Section 4.1).
65 //
66 // It returns a *[rsa.PublicKey], *[dsa.PublicKey], *[ecdsa.PublicKey],
67 // [ed25519.PublicKey] (not a pointer), or *[ecdh.PublicKey] (for X25519).
68 // More types might be supported in the future.
69 //
70 // This kind of key is commonly encoded in PEM blocks of type "PUBLIC KEY".
71 func ParsePKIXPublicKey(derBytes []byte) (pub any, err error) {
72         var pki publicKeyInfo
73         if rest, err := asn1.Unmarshal(derBytes, &pki); err != nil {
74                 if _, err := asn1.Unmarshal(derBytes, &pkcs1PublicKey{}); err == nil {
75                         return nil, errors.New("x509: failed to parse public key (use ParsePKCS1PublicKey instead for this key format)")
76                 }
77                 return nil, err
78         } else if len(rest) != 0 {
79                 return nil, errors.New("x509: trailing data after ASN.1 of public-key")
80         }
81         return parsePublicKey(&pki)
82 }
83
84 func marshalPublicKey(pub any) (publicKeyBytes []byte, publicKeyAlgorithm pkix.AlgorithmIdentifier, err error) {
85         switch pub := pub.(type) {
86         case *rsa.PublicKey:
87                 publicKeyBytes, err = asn1.Marshal(pkcs1PublicKey{
88                         N: pub.N,
89                         E: pub.E,
90                 })
91                 if err != nil {
92                         return nil, pkix.AlgorithmIdentifier{}, err
93                 }
94                 publicKeyAlgorithm.Algorithm = oidPublicKeyRSA
95                 // This is a NULL parameters value which is required by
96                 // RFC 3279, Section 2.3.1.
97                 publicKeyAlgorithm.Parameters = asn1.NullRawValue
98         case *ecdsa.PublicKey:
99                 oid, ok := oidFromNamedCurve(pub.Curve)
100                 if !ok {
101                         return nil, pkix.AlgorithmIdentifier{}, errors.New("x509: unsupported elliptic curve")
102                 }
103                 if !pub.Curve.IsOnCurve(pub.X, pub.Y) {
104                         return nil, pkix.AlgorithmIdentifier{}, errors.New("x509: invalid elliptic curve public key")
105                 }
106                 publicKeyBytes = elliptic.Marshal(pub.Curve, pub.X, pub.Y)
107                 publicKeyAlgorithm.Algorithm = oidPublicKeyECDSA
108                 var paramBytes []byte
109                 paramBytes, err = asn1.Marshal(oid)
110                 if err != nil {
111                         return
112                 }
113                 publicKeyAlgorithm.Parameters.FullBytes = paramBytes
114         case ed25519.PublicKey:
115                 publicKeyBytes = pub
116                 publicKeyAlgorithm.Algorithm = oidPublicKeyEd25519
117         case *ecdh.PublicKey:
118                 publicKeyBytes = pub.Bytes()
119                 if pub.Curve() == ecdh.X25519() {
120                         publicKeyAlgorithm.Algorithm = oidPublicKeyX25519
121                 } else {
122                         oid, ok := oidFromECDHCurve(pub.Curve())
123                         if !ok {
124                                 return nil, pkix.AlgorithmIdentifier{}, errors.New("x509: unsupported elliptic curve")
125                         }
126                         publicKeyAlgorithm.Algorithm = oidPublicKeyECDSA
127                         var paramBytes []byte
128                         paramBytes, err = asn1.Marshal(oid)
129                         if err != nil {
130                                 return
131                         }
132                         publicKeyAlgorithm.Parameters.FullBytes = paramBytes
133                 }
134         default:
135                 return nil, pkix.AlgorithmIdentifier{}, fmt.Errorf("x509: unsupported public key type: %T", pub)
136         }
137
138         return publicKeyBytes, publicKeyAlgorithm, nil
139 }
140
141 // MarshalPKIXPublicKey converts a public key to PKIX, ASN.1 DER form.
142 // The encoded public key is a SubjectPublicKeyInfo structure
143 // (see RFC 5280, Section 4.1).
144 //
145 // The following key types are currently supported: *[rsa.PublicKey],
146 // *[ecdsa.PublicKey], [ed25519.PublicKey] (not a pointer), and *[ecdh.PublicKey].
147 // Unsupported key types result in an error.
148 //
149 // This kind of key is commonly encoded in PEM blocks of type "PUBLIC KEY".
150 func MarshalPKIXPublicKey(pub any) ([]byte, error) {
151         var publicKeyBytes []byte
152         var publicKeyAlgorithm pkix.AlgorithmIdentifier
153         var err error
154
155         if publicKeyBytes, publicKeyAlgorithm, err = marshalPublicKey(pub); err != nil {
156                 return nil, err
157         }
158
159         pkix := pkixPublicKey{
160                 Algo: publicKeyAlgorithm,
161                 BitString: asn1.BitString{
162                         Bytes:     publicKeyBytes,
163                         BitLength: 8 * len(publicKeyBytes),
164                 },
165         }
166
167         ret, _ := asn1.Marshal(pkix)
168         return ret, nil
169 }
170
171 // These structures reflect the ASN.1 structure of X.509 certificates.:
172
173 type certificate struct {
174         TBSCertificate     tbsCertificate
175         SignatureAlgorithm pkix.AlgorithmIdentifier
176         SignatureValue     asn1.BitString
177 }
178
179 type tbsCertificate struct {
180         Raw                asn1.RawContent
181         Version            int `asn1:"optional,explicit,default:0,tag:0"`
182         SerialNumber       *big.Int
183         SignatureAlgorithm pkix.AlgorithmIdentifier
184         Issuer             asn1.RawValue
185         Validity           validity
186         Subject            asn1.RawValue
187         PublicKey          publicKeyInfo
188         UniqueId           asn1.BitString   `asn1:"optional,tag:1"`
189         SubjectUniqueId    asn1.BitString   `asn1:"optional,tag:2"`
190         Extensions         []pkix.Extension `asn1:"omitempty,optional,explicit,tag:3"`
191 }
192
193 type dsaAlgorithmParameters struct {
194         P, Q, G *big.Int
195 }
196
197 type validity struct {
198         NotBefore, NotAfter time.Time
199 }
200
201 type publicKeyInfo struct {
202         Raw       asn1.RawContent
203         Algorithm pkix.AlgorithmIdentifier
204         PublicKey asn1.BitString
205 }
206
207 // RFC 5280,  4.2.1.1
208 type authKeyId struct {
209         Id []byte `asn1:"optional,tag:0"`
210 }
211
212 type SignatureAlgorithm int
213
214 const (
215         UnknownSignatureAlgorithm SignatureAlgorithm = iota
216
217         MD2WithRSA  // Unsupported.
218         MD5WithRSA  // Only supported for signing, not verification.
219         SHA1WithRSA // Only supported for signing, and verification of CRLs, CSRs, and OCSP responses.
220         SHA256WithRSA
221         SHA384WithRSA
222         SHA512WithRSA
223         DSAWithSHA1   // Unsupported.
224         DSAWithSHA256 // Unsupported.
225         ECDSAWithSHA1 // Only supported for signing, and verification of CRLs, CSRs, and OCSP responses.
226         ECDSAWithSHA256
227         ECDSAWithSHA384
228         ECDSAWithSHA512
229         SHA256WithRSAPSS
230         SHA384WithRSAPSS
231         SHA512WithRSAPSS
232         PureEd25519
233 )
234
235 func (algo SignatureAlgorithm) isRSAPSS() bool {
236         switch algo {
237         case SHA256WithRSAPSS, SHA384WithRSAPSS, SHA512WithRSAPSS:
238                 return true
239         default:
240                 return false
241         }
242 }
243
244 func (algo SignatureAlgorithm) String() string {
245         for _, details := range signatureAlgorithmDetails {
246                 if details.algo == algo {
247                         return details.name
248                 }
249         }
250         return strconv.Itoa(int(algo))
251 }
252
253 type PublicKeyAlgorithm int
254
255 const (
256         UnknownPublicKeyAlgorithm PublicKeyAlgorithm = iota
257         RSA
258         DSA // Only supported for parsing.
259         ECDSA
260         Ed25519
261 )
262
263 var publicKeyAlgoName = [...]string{
264         RSA:     "RSA",
265         DSA:     "DSA",
266         ECDSA:   "ECDSA",
267         Ed25519: "Ed25519",
268 }
269
270 func (algo PublicKeyAlgorithm) String() string {
271         if 0 < algo && int(algo) < len(publicKeyAlgoName) {
272                 return publicKeyAlgoName[algo]
273         }
274         return strconv.Itoa(int(algo))
275 }
276
277 // OIDs for signature algorithms
278 //
279 //      pkcs-1 OBJECT IDENTIFIER ::= {
280 //              iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 1 }
281 //
282 // RFC 3279 2.2.1 RSA Signature Algorithms
283 //
284 //      md2WithRSAEncryption OBJECT IDENTIFIER ::= { pkcs-1 2 }
285 //
286 //      md5WithRSAEncryption OBJECT IDENTIFIER ::= { pkcs-1 4 }
287 //
288 //      sha-1WithRSAEncryption OBJECT IDENTIFIER ::= { pkcs-1 5 }
289 //
290 //      dsaWithSha1 OBJECT IDENTIFIER ::= {
291 //              iso(1) member-body(2) us(840) x9-57(10040) x9cm(4) 3 }
292 //
293 // RFC 3279 2.2.3 ECDSA Signature Algorithm
294 //
295 //      ecdsa-with-SHA1 OBJECT IDENTIFIER ::= {
296 //              iso(1) member-body(2) us(840) ansi-x962(10045)
297 //              signatures(4) ecdsa-with-SHA1(1)}
298 //
299 // RFC 4055 5 PKCS #1 Version 1.5
300 //
301 //      sha256WithRSAEncryption OBJECT IDENTIFIER ::= { pkcs-1 11 }
302 //
303 //      sha384WithRSAEncryption OBJECT IDENTIFIER ::= { pkcs-1 12 }
304 //
305 //      sha512WithRSAEncryption OBJECT IDENTIFIER ::= { pkcs-1 13 }
306 //
307 // RFC 5758 3.1 DSA Signature Algorithms
308 //
309 //      dsaWithSha256 OBJECT IDENTIFIER ::= {
310 //              joint-iso-ccitt(2) country(16) us(840) organization(1) gov(101)
311 //              csor(3) algorithms(4) id-dsa-with-sha2(3) 2}
312 //
313 // RFC 5758 3.2 ECDSA Signature Algorithm
314 //
315 //      ecdsa-with-SHA256 OBJECT IDENTIFIER ::= { iso(1) member-body(2)
316 //              us(840) ansi-X9-62(10045) signatures(4) ecdsa-with-SHA2(3) 2 }
317 //
318 //      ecdsa-with-SHA384 OBJECT IDENTIFIER ::= { iso(1) member-body(2)
319 //              us(840) ansi-X9-62(10045) signatures(4) ecdsa-with-SHA2(3) 3 }
320 //
321 //      ecdsa-with-SHA512 OBJECT IDENTIFIER ::= { iso(1) member-body(2)
322 //              us(840) ansi-X9-62(10045) signatures(4) ecdsa-with-SHA2(3) 4 }
323 //
324 // RFC 8410 3 Curve25519 and Curve448 Algorithm Identifiers
325 //
326 //      id-Ed25519   OBJECT IDENTIFIER ::= { 1 3 101 112 }
327 var (
328         oidSignatureMD2WithRSA      = asn1.ObjectIdentifier{1, 2, 840, 113549, 1, 1, 2}
329         oidSignatureMD5WithRSA      = asn1.ObjectIdentifier{1, 2, 840, 113549, 1, 1, 4}
330         oidSignatureSHA1WithRSA     = asn1.ObjectIdentifier{1, 2, 840, 113549, 1, 1, 5}
331         oidSignatureSHA256WithRSA   = asn1.ObjectIdentifier{1, 2, 840, 113549, 1, 1, 11}
332         oidSignatureSHA384WithRSA   = asn1.ObjectIdentifier{1, 2, 840, 113549, 1, 1, 12}
333         oidSignatureSHA512WithRSA   = asn1.ObjectIdentifier{1, 2, 840, 113549, 1, 1, 13}
334         oidSignatureRSAPSS          = asn1.ObjectIdentifier{1, 2, 840, 113549, 1, 1, 10}
335         oidSignatureDSAWithSHA1     = asn1.ObjectIdentifier{1, 2, 840, 10040, 4, 3}
336         oidSignatureDSAWithSHA256   = asn1.ObjectIdentifier{2, 16, 840, 1, 101, 3, 4, 3, 2}
337         oidSignatureECDSAWithSHA1   = asn1.ObjectIdentifier{1, 2, 840, 10045, 4, 1}
338         oidSignatureECDSAWithSHA256 = asn1.ObjectIdentifier{1, 2, 840, 10045, 4, 3, 2}
339         oidSignatureECDSAWithSHA384 = asn1.ObjectIdentifier{1, 2, 840, 10045, 4, 3, 3}
340         oidSignatureECDSAWithSHA512 = asn1.ObjectIdentifier{1, 2, 840, 10045, 4, 3, 4}
341         oidSignatureEd25519         = asn1.ObjectIdentifier{1, 3, 101, 112}
342
343         oidSHA256 = asn1.ObjectIdentifier{2, 16, 840, 1, 101, 3, 4, 2, 1}
344         oidSHA384 = asn1.ObjectIdentifier{2, 16, 840, 1, 101, 3, 4, 2, 2}
345         oidSHA512 = asn1.ObjectIdentifier{2, 16, 840, 1, 101, 3, 4, 2, 3}
346
347         oidMGF1 = asn1.ObjectIdentifier{1, 2, 840, 113549, 1, 1, 8}
348
349         // oidISOSignatureSHA1WithRSA means the same as oidSignatureSHA1WithRSA
350         // but it's specified by ISO. Microsoft's makecert.exe has been known
351         // to produce certificates with this OID.
352         oidISOSignatureSHA1WithRSA = asn1.ObjectIdentifier{1, 3, 14, 3, 2, 29}
353 )
354
355 var signatureAlgorithmDetails = []struct {
356         algo       SignatureAlgorithm
357         name       string
358         oid        asn1.ObjectIdentifier
359         pubKeyAlgo PublicKeyAlgorithm
360         hash       crypto.Hash
361 }{
362         {MD2WithRSA, "MD2-RSA", oidSignatureMD2WithRSA, RSA, crypto.Hash(0) /* no value for MD2 */},
363         {MD5WithRSA, "MD5-RSA", oidSignatureMD5WithRSA, RSA, crypto.MD5},
364         {SHA1WithRSA, "SHA1-RSA", oidSignatureSHA1WithRSA, RSA, crypto.SHA1},
365         {SHA1WithRSA, "SHA1-RSA", oidISOSignatureSHA1WithRSA, RSA, crypto.SHA1},
366         {SHA256WithRSA, "SHA256-RSA", oidSignatureSHA256WithRSA, RSA, crypto.SHA256},
367         {SHA384WithRSA, "SHA384-RSA", oidSignatureSHA384WithRSA, RSA, crypto.SHA384},
368         {SHA512WithRSA, "SHA512-RSA", oidSignatureSHA512WithRSA, RSA, crypto.SHA512},
369         {SHA256WithRSAPSS, "SHA256-RSAPSS", oidSignatureRSAPSS, RSA, crypto.SHA256},
370         {SHA384WithRSAPSS, "SHA384-RSAPSS", oidSignatureRSAPSS, RSA, crypto.SHA384},
371         {SHA512WithRSAPSS, "SHA512-RSAPSS", oidSignatureRSAPSS, RSA, crypto.SHA512},
372         {DSAWithSHA1, "DSA-SHA1", oidSignatureDSAWithSHA1, DSA, crypto.SHA1},
373         {DSAWithSHA256, "DSA-SHA256", oidSignatureDSAWithSHA256, DSA, crypto.SHA256},
374         {ECDSAWithSHA1, "ECDSA-SHA1", oidSignatureECDSAWithSHA1, ECDSA, crypto.SHA1},
375         {ECDSAWithSHA256, "ECDSA-SHA256", oidSignatureECDSAWithSHA256, ECDSA, crypto.SHA256},
376         {ECDSAWithSHA384, "ECDSA-SHA384", oidSignatureECDSAWithSHA384, ECDSA, crypto.SHA384},
377         {ECDSAWithSHA512, "ECDSA-SHA512", oidSignatureECDSAWithSHA512, ECDSA, crypto.SHA512},
378         {PureEd25519, "Ed25519", oidSignatureEd25519, Ed25519, crypto.Hash(0) /* no pre-hashing */},
379 }
380
381 // hashToPSSParameters contains the DER encoded RSA PSS parameters for the
382 // SHA256, SHA384, and SHA512 hashes as defined in RFC 3447, Appendix A.2.3.
383 // The parameters contain the following values:
384 //   - hashAlgorithm contains the associated hash identifier with NULL parameters
385 //   - maskGenAlgorithm always contains the default mgf1SHA1 identifier
386 //   - saltLength contains the length of the associated hash
387 //   - trailerField always contains the default trailerFieldBC value
388 var hashToPSSParameters = map[crypto.Hash]asn1.RawValue{
389         crypto.SHA256: asn1.RawValue{FullBytes: []byte{48, 52, 160, 15, 48, 13, 6, 9, 96, 134, 72, 1, 101, 3, 4, 2, 1, 5, 0, 161, 28, 48, 26, 6, 9, 42, 134, 72, 134, 247, 13, 1, 1, 8, 48, 13, 6, 9, 96, 134, 72, 1, 101, 3, 4, 2, 1, 5, 0, 162, 3, 2, 1, 32}},
390         crypto.SHA384: asn1.RawValue{FullBytes: []byte{48, 52, 160, 15, 48, 13, 6, 9, 96, 134, 72, 1, 101, 3, 4, 2, 2, 5, 0, 161, 28, 48, 26, 6, 9, 42, 134, 72, 134, 247, 13, 1, 1, 8, 48, 13, 6, 9, 96, 134, 72, 1, 101, 3, 4, 2, 2, 5, 0, 162, 3, 2, 1, 48}},
391         crypto.SHA512: asn1.RawValue{FullBytes: []byte{48, 52, 160, 15, 48, 13, 6, 9, 96, 134, 72, 1, 101, 3, 4, 2, 3, 5, 0, 161, 28, 48, 26, 6, 9, 42, 134, 72, 134, 247, 13, 1, 1, 8, 48, 13, 6, 9, 96, 134, 72, 1, 101, 3, 4, 2, 3, 5, 0, 162, 3, 2, 1, 64}},
392 }
393
394 // pssParameters reflects the parameters in an AlgorithmIdentifier that
395 // specifies RSA PSS. See RFC 3447, Appendix A.2.3.
396 type pssParameters struct {
397         // The following three fields are not marked as
398         // optional because the default values specify SHA-1,
399         // which is no longer suitable for use in signatures.
400         Hash         pkix.AlgorithmIdentifier `asn1:"explicit,tag:0"`
401         MGF          pkix.AlgorithmIdentifier `asn1:"explicit,tag:1"`
402         SaltLength   int                      `asn1:"explicit,tag:2"`
403         TrailerField int                      `asn1:"optional,explicit,tag:3,default:1"`
404 }
405
406 func getSignatureAlgorithmFromAI(ai pkix.AlgorithmIdentifier) SignatureAlgorithm {
407         if ai.Algorithm.Equal(oidSignatureEd25519) {
408                 // RFC 8410, Section 3
409                 // > For all of the OIDs, the parameters MUST be absent.
410                 if len(ai.Parameters.FullBytes) != 0 {
411                         return UnknownSignatureAlgorithm
412                 }
413         }
414
415         if !ai.Algorithm.Equal(oidSignatureRSAPSS) {
416                 for _, details := range signatureAlgorithmDetails {
417                         if ai.Algorithm.Equal(details.oid) {
418                                 return details.algo
419                         }
420                 }
421                 return UnknownSignatureAlgorithm
422         }
423
424         // RSA PSS is special because it encodes important parameters
425         // in the Parameters.
426
427         var params pssParameters
428         if _, err := asn1.Unmarshal(ai.Parameters.FullBytes, &params); err != nil {
429                 return UnknownSignatureAlgorithm
430         }
431
432         var mgf1HashFunc pkix.AlgorithmIdentifier
433         if _, err := asn1.Unmarshal(params.MGF.Parameters.FullBytes, &mgf1HashFunc); err != nil {
434                 return UnknownSignatureAlgorithm
435         }
436
437         // PSS is greatly overburdened with options. This code forces them into
438         // three buckets by requiring that the MGF1 hash function always match the
439         // message hash function (as recommended in RFC 3447, Section 8.1), that the
440         // salt length matches the hash length, and that the trailer field has the
441         // default value.
442         if (len(params.Hash.Parameters.FullBytes) != 0 && !bytes.Equal(params.Hash.Parameters.FullBytes, asn1.NullBytes)) ||
443                 !params.MGF.Algorithm.Equal(oidMGF1) ||
444                 !mgf1HashFunc.Algorithm.Equal(params.Hash.Algorithm) ||
445                 (len(mgf1HashFunc.Parameters.FullBytes) != 0 && !bytes.Equal(mgf1HashFunc.Parameters.FullBytes, asn1.NullBytes)) ||
446                 params.TrailerField != 1 {
447                 return UnknownSignatureAlgorithm
448         }
449
450         switch {
451         case params.Hash.Algorithm.Equal(oidSHA256) && params.SaltLength == 32:
452                 return SHA256WithRSAPSS
453         case params.Hash.Algorithm.Equal(oidSHA384) && params.SaltLength == 48:
454                 return SHA384WithRSAPSS
455         case params.Hash.Algorithm.Equal(oidSHA512) && params.SaltLength == 64:
456                 return SHA512WithRSAPSS
457         }
458
459         return UnknownSignatureAlgorithm
460 }
461
462 var (
463         // RFC 3279, 2.3 Public Key Algorithms
464         //
465         //      pkcs-1 OBJECT IDENTIFIER ::== { iso(1) member-body(2) us(840)
466         //              rsadsi(113549) pkcs(1) 1 }
467         //
468         // rsaEncryption OBJECT IDENTIFIER ::== { pkcs1-1 1 }
469         //
470         //      id-dsa OBJECT IDENTIFIER ::== { iso(1) member-body(2) us(840)
471         //              x9-57(10040) x9cm(4) 1 }
472         oidPublicKeyRSA = asn1.ObjectIdentifier{1, 2, 840, 113549, 1, 1, 1}
473         oidPublicKeyDSA = asn1.ObjectIdentifier{1, 2, 840, 10040, 4, 1}
474         // RFC 5480, 2.1.1 Unrestricted Algorithm Identifier and Parameters
475         //
476         //      id-ecPublicKey OBJECT IDENTIFIER ::= {
477         //              iso(1) member-body(2) us(840) ansi-X9-62(10045) keyType(2) 1 }
478         oidPublicKeyECDSA = asn1.ObjectIdentifier{1, 2, 840, 10045, 2, 1}
479         // RFC 8410, Section 3
480         //
481         //      id-X25519    OBJECT IDENTIFIER ::= { 1 3 101 110 }
482         //      id-Ed25519   OBJECT IDENTIFIER ::= { 1 3 101 112 }
483         oidPublicKeyX25519  = asn1.ObjectIdentifier{1, 3, 101, 110}
484         oidPublicKeyEd25519 = asn1.ObjectIdentifier{1, 3, 101, 112}
485 )
486
487 // getPublicKeyAlgorithmFromOID returns the exposed PublicKeyAlgorithm
488 // identifier for public key types supported in certificates and CSRs. Marshal
489 // and Parse functions may support a different set of public key types.
490 func getPublicKeyAlgorithmFromOID(oid asn1.ObjectIdentifier) PublicKeyAlgorithm {
491         switch {
492         case oid.Equal(oidPublicKeyRSA):
493                 return RSA
494         case oid.Equal(oidPublicKeyDSA):
495                 return DSA
496         case oid.Equal(oidPublicKeyECDSA):
497                 return ECDSA
498         case oid.Equal(oidPublicKeyEd25519):
499                 return Ed25519
500         }
501         return UnknownPublicKeyAlgorithm
502 }
503
504 // RFC 5480, 2.1.1.1. Named Curve
505 //
506 //      secp224r1 OBJECT IDENTIFIER ::= {
507 //        iso(1) identified-organization(3) certicom(132) curve(0) 33 }
508 //
509 //      secp256r1 OBJECT IDENTIFIER ::= {
510 //        iso(1) member-body(2) us(840) ansi-X9-62(10045) curves(3)
511 //        prime(1) 7 }
512 //
513 //      secp384r1 OBJECT IDENTIFIER ::= {
514 //        iso(1) identified-organization(3) certicom(132) curve(0) 34 }
515 //
516 //      secp521r1 OBJECT IDENTIFIER ::= {
517 //        iso(1) identified-organization(3) certicom(132) curve(0) 35 }
518 //
519 // NB: secp256r1 is equivalent to prime256v1
520 var (
521         oidNamedCurveP224 = asn1.ObjectIdentifier{1, 3, 132, 0, 33}
522         oidNamedCurveP256 = asn1.ObjectIdentifier{1, 2, 840, 10045, 3, 1, 7}
523         oidNamedCurveP384 = asn1.ObjectIdentifier{1, 3, 132, 0, 34}
524         oidNamedCurveP521 = asn1.ObjectIdentifier{1, 3, 132, 0, 35}
525 )
526
527 func namedCurveFromOID(oid asn1.ObjectIdentifier) elliptic.Curve {
528         switch {
529         case oid.Equal(oidNamedCurveP224):
530                 return elliptic.P224()
531         case oid.Equal(oidNamedCurveP256):
532                 return elliptic.P256()
533         case oid.Equal(oidNamedCurveP384):
534                 return elliptic.P384()
535         case oid.Equal(oidNamedCurveP521):
536                 return elliptic.P521()
537         }
538         return nil
539 }
540
541 func oidFromNamedCurve(curve elliptic.Curve) (asn1.ObjectIdentifier, bool) {
542         switch curve {
543         case elliptic.P224():
544                 return oidNamedCurveP224, true
545         case elliptic.P256():
546                 return oidNamedCurveP256, true
547         case elliptic.P384():
548                 return oidNamedCurveP384, true
549         case elliptic.P521():
550                 return oidNamedCurveP521, true
551         }
552
553         return nil, false
554 }
555
556 func oidFromECDHCurve(curve ecdh.Curve) (asn1.ObjectIdentifier, bool) {
557         switch curve {
558         case ecdh.X25519():
559                 return oidPublicKeyX25519, true
560         case ecdh.P256():
561                 return oidNamedCurveP256, true
562         case ecdh.P384():
563                 return oidNamedCurveP384, true
564         case ecdh.P521():
565                 return oidNamedCurveP521, true
566         }
567
568         return nil, false
569 }
570
571 // KeyUsage represents the set of actions that are valid for a given key. It's
572 // a bitmap of the KeyUsage* constants.
573 type KeyUsage int
574
575 const (
576         KeyUsageDigitalSignature KeyUsage = 1 << iota
577         KeyUsageContentCommitment
578         KeyUsageKeyEncipherment
579         KeyUsageDataEncipherment
580         KeyUsageKeyAgreement
581         KeyUsageCertSign
582         KeyUsageCRLSign
583         KeyUsageEncipherOnly
584         KeyUsageDecipherOnly
585 )
586
587 // RFC 5280, 4.2.1.12  Extended Key Usage
588 //
589 //      anyExtendedKeyUsage OBJECT IDENTIFIER ::= { id-ce-extKeyUsage 0 }
590 //
591 //      id-kp OBJECT IDENTIFIER ::= { id-pkix 3 }
592 //
593 //      id-kp-serverAuth             OBJECT IDENTIFIER ::= { id-kp 1 }
594 //      id-kp-clientAuth             OBJECT IDENTIFIER ::= { id-kp 2 }
595 //      id-kp-codeSigning            OBJECT IDENTIFIER ::= { id-kp 3 }
596 //      id-kp-emailProtection        OBJECT IDENTIFIER ::= { id-kp 4 }
597 //      id-kp-timeStamping           OBJECT IDENTIFIER ::= { id-kp 8 }
598 //      id-kp-OCSPSigning            OBJECT IDENTIFIER ::= { id-kp 9 }
599 var (
600         oidExtKeyUsageAny                            = asn1.ObjectIdentifier{2, 5, 29, 37, 0}
601         oidExtKeyUsageServerAuth                     = asn1.ObjectIdentifier{1, 3, 6, 1, 5, 5, 7, 3, 1}
602         oidExtKeyUsageClientAuth                     = asn1.ObjectIdentifier{1, 3, 6, 1, 5, 5, 7, 3, 2}
603         oidExtKeyUsageCodeSigning                    = asn1.ObjectIdentifier{1, 3, 6, 1, 5, 5, 7, 3, 3}
604         oidExtKeyUsageEmailProtection                = asn1.ObjectIdentifier{1, 3, 6, 1, 5, 5, 7, 3, 4}
605         oidExtKeyUsageIPSECEndSystem                 = asn1.ObjectIdentifier{1, 3, 6, 1, 5, 5, 7, 3, 5}
606         oidExtKeyUsageIPSECTunnel                    = asn1.ObjectIdentifier{1, 3, 6, 1, 5, 5, 7, 3, 6}
607         oidExtKeyUsageIPSECUser                      = asn1.ObjectIdentifier{1, 3, 6, 1, 5, 5, 7, 3, 7}
608         oidExtKeyUsageTimeStamping                   = asn1.ObjectIdentifier{1, 3, 6, 1, 5, 5, 7, 3, 8}
609         oidExtKeyUsageOCSPSigning                    = asn1.ObjectIdentifier{1, 3, 6, 1, 5, 5, 7, 3, 9}
610         oidExtKeyUsageMicrosoftServerGatedCrypto     = asn1.ObjectIdentifier{1, 3, 6, 1, 4, 1, 311, 10, 3, 3}
611         oidExtKeyUsageNetscapeServerGatedCrypto      = asn1.ObjectIdentifier{2, 16, 840, 1, 113730, 4, 1}
612         oidExtKeyUsageMicrosoftCommercialCodeSigning = asn1.ObjectIdentifier{1, 3, 6, 1, 4, 1, 311, 2, 1, 22}
613         oidExtKeyUsageMicrosoftKernelCodeSigning     = asn1.ObjectIdentifier{1, 3, 6, 1, 4, 1, 311, 61, 1, 1}
614 )
615
616 // ExtKeyUsage represents an extended set of actions that are valid for a given key.
617 // Each of the ExtKeyUsage* constants define a unique action.
618 type ExtKeyUsage int
619
620 const (
621         ExtKeyUsageAny ExtKeyUsage = iota
622         ExtKeyUsageServerAuth
623         ExtKeyUsageClientAuth
624         ExtKeyUsageCodeSigning
625         ExtKeyUsageEmailProtection
626         ExtKeyUsageIPSECEndSystem
627         ExtKeyUsageIPSECTunnel
628         ExtKeyUsageIPSECUser
629         ExtKeyUsageTimeStamping
630         ExtKeyUsageOCSPSigning
631         ExtKeyUsageMicrosoftServerGatedCrypto
632         ExtKeyUsageNetscapeServerGatedCrypto
633         ExtKeyUsageMicrosoftCommercialCodeSigning
634         ExtKeyUsageMicrosoftKernelCodeSigning
635 )
636
637 // extKeyUsageOIDs contains the mapping between an ExtKeyUsage and its OID.
638 var extKeyUsageOIDs = []struct {
639         extKeyUsage ExtKeyUsage
640         oid         asn1.ObjectIdentifier
641 }{
642         {ExtKeyUsageAny, oidExtKeyUsageAny},
643         {ExtKeyUsageServerAuth, oidExtKeyUsageServerAuth},
644         {ExtKeyUsageClientAuth, oidExtKeyUsageClientAuth},
645         {ExtKeyUsageCodeSigning, oidExtKeyUsageCodeSigning},
646         {ExtKeyUsageEmailProtection, oidExtKeyUsageEmailProtection},
647         {ExtKeyUsageIPSECEndSystem, oidExtKeyUsageIPSECEndSystem},
648         {ExtKeyUsageIPSECTunnel, oidExtKeyUsageIPSECTunnel},
649         {ExtKeyUsageIPSECUser, oidExtKeyUsageIPSECUser},
650         {ExtKeyUsageTimeStamping, oidExtKeyUsageTimeStamping},
651         {ExtKeyUsageOCSPSigning, oidExtKeyUsageOCSPSigning},
652         {ExtKeyUsageMicrosoftServerGatedCrypto, oidExtKeyUsageMicrosoftServerGatedCrypto},
653         {ExtKeyUsageNetscapeServerGatedCrypto, oidExtKeyUsageNetscapeServerGatedCrypto},
654         {ExtKeyUsageMicrosoftCommercialCodeSigning, oidExtKeyUsageMicrosoftCommercialCodeSigning},
655         {ExtKeyUsageMicrosoftKernelCodeSigning, oidExtKeyUsageMicrosoftKernelCodeSigning},
656 }
657
658 func extKeyUsageFromOID(oid asn1.ObjectIdentifier) (eku ExtKeyUsage, ok bool) {
659         for _, pair := range extKeyUsageOIDs {
660                 if oid.Equal(pair.oid) {
661                         return pair.extKeyUsage, true
662                 }
663         }
664         return
665 }
666
667 func oidFromExtKeyUsage(eku ExtKeyUsage) (oid asn1.ObjectIdentifier, ok bool) {
668         for _, pair := range extKeyUsageOIDs {
669                 if eku == pair.extKeyUsage {
670                         return pair.oid, true
671                 }
672         }
673         return
674 }
675
676 // A Certificate represents an X.509 certificate.
677 type Certificate struct {
678         Raw                     []byte // Complete ASN.1 DER content (certificate, signature algorithm and signature).
679         RawTBSCertificate       []byte // Certificate part of raw ASN.1 DER content.
680         RawSubjectPublicKeyInfo []byte // DER encoded SubjectPublicKeyInfo.
681         RawSubject              []byte // DER encoded Subject
682         RawIssuer               []byte // DER encoded Issuer
683
684         Signature          []byte
685         SignatureAlgorithm SignatureAlgorithm
686
687         PublicKeyAlgorithm PublicKeyAlgorithm
688         PublicKey          any
689
690         Version             int
691         SerialNumber        *big.Int
692         Issuer              pkix.Name
693         Subject             pkix.Name
694         NotBefore, NotAfter time.Time // Validity bounds.
695         KeyUsage            KeyUsage
696
697         // Extensions contains raw X.509 extensions. When parsing certificates,
698         // this can be used to extract non-critical extensions that are not
699         // parsed by this package. When marshaling certificates, the Extensions
700         // field is ignored, see ExtraExtensions.
701         Extensions []pkix.Extension
702
703         // ExtraExtensions contains extensions to be copied, raw, into any
704         // marshaled certificates. Values override any extensions that would
705         // otherwise be produced based on the other fields. The ExtraExtensions
706         // field is not populated when parsing certificates, see Extensions.
707         ExtraExtensions []pkix.Extension
708
709         // UnhandledCriticalExtensions contains a list of extension IDs that
710         // were not (fully) processed when parsing. Verify will fail if this
711         // slice is non-empty, unless verification is delegated to an OS
712         // library which understands all the critical extensions.
713         //
714         // Users can access these extensions using Extensions and can remove
715         // elements from this slice if they believe that they have been
716         // handled.
717         UnhandledCriticalExtensions []asn1.ObjectIdentifier
718
719         ExtKeyUsage        []ExtKeyUsage           // Sequence of extended key usages.
720         UnknownExtKeyUsage []asn1.ObjectIdentifier // Encountered extended key usages unknown to this package.
721
722         // BasicConstraintsValid indicates whether IsCA, MaxPathLen,
723         // and MaxPathLenZero are valid.
724         BasicConstraintsValid bool
725         IsCA                  bool
726
727         // MaxPathLen and MaxPathLenZero indicate the presence and
728         // value of the BasicConstraints' "pathLenConstraint".
729         //
730         // When parsing a certificate, a positive non-zero MaxPathLen
731         // means that the field was specified, -1 means it was unset,
732         // and MaxPathLenZero being true mean that the field was
733         // explicitly set to zero. The case of MaxPathLen==0 with MaxPathLenZero==false
734         // should be treated equivalent to -1 (unset).
735         //
736         // When generating a certificate, an unset pathLenConstraint
737         // can be requested with either MaxPathLen == -1 or using the
738         // zero value for both MaxPathLen and MaxPathLenZero.
739         MaxPathLen int
740         // MaxPathLenZero indicates that BasicConstraintsValid==true
741         // and MaxPathLen==0 should be interpreted as an actual
742         // maximum path length of zero. Otherwise, that combination is
743         // interpreted as MaxPathLen not being set.
744         MaxPathLenZero bool
745
746         SubjectKeyId   []byte
747         AuthorityKeyId []byte
748
749         // RFC 5280, 4.2.2.1 (Authority Information Access)
750         OCSPServer            []string
751         IssuingCertificateURL []string
752
753         // Subject Alternate Name values. (Note that these values may not be valid
754         // if invalid values were contained within a parsed certificate. For
755         // example, an element of DNSNames may not be a valid DNS domain name.)
756         DNSNames       []string
757         EmailAddresses []string
758         IPAddresses    []net.IP
759         URIs           []*url.URL
760
761         // Name constraints
762         PermittedDNSDomainsCritical bool // if true then the name constraints are marked critical.
763         PermittedDNSDomains         []string
764         ExcludedDNSDomains          []string
765         PermittedIPRanges           []*net.IPNet
766         ExcludedIPRanges            []*net.IPNet
767         PermittedEmailAddresses     []string
768         ExcludedEmailAddresses      []string
769         PermittedURIDomains         []string
770         ExcludedURIDomains          []string
771
772         // CRL Distribution Points
773         CRLDistributionPoints []string
774
775         // PolicyIdentifiers contains asn1.ObjectIdentifiers, the components
776         // of which are limited to int32. If a certificate contains a policy which
777         // cannot be represented by asn1.ObjectIdentifier, it will not be included in
778         // PolicyIdentifiers, but will be present in Policies, which contains all parsed
779         // policy OIDs.
780         PolicyIdentifiers []asn1.ObjectIdentifier
781
782         // Policies contains all policy identifiers included in the certificate.
783         Policies []OID
784 }
785
786 // ErrUnsupportedAlgorithm results from attempting to perform an operation that
787 // involves algorithms that are not currently implemented.
788 var ErrUnsupportedAlgorithm = errors.New("x509: cannot verify signature: algorithm unimplemented")
789
790 // An InsecureAlgorithmError indicates that the [SignatureAlgorithm] used to
791 // generate the signature is not secure, and the signature has been rejected.
792 //
793 // To temporarily restore support for SHA-1 signatures, include the value
794 // "x509sha1=1" in the GODEBUG environment variable. Note that this option will
795 // be removed in a future release.
796 type InsecureAlgorithmError SignatureAlgorithm
797
798 func (e InsecureAlgorithmError) Error() string {
799         var override string
800         if SignatureAlgorithm(e) == SHA1WithRSA || SignatureAlgorithm(e) == ECDSAWithSHA1 {
801                 override = " (temporarily override with GODEBUG=x509sha1=1)"
802         }
803         return fmt.Sprintf("x509: cannot verify signature: insecure algorithm %v", SignatureAlgorithm(e)) + override
804 }
805
806 // ConstraintViolationError results when a requested usage is not permitted by
807 // a certificate. For example: checking a signature when the public key isn't a
808 // certificate signing key.
809 type ConstraintViolationError struct{}
810
811 func (ConstraintViolationError) Error() string {
812         return "x509: invalid signature: parent certificate cannot sign this kind of certificate"
813 }
814
815 func (c *Certificate) Equal(other *Certificate) bool {
816         if c == nil || other == nil {
817                 return c == other
818         }
819         return bytes.Equal(c.Raw, other.Raw)
820 }
821
822 func (c *Certificate) hasSANExtension() bool {
823         return oidInExtensions(oidExtensionSubjectAltName, c.Extensions)
824 }
825
826 // CheckSignatureFrom verifies that the signature on c is a valid signature from parent.
827 //
828 // This is a low-level API that performs very limited checks, and not a full
829 // path verifier. Most users should use [Certificate.Verify] instead.
830 func (c *Certificate) CheckSignatureFrom(parent *Certificate) error {
831         // RFC 5280, 4.2.1.9:
832         // "If the basic constraints extension is not present in a version 3
833         // certificate, or the extension is present but the cA boolean is not
834         // asserted, then the certified public key MUST NOT be used to verify
835         // certificate signatures."
836         if parent.Version == 3 && !parent.BasicConstraintsValid ||
837                 parent.BasicConstraintsValid && !parent.IsCA {
838                 return ConstraintViolationError{}
839         }
840
841         if parent.KeyUsage != 0 && parent.KeyUsage&KeyUsageCertSign == 0 {
842                 return ConstraintViolationError{}
843         }
844
845         if parent.PublicKeyAlgorithm == UnknownPublicKeyAlgorithm {
846                 return ErrUnsupportedAlgorithm
847         }
848
849         return checkSignature(c.SignatureAlgorithm, c.RawTBSCertificate, c.Signature, parent.PublicKey, false)
850 }
851
852 // CheckSignature verifies that signature is a valid signature over signed from
853 // c's public key.
854 //
855 // This is a low-level API that performs no validity checks on the certificate.
856 //
857 // [MD5WithRSA] signatures are rejected, while [SHA1WithRSA] and [ECDSAWithSHA1]
858 // signatures are currently accepted.
859 func (c *Certificate) CheckSignature(algo SignatureAlgorithm, signed, signature []byte) error {
860         return checkSignature(algo, signed, signature, c.PublicKey, true)
861 }
862
863 func (c *Certificate) hasNameConstraints() bool {
864         return oidInExtensions(oidExtensionNameConstraints, c.Extensions)
865 }
866
867 func (c *Certificate) getSANExtension() []byte {
868         for _, e := range c.Extensions {
869                 if e.Id.Equal(oidExtensionSubjectAltName) {
870                         return e.Value
871                 }
872         }
873         return nil
874 }
875
876 func signaturePublicKeyAlgoMismatchError(expectedPubKeyAlgo PublicKeyAlgorithm, pubKey any) error {
877         return fmt.Errorf("x509: signature algorithm specifies an %s public key, but have public key of type %T", expectedPubKeyAlgo.String(), pubKey)
878 }
879
880 var x509sha1 = godebug.New("x509sha1")
881
882 // checkSignature verifies that signature is a valid signature over signed from
883 // a crypto.PublicKey.
884 func checkSignature(algo SignatureAlgorithm, signed, signature []byte, publicKey crypto.PublicKey, allowSHA1 bool) (err error) {
885         var hashType crypto.Hash
886         var pubKeyAlgo PublicKeyAlgorithm
887
888         for _, details := range signatureAlgorithmDetails {
889                 if details.algo == algo {
890                         hashType = details.hash
891                         pubKeyAlgo = details.pubKeyAlgo
892                         break
893                 }
894         }
895
896         switch hashType {
897         case crypto.Hash(0):
898                 if pubKeyAlgo != Ed25519 {
899                         return ErrUnsupportedAlgorithm
900                 }
901         case crypto.MD5:
902                 return InsecureAlgorithmError(algo)
903         case crypto.SHA1:
904                 // SHA-1 signatures are mostly disabled. See go.dev/issue/41682.
905                 if !allowSHA1 {
906                         if x509sha1.Value() != "1" {
907                                 return InsecureAlgorithmError(algo)
908                         }
909                         x509sha1.IncNonDefault()
910                 }
911                 fallthrough
912         default:
913                 if !hashType.Available() {
914                         return ErrUnsupportedAlgorithm
915                 }
916                 h := hashType.New()
917                 h.Write(signed)
918                 signed = h.Sum(nil)
919         }
920
921         switch pub := publicKey.(type) {
922         case *rsa.PublicKey:
923                 if pubKeyAlgo != RSA {
924                         return signaturePublicKeyAlgoMismatchError(pubKeyAlgo, pub)
925                 }
926                 if algo.isRSAPSS() {
927                         return rsa.VerifyPSS(pub, hashType, signed, signature, &rsa.PSSOptions{SaltLength: rsa.PSSSaltLengthEqualsHash})
928                 } else {
929                         return rsa.VerifyPKCS1v15(pub, hashType, signed, signature)
930                 }
931         case *ecdsa.PublicKey:
932                 if pubKeyAlgo != ECDSA {
933                         return signaturePublicKeyAlgoMismatchError(pubKeyAlgo, pub)
934                 }
935                 if !ecdsa.VerifyASN1(pub, signed, signature) {
936                         return errors.New("x509: ECDSA verification failure")
937                 }
938                 return
939         case ed25519.PublicKey:
940                 if pubKeyAlgo != Ed25519 {
941                         return signaturePublicKeyAlgoMismatchError(pubKeyAlgo, pub)
942                 }
943                 if !ed25519.Verify(pub, signed, signature) {
944                         return errors.New("x509: Ed25519 verification failure")
945                 }
946                 return
947         }
948         return ErrUnsupportedAlgorithm
949 }
950
951 // CheckCRLSignature checks that the signature in crl is from c.
952 //
953 // Deprecated: Use [RevocationList.CheckSignatureFrom] instead.
954 func (c *Certificate) CheckCRLSignature(crl *pkix.CertificateList) error {
955         algo := getSignatureAlgorithmFromAI(crl.SignatureAlgorithm)
956         return c.CheckSignature(algo, crl.TBSCertList.Raw, crl.SignatureValue.RightAlign())
957 }
958
959 type UnhandledCriticalExtension struct{}
960
961 func (h UnhandledCriticalExtension) Error() string {
962         return "x509: unhandled critical extension"
963 }
964
965 type basicConstraints struct {
966         IsCA       bool `asn1:"optional"`
967         MaxPathLen int  `asn1:"optional,default:-1"`
968 }
969
970 // RFC 5280 4.2.1.4
971 type policyInformation struct {
972         Policy asn1.ObjectIdentifier
973         // policyQualifiers omitted
974 }
975
976 const (
977         nameTypeEmail = 1
978         nameTypeDNS   = 2
979         nameTypeURI   = 6
980         nameTypeIP    = 7
981 )
982
983 // RFC 5280, 4.2.2.1
984 type authorityInfoAccess struct {
985         Method   asn1.ObjectIdentifier
986         Location asn1.RawValue
987 }
988
989 // RFC 5280, 4.2.1.14
990 type distributionPoint struct {
991         DistributionPoint distributionPointName `asn1:"optional,tag:0"`
992         Reason            asn1.BitString        `asn1:"optional,tag:1"`
993         CRLIssuer         asn1.RawValue         `asn1:"optional,tag:2"`
994 }
995
996 type distributionPointName struct {
997         FullName     []asn1.RawValue  `asn1:"optional,tag:0"`
998         RelativeName pkix.RDNSequence `asn1:"optional,tag:1"`
999 }
1000
1001 func reverseBitsInAByte(in byte) byte {
1002         b1 := in>>4 | in<<4
1003         b2 := b1>>2&0x33 | b1<<2&0xcc
1004         b3 := b2>>1&0x55 | b2<<1&0xaa
1005         return b3
1006 }
1007
1008 // asn1BitLength returns the bit-length of bitString by considering the
1009 // most-significant bit in a byte to be the "first" bit. This convention
1010 // matches ASN.1, but differs from almost everything else.
1011 func asn1BitLength(bitString []byte) int {
1012         bitLen := len(bitString) * 8
1013
1014         for i := range bitString {
1015                 b := bitString[len(bitString)-i-1]
1016
1017                 for bit := uint(0); bit < 8; bit++ {
1018                         if (b>>bit)&1 == 1 {
1019                                 return bitLen
1020                         }
1021                         bitLen--
1022                 }
1023         }
1024
1025         return 0
1026 }
1027
1028 var (
1029         oidExtensionSubjectKeyId          = []int{2, 5, 29, 14}
1030         oidExtensionKeyUsage              = []int{2, 5, 29, 15}
1031         oidExtensionExtendedKeyUsage      = []int{2, 5, 29, 37}
1032         oidExtensionAuthorityKeyId        = []int{2, 5, 29, 35}
1033         oidExtensionBasicConstraints      = []int{2, 5, 29, 19}
1034         oidExtensionSubjectAltName        = []int{2, 5, 29, 17}
1035         oidExtensionCertificatePolicies   = []int{2, 5, 29, 32}
1036         oidExtensionNameConstraints       = []int{2, 5, 29, 30}
1037         oidExtensionCRLDistributionPoints = []int{2, 5, 29, 31}
1038         oidExtensionAuthorityInfoAccess   = []int{1, 3, 6, 1, 5, 5, 7, 1, 1}
1039         oidExtensionCRLNumber             = []int{2, 5, 29, 20}
1040         oidExtensionReasonCode            = []int{2, 5, 29, 21}
1041 )
1042
1043 var (
1044         oidAuthorityInfoAccessOcsp    = asn1.ObjectIdentifier{1, 3, 6, 1, 5, 5, 7, 48, 1}
1045         oidAuthorityInfoAccessIssuers = asn1.ObjectIdentifier{1, 3, 6, 1, 5, 5, 7, 48, 2}
1046 )
1047
1048 // oidInExtensions reports whether an extension with the given oid exists in
1049 // extensions.
1050 func oidInExtensions(oid asn1.ObjectIdentifier, extensions []pkix.Extension) bool {
1051         for _, e := range extensions {
1052                 if e.Id.Equal(oid) {
1053                         return true
1054                 }
1055         }
1056         return false
1057 }
1058
1059 // marshalSANs marshals a list of addresses into a the contents of an X.509
1060 // SubjectAlternativeName extension.
1061 func marshalSANs(dnsNames, emailAddresses []string, ipAddresses []net.IP, uris []*url.URL) (derBytes []byte, err error) {
1062         var rawValues []asn1.RawValue
1063         for _, name := range dnsNames {
1064                 if err := isIA5String(name); err != nil {
1065                         return nil, err
1066                 }
1067                 rawValues = append(rawValues, asn1.RawValue{Tag: nameTypeDNS, Class: 2, Bytes: []byte(name)})
1068         }
1069         for _, email := range emailAddresses {
1070                 if err := isIA5String(email); err != nil {
1071                         return nil, err
1072                 }
1073                 rawValues = append(rawValues, asn1.RawValue{Tag: nameTypeEmail, Class: 2, Bytes: []byte(email)})
1074         }
1075         for _, rawIP := range ipAddresses {
1076                 // If possible, we always want to encode IPv4 addresses in 4 bytes.
1077                 ip := rawIP.To4()
1078                 if ip == nil {
1079                         ip = rawIP
1080                 }
1081                 rawValues = append(rawValues, asn1.RawValue{Tag: nameTypeIP, Class: 2, Bytes: ip})
1082         }
1083         for _, uri := range uris {
1084                 uriStr := uri.String()
1085                 if err := isIA5String(uriStr); err != nil {
1086                         return nil, err
1087                 }
1088                 rawValues = append(rawValues, asn1.RawValue{Tag: nameTypeURI, Class: 2, Bytes: []byte(uriStr)})
1089         }
1090         return asn1.Marshal(rawValues)
1091 }
1092
1093 func isIA5String(s string) error {
1094         for _, r := range s {
1095                 // Per RFC5280 "IA5String is limited to the set of ASCII characters"
1096                 if r > unicode.MaxASCII {
1097                         return fmt.Errorf("x509: %q cannot be encoded as an IA5String", s)
1098                 }
1099         }
1100
1101         return nil
1102 }
1103
1104 func buildCertExtensions(template *Certificate, subjectIsEmpty bool, authorityKeyId []byte, subjectKeyId []byte) (ret []pkix.Extension, err error) {
1105         ret = make([]pkix.Extension, 10 /* maximum number of elements. */)
1106         n := 0
1107
1108         if template.KeyUsage != 0 &&
1109                 !oidInExtensions(oidExtensionKeyUsage, template.ExtraExtensions) {
1110                 ret[n], err = marshalKeyUsage(template.KeyUsage)
1111                 if err != nil {
1112                         return nil, err
1113                 }
1114                 n++
1115         }
1116
1117         if (len(template.ExtKeyUsage) > 0 || len(template.UnknownExtKeyUsage) > 0) &&
1118                 !oidInExtensions(oidExtensionExtendedKeyUsage, template.ExtraExtensions) {
1119                 ret[n], err = marshalExtKeyUsage(template.ExtKeyUsage, template.UnknownExtKeyUsage)
1120                 if err != nil {
1121                         return nil, err
1122                 }
1123                 n++
1124         }
1125
1126         if template.BasicConstraintsValid && !oidInExtensions(oidExtensionBasicConstraints, template.ExtraExtensions) {
1127                 ret[n], err = marshalBasicConstraints(template.IsCA, template.MaxPathLen, template.MaxPathLenZero)
1128                 if err != nil {
1129                         return nil, err
1130                 }
1131                 n++
1132         }
1133
1134         if len(subjectKeyId) > 0 && !oidInExtensions(oidExtensionSubjectKeyId, template.ExtraExtensions) {
1135                 ret[n].Id = oidExtensionSubjectKeyId
1136                 ret[n].Value, err = asn1.Marshal(subjectKeyId)
1137                 if err != nil {
1138                         return
1139                 }
1140                 n++
1141         }
1142
1143         if len(authorityKeyId) > 0 && !oidInExtensions(oidExtensionAuthorityKeyId, template.ExtraExtensions) {
1144                 ret[n].Id = oidExtensionAuthorityKeyId
1145                 ret[n].Value, err = asn1.Marshal(authKeyId{authorityKeyId})
1146                 if err != nil {
1147                         return
1148                 }
1149                 n++
1150         }
1151
1152         if (len(template.OCSPServer) > 0 || len(template.IssuingCertificateURL) > 0) &&
1153                 !oidInExtensions(oidExtensionAuthorityInfoAccess, template.ExtraExtensions) {
1154                 ret[n].Id = oidExtensionAuthorityInfoAccess
1155                 var aiaValues []authorityInfoAccess
1156                 for _, name := range template.OCSPServer {
1157                         aiaValues = append(aiaValues, authorityInfoAccess{
1158                                 Method:   oidAuthorityInfoAccessOcsp,
1159                                 Location: asn1.RawValue{Tag: 6, Class: 2, Bytes: []byte(name)},
1160                         })
1161                 }
1162                 for _, name := range template.IssuingCertificateURL {
1163                         aiaValues = append(aiaValues, authorityInfoAccess{
1164                                 Method:   oidAuthorityInfoAccessIssuers,
1165                                 Location: asn1.RawValue{Tag: 6, Class: 2, Bytes: []byte(name)},
1166                         })
1167                 }
1168                 ret[n].Value, err = asn1.Marshal(aiaValues)
1169                 if err != nil {
1170                         return
1171                 }
1172                 n++
1173         }
1174
1175         if (len(template.DNSNames) > 0 || len(template.EmailAddresses) > 0 || len(template.IPAddresses) > 0 || len(template.URIs) > 0) &&
1176                 !oidInExtensions(oidExtensionSubjectAltName, template.ExtraExtensions) {
1177                 ret[n].Id = oidExtensionSubjectAltName
1178                 // From RFC 5280, Section 4.2.1.6:
1179                 // “If the subject field contains an empty sequence ... then
1180                 // subjectAltName extension ... is marked as critical”
1181                 ret[n].Critical = subjectIsEmpty
1182                 ret[n].Value, err = marshalSANs(template.DNSNames, template.EmailAddresses, template.IPAddresses, template.URIs)
1183                 if err != nil {
1184                         return
1185                 }
1186                 n++
1187         }
1188
1189         if len(template.PolicyIdentifiers) > 0 &&
1190                 !oidInExtensions(oidExtensionCertificatePolicies, template.ExtraExtensions) {
1191                 ret[n], err = marshalCertificatePolicies(template.Policies, template.PolicyIdentifiers)
1192                 if err != nil {
1193                         return nil, err
1194                 }
1195                 n++
1196         }
1197
1198         if (len(template.PermittedDNSDomains) > 0 || len(template.ExcludedDNSDomains) > 0 ||
1199                 len(template.PermittedIPRanges) > 0 || len(template.ExcludedIPRanges) > 0 ||
1200                 len(template.PermittedEmailAddresses) > 0 || len(template.ExcludedEmailAddresses) > 0 ||
1201                 len(template.PermittedURIDomains) > 0 || len(template.ExcludedURIDomains) > 0) &&
1202                 !oidInExtensions(oidExtensionNameConstraints, template.ExtraExtensions) {
1203                 ret[n].Id = oidExtensionNameConstraints
1204                 ret[n].Critical = template.PermittedDNSDomainsCritical
1205
1206                 ipAndMask := func(ipNet *net.IPNet) []byte {
1207                         maskedIP := ipNet.IP.Mask(ipNet.Mask)
1208                         ipAndMask := make([]byte, 0, len(maskedIP)+len(ipNet.Mask))
1209                         ipAndMask = append(ipAndMask, maskedIP...)
1210                         ipAndMask = append(ipAndMask, ipNet.Mask...)
1211                         return ipAndMask
1212                 }
1213
1214                 serialiseConstraints := func(dns []string, ips []*net.IPNet, emails []string, uriDomains []string) (der []byte, err error) {
1215                         var b cryptobyte.Builder
1216
1217                         for _, name := range dns {
1218                                 if err = isIA5String(name); err != nil {
1219                                         return nil, err
1220                                 }
1221
1222                                 b.AddASN1(cryptobyte_asn1.SEQUENCE, func(b *cryptobyte.Builder) {
1223                                         b.AddASN1(cryptobyte_asn1.Tag(2).ContextSpecific(), func(b *cryptobyte.Builder) {
1224                                                 b.AddBytes([]byte(name))
1225                                         })
1226                                 })
1227                         }
1228
1229                         for _, ipNet := range ips {
1230                                 b.AddASN1(cryptobyte_asn1.SEQUENCE, func(b *cryptobyte.Builder) {
1231                                         b.AddASN1(cryptobyte_asn1.Tag(7).ContextSpecific(), func(b *cryptobyte.Builder) {
1232                                                 b.AddBytes(ipAndMask(ipNet))
1233                                         })
1234                                 })
1235                         }
1236
1237                         for _, email := range emails {
1238                                 if err = isIA5String(email); err != nil {
1239                                         return nil, err
1240                                 }
1241
1242                                 b.AddASN1(cryptobyte_asn1.SEQUENCE, func(b *cryptobyte.Builder) {
1243                                         b.AddASN1(cryptobyte_asn1.Tag(1).ContextSpecific(), func(b *cryptobyte.Builder) {
1244                                                 b.AddBytes([]byte(email))
1245                                         })
1246                                 })
1247                         }
1248
1249                         for _, uriDomain := range uriDomains {
1250                                 if err = isIA5String(uriDomain); err != nil {
1251                                         return nil, err
1252                                 }
1253
1254                                 b.AddASN1(cryptobyte_asn1.SEQUENCE, func(b *cryptobyte.Builder) {
1255                                         b.AddASN1(cryptobyte_asn1.Tag(6).ContextSpecific(), func(b *cryptobyte.Builder) {
1256                                                 b.AddBytes([]byte(uriDomain))
1257                                         })
1258                                 })
1259                         }
1260
1261                         return b.Bytes()
1262                 }
1263
1264                 permitted, err := serialiseConstraints(template.PermittedDNSDomains, template.PermittedIPRanges, template.PermittedEmailAddresses, template.PermittedURIDomains)
1265                 if err != nil {
1266                         return nil, err
1267                 }
1268
1269                 excluded, err := serialiseConstraints(template.ExcludedDNSDomains, template.ExcludedIPRanges, template.ExcludedEmailAddresses, template.ExcludedURIDomains)
1270                 if err != nil {
1271                         return nil, err
1272                 }
1273
1274                 var b cryptobyte.Builder
1275                 b.AddASN1(cryptobyte_asn1.SEQUENCE, func(b *cryptobyte.Builder) {
1276                         if len(permitted) > 0 {
1277                                 b.AddASN1(cryptobyte_asn1.Tag(0).ContextSpecific().Constructed(), func(b *cryptobyte.Builder) {
1278                                         b.AddBytes(permitted)
1279                                 })
1280                         }
1281
1282                         if len(excluded) > 0 {
1283                                 b.AddASN1(cryptobyte_asn1.Tag(1).ContextSpecific().Constructed(), func(b *cryptobyte.Builder) {
1284                                         b.AddBytes(excluded)
1285                                 })
1286                         }
1287                 })
1288
1289                 ret[n].Value, err = b.Bytes()
1290                 if err != nil {
1291                         return nil, err
1292                 }
1293                 n++
1294         }
1295
1296         if len(template.CRLDistributionPoints) > 0 &&
1297                 !oidInExtensions(oidExtensionCRLDistributionPoints, template.ExtraExtensions) {
1298                 ret[n].Id = oidExtensionCRLDistributionPoints
1299
1300                 var crlDp []distributionPoint
1301                 for _, name := range template.CRLDistributionPoints {
1302                         dp := distributionPoint{
1303                                 DistributionPoint: distributionPointName{
1304                                         FullName: []asn1.RawValue{
1305                                                 {Tag: 6, Class: 2, Bytes: []byte(name)},
1306                                         },
1307                                 },
1308                         }
1309                         crlDp = append(crlDp, dp)
1310                 }
1311
1312                 ret[n].Value, err = asn1.Marshal(crlDp)
1313                 if err != nil {
1314                         return
1315                 }
1316                 n++
1317         }
1318
1319         // Adding another extension here? Remember to update the maximum number
1320         // of elements in the make() at the top of the function and the list of
1321         // template fields used in CreateCertificate documentation.
1322
1323         return append(ret[:n], template.ExtraExtensions...), nil
1324 }
1325
1326 func marshalKeyUsage(ku KeyUsage) (pkix.Extension, error) {
1327         ext := pkix.Extension{Id: oidExtensionKeyUsage, Critical: true}
1328
1329         var a [2]byte
1330         a[0] = reverseBitsInAByte(byte(ku))
1331         a[1] = reverseBitsInAByte(byte(ku >> 8))
1332
1333         l := 1
1334         if a[1] != 0 {
1335                 l = 2
1336         }
1337
1338         bitString := a[:l]
1339         var err error
1340         ext.Value, err = asn1.Marshal(asn1.BitString{Bytes: bitString, BitLength: asn1BitLength(bitString)})
1341         return ext, err
1342 }
1343
1344 func marshalExtKeyUsage(extUsages []ExtKeyUsage, unknownUsages []asn1.ObjectIdentifier) (pkix.Extension, error) {
1345         ext := pkix.Extension{Id: oidExtensionExtendedKeyUsage}
1346
1347         oids := make([]asn1.ObjectIdentifier, len(extUsages)+len(unknownUsages))
1348         for i, u := range extUsages {
1349                 if oid, ok := oidFromExtKeyUsage(u); ok {
1350                         oids[i] = oid
1351                 } else {
1352                         return ext, errors.New("x509: unknown extended key usage")
1353                 }
1354         }
1355
1356         copy(oids[len(extUsages):], unknownUsages)
1357
1358         var err error
1359         ext.Value, err = asn1.Marshal(oids)
1360         return ext, err
1361 }
1362
1363 func marshalBasicConstraints(isCA bool, maxPathLen int, maxPathLenZero bool) (pkix.Extension, error) {
1364         ext := pkix.Extension{Id: oidExtensionBasicConstraints, Critical: true}
1365         // Leaving MaxPathLen as zero indicates that no maximum path
1366         // length is desired, unless MaxPathLenZero is set. A value of
1367         // -1 causes encoding/asn1 to omit the value as desired.
1368         if maxPathLen == 0 && !maxPathLenZero {
1369                 maxPathLen = -1
1370         }
1371         var err error
1372         ext.Value, err = asn1.Marshal(basicConstraints{isCA, maxPathLen})
1373         return ext, err
1374 }
1375
1376 func marshalCertificatePolicies(policies []OID, policyIdentifiers []asn1.ObjectIdentifier) (pkix.Extension, error) {
1377         ext := pkix.Extension{Id: oidExtensionCertificatePolicies}
1378
1379         b := cryptobyte.NewBuilder(make([]byte, 0, 128))
1380         b.AddASN1(cryptobyte_asn1.SEQUENCE, func(child *cryptobyte.Builder) {
1381                 for _, v := range policies {
1382                         child.AddASN1(cryptobyte_asn1.SEQUENCE, func(child *cryptobyte.Builder) {
1383                                 child.AddASN1(cryptobyte_asn1.OBJECT_IDENTIFIER, func(child *cryptobyte.Builder) {
1384                                         child.AddBytes(v.der)
1385                                 })
1386                         })
1387                 }
1388                 for _, v := range policyIdentifiers {
1389                         child.AddASN1(cryptobyte_asn1.SEQUENCE, func(child *cryptobyte.Builder) {
1390                                 child.AddASN1ObjectIdentifier(v)
1391                         })
1392                 }
1393         })
1394
1395         var err error
1396         ext.Value, err = b.Bytes()
1397         return ext, err
1398 }
1399
1400 func buildCSRExtensions(template *CertificateRequest) ([]pkix.Extension, error) {
1401         var ret []pkix.Extension
1402
1403         if (len(template.DNSNames) > 0 || len(template.EmailAddresses) > 0 || len(template.IPAddresses) > 0 || len(template.URIs) > 0) &&
1404                 !oidInExtensions(oidExtensionSubjectAltName, template.ExtraExtensions) {
1405                 sanBytes, err := marshalSANs(template.DNSNames, template.EmailAddresses, template.IPAddresses, template.URIs)
1406                 if err != nil {
1407                         return nil, err
1408                 }
1409
1410                 ret = append(ret, pkix.Extension{
1411                         Id:    oidExtensionSubjectAltName,
1412                         Value: sanBytes,
1413                 })
1414         }
1415
1416         return append(ret, template.ExtraExtensions...), nil
1417 }
1418
1419 func subjectBytes(cert *Certificate) ([]byte, error) {
1420         if len(cert.RawSubject) > 0 {
1421                 return cert.RawSubject, nil
1422         }
1423
1424         return asn1.Marshal(cert.Subject.ToRDNSequence())
1425 }
1426
1427 // signingParamsForPublicKey returns the parameters to use for signing with
1428 // priv. If requestedSigAlgo is not zero then it overrides the default
1429 // signature algorithm.
1430 func signingParamsForPublicKey(pub any, requestedSigAlgo SignatureAlgorithm) (hashFunc crypto.Hash, sigAlgo pkix.AlgorithmIdentifier, err error) {
1431         var pubType PublicKeyAlgorithm
1432
1433         switch pub := pub.(type) {
1434         case *rsa.PublicKey:
1435                 pubType = RSA
1436                 hashFunc = crypto.SHA256
1437                 sigAlgo.Algorithm = oidSignatureSHA256WithRSA
1438                 sigAlgo.Parameters = asn1.NullRawValue
1439
1440         case *ecdsa.PublicKey:
1441                 pubType = ECDSA
1442
1443                 switch pub.Curve {
1444                 case elliptic.P224(), elliptic.P256():
1445                         hashFunc = crypto.SHA256
1446                         sigAlgo.Algorithm = oidSignatureECDSAWithSHA256
1447                 case elliptic.P384():
1448                         hashFunc = crypto.SHA384
1449                         sigAlgo.Algorithm = oidSignatureECDSAWithSHA384
1450                 case elliptic.P521():
1451                         hashFunc = crypto.SHA512
1452                         sigAlgo.Algorithm = oidSignatureECDSAWithSHA512
1453                 default:
1454                         err = errors.New("x509: unknown elliptic curve")
1455                 }
1456
1457         case ed25519.PublicKey:
1458                 pubType = Ed25519
1459                 sigAlgo.Algorithm = oidSignatureEd25519
1460
1461         default:
1462                 err = errors.New("x509: only RSA, ECDSA and Ed25519 keys supported")
1463         }
1464
1465         if err != nil {
1466                 return
1467         }
1468
1469         if requestedSigAlgo == 0 {
1470                 return
1471         }
1472
1473         found := false
1474         for _, details := range signatureAlgorithmDetails {
1475                 if details.algo == requestedSigAlgo {
1476                         if details.pubKeyAlgo != pubType {
1477                                 err = errors.New("x509: requested SignatureAlgorithm does not match private key type")
1478                                 return
1479                         }
1480                         sigAlgo.Algorithm, hashFunc = details.oid, details.hash
1481                         if hashFunc == 0 && pubType != Ed25519 {
1482                                 err = errors.New("x509: cannot sign with hash function requested")
1483                                 return
1484                         }
1485                         if hashFunc == crypto.MD5 {
1486                                 err = errors.New("x509: signing with MD5 is not supported")
1487                                 return
1488                         }
1489                         if requestedSigAlgo.isRSAPSS() {
1490                                 sigAlgo.Parameters = hashToPSSParameters[hashFunc]
1491                         }
1492                         found = true
1493                         break
1494                 }
1495         }
1496
1497         if !found {
1498                 err = errors.New("x509: unknown SignatureAlgorithm")
1499         }
1500
1501         return
1502 }
1503
1504 // emptyASN1Subject is the ASN.1 DER encoding of an empty Subject, which is
1505 // just an empty SEQUENCE.
1506 var emptyASN1Subject = []byte{0x30, 0}
1507
1508 // CreateCertificate creates a new X.509 v3 certificate based on a template.
1509 // The following members of template are currently used:
1510 //
1511 //   - AuthorityKeyId
1512 //   - BasicConstraintsValid
1513 //   - CRLDistributionPoints
1514 //   - DNSNames
1515 //   - EmailAddresses
1516 //   - ExcludedDNSDomains
1517 //   - ExcludedEmailAddresses
1518 //   - ExcludedIPRanges
1519 //   - ExcludedURIDomains
1520 //   - ExtKeyUsage
1521 //   - ExtraExtensions
1522 //   - IPAddresses
1523 //   - IsCA
1524 //   - IssuingCertificateURL
1525 //   - KeyUsage
1526 //   - MaxPathLen
1527 //   - MaxPathLenZero
1528 //   - NotAfter
1529 //   - NotBefore
1530 //   - OCSPServer
1531 //   - PermittedDNSDomains
1532 //   - PermittedDNSDomainsCritical
1533 //   - PermittedEmailAddresses
1534 //   - PermittedIPRanges
1535 //   - PermittedURIDomains
1536 //   - PolicyIdentifiers
1537 //   - SerialNumber
1538 //   - SignatureAlgorithm
1539 //   - Subject
1540 //   - SubjectKeyId
1541 //   - URIs
1542 //   - UnknownExtKeyUsage
1543 //
1544 // The certificate is signed by parent. If parent is equal to template then the
1545 // certificate is self-signed. The parameter pub is the public key of the
1546 // certificate to be generated and priv is the private key of the signer.
1547 //
1548 // The returned slice is the certificate in DER encoding.
1549 //
1550 // The currently supported key types are *rsa.PublicKey, *ecdsa.PublicKey and
1551 // ed25519.PublicKey. pub must be a supported key type, and priv must be a
1552 // crypto.Signer with a supported public key.
1553 //
1554 // The AuthorityKeyId will be taken from the SubjectKeyId of parent, if any,
1555 // unless the resulting certificate is self-signed. Otherwise the value from
1556 // template will be used.
1557 //
1558 // If SubjectKeyId from template is empty and the template is a CA, SubjectKeyId
1559 // will be generated from the hash of the public key.
1560 func CreateCertificate(rand io.Reader, template, parent *Certificate, pub, priv any) ([]byte, error) {
1561         key, ok := priv.(crypto.Signer)
1562         if !ok {
1563                 return nil, errors.New("x509: certificate private key does not implement crypto.Signer")
1564         }
1565
1566         if template.SerialNumber == nil {
1567                 return nil, errors.New("x509: no SerialNumber given")
1568         }
1569
1570         // RFC 5280 Section 4.1.2.2: serial number must positive
1571         //
1572         // We _should_ also restrict serials to <= 20 octets, but it turns out a lot of people
1573         // get this wrong, in part because the encoding can itself alter the length of the
1574         // serial. For now we accept these non-conformant serials.
1575         if template.SerialNumber.Sign() == -1 {
1576                 return nil, errors.New("x509: serial number must be positive")
1577         }
1578
1579         if template.BasicConstraintsValid && !template.IsCA && template.MaxPathLen != -1 && (template.MaxPathLen != 0 || template.MaxPathLenZero) {
1580                 return nil, errors.New("x509: only CAs are allowed to specify MaxPathLen")
1581         }
1582
1583         hashFunc, signatureAlgorithm, err := signingParamsForPublicKey(key.Public(), template.SignatureAlgorithm)
1584         if err != nil {
1585                 return nil, err
1586         }
1587
1588         publicKeyBytes, publicKeyAlgorithm, err := marshalPublicKey(pub)
1589         if err != nil {
1590                 return nil, err
1591         }
1592         if getPublicKeyAlgorithmFromOID(publicKeyAlgorithm.Algorithm) == UnknownPublicKeyAlgorithm {
1593                 return nil, fmt.Errorf("x509: unsupported public key type: %T", pub)
1594         }
1595
1596         asn1Issuer, err := subjectBytes(parent)
1597         if err != nil {
1598                 return nil, err
1599         }
1600
1601         asn1Subject, err := subjectBytes(template)
1602         if err != nil {
1603                 return nil, err
1604         }
1605
1606         authorityKeyId := template.AuthorityKeyId
1607         if !bytes.Equal(asn1Issuer, asn1Subject) && len(parent.SubjectKeyId) > 0 {
1608                 authorityKeyId = parent.SubjectKeyId
1609         }
1610
1611         subjectKeyId := template.SubjectKeyId
1612         if len(subjectKeyId) == 0 && template.IsCA {
1613                 // SubjectKeyId generated using method 1 in RFC 5280, Section 4.2.1.2:
1614                 //   (1) The keyIdentifier is composed of the 160-bit SHA-1 hash of the
1615                 //   value of the BIT STRING subjectPublicKey (excluding the tag,
1616                 //   length, and number of unused bits).
1617                 h := sha1.Sum(publicKeyBytes)
1618                 subjectKeyId = h[:]
1619         }
1620
1621         // Check that the signer's public key matches the private key, if available.
1622         type privateKey interface {
1623                 Equal(crypto.PublicKey) bool
1624         }
1625         if privPub, ok := key.Public().(privateKey); !ok {
1626                 return nil, errors.New("x509: internal error: supported public key does not implement Equal")
1627         } else if parent.PublicKey != nil && !privPub.Equal(parent.PublicKey) {
1628                 return nil, errors.New("x509: provided PrivateKey doesn't match parent's PublicKey")
1629         }
1630
1631         extensions, err := buildCertExtensions(template, bytes.Equal(asn1Subject, emptyASN1Subject), authorityKeyId, subjectKeyId)
1632         if err != nil {
1633                 return nil, err
1634         }
1635
1636         encodedPublicKey := asn1.BitString{BitLength: len(publicKeyBytes) * 8, Bytes: publicKeyBytes}
1637         c := tbsCertificate{
1638                 Version:            2,
1639                 SerialNumber:       template.SerialNumber,
1640                 SignatureAlgorithm: signatureAlgorithm,
1641                 Issuer:             asn1.RawValue{FullBytes: asn1Issuer},
1642                 Validity:           validity{template.NotBefore.UTC(), template.NotAfter.UTC()},
1643                 Subject:            asn1.RawValue{FullBytes: asn1Subject},
1644                 PublicKey:          publicKeyInfo{nil, publicKeyAlgorithm, encodedPublicKey},
1645                 Extensions:         extensions,
1646         }
1647
1648         tbsCertContents, err := asn1.Marshal(c)
1649         if err != nil {
1650                 return nil, err
1651         }
1652         c.Raw = tbsCertContents
1653
1654         signed := tbsCertContents
1655         if hashFunc != 0 {
1656                 h := hashFunc.New()
1657                 h.Write(signed)
1658                 signed = h.Sum(nil)
1659         }
1660
1661         var signerOpts crypto.SignerOpts = hashFunc
1662         if template.SignatureAlgorithm != 0 && template.SignatureAlgorithm.isRSAPSS() {
1663                 signerOpts = &rsa.PSSOptions{
1664                         SaltLength: rsa.PSSSaltLengthEqualsHash,
1665                         Hash:       hashFunc,
1666                 }
1667         }
1668
1669         var signature []byte
1670         signature, err = key.Sign(rand, signed, signerOpts)
1671         if err != nil {
1672                 return nil, err
1673         }
1674
1675         signedCert, err := asn1.Marshal(certificate{
1676                 c,
1677                 signatureAlgorithm,
1678                 asn1.BitString{Bytes: signature, BitLength: len(signature) * 8},
1679         })
1680         if err != nil {
1681                 return nil, err
1682         }
1683
1684         // Check the signature to ensure the crypto.Signer behaved correctly.
1685         if err := checkSignature(getSignatureAlgorithmFromAI(signatureAlgorithm), c.Raw, signature, key.Public(), true); err != nil {
1686                 return nil, fmt.Errorf("x509: signature over certificate returned by signer is invalid: %w", err)
1687         }
1688
1689         return signedCert, nil
1690 }
1691
1692 // pemCRLPrefix is the magic string that indicates that we have a PEM encoded
1693 // CRL.
1694 var pemCRLPrefix = []byte("-----BEGIN X509 CRL")
1695
1696 // pemType is the type of a PEM encoded CRL.
1697 var pemType = "X509 CRL"
1698
1699 // ParseCRL parses a CRL from the given bytes. It's often the case that PEM
1700 // encoded CRLs will appear where they should be DER encoded, so this function
1701 // will transparently handle PEM encoding as long as there isn't any leading
1702 // garbage.
1703 //
1704 // Deprecated: Use [ParseRevocationList] instead.
1705 func ParseCRL(crlBytes []byte) (*pkix.CertificateList, error) {
1706         if bytes.HasPrefix(crlBytes, pemCRLPrefix) {
1707                 block, _ := pem.Decode(crlBytes)
1708                 if block != nil && block.Type == pemType {
1709                         crlBytes = block.Bytes
1710                 }
1711         }
1712         return ParseDERCRL(crlBytes)
1713 }
1714
1715 // ParseDERCRL parses a DER encoded CRL from the given bytes.
1716 //
1717 // Deprecated: Use [ParseRevocationList] instead.
1718 func ParseDERCRL(derBytes []byte) (*pkix.CertificateList, error) {
1719         certList := new(pkix.CertificateList)
1720         if rest, err := asn1.Unmarshal(derBytes, certList); err != nil {
1721                 return nil, err
1722         } else if len(rest) != 0 {
1723                 return nil, errors.New("x509: trailing data after CRL")
1724         }
1725         return certList, nil
1726 }
1727
1728 // CreateCRL returns a DER encoded CRL, signed by this Certificate, that
1729 // contains the given list of revoked certificates.
1730 //
1731 // Deprecated: this method does not generate an RFC 5280 conformant X.509 v2 CRL.
1732 // To generate a standards compliant CRL, use [CreateRevocationList] instead.
1733 func (c *Certificate) CreateCRL(rand io.Reader, priv any, revokedCerts []pkix.RevokedCertificate, now, expiry time.Time) (crlBytes []byte, err error) {
1734         key, ok := priv.(crypto.Signer)
1735         if !ok {
1736                 return nil, errors.New("x509: certificate private key does not implement crypto.Signer")
1737         }
1738
1739         hashFunc, signatureAlgorithm, err := signingParamsForPublicKey(key.Public(), 0)
1740         if err != nil {
1741                 return nil, err
1742         }
1743
1744         // Force revocation times to UTC per RFC 5280.
1745         revokedCertsUTC := make([]pkix.RevokedCertificate, len(revokedCerts))
1746         for i, rc := range revokedCerts {
1747                 rc.RevocationTime = rc.RevocationTime.UTC()
1748                 revokedCertsUTC[i] = rc
1749         }
1750
1751         tbsCertList := pkix.TBSCertificateList{
1752                 Version:             1,
1753                 Signature:           signatureAlgorithm,
1754                 Issuer:              c.Subject.ToRDNSequence(),
1755                 ThisUpdate:          now.UTC(),
1756                 NextUpdate:          expiry.UTC(),
1757                 RevokedCertificates: revokedCertsUTC,
1758         }
1759
1760         // Authority Key Id
1761         if len(c.SubjectKeyId) > 0 {
1762                 var aki pkix.Extension
1763                 aki.Id = oidExtensionAuthorityKeyId
1764                 aki.Value, err = asn1.Marshal(authKeyId{Id: c.SubjectKeyId})
1765                 if err != nil {
1766                         return
1767                 }
1768                 tbsCertList.Extensions = append(tbsCertList.Extensions, aki)
1769         }
1770
1771         tbsCertListContents, err := asn1.Marshal(tbsCertList)
1772         if err != nil {
1773                 return
1774         }
1775
1776         signed := tbsCertListContents
1777         if hashFunc != 0 {
1778                 h := hashFunc.New()
1779                 h.Write(signed)
1780                 signed = h.Sum(nil)
1781         }
1782
1783         var signature []byte
1784         signature, err = key.Sign(rand, signed, hashFunc)
1785         if err != nil {
1786                 return
1787         }
1788
1789         return asn1.Marshal(pkix.CertificateList{
1790                 TBSCertList:        tbsCertList,
1791                 SignatureAlgorithm: signatureAlgorithm,
1792                 SignatureValue:     asn1.BitString{Bytes: signature, BitLength: len(signature) * 8},
1793         })
1794 }
1795
1796 // CertificateRequest represents a PKCS #10, certificate signature request.
1797 type CertificateRequest struct {
1798         Raw                      []byte // Complete ASN.1 DER content (CSR, signature algorithm and signature).
1799         RawTBSCertificateRequest []byte // Certificate request info part of raw ASN.1 DER content.
1800         RawSubjectPublicKeyInfo  []byte // DER encoded SubjectPublicKeyInfo.
1801         RawSubject               []byte // DER encoded Subject.
1802
1803         Version            int
1804         Signature          []byte
1805         SignatureAlgorithm SignatureAlgorithm
1806
1807         PublicKeyAlgorithm PublicKeyAlgorithm
1808         PublicKey          any
1809
1810         Subject pkix.Name
1811
1812         // Attributes contains the CSR attributes that can parse as
1813         // pkix.AttributeTypeAndValueSET.
1814         //
1815         // Deprecated: Use Extensions and ExtraExtensions instead for parsing and
1816         // generating the requestedExtensions attribute.
1817         Attributes []pkix.AttributeTypeAndValueSET
1818
1819         // Extensions contains all requested extensions, in raw form. When parsing
1820         // CSRs, this can be used to extract extensions that are not parsed by this
1821         // package.
1822         Extensions []pkix.Extension
1823
1824         // ExtraExtensions contains extensions to be copied, raw, into any CSR
1825         // marshaled by CreateCertificateRequest. Values override any extensions
1826         // that would otherwise be produced based on the other fields but are
1827         // overridden by any extensions specified in Attributes.
1828         //
1829         // The ExtraExtensions field is not populated by ParseCertificateRequest,
1830         // see Extensions instead.
1831         ExtraExtensions []pkix.Extension
1832
1833         // Subject Alternate Name values.
1834         DNSNames       []string
1835         EmailAddresses []string
1836         IPAddresses    []net.IP
1837         URIs           []*url.URL
1838 }
1839
1840 // These structures reflect the ASN.1 structure of X.509 certificate
1841 // signature requests (see RFC 2986):
1842
1843 type tbsCertificateRequest struct {
1844         Raw           asn1.RawContent
1845         Version       int
1846         Subject       asn1.RawValue
1847         PublicKey     publicKeyInfo
1848         RawAttributes []asn1.RawValue `asn1:"tag:0"`
1849 }
1850
1851 type certificateRequest struct {
1852         Raw                asn1.RawContent
1853         TBSCSR             tbsCertificateRequest
1854         SignatureAlgorithm pkix.AlgorithmIdentifier
1855         SignatureValue     asn1.BitString
1856 }
1857
1858 // oidExtensionRequest is a PKCS #9 OBJECT IDENTIFIER that indicates requested
1859 // extensions in a CSR.
1860 var oidExtensionRequest = asn1.ObjectIdentifier{1, 2, 840, 113549, 1, 9, 14}
1861
1862 // newRawAttributes converts AttributeTypeAndValueSETs from a template
1863 // CertificateRequest's Attributes into tbsCertificateRequest RawAttributes.
1864 func newRawAttributes(attributes []pkix.AttributeTypeAndValueSET) ([]asn1.RawValue, error) {
1865         var rawAttributes []asn1.RawValue
1866         b, err := asn1.Marshal(attributes)
1867         if err != nil {
1868                 return nil, err
1869         }
1870         rest, err := asn1.Unmarshal(b, &rawAttributes)
1871         if err != nil {
1872                 return nil, err
1873         }
1874         if len(rest) != 0 {
1875                 return nil, errors.New("x509: failed to unmarshal raw CSR Attributes")
1876         }
1877         return rawAttributes, nil
1878 }
1879
1880 // parseRawAttributes Unmarshals RawAttributes into AttributeTypeAndValueSETs.
1881 func parseRawAttributes(rawAttributes []asn1.RawValue) []pkix.AttributeTypeAndValueSET {
1882         var attributes []pkix.AttributeTypeAndValueSET
1883         for _, rawAttr := range rawAttributes {
1884                 var attr pkix.AttributeTypeAndValueSET
1885                 rest, err := asn1.Unmarshal(rawAttr.FullBytes, &attr)
1886                 // Ignore attributes that don't parse into pkix.AttributeTypeAndValueSET
1887                 // (i.e.: challengePassword or unstructuredName).
1888                 if err == nil && len(rest) == 0 {
1889                         attributes = append(attributes, attr)
1890                 }
1891         }
1892         return attributes
1893 }
1894
1895 // parseCSRExtensions parses the attributes from a CSR and extracts any
1896 // requested extensions.
1897 func parseCSRExtensions(rawAttributes []asn1.RawValue) ([]pkix.Extension, error) {
1898         // pkcs10Attribute reflects the Attribute structure from RFC 2986, Section 4.1.
1899         type pkcs10Attribute struct {
1900                 Id     asn1.ObjectIdentifier
1901                 Values []asn1.RawValue `asn1:"set"`
1902         }
1903
1904         var ret []pkix.Extension
1905         requestedExts := make(map[string]bool)
1906         for _, rawAttr := range rawAttributes {
1907                 var attr pkcs10Attribute
1908                 if rest, err := asn1.Unmarshal(rawAttr.FullBytes, &attr); err != nil || len(rest) != 0 || len(attr.Values) == 0 {
1909                         // Ignore attributes that don't parse.
1910                         continue
1911                 }
1912
1913                 if !attr.Id.Equal(oidExtensionRequest) {
1914                         continue
1915                 }
1916
1917                 var extensions []pkix.Extension
1918                 if _, err := asn1.Unmarshal(attr.Values[0].FullBytes, &extensions); err != nil {
1919                         return nil, err
1920                 }
1921                 for _, ext := range extensions {
1922                         oidStr := ext.Id.String()
1923                         if requestedExts[oidStr] {
1924                                 return nil, errors.New("x509: certificate request contains duplicate requested extensions")
1925                         }
1926                         requestedExts[oidStr] = true
1927                 }
1928                 ret = append(ret, extensions...)
1929         }
1930
1931         return ret, nil
1932 }
1933
1934 // CreateCertificateRequest creates a new certificate request based on a
1935 // template. The following members of template are used:
1936 //
1937 //   - SignatureAlgorithm
1938 //   - Subject
1939 //   - DNSNames
1940 //   - EmailAddresses
1941 //   - IPAddresses
1942 //   - URIs
1943 //   - ExtraExtensions
1944 //   - Attributes (deprecated)
1945 //
1946 // priv is the private key to sign the CSR with, and the corresponding public
1947 // key will be included in the CSR. It must implement crypto.Signer and its
1948 // Public() method must return a *rsa.PublicKey or a *ecdsa.PublicKey or a
1949 // ed25519.PublicKey. (A *rsa.PrivateKey, *ecdsa.PrivateKey or
1950 // ed25519.PrivateKey satisfies this.)
1951 //
1952 // The returned slice is the certificate request in DER encoding.
1953 func CreateCertificateRequest(rand io.Reader, template *CertificateRequest, priv any) (csr []byte, err error) {
1954         key, ok := priv.(crypto.Signer)
1955         if !ok {
1956                 return nil, errors.New("x509: certificate private key does not implement crypto.Signer")
1957         }
1958
1959         var hashFunc crypto.Hash
1960         var sigAlgo pkix.AlgorithmIdentifier
1961         hashFunc, sigAlgo, err = signingParamsForPublicKey(key.Public(), template.SignatureAlgorithm)
1962         if err != nil {
1963                 return nil, err
1964         }
1965
1966         var publicKeyBytes []byte
1967         var publicKeyAlgorithm pkix.AlgorithmIdentifier
1968         publicKeyBytes, publicKeyAlgorithm, err = marshalPublicKey(key.Public())
1969         if err != nil {
1970                 return nil, err
1971         }
1972
1973         extensions, err := buildCSRExtensions(template)
1974         if err != nil {
1975                 return nil, err
1976         }
1977
1978         // Make a copy of template.Attributes because we may alter it below.
1979         attributes := make([]pkix.AttributeTypeAndValueSET, 0, len(template.Attributes))
1980         for _, attr := range template.Attributes {
1981                 values := make([][]pkix.AttributeTypeAndValue, len(attr.Value))
1982                 copy(values, attr.Value)
1983                 attributes = append(attributes, pkix.AttributeTypeAndValueSET{
1984                         Type:  attr.Type,
1985                         Value: values,
1986                 })
1987         }
1988
1989         extensionsAppended := false
1990         if len(extensions) > 0 {
1991                 // Append the extensions to an existing attribute if possible.
1992                 for _, atvSet := range attributes {
1993                         if !atvSet.Type.Equal(oidExtensionRequest) || len(atvSet.Value) == 0 {
1994                                 continue
1995                         }
1996
1997                         // specifiedExtensions contains all the extensions that we
1998                         // found specified via template.Attributes.
1999                         specifiedExtensions := make(map[string]bool)
2000
2001                         for _, atvs := range atvSet.Value {
2002                                 for _, atv := range atvs {
2003                                         specifiedExtensions[atv.Type.String()] = true
2004                                 }
2005                         }
2006
2007                         newValue := make([]pkix.AttributeTypeAndValue, 0, len(atvSet.Value[0])+len(extensions))
2008                         newValue = append(newValue, atvSet.Value[0]...)
2009
2010                         for _, e := range extensions {
2011                                 if specifiedExtensions[e.Id.String()] {
2012                                         // Attributes already contained a value for
2013                                         // this extension and it takes priority.
2014                                         continue
2015                                 }
2016
2017                                 newValue = append(newValue, pkix.AttributeTypeAndValue{
2018                                         // There is no place for the critical
2019                                         // flag in an AttributeTypeAndValue.
2020                                         Type:  e.Id,
2021                                         Value: e.Value,
2022                                 })
2023                         }
2024
2025                         atvSet.Value[0] = newValue
2026                         extensionsAppended = true
2027                         break
2028                 }
2029         }
2030
2031         rawAttributes, err := newRawAttributes(attributes)
2032         if err != nil {
2033                 return
2034         }
2035
2036         // If not included in attributes, add a new attribute for the
2037         // extensions.
2038         if len(extensions) > 0 && !extensionsAppended {
2039                 attr := struct {
2040                         Type  asn1.ObjectIdentifier
2041                         Value [][]pkix.Extension `asn1:"set"`
2042                 }{
2043                         Type:  oidExtensionRequest,
2044                         Value: [][]pkix.Extension{extensions},
2045                 }
2046
2047                 b, err := asn1.Marshal(attr)
2048                 if err != nil {
2049                         return nil, errors.New("x509: failed to serialise extensions attribute: " + err.Error())
2050                 }
2051
2052                 var rawValue asn1.RawValue
2053                 if _, err := asn1.Unmarshal(b, &rawValue); err != nil {
2054                         return nil, err
2055                 }
2056
2057                 rawAttributes = append(rawAttributes, rawValue)
2058         }
2059
2060         asn1Subject := template.RawSubject
2061         if len(asn1Subject) == 0 {
2062                 asn1Subject, err = asn1.Marshal(template.Subject.ToRDNSequence())
2063                 if err != nil {
2064                         return nil, err
2065                 }
2066         }
2067
2068         tbsCSR := tbsCertificateRequest{
2069                 Version: 0, // PKCS #10, RFC 2986
2070                 Subject: asn1.RawValue{FullBytes: asn1Subject},
2071                 PublicKey: publicKeyInfo{
2072                         Algorithm: publicKeyAlgorithm,
2073                         PublicKey: asn1.BitString{
2074                                 Bytes:     publicKeyBytes,
2075                                 BitLength: len(publicKeyBytes) * 8,
2076                         },
2077                 },
2078                 RawAttributes: rawAttributes,
2079         }
2080
2081         tbsCSRContents, err := asn1.Marshal(tbsCSR)
2082         if err != nil {
2083                 return
2084         }
2085         tbsCSR.Raw = tbsCSRContents
2086
2087         signed := tbsCSRContents
2088         if hashFunc != 0 {
2089                 h := hashFunc.New()
2090                 h.Write(signed)
2091                 signed = h.Sum(nil)
2092         }
2093
2094         var signature []byte
2095         signature, err = key.Sign(rand, signed, hashFunc)
2096         if err != nil {
2097                 return
2098         }
2099
2100         return asn1.Marshal(certificateRequest{
2101                 TBSCSR:             tbsCSR,
2102                 SignatureAlgorithm: sigAlgo,
2103                 SignatureValue: asn1.BitString{
2104                         Bytes:     signature,
2105                         BitLength: len(signature) * 8,
2106                 },
2107         })
2108 }
2109
2110 // ParseCertificateRequest parses a single certificate request from the
2111 // given ASN.1 DER data.
2112 func ParseCertificateRequest(asn1Data []byte) (*CertificateRequest, error) {
2113         var csr certificateRequest
2114
2115         rest, err := asn1.Unmarshal(asn1Data, &csr)
2116         if err != nil {
2117                 return nil, err
2118         } else if len(rest) != 0 {
2119                 return nil, asn1.SyntaxError{Msg: "trailing data"}
2120         }
2121
2122         return parseCertificateRequest(&csr)
2123 }
2124
2125 func parseCertificateRequest(in *certificateRequest) (*CertificateRequest, error) {
2126         out := &CertificateRequest{
2127                 Raw:                      in.Raw,
2128                 RawTBSCertificateRequest: in.TBSCSR.Raw,
2129                 RawSubjectPublicKeyInfo:  in.TBSCSR.PublicKey.Raw,
2130                 RawSubject:               in.TBSCSR.Subject.FullBytes,
2131
2132                 Signature:          in.SignatureValue.RightAlign(),
2133                 SignatureAlgorithm: getSignatureAlgorithmFromAI(in.SignatureAlgorithm),
2134
2135                 PublicKeyAlgorithm: getPublicKeyAlgorithmFromOID(in.TBSCSR.PublicKey.Algorithm.Algorithm),
2136
2137                 Version:    in.TBSCSR.Version,
2138                 Attributes: parseRawAttributes(in.TBSCSR.RawAttributes),
2139         }
2140
2141         var err error
2142         if out.PublicKeyAlgorithm != UnknownPublicKeyAlgorithm {
2143                 out.PublicKey, err = parsePublicKey(&in.TBSCSR.PublicKey)
2144                 if err != nil {
2145                         return nil, err
2146                 }
2147         }
2148
2149         var subject pkix.RDNSequence
2150         if rest, err := asn1.Unmarshal(in.TBSCSR.Subject.FullBytes, &subject); err != nil {
2151                 return nil, err
2152         } else if len(rest) != 0 {
2153                 return nil, errors.New("x509: trailing data after X.509 Subject")
2154         }
2155
2156         out.Subject.FillFromRDNSequence(&subject)
2157
2158         if out.Extensions, err = parseCSRExtensions(in.TBSCSR.RawAttributes); err != nil {
2159                 return nil, err
2160         }
2161
2162         for _, extension := range out.Extensions {
2163                 switch {
2164                 case extension.Id.Equal(oidExtensionSubjectAltName):
2165                         out.DNSNames, out.EmailAddresses, out.IPAddresses, out.URIs, err = parseSANExtension(extension.Value)
2166                         if err != nil {
2167                                 return nil, err
2168                         }
2169                 }
2170         }
2171
2172         return out, nil
2173 }
2174
2175 // CheckSignature reports whether the signature on c is valid.
2176 func (c *CertificateRequest) CheckSignature() error {
2177         return checkSignature(c.SignatureAlgorithm, c.RawTBSCertificateRequest, c.Signature, c.PublicKey, true)
2178 }
2179
2180 // RevocationListEntry represents an entry in the revokedCertificates
2181 // sequence of a CRL.
2182 type RevocationListEntry struct {
2183         // Raw contains the raw bytes of the revokedCertificates entry. It is set when
2184         // parsing a CRL; it is ignored when generating a CRL.
2185         Raw []byte
2186
2187         // SerialNumber represents the serial number of a revoked certificate. It is
2188         // both used when creating a CRL and populated when parsing a CRL. It must not
2189         // be nil.
2190         SerialNumber *big.Int
2191         // RevocationTime represents the time at which the certificate was revoked. It
2192         // is both used when creating a CRL and populated when parsing a CRL. It must
2193         // not be the zero time.
2194         RevocationTime time.Time
2195         // ReasonCode represents the reason for revocation, using the integer enum
2196         // values specified in RFC 5280 Section 5.3.1. When creating a CRL, the zero
2197         // value will result in the reasonCode extension being omitted. When parsing a
2198         // CRL, the zero value may represent either the reasonCode extension being
2199         // absent (which implies the default revocation reason of 0/Unspecified), or
2200         // it may represent the reasonCode extension being present and explicitly
2201         // containing a value of 0/Unspecified (which should not happen according to
2202         // the DER encoding rules, but can and does happen anyway).
2203         ReasonCode int
2204
2205         // Extensions contains raw X.509 extensions. When parsing CRL entries,
2206         // this can be used to extract non-critical extensions that are not
2207         // parsed by this package. When marshaling CRL entries, the Extensions
2208         // field is ignored, see ExtraExtensions.
2209         Extensions []pkix.Extension
2210         // ExtraExtensions contains extensions to be copied, raw, into any
2211         // marshaled CRL entries. Values override any extensions that would
2212         // otherwise be produced based on the other fields. The ExtraExtensions
2213         // field is not populated when parsing CRL entries, see Extensions.
2214         ExtraExtensions []pkix.Extension
2215 }
2216
2217 // RevocationList represents a [Certificate] Revocation List (CRL) as specified
2218 // by RFC 5280.
2219 type RevocationList struct {
2220         // Raw contains the complete ASN.1 DER content of the CRL (tbsCertList,
2221         // signatureAlgorithm, and signatureValue.)
2222         Raw []byte
2223         // RawTBSRevocationList contains just the tbsCertList portion of the ASN.1
2224         // DER.
2225         RawTBSRevocationList []byte
2226         // RawIssuer contains the DER encoded Issuer.
2227         RawIssuer []byte
2228
2229         // Issuer contains the DN of the issuing certificate.
2230         Issuer pkix.Name
2231         // AuthorityKeyId is used to identify the public key associated with the
2232         // issuing certificate. It is populated from the authorityKeyIdentifier
2233         // extension when parsing a CRL. It is ignored when creating a CRL; the
2234         // extension is populated from the issuing certificate itself.
2235         AuthorityKeyId []byte
2236
2237         Signature []byte
2238         // SignatureAlgorithm is used to determine the signature algorithm to be
2239         // used when signing the CRL. If 0 the default algorithm for the signing
2240         // key will be used.
2241         SignatureAlgorithm SignatureAlgorithm
2242
2243         // RevokedCertificateEntries represents the revokedCertificates sequence in
2244         // the CRL. It is used when creating a CRL and also populated when parsing a
2245         // CRL. When creating a CRL, it may be empty or nil, in which case the
2246         // revokedCertificates ASN.1 sequence will be omitted from the CRL entirely.
2247         RevokedCertificateEntries []RevocationListEntry
2248
2249         // RevokedCertificates is used to populate the revokedCertificates
2250         // sequence in the CRL if RevokedCertificateEntries is empty. It may be empty
2251         // or nil, in which case an empty CRL will be created.
2252         //
2253         // Deprecated: Use RevokedCertificateEntries instead.
2254         RevokedCertificates []pkix.RevokedCertificate
2255
2256         // Number is used to populate the X.509 v2 cRLNumber extension in the CRL,
2257         // which should be a monotonically increasing sequence number for a given
2258         // CRL scope and CRL issuer. It is also populated from the cRLNumber
2259         // extension when parsing a CRL.
2260         Number *big.Int
2261
2262         // ThisUpdate is used to populate the thisUpdate field in the CRL, which
2263         // indicates the issuance date of the CRL.
2264         ThisUpdate time.Time
2265         // NextUpdate is used to populate the nextUpdate field in the CRL, which
2266         // indicates the date by which the next CRL will be issued. NextUpdate
2267         // must be greater than ThisUpdate.
2268         NextUpdate time.Time
2269
2270         // Extensions contains raw X.509 extensions. When creating a CRL,
2271         // the Extensions field is ignored, see ExtraExtensions.
2272         Extensions []pkix.Extension
2273
2274         // ExtraExtensions contains any additional extensions to add directly to
2275         // the CRL.
2276         ExtraExtensions []pkix.Extension
2277 }
2278
2279 // These structures reflect the ASN.1 structure of X.509 CRLs better than
2280 // the existing crypto/x509/pkix variants do. These mirror the existing
2281 // certificate structs in this file.
2282 //
2283 // Notably, we include issuer as an asn1.RawValue, mirroring the behavior of
2284 // tbsCertificate and allowing raw (unparsed) subjects to be passed cleanly.
2285 type certificateList struct {
2286         TBSCertList        tbsCertificateList
2287         SignatureAlgorithm pkix.AlgorithmIdentifier
2288         SignatureValue     asn1.BitString
2289 }
2290
2291 type tbsCertificateList struct {
2292         Raw                 asn1.RawContent
2293         Version             int `asn1:"optional,default:0"`
2294         Signature           pkix.AlgorithmIdentifier
2295         Issuer              asn1.RawValue
2296         ThisUpdate          time.Time
2297         NextUpdate          time.Time                 `asn1:"optional"`
2298         RevokedCertificates []pkix.RevokedCertificate `asn1:"optional"`
2299         Extensions          []pkix.Extension          `asn1:"tag:0,optional,explicit"`
2300 }
2301
2302 // CreateRevocationList creates a new X.509 v2 [Certificate] Revocation List,
2303 // according to RFC 5280, based on template.
2304 //
2305 // The CRL is signed by priv which should be the private key associated with
2306 // the public key in the issuer certificate.
2307 //
2308 // The issuer may not be nil, and the crlSign bit must be set in [KeyUsage] in
2309 // order to use it as a CRL issuer.
2310 //
2311 // The issuer distinguished name CRL field and authority key identifier
2312 // extension are populated using the issuer certificate. issuer must have
2313 // SubjectKeyId set.
2314 func CreateRevocationList(rand io.Reader, template *RevocationList, issuer *Certificate, priv crypto.Signer) ([]byte, error) {
2315         if template == nil {
2316                 return nil, errors.New("x509: template can not be nil")
2317         }
2318         if issuer == nil {
2319                 return nil, errors.New("x509: issuer can not be nil")
2320         }
2321         if (issuer.KeyUsage & KeyUsageCRLSign) == 0 {
2322                 return nil, errors.New("x509: issuer must have the crlSign key usage bit set")
2323         }
2324         if len(issuer.SubjectKeyId) == 0 {
2325                 return nil, errors.New("x509: issuer certificate doesn't contain a subject key identifier")
2326         }
2327         if template.NextUpdate.Before(template.ThisUpdate) {
2328                 return nil, errors.New("x509: template.ThisUpdate is after template.NextUpdate")
2329         }
2330         if template.Number == nil {
2331                 return nil, errors.New("x509: template contains nil Number field")
2332         }
2333
2334         hashFunc, signatureAlgorithm, err := signingParamsForPublicKey(priv.Public(), template.SignatureAlgorithm)
2335         if err != nil {
2336                 return nil, err
2337         }
2338
2339         var revokedCerts []pkix.RevokedCertificate
2340         // Only process the deprecated RevokedCertificates field if it is populated
2341         // and the new RevokedCertificateEntries field is not populated.
2342         if len(template.RevokedCertificates) > 0 && len(template.RevokedCertificateEntries) == 0 {
2343                 // Force revocation times to UTC per RFC 5280.
2344                 revokedCerts = make([]pkix.RevokedCertificate, len(template.RevokedCertificates))
2345                 for i, rc := range template.RevokedCertificates {
2346                         rc.RevocationTime = rc.RevocationTime.UTC()
2347                         revokedCerts[i] = rc
2348                 }
2349         } else {
2350                 // Convert the ReasonCode field to a proper extension, and force revocation
2351                 // times to UTC per RFC 5280.
2352                 revokedCerts = make([]pkix.RevokedCertificate, len(template.RevokedCertificateEntries))
2353                 for i, rce := range template.RevokedCertificateEntries {
2354                         if rce.SerialNumber == nil {
2355                                 return nil, errors.New("x509: template contains entry with nil SerialNumber field")
2356                         }
2357                         if rce.RevocationTime.IsZero() {
2358                                 return nil, errors.New("x509: template contains entry with zero RevocationTime field")
2359                         }
2360
2361                         rc := pkix.RevokedCertificate{
2362                                 SerialNumber:   rce.SerialNumber,
2363                                 RevocationTime: rce.RevocationTime.UTC(),
2364                         }
2365
2366                         // Copy over any extra extensions, except for a Reason Code extension,
2367                         // because we'll synthesize that ourselves to ensure it is correct.
2368                         exts := make([]pkix.Extension, 0, len(rce.ExtraExtensions))
2369                         for _, ext := range rce.ExtraExtensions {
2370                                 if ext.Id.Equal(oidExtensionReasonCode) {
2371                                         return nil, errors.New("x509: template contains entry with ReasonCode ExtraExtension; use ReasonCode field instead")
2372                                 }
2373                                 exts = append(exts, ext)
2374                         }
2375
2376                         // Only add a reasonCode extension if the reason is non-zero, as per
2377                         // RFC 5280 Section 5.3.1.
2378                         if rce.ReasonCode != 0 {
2379                                 reasonBytes, err := asn1.Marshal(asn1.Enumerated(rce.ReasonCode))
2380                                 if err != nil {
2381                                         return nil, err
2382                                 }
2383
2384                                 exts = append(exts, pkix.Extension{
2385                                         Id:    oidExtensionReasonCode,
2386                                         Value: reasonBytes,
2387                                 })
2388                         }
2389
2390                         if len(exts) > 0 {
2391                                 rc.Extensions = exts
2392                         }
2393                         revokedCerts[i] = rc
2394                 }
2395         }
2396
2397         aki, err := asn1.Marshal(authKeyId{Id: issuer.SubjectKeyId})
2398         if err != nil {
2399                 return nil, err
2400         }
2401
2402         if numBytes := template.Number.Bytes(); len(numBytes) > 20 || (len(numBytes) == 20 && numBytes[0]&0x80 != 0) {
2403                 return nil, errors.New("x509: CRL number exceeds 20 octets")
2404         }
2405         crlNum, err := asn1.Marshal(template.Number)
2406         if err != nil {
2407                 return nil, err
2408         }
2409
2410         // Correctly use the issuer's subject sequence if one is specified.
2411         issuerSubject, err := subjectBytes(issuer)
2412         if err != nil {
2413                 return nil, err
2414         }
2415
2416         tbsCertList := tbsCertificateList{
2417                 Version:    1, // v2
2418                 Signature:  signatureAlgorithm,
2419                 Issuer:     asn1.RawValue{FullBytes: issuerSubject},
2420                 ThisUpdate: template.ThisUpdate.UTC(),
2421                 NextUpdate: template.NextUpdate.UTC(),
2422                 Extensions: []pkix.Extension{
2423                         {
2424                                 Id:    oidExtensionAuthorityKeyId,
2425                                 Value: aki,
2426                         },
2427                         {
2428                                 Id:    oidExtensionCRLNumber,
2429                                 Value: crlNum,
2430                         },
2431                 },
2432         }
2433         if len(revokedCerts) > 0 {
2434                 tbsCertList.RevokedCertificates = revokedCerts
2435         }
2436
2437         if len(template.ExtraExtensions) > 0 {
2438                 tbsCertList.Extensions = append(tbsCertList.Extensions, template.ExtraExtensions...)
2439         }
2440
2441         tbsCertListContents, err := asn1.Marshal(tbsCertList)
2442         if err != nil {
2443                 return nil, err
2444         }
2445
2446         // Optimization to only marshal this struct once, when signing and
2447         // then embedding in certificateList below.
2448         tbsCertList.Raw = tbsCertListContents
2449
2450         input := tbsCertListContents
2451         if hashFunc != 0 {
2452                 h := hashFunc.New()
2453                 h.Write(tbsCertListContents)
2454                 input = h.Sum(nil)
2455         }
2456         var signerOpts crypto.SignerOpts = hashFunc
2457         if template.SignatureAlgorithm.isRSAPSS() {
2458                 signerOpts = &rsa.PSSOptions{
2459                         SaltLength: rsa.PSSSaltLengthEqualsHash,
2460                         Hash:       hashFunc,
2461                 }
2462         }
2463
2464         signature, err := priv.Sign(rand, input, signerOpts)
2465         if err != nil {
2466                 return nil, err
2467         }
2468
2469         return asn1.Marshal(certificateList{
2470                 TBSCertList:        tbsCertList,
2471                 SignatureAlgorithm: signatureAlgorithm,
2472                 SignatureValue:     asn1.BitString{Bytes: signature, BitLength: len(signature) * 8},
2473         })
2474 }
2475
2476 // CheckSignatureFrom verifies that the signature on rl is a valid signature
2477 // from issuer.
2478 func (rl *RevocationList) CheckSignatureFrom(parent *Certificate) error {
2479         if parent.Version == 3 && !parent.BasicConstraintsValid ||
2480                 parent.BasicConstraintsValid && !parent.IsCA {
2481                 return ConstraintViolationError{}
2482         }
2483
2484         if parent.KeyUsage != 0 && parent.KeyUsage&KeyUsageCRLSign == 0 {
2485                 return ConstraintViolationError{}
2486         }
2487
2488         if parent.PublicKeyAlgorithm == UnknownPublicKeyAlgorithm {
2489                 return ErrUnsupportedAlgorithm
2490         }
2491
2492         return parent.CheckSignature(rl.SignatureAlgorithm, rl.RawTBSRevocationList, rl.Signature)
2493 }