ssh: return clearer error when signature algorithm is used as key format
ParsePublicKey now returns a more specific error when a signature algorithm like rsa-sha2-256 is mistakenly provided as a key format Change-Id: Ic08286a5b2b326e99dd3e61594919203f0c36791 Reviewed-on: https://go-review.googlesource.com/c/crypto/+/695075 Reviewed-by: Filippo Valsorda <filippo@golang.org> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Mark Freeman <markfreeman@google.com> Reviewed-by: Michael Knyszek <mknyszek@google.com>
This commit is contained in:
@@ -312,6 +312,35 @@ func algorithmsForKeyFormat(keyFormat string) []string {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// keyFormatForAlgorithm returns the key format corresponding to the given
|
||||||
|
// signature algorithm. It returns an empty string if the signature algorithm is
|
||||||
|
// invalid or unsupported.
|
||||||
|
func keyFormatForAlgorithm(sigAlgo string) string {
|
||||||
|
switch sigAlgo {
|
||||||
|
case KeyAlgoRSA, KeyAlgoRSASHA256, KeyAlgoRSASHA512:
|
||||||
|
return KeyAlgoRSA
|
||||||
|
case CertAlgoRSAv01, CertAlgoRSASHA256v01, CertAlgoRSASHA512v01:
|
||||||
|
return CertAlgoRSAv01
|
||||||
|
case KeyAlgoED25519,
|
||||||
|
KeyAlgoSKED25519,
|
||||||
|
KeyAlgoSKECDSA256,
|
||||||
|
KeyAlgoECDSA256,
|
||||||
|
KeyAlgoECDSA384,
|
||||||
|
KeyAlgoECDSA521,
|
||||||
|
InsecureKeyAlgoDSA,
|
||||||
|
InsecureCertAlgoDSAv01,
|
||||||
|
CertAlgoECDSA256v01,
|
||||||
|
CertAlgoECDSA384v01,
|
||||||
|
CertAlgoECDSA521v01,
|
||||||
|
CertAlgoSKECDSA256v01,
|
||||||
|
CertAlgoED25519v01,
|
||||||
|
CertAlgoSKED25519v01:
|
||||||
|
return sigAlgo
|
||||||
|
default:
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// isRSA returns whether algo is a supported RSA algorithm, including certificate
|
// isRSA returns whether algo is a supported RSA algorithm, including certificate
|
||||||
// algorithms.
|
// algorithms.
|
||||||
func isRSA(algo string) bool {
|
func isRSA(algo string) bool {
|
||||||
|
|||||||
@@ -5,7 +5,9 @@
|
|||||||
package ssh
|
package ssh
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"maps"
|
||||||
"reflect"
|
"reflect"
|
||||||
|
"slices"
|
||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -174,3 +176,21 @@ func TestFindAgreedAlgorithms(t *testing.T) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestKeyFormatAlgorithms(t *testing.T) {
|
||||||
|
supportedAlgos := SupportedAlgorithms()
|
||||||
|
insecureAlgos := InsecureAlgorithms()
|
||||||
|
algoritms := append(supportedAlgos.PublicKeyAuths, insecureAlgos.PublicKeyAuths...)
|
||||||
|
algoritms = append(algoritms, slices.Collect(maps.Keys(certKeyAlgoNames))...)
|
||||||
|
|
||||||
|
for _, algo := range algoritms {
|
||||||
|
keyFormat := keyFormatForAlgorithm(algo)
|
||||||
|
if keyFormat == "" {
|
||||||
|
t.Errorf("got empty key format for algorithm %q", algo)
|
||||||
|
}
|
||||||
|
if !slices.Contains(algorithmsForKeyFormat(keyFormat), algo) {
|
||||||
|
t.Errorf("algorithms for key format %q, does not contain %q", keyFormat, algo)
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
+16
-2
@@ -89,6 +89,11 @@ func parsePubKey(in []byte, algo string) (pubKey PublicKey, rest []byte, err err
|
|||||||
}
|
}
|
||||||
return cert, nil, nil
|
return cert, nil, nil
|
||||||
}
|
}
|
||||||
|
if keyFormat := keyFormatForAlgorithm(algo); keyFormat != "" {
|
||||||
|
return nil, nil, fmt.Errorf("ssh: signature algorithm %q isn't a key format; key is malformed and should be re-encoded with type %q",
|
||||||
|
algo, keyFormat)
|
||||||
|
}
|
||||||
|
|
||||||
return nil, nil, fmt.Errorf("ssh: unknown key algorithm: %v", algo)
|
return nil, nil, fmt.Errorf("ssh: unknown key algorithm: %v", algo)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -191,9 +196,10 @@ func ParseKnownHosts(in []byte) (marker string, hosts []string, pubKey PublicKey
|
|||||||
return "", nil, nil, "", nil, io.EOF
|
return "", nil, nil, "", nil, io.EOF
|
||||||
}
|
}
|
||||||
|
|
||||||
// ParseAuthorizedKey parses a public key from an authorized_keys
|
// ParseAuthorizedKey parses a public key from an authorized_keys file used in
|
||||||
// file used in OpenSSH according to the sshd(8) manual page.
|
// OpenSSH according to the sshd(8) manual page. Invalid lines are ignored.
|
||||||
func ParseAuthorizedKey(in []byte) (out PublicKey, comment string, options []string, rest []byte, err error) {
|
func ParseAuthorizedKey(in []byte) (out PublicKey, comment string, options []string, rest []byte, err error) {
|
||||||
|
var lastErr error
|
||||||
for len(in) > 0 {
|
for len(in) > 0 {
|
||||||
end := bytes.IndexByte(in, '\n')
|
end := bytes.IndexByte(in, '\n')
|
||||||
if end != -1 {
|
if end != -1 {
|
||||||
@@ -222,6 +228,8 @@ func ParseAuthorizedKey(in []byte) (out PublicKey, comment string, options []str
|
|||||||
|
|
||||||
if out, comment, err = parseAuthorizedKey(in[i:]); err == nil {
|
if out, comment, err = parseAuthorizedKey(in[i:]); err == nil {
|
||||||
return out, comment, options, rest, nil
|
return out, comment, options, rest, nil
|
||||||
|
} else {
|
||||||
|
lastErr = err
|
||||||
}
|
}
|
||||||
|
|
||||||
// No key type recognised. Maybe there's an options field at
|
// No key type recognised. Maybe there's an options field at
|
||||||
@@ -264,12 +272,18 @@ func ParseAuthorizedKey(in []byte) (out PublicKey, comment string, options []str
|
|||||||
if out, comment, err = parseAuthorizedKey(in[i:]); err == nil {
|
if out, comment, err = parseAuthorizedKey(in[i:]); err == nil {
|
||||||
options = candidateOptions
|
options = candidateOptions
|
||||||
return out, comment, options, rest, nil
|
return out, comment, options, rest, nil
|
||||||
|
} else {
|
||||||
|
lastErr = err
|
||||||
}
|
}
|
||||||
|
|
||||||
in = rest
|
in = rest
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if lastErr != nil {
|
||||||
|
return nil, "", nil, nil, fmt.Errorf("ssh: no key found; last parsing error for ignored line: %w", lastErr)
|
||||||
|
}
|
||||||
|
|
||||||
return nil, "", nil, nil, errors.New("ssh: no key found")
|
return nil, "", nil, nil, errors.New("ssh: no key found")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -59,6 +59,17 @@ func TestKeyMarshalParse(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestParsePublicKeyWithSigningAlgoAsKeyFormat(t *testing.T) {
|
||||||
|
key := []byte(`rsa-sha2-256 AAAADHJzYS1zaGEyLTI1NgAAAAMBAAEAAAEBAJ7qMyjLXEJCCJmRknuCLo0uPi5GrPY5pQYr84lhlN8Gor5KVL2LKYCW4e70r5xzj7SrHHSCft1FMlYg1KDO9xrprJh733kQqAPWETmSuH0EfRtGtcH6EarKyVxk6As076/yNiiMKVBtG0RPa1L7FviTfcYK4vnCCVrbv3RmA5CCzuG5BSMbRLxzVb4Ri3p8jhxYT8N4QGe/2yqvJLys5vQ9szpZR3tcFp3DJIVZhBRfR6LnoY23XZniAAMQaUVBX86dXQ++dNwAwZSXSt9Og+AniOCiBYqhNVa5n3DID/H7YtEtG+CbZr3r2KD3fv8AfSLRar4XOp8rsRdD31h/kr8=`)
|
||||||
|
_, _, _, _, err := ParseAuthorizedKey(key)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("parsing a public key using a signature algorithm as the key format succeeded unexpectedly")
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), `signature algorithm "rsa-sha2-256" isn't a key format`) {
|
||||||
|
t.Errorf(`got %v, expected 'signature algorithm "rsa-sha2-256" isn't a key format'`, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestUnsupportedCurves(t *testing.T) {
|
func TestUnsupportedCurves(t *testing.T) {
|
||||||
raw, err := ecdsa.GenerateKey(elliptic.P224(), rand.Reader)
|
raw, err := ecdsa.GenerateKey(elliptic.P224(), rand.Reader)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
Reference in New Issue
Block a user