mirror of
https://github.com/pomerium/pomerium.git
synced 2025-07-17 16:48:13 +02:00
cryptutil: add a function to normalize PEM files so that leaf certificates appear first (#5642)
## Summary Go requires that the first certificate in a bundle be the one associated with a private key: > LoadX509KeyPair reads and parses a public/private key pair from a pair of files. The files must contain PEM encoded data. The certificate file may contain intermediate certificates following the leaf certificate to form a certificate chain. On successful return, Certificate.Leaf will be populated. I don't think Go is unusual in this regard, but to make the code more tolerant, add a new `NormalizePEM` function which will take raw PEM data and rewrite it so that leaf certificates appear first. This will be used in zero and the enterprise console. ## Related issues - [ENG-2433](https://linear.app/pomerium/issue/ENG-2423/enterprise-console-updatekeypair-check-is-too-restrictive) ## Checklist - [x] reference any related issues - [x] updated unit tests - [x] add appropriate label (`enhancement`, `bug`, `breaking`, `dependencies`, `ci`) - [x] ready for review
This commit is contained in:
parent
6e765abe2e
commit
9631d9ff1c
3 changed files with 285 additions and 0 deletions
129
pkg/cryptutil/pem.go
Normal file
129
pkg/cryptutil/pem.go
Normal file
|
@ -0,0 +1,129 @@
|
|||
package cryptutil
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"cmp"
|
||||
"crypto/x509"
|
||||
"encoding/pem"
|
||||
"iter"
|
||||
"slices"
|
||||
)
|
||||
|
||||
// NormalizePEM takes PEM-encoded data and normalizes it.
|
||||
//
|
||||
// If the PEM data contains multiple certificates, signing certificates
|
||||
// will be moved after the things they sign.
|
||||
func NormalizePEM(data []byte) []byte {
|
||||
type Segment struct {
|
||||
ID int
|
||||
Data []byte
|
||||
}
|
||||
var segments []Segment
|
||||
for block := range iteratePEM(data) {
|
||||
segments = append(segments, Segment{ID: len(segments), Data: block})
|
||||
}
|
||||
|
||||
// build a lookup table for subject keys and authority keys
|
||||
// a certificate with an authority key set to the subject key
|
||||
// of another certificate should appear before that certificate
|
||||
idToAuthorityKey := map[int]string{}
|
||||
subjectKeyToID := map[string]int{}
|
||||
for _, segment := range segments {
|
||||
block, _ := pem.Decode(segment.Data)
|
||||
if block == nil {
|
||||
continue
|
||||
}
|
||||
if block.Type != "CERTIFICATE" {
|
||||
continue
|
||||
}
|
||||
cert, err := x509.ParseCertificate(block.Bytes)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
if len(cert.AuthorityKeyId) > 0 {
|
||||
idToAuthorityKey[segment.ID] = string(cert.AuthorityKeyId)
|
||||
}
|
||||
if len(cert.SubjectKeyId) > 0 {
|
||||
subjectKeyToID[string(cert.SubjectKeyId)] = segment.ID
|
||||
}
|
||||
}
|
||||
|
||||
// calculate the depth of each certificate, deeper certificates will appear last
|
||||
depth := make([]int, len(segments))
|
||||
for i := range segments {
|
||||
id := segments[i].ID
|
||||
for {
|
||||
authorityKey, ok := idToAuthorityKey[id]
|
||||
if !ok {
|
||||
break
|
||||
}
|
||||
|
||||
id, ok = subjectKeyToID[authorityKey]
|
||||
if !ok {
|
||||
break
|
||||
}
|
||||
depth[id]++
|
||||
}
|
||||
}
|
||||
|
||||
// sort the segments
|
||||
slices.SortStableFunc(segments, func(x, y Segment) int {
|
||||
return cmp.Compare(depth[x.ID], depth[y.ID])
|
||||
})
|
||||
|
||||
// join the segments back together
|
||||
var buf bytes.Buffer
|
||||
for _, segment := range segments {
|
||||
buf.Write(segment.Data)
|
||||
}
|
||||
return buf.Bytes()
|
||||
}
|
||||
|
||||
var (
|
||||
pemBegin = []byte("-----BEGIN ")
|
||||
pemEnd = []byte("-----END ")
|
||||
)
|
||||
|
||||
// splitPEM attempts to split a slice of bytes into a single pem block
|
||||
// followed by the rest of the data. The pem block may contain extra
|
||||
// text before the BEGIN but won't contain more than one pem block.
|
||||
func splitPEM(data []byte) (before, after []byte) {
|
||||
idx1 := bytes.Index(data, pemBegin)
|
||||
if idx1 < 0 {
|
||||
return data, nil
|
||||
}
|
||||
|
||||
idx2 := bytes.IndexByte(data[idx1+len(pemBegin):], '\n')
|
||||
if idx2 < 0 {
|
||||
return data, nil
|
||||
}
|
||||
idx2 += idx1 + len(pemBegin)
|
||||
|
||||
idx3 := bytes.Index(data[idx2+1:], pemEnd)
|
||||
if idx3 < 0 {
|
||||
return data, nil
|
||||
}
|
||||
idx3 += idx2 + 1
|
||||
|
||||
idx4 := bytes.IndexByte(data[idx3+len(pemEnd):], '\n')
|
||||
if idx4 < 0 {
|
||||
return data, nil
|
||||
}
|
||||
idx4 += idx3 + len(pemEnd)
|
||||
|
||||
return data[:idx4+1], data[idx4+1:]
|
||||
}
|
||||
|
||||
// iteratePEM iterates over all the raw PEM blocks
|
||||
func iteratePEM(data []byte) iter.Seq[[]byte] {
|
||||
return func(yield func([]byte) bool) {
|
||||
rest := data
|
||||
for len(rest) > 0 {
|
||||
before, after := splitPEM(rest)
|
||||
if !yield(before) {
|
||||
return
|
||||
}
|
||||
rest = after
|
||||
}
|
||||
}
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue