Add support for SSH private key passphrases (#2331)
This adds support for encrypted SSH keys via passphrase. Co-authored-by: Louis Ruch <louisruch@gmail.com> Co-authored-by: Michael Gaffney <mgaffney@users.noreply.github.com>
This commit is contained in:
45 files changed
+1921
-382
No files matched your search
@@ -2,6 +2,7 @@ package credentials
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/x509"
|
||||
"encoding/base64"
|
||||
"fmt"
|
||||
|
||||
@@ -27,10 +28,11 @@ import (
|
||||
)
|
||||
|
||||
const (
|
||||
usernameField = "attributes.username"
|
||||
passwordField = "attributes.password"
|
||||
privateKeyField = "attributes.private_key"
|
||||
domain = "credential"
|
||||
usernameField = "attributes.username"
|
||||
passwordField = "attributes.password"
|
||||
privateKeyField = "attributes.private_key"
|
||||
privateKeyPassphraseField = "attributes.private_key_passphrase"
|
||||
domain = "credential"
|
||||
)
|
||||
|
||||
var (
|
||||
@@ -409,6 +411,16 @@ func (s Service) updateInRepo(
|
||||
if err != nil {
|
||||
return nil, errors.Wrap(ctx, err, op, errors.WithMsg("unable to convert to ssh private key storage credential"))
|
||||
}
|
||||
if cred.PassphraseUnneeded {
|
||||
// This happens when we have a private key given and no passphrase
|
||||
// given and everything parses correctly. In that case we want to
|
||||
// ensure that if a passphrase was in the database for the previous
|
||||
// key that we get rid of it. We'll have nilled out several values
|
||||
// above. Note that adding the passphrase field will, once we get to
|
||||
// the repo, result in the mask for the other two related fields as
|
||||
// well.
|
||||
dbMasks = append(dbMasks, static.PrivateKeyPassphraseField)
|
||||
}
|
||||
cred.PublicId = id
|
||||
repo, err := s.repoFn()
|
||||
if err != nil {
|
||||
@@ -553,8 +565,9 @@ func toProto(in credential.Static, opt ...handlers.Option) (*pb.Credential, erro
|
||||
if outputFields.Has(globals.AttributesField) {
|
||||
out.Attrs = &pb.Credential_SshPrivateKeyAttributes{
|
||||
SshPrivateKeyAttributes: &pb.SshPrivateKeyAttributes{
|
||||
Username: wrapperspb.String(cred.GetUsername()),
|
||||
PrivateKeyHmac: base64.RawURLEncoding.EncodeToString(cred.GetPrivateKeyHmac()),
|
||||
Username: wrapperspb.String(cred.GetUsername()),
|
||||
PrivateKeyHmac: base64.RawURLEncoding.EncodeToString(cred.GetPrivateKeyHmac()),
|
||||
PrivateKeyPassphraseHmac: base64.RawURLEncoding.EncodeToString(cred.GetPrivateKeyPassphraseHmac()),
|
||||
},
|
||||
}
|
||||
}
|
||||
@@ -596,6 +609,9 @@ func toSshPrivateKeyStorageCredential(ctx context.Context, storeId string, in *p
|
||||
}
|
||||
|
||||
attrs := in.GetSshPrivateKeyAttributes()
|
||||
if attrs.GetPrivateKeyPassphrase() != nil {
|
||||
opts = append(opts, static.WithPrivateKeyPassphrase([]byte(attrs.GetPrivateKeyPassphrase().GetValue())))
|
||||
}
|
||||
cs, err := static.NewSshPrivateKeyCredential(
|
||||
ctx,
|
||||
storeId,
|
||||
@@ -645,16 +661,27 @@ func validateCreateRequest(req *pbs.CreateCredentialRequest) error {
|
||||
badFields[usernameField] = "Field required for creating an SSH private key credential."
|
||||
}
|
||||
privateKey := req.Item.GetSshPrivateKeyAttributes().GetPrivateKey().GetValue()
|
||||
passphrase := req.Item.GetSshPrivateKeyAttributes().GetPrivateKeyPassphrase().GetValue()
|
||||
if privateKey == "" {
|
||||
badFields[privateKeyField] = "Field required for creating an SSH private key credential."
|
||||
} else {
|
||||
_, err := ssh.ParsePrivateKey([]byte(privateKey))
|
||||
switch {
|
||||
case err == nil:
|
||||
case err.Error() == (&ssh.PassphraseMissingError{}).Error():
|
||||
// This is okay, if it's brokered and the client can use it, no worries
|
||||
switch passphrase {
|
||||
case "":
|
||||
if _, err := ssh.ParsePrivateKey([]byte(privateKey)); err != nil {
|
||||
badFields[privateKeyField] = fmt.Sprintf("Unable to parse given private key value: %v.", err)
|
||||
}
|
||||
default:
|
||||
badFields[privateKeyField] = "Unable to parse given private key value."
|
||||
if _, err := ssh.ParsePrivateKeyWithPassphrase([]byte(privateKey), []byte(passphrase)); err != nil {
|
||||
if errors.Is(err, x509.IncorrectPasswordError) {
|
||||
badFields[privateKeyPassphraseField] = "Incorrect private key passphrase."
|
||||
} else {
|
||||
if _, err := ssh.ParsePrivateKey([]byte(privateKey)); err == nil {
|
||||
badFields[privateKeyPassphraseField] = "Passphrase supplied for unencrypted key."
|
||||
} else {
|
||||
badFields[privateKeyField] = fmt.Sprintf("Unable to parse given private key value: %v.", err)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -669,9 +696,8 @@ func validateCreateRequest(req *pbs.CreateCredentialRequest) error {
|
||||
func validateUpdateRequest(req *pbs.UpdateCredentialRequest) error {
|
||||
return handlers.ValidateUpdateRequest(req, req.GetItem(), func() map[string]string {
|
||||
badFields := map[string]string{}
|
||||
switch req.GetItem().GetType() {
|
||||
case "":
|
||||
case credential.UsernamePasswordSubtype.String():
|
||||
switch subtypes.SubtypeFromId(domain, req.GetId()) {
|
||||
case credential.UsernamePasswordSubtype:
|
||||
attrs := req.GetItem().GetUsernamePasswordAttributes()
|
||||
if handlers.MaskContains(req.GetUpdateMask().GetPaths(), usernameField) && attrs.GetUsername().GetValue() == "" {
|
||||
badFields[usernameField] = "This is a required field and cannot be set to empty."
|
||||
@@ -680,27 +706,40 @@ func validateUpdateRequest(req *pbs.UpdateCredentialRequest) error {
|
||||
badFields[passwordField] = "This is a required field and cannot be set to empty."
|
||||
}
|
||||
|
||||
case credential.SshPrivateKeySubtype.String():
|
||||
case credential.SshPrivateKeySubtype:
|
||||
attrs := req.GetItem().GetSshPrivateKeyAttributes()
|
||||
if handlers.MaskContains(req.GetUpdateMask().GetPaths(), usernameField) && attrs.GetUsername().GetValue() == "" {
|
||||
badFields[usernameField] = "This is a required field and cannot be set to empty."
|
||||
}
|
||||
privateKey := attrs.GetPrivateKey().GetValue()
|
||||
if handlers.MaskContains(req.GetUpdateMask().GetPaths(), privateKeyField) && privateKey == "" {
|
||||
badFields[privateKeyField] = "This is a required field and cannot be set to empty."
|
||||
} else {
|
||||
_, err := ssh.ParsePrivateKey([]byte(privateKey))
|
||||
switch {
|
||||
case err == nil:
|
||||
case err.Error() == (&ssh.PassphraseMissingError{}).Error():
|
||||
// This is okay, if it's brokered and the client can use it, no worries
|
||||
default:
|
||||
badFields[privateKeyField] = "Unable to parse given private key value."
|
||||
passphrase := attrs.GetPrivateKeyPassphrase().GetValue()
|
||||
if handlers.MaskContains(req.GetUpdateMask().GetPaths(), privateKeyField) {
|
||||
if privateKey == "" {
|
||||
badFields[privateKeyField] = "This is a required field and cannot be set to empty."
|
||||
} else {
|
||||
switch passphrase {
|
||||
case "":
|
||||
if _, err := ssh.ParsePrivateKey([]byte(privateKey)); err != nil {
|
||||
badFields[privateKeyField] = fmt.Sprintf("Unable to parse given private key value: %v.", err)
|
||||
}
|
||||
default:
|
||||
if _, err := ssh.ParsePrivateKeyWithPassphrase([]byte(privateKey), []byte(passphrase)); err != nil {
|
||||
if errors.Is(err, x509.IncorrectPasswordError) {
|
||||
badFields[privateKeyPassphraseField] = "Incorrect private key passphrase."
|
||||
} else {
|
||||
if _, err := ssh.ParsePrivateKey([]byte(privateKey)); err == nil {
|
||||
badFields[privateKeyPassphraseField] = "Passphrase supplied for unencrypted key."
|
||||
} else {
|
||||
badFields[privateKeyField] = fmt.Sprintf("Unable to parse given private key value: %v.", err)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
default:
|
||||
badFields[globals.TypeField] = "Cannot modify resource type."
|
||||
badFields[globals.IdField] = "Unknown credential type."
|
||||
}
|
||||
|
||||
return badFields
|
||||
|
||||
@@ -25,6 +25,7 @@ import (
|
||||
scopepb "github.com/hashicorp/boundary/sdk/pbs/controller/api/resources/scopes"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"golang.org/x/crypto/ssh/testdata"
|
||||
"google.golang.org/grpc/codes"
|
||||
"google.golang.org/protobuf/proto"
|
||||
"google.golang.org/protobuf/testing/protocmp"
|
||||
@@ -205,6 +206,15 @@ func TestGet(t *testing.T) {
|
||||
spkHm, err := crypto.HmacSha256(context.Background(), []byte(static.TestSshPrivateKeyPem), databaseWrapper, []byte(store.GetPublicId()), nil)
|
||||
require.NoError(t, err)
|
||||
|
||||
spkCredWithPass := static.TestSshPrivateKeyCredential(t, conn, wrapper,
|
||||
"user", string(testdata.PEMEncryptedKeys[0].PEMBytes),
|
||||
store.GetPublicId(), prj.GetPublicId(),
|
||||
static.WithPrivateKeyPassphrase([]byte(testdata.PEMEncryptedKeys[0].EncryptionKey)))
|
||||
spkWithPassHm, err := crypto.HmacSha256(context.Background(), []byte(testdata.PEMEncryptedKeys[0].PEMBytes), databaseWrapper, []byte(store.GetPublicId()), nil)
|
||||
require.NoError(t, err)
|
||||
passHm, err := crypto.HmacSha256(context.Background(), []byte(testdata.PEMEncryptedKeys[0].EncryptionKey), databaseWrapper, []byte(store.GetPublicId()), nil)
|
||||
require.NoError(t, err)
|
||||
|
||||
cases := []struct {
|
||||
name string
|
||||
id string
|
||||
@@ -277,6 +287,29 @@ func TestGet(t *testing.T) {
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "success-spk-with-pass",
|
||||
id: spkCredWithPass.GetPublicId(),
|
||||
res: &pbs.GetCredentialResponse{
|
||||
Item: &pb.Credential{
|
||||
Id: spkCredWithPass.GetPublicId(),
|
||||
CredentialStoreId: spkCredWithPass.GetStoreId(),
|
||||
Scope: &scopepb.ScopeInfo{Id: store.GetScopeId(), Type: scope.Project.String(), ParentScopeId: prj.GetParentId()},
|
||||
Type: credential.SshPrivateKeySubtype.String(),
|
||||
AuthorizedActions: testAuthorizedActions,
|
||||
CreatedTime: spkCredWithPass.CreateTime.GetTimestamp(),
|
||||
UpdatedTime: spkCredWithPass.UpdateTime.GetTimestamp(),
|
||||
Version: 1,
|
||||
Attrs: &pb.Credential_SshPrivateKeyAttributes{
|
||||
SshPrivateKeyAttributes: &pb.SshPrivateKeyAttributes{
|
||||
Username: wrapperspb.String("user"),
|
||||
PrivateKeyHmac: base64.RawURLEncoding.EncodeToString([]byte(spkWithPassHm)),
|
||||
PrivateKeyPassphraseHmac: base64.RawURLEncoding.EncodeToString([]byte(passHm)),
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "not found error",
|
||||
id: fmt.Sprintf("%s_1234567890", credential.UsernamePasswordCredentialPrefix),
|
||||
@@ -576,6 +609,34 @@ func TestCreate(t *testing.T) {
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "valid-spk-with-passphrase",
|
||||
req: &pbs.CreateCredentialRequest{Item: &pb.Credential{
|
||||
CredentialStoreId: store.GetPublicId(),
|
||||
Type: credential.SshPrivateKeySubtype.String(),
|
||||
Attrs: &pb.Credential_SshPrivateKeyAttributes{
|
||||
SshPrivateKeyAttributes: &pb.SshPrivateKeyAttributes{
|
||||
Username: wrapperspb.String("username"),
|
||||
PrivateKey: wrapperspb.String(string(testdata.PEMEncryptedKeys[0].PEMBytes)),
|
||||
PrivateKeyPassphrase: wrapperspb.String(testdata.PEMEncryptedKeys[0].EncryptionKey),
|
||||
},
|
||||
},
|
||||
}},
|
||||
idPrefix: credential.SshPrivateKeyCredentialPrefix + "_",
|
||||
res: &pbs.CreateCredentialResponse{
|
||||
Uri: fmt.Sprintf("credentials/%s_", credential.SshPrivateKeyCredentialPrefix),
|
||||
Item: &pb.Credential{
|
||||
Id: store.GetPublicId(),
|
||||
CredentialStoreId: store.GetPublicId(),
|
||||
CreatedTime: store.GetCreateTime().GetTimestamp(),
|
||||
UpdatedTime: store.GetUpdateTime().GetTimestamp(),
|
||||
Scope: &scopepb.ScopeInfo{Id: prj.GetPublicId(), Type: prj.GetType(), ParentScopeId: prj.GetParentId()},
|
||||
Version: 1,
|
||||
Type: credential.SshPrivateKeySubtype.String(),
|
||||
AuthorizedActions: testAuthorizedActions,
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
@@ -623,7 +684,8 @@ func TestCreate(t *testing.T) {
|
||||
assert.Empty(got.GetItem().GetUsernamePasswordAttributes().GetPassword())
|
||||
|
||||
case credential.SshPrivateKeySubtype.String():
|
||||
hm, err := crypto.HmacSha256(context.Background(), []byte(static.TestSshPrivateKeyPem), databaseWrapper, []byte(store.GetPublicId()), nil)
|
||||
pk := tc.req.GetItem().GetSshPrivateKeyAttributes().GetPrivateKey().GetValue()
|
||||
hm, err := crypto.HmacSha256(context.Background(), []byte(pk), databaseWrapper, []byte(store.GetPublicId()), nil)
|
||||
require.NoError(err)
|
||||
|
||||
// Validate attributes equal
|
||||
@@ -632,6 +694,14 @@ func TestCreate(t *testing.T) {
|
||||
assert.Equal(base64.RawURLEncoding.EncodeToString([]byte(hm)), got.GetItem().GetSshPrivateKeyAttributes().GetPrivateKeyHmac())
|
||||
assert.Empty(got.GetItem().GetSshPrivateKeyAttributes().GetPrivateKey())
|
||||
|
||||
if pass := tc.req.GetItem().GetSshPrivateKeyAttributes().GetPrivateKeyPassphrase().GetValue(); pass != "" {
|
||||
hm, err := crypto.HmacSha256(context.Background(), []byte(pass), databaseWrapper, []byte(store.GetPublicId()), nil)
|
||||
require.NoError(err)
|
||||
|
||||
assert.Equal(base64.RawURLEncoding.EncodeToString([]byte(hm)), got.GetItem().GetSshPrivateKeyAttributes().GetPrivateKeyPassphraseHmac())
|
||||
assert.Empty(got.GetItem().GetSshPrivateKeyAttributes().GetPrivateKeyPassphrase())
|
||||
}
|
||||
|
||||
default:
|
||||
require.Fail("unknown type")
|
||||
}
|
||||
@@ -708,10 +778,11 @@ func TestUpdate(t *testing.T) {
|
||||
databaseWrapper, err := kkms.GetWrapper(context.Background(), prj.GetPublicId(), kms.KeyPurposeDatabase)
|
||||
require.NoError(t, err)
|
||||
|
||||
successCases := []struct {
|
||||
name string
|
||||
req *pbs.UpdateCredentialRequest
|
||||
res func(cred *pb.Credential) *pb.Credential
|
||||
successFailCases := []struct {
|
||||
name string
|
||||
req *pbs.UpdateCredentialRequest
|
||||
res func(cred *pb.Credential) *pb.Credential
|
||||
expErrorContains string
|
||||
}{
|
||||
{
|
||||
name: "name",
|
||||
@@ -897,9 +968,87 @@ func TestUpdate(t *testing.T) {
|
||||
return out
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "update-spk-with-passphrase",
|
||||
req: &pbs.UpdateCredentialRequest{
|
||||
UpdateMask: fieldmask("attributes.private_key", "attributes.private_key_passphrase"),
|
||||
Item: &pb.Credential{
|
||||
Attrs: &pb.Credential_SshPrivateKeyAttributes{
|
||||
SshPrivateKeyAttributes: &pb.SshPrivateKeyAttributes{
|
||||
PrivateKey: wrapperspb.String(string(testdata.PEMEncryptedKeys[0].PEMBytes)),
|
||||
PrivateKeyPassphrase: wrapperspb.String(testdata.PEMEncryptedKeys[0].EncryptionKey),
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
res: func(in *pb.Credential) *pb.Credential {
|
||||
out := proto.Clone(in).(*pb.Credential)
|
||||
|
||||
hm, err := crypto.HmacSha256(context.Background(), testdata.PEMEncryptedKeys[0].PEMBytes, databaseWrapper, []byte(store.GetPublicId()), nil)
|
||||
require.NoError(t, err)
|
||||
out.GetSshPrivateKeyAttributes().PrivateKeyHmac = base64.RawURLEncoding.EncodeToString([]byte(hm))
|
||||
|
||||
hm, err = crypto.HmacSha256(context.Background(), []byte(testdata.PEMEncryptedKeys[0].EncryptionKey), databaseWrapper, []byte(store.GetPublicId()), nil)
|
||||
require.NoError(t, err)
|
||||
out.GetSshPrivateKeyAttributes().PrivateKeyPassphraseHmac = base64.RawURLEncoding.EncodeToString([]byte(hm))
|
||||
return out
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "update-spk-with-bad-passphrase",
|
||||
req: &pbs.UpdateCredentialRequest{
|
||||
UpdateMask: fieldmask("attributes.private_key", "attributes.private_key_passphrase"),
|
||||
Item: &pb.Credential{
|
||||
Attrs: &pb.Credential_SshPrivateKeyAttributes{
|
||||
SshPrivateKeyAttributes: &pb.SshPrivateKeyAttributes{
|
||||
PrivateKey: wrapperspb.String(string(testdata.PEMEncryptedKeys[0].PEMBytes)),
|
||||
PrivateKeyPassphrase: wrapperspb.String(strings.ToLower(testdata.PEMEncryptedKeys[0].EncryptionKey)),
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
expErrorContains: "Incorrect private key passphrase",
|
||||
},
|
||||
{
|
||||
name: "update-non-passphrase-spk-with-passphrase",
|
||||
req: &pbs.UpdateCredentialRequest{
|
||||
UpdateMask: fieldmask("attributes.private_key"),
|
||||
Item: &pb.Credential{
|
||||
Attrs: &pb.Credential_SshPrivateKeyAttributes{
|
||||
SshPrivateKeyAttributes: &pb.SshPrivateKeyAttributes{
|
||||
PrivateKey: wrapperspb.String(static.TestSshPrivateKeyPem),
|
||||
PrivateKeyPassphrase: wrapperspb.String(testdata.PEMEncryptedKeys[0].EncryptionKey),
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
expErrorContains: "Passphrase supplied for unencrypted key",
|
||||
},
|
||||
{
|
||||
name: "update-non-passphrase-spk-with-no-passphrase",
|
||||
req: &pbs.UpdateCredentialRequest{
|
||||
UpdateMask: fieldmask("attributes.private_key"),
|
||||
Item: &pb.Credential{
|
||||
Attrs: &pb.Credential_SshPrivateKeyAttributes{
|
||||
SshPrivateKeyAttributes: &pb.SshPrivateKeyAttributes{
|
||||
PrivateKey: wrapperspb.String(static.TestSshPrivateKeyPem),
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
res: func(in *pb.Credential) *pb.Credential {
|
||||
out := proto.Clone(in).(*pb.Credential)
|
||||
|
||||
hm, err := crypto.HmacSha256(context.Background(), []byte(static.TestSshPrivateKeyPem), databaseWrapper, []byte(store.GetPublicId()), nil)
|
||||
require.NoError(t, err)
|
||||
out.GetSshPrivateKeyAttributes().PrivateKeyHmac = base64.RawURLEncoding.EncodeToString([]byte(hm))
|
||||
out.GetSshPrivateKeyAttributes().PrivateKeyPassphraseHmac = ""
|
||||
return out
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range successCases {
|
||||
for _, tc := range successFailCases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
assert, require := assert.New(t), require.New(t)
|
||||
var cred credential.Static
|
||||
@@ -920,12 +1069,18 @@ func TestUpdate(t *testing.T) {
|
||||
}
|
||||
resToChange, err := s.GetCredential(ctx, &pbs.GetCredentialRequest{Id: cred.GetPublicId()})
|
||||
require.NoError(err)
|
||||
want := &pbs.UpdateCredentialResponse{Item: tc.res(resToChange.GetItem())}
|
||||
|
||||
got, gErr := s.UpdateCredential(ctx, tc.req)
|
||||
if tc.expErrorContains != "" {
|
||||
require.NotNil(gErr)
|
||||
assert.Contains(gErr.Error(), tc.expErrorContains)
|
||||
return
|
||||
}
|
||||
require.NoError(gErr)
|
||||
require.NotNil(got)
|
||||
|
||||
want := &pbs.UpdateCredentialResponse{Item: tc.res(resToChange.GetItem())}
|
||||
|
||||
gotUpdateTime := got.GetItem().GetUpdatedTime()
|
||||
created := cred.GetCreateTime().GetTimestamp()
|
||||
assert.True(gotUpdateTime.AsTime().After(created.AsTime()), "Should have been updated after it's creation. Was updated %v, which is after %v", gotUpdateTime, created)
|
||||
|
||||
Reference in new issue
Block a user