Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

trim whitespace around public keys before parsing #1175

Merged
merged 2 commits into from
Nov 5, 2022
Merged

trim whitespace around public keys before parsing #1175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40e2b85
trim whitespace around public keys before parsing
bobcallaway Nov 4, 2022
132bbe8
add test to ensure canonicalized key has single trailing newline
bobcallaway Nov 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions pkg/pki/x509/x509.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,16 +106,17 @@ func NewPublicKey(r io.Reader) (*PublicKey, error) {
if err != nil {
return nil, err
}
trimmedRawPub := bytes.TrimSpace(rawPub)

block, rest := pem.Decode(rawPub)
block, rest := pem.Decode(trimmedRawPub)
if block == nil {
return nil, errors.New("invalid public key: failure decoding PEM")
}

// Handle certificate chain, concatenated PEM-encoded certificates
if len(rest) > 0 {
// Support up to 10 certificates in a chain, to avoid parsing extremely long chains
certs, err := cryptoutils.UnmarshalCertificatesFromPEMLimited(rawPub, 10)
certs, err := cryptoutils.UnmarshalCertificatesFromPEMLimited(trimmedRawPub, 10)
if err != nil {
return nil, err
}
Expand Down
30 changes: 26 additions & 4 deletions pkg/pki/x509/x509_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,11 @@ pPZrHZ1cFykidZoURKoYXfkohJ+U/USYy8Sd8b4DMd5xDRZCnlDM0h37

// Extracted from above with:
// openssl ec -in ec_private.pem -pubout
const pub = `-----BEGIN PUBLIC KEY-----
const pubStr = `-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEx+ikqUxXurlxZltajRBV2ju31j32
baT2ax2dXBcpInWaFESqGF35KISflP1EmMvEnfG+AzHecQ0WQp5QzNId+w==
-----END PUBLIC KEY-----`
-----END PUBLIC KEY-----
`

// Generated with:
// openssl genpkey -algorithm ED25519 -out edprivate.pem
Expand All @@ -79,6 +80,13 @@ const ed25519Pub = `-----BEGIN PUBLIC KEY-----
MCowBQYDK2VwAyEAizWek2gKgMM+bad4rVJ5nc9NsbNOba0A0BNfzOgklRs=
-----END PUBLIC KEY-----`

const pubWithTrailingNewLine = `-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEx+ikqUxXurlxZltajRBV2ju31j32
baT2ax2dXBcpInWaFESqGF35KISflP1EmMvEnfG+AzHecQ0WQp5QzNId+w==
-----END PUBLIC KEY-----

`

func signData(t *testing.T, b []byte, pkey string) []byte {

priv, err := cryptoutils.UnmarshalPEMToPrivateKey([]byte(pkey), cryptoutils.SkipPassword)
Expand Down Expand Up @@ -111,7 +119,7 @@ func TestSignature_Verify(t *testing.T) {
{
name: "ec",
priv: priv,
pub: pub,
pub: pubStr,
},
{
name: "ed25519",
Expand Down Expand Up @@ -167,7 +175,7 @@ func TestSignature_VerifyFail(t *testing.T) {
{
name: "ec",
priv: priv,
pub: pub,
pub: pubStr,
},
{
name: "ed25519",
Expand Down Expand Up @@ -303,4 +311,18 @@ func TestPublicKeyWithCertChain(t *testing.T) {
if err == nil || !strings.Contains(err.Error(), "too many certificates specified in PEM block") {
t.Fatalf("expected error with long certificate chain, got %v", err)
}

// Verify public key with extra trailing newline is parsed OK
key, err := NewPublicKey(strings.NewReader(pubWithTrailingNewLine))
if err != nil {
t.Fatalf("unexpected error parsing public key with extra trailing newline: %v", err)
}
canonicalKeyBytes, err := key.CanonicalValue()
if err != nil {
t.Fatalf("unexpected error canonicalizing public key with extra trailing newline: %v", err)
}

if !bytes.Equal([]byte(pubStr), canonicalKeyBytes) {
t.Fatalf("expected canonical value to match original without extra trailing new line")
}
}