Skip to content

Vault: canonicalize owner at storage and validate Ethereum addresses #22828

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

Open
prashantkumar1982 wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Vault: canonicalize owner at storage and validate Ethereum addresses #22828

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
dc31e4e
Normalize Owner before persisting in KVStore
prashantkumar1982 Jun 12, 2026
913d17b
Merge branch 'develop' of https://github.com/smartcontractkit/chainli…
prashantkumar1982 Jun 12, 2026
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
21 changes: 12 additions & 9 deletions core/capabilities/vault/capability_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ import (
"github.com/smartcontractkit/chainlink/v2/core/logger"
)

const capabilityTestWorkflowOwner = "0x0001020304050607080900010203040506070809"
const capabilityTestWorkflowOwnerAlt = "0x1111111111111111111111111111111111111111"

func newTestRequestLifecycleTracker(t *testing.T) *RequestLifecycleTracker {
t.Helper()
tr, err := NewRequestLifecycleTracker(logger.TestLogger(t))
Expand All @@ -47,7 +50,7 @@ func TestCapability_CapabilityCall(t *testing.T) {
require.NoError(t, err)
servicetest.Run(t, capability)

owner := "testowner"
owner := capabilityTestWorkflowOwner
workflowID := "test-workflow-id"
workflowExecutionID := "test-workflow-execution-id"
referenceID := "test-reference-id"
Expand Down Expand Up @@ -144,7 +147,7 @@ func TestCapability_CapabilityCall_DuringSubscriptionPhase(t *testing.T) {
require.NoError(t, err)
servicetest.Run(t, capability)

owner := "testowner"
owner := capabilityTestWorkflowOwner
workflowID := "test-workflow-id"
referenceID := "0"

Expand Down Expand Up @@ -637,7 +640,7 @@ func TestCapability_CapabilityCall_ForwardsRequestGetSecretsIdentity(t *testing.
Id: &vault.SecretIdentifier{
Key: "Foo",
Namespace: "Bar",
Owner: "owner",
Owner: capabilityTestWorkflowOwner,
},
Result: &vault.SecretResponse_Data{
Data: &vault.SecretData{EncryptedValue: "encrypted-value"},
Expand Down Expand Up @@ -804,7 +807,7 @@ func TestCapability_CapabilityCall_ReturnsIncorrectType(t *testing.T) {
require.NoError(t, err)
servicetest.Run(t, capability)

owner := "testowner"
owner := capabilityTestWorkflowOwner
workflowID := "test-workflow-id"
workflowExecutionID := "test-workflow-execution-id"
referenceID := "test-reference-id"
Expand Down Expand Up @@ -878,7 +881,7 @@ func TestCapability_CapabilityCall_TimeOut(t *testing.T) {
require.NoError(t, err)
servicetest.Run(t, capability)

owner := "testowner"
owner := capabilityTestWorkflowOwner
workflowID := "test-workflow-id"
workflowExecutionID := "test-workflow-execution-id"
referenceID := "test-reference-id"
Expand Down Expand Up @@ -1062,7 +1065,7 @@ func TestCapability_CRUD(t *testing.T) {
Id: &vault.SecretIdentifier{
Key: "a",
Namespace: "Bar",
Owner: "a",
Owner: capabilityTestWorkflowOwnerAlt,
},
EncryptedValue: encryptedSecret,
},
Expand Down Expand Up @@ -1263,7 +1266,7 @@ func TestCapability_CRUD(t *testing.T) {
Id: &vault.SecretIdentifier{
Key: "w",
Namespace: "na",
Owner: "random",
Owner: capabilityTestWorkflowOwnerAlt,
},
EncryptedValue: encryptedSecret,
},
Expand Down Expand Up @@ -1458,7 +1461,7 @@ func TestCapability_CRUD(t *testing.T) {
{
Key: "Foo",
Namespace: "",
Owner: "random",
Owner: owner,
},
},
}
Expand Down Expand Up @@ -1524,7 +1527,7 @@ func TestCapability_CRUD(t *testing.T) {
call: func(t *testing.T, capability *Capability) (*vaulttypes.Response, error) {
req := &vault.ListSecretIdentifiersRequest{
RequestId: "",
Owner: "owner",
Owner: capabilityTestWorkflowOwner,
Namespace: "namespace",
}
return capability.ListSecretIdentifiers(t.Context(), req)
Expand Down
86 changes: 47 additions & 39 deletions core/capabilities/vault/gw_handler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ import (
connector_mocks "github.com/smartcontractkit/chainlink/v2/core/services/gateway/connector/mocks"
)

const (
gwTestOwnerA = "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B"
gwTestOwnerALower = "0xab5801a7d398351b8be11c439e05c5b3259aec9b"
gwTestOwnerB = "0x1111111111111111111111111111111111111111"
gwTestOwnerC = "0x2222222222222222222222222222222222222222"
)

func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
lggr := logger.TestLogger(t)
ctx := t.Context()
Expand All @@ -47,12 +54,12 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
setupMocks: func(ss *vaulttypesmocks.SecretsService, gc *connector_mocks.GatewayConnector, ra *vaultcapmocks.Authorizer) {
ra.EXPECT().AuthorizeRequest(mock.Anything, mock.MatchedBy(func(req jsonrpc.Request[json.RawMessage]) bool {
return req.Method == vaulttypes.MethodSecretsCreate && req.ID == "1"
})).Return(authResult("", "0xabc"), nil)
})).Return(authResult("", gwTestOwnerA), nil)
ss.EXPECT().CreateSecrets(mock.Anything, mock.MatchedBy(func(req *vaultcommon.CreateSecretsRequest) bool {
return len(req.EncryptedSecrets) == 1 &&
req.EncryptedSecrets[0].Id.Key == "test-secret" &&
req.EncryptedSecrets[0].Id.Owner == "0xAbC" &&
req.RequestId == "0xabc"+vaulttypes.RequestIDSeparator+"1"
req.EncryptedSecrets[0].Id.Owner == gwTestOwnerA &&
req.RequestId == gwTestOwnerA+vaulttypes.RequestIDSeparator+"1"
})).Return(&vaulttypes.Response{ID: "test-secret"}, nil)

gc.On("SendToGateway", mock.Anything, "gateway-1", mock.MatchedBy(func(resp *jsonrpc.Response[json.RawMessage]) bool {
Expand All @@ -69,7 +76,7 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
{
Id: &vaultcommon.SecretIdentifier{
Key: "test-secret",
Owner: "0xAbC",
Owner: gwTestOwnerA,
},
EncryptedValue: "encrypted-value",
},
Expand All @@ -86,12 +93,12 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
setupMocks: func(ss *vaulttypesmocks.SecretsService, gc *connector_mocks.GatewayConnector, ra *vaultcapmocks.Authorizer) {
ra.EXPECT().AuthorizeRequest(mock.Anything, mock.MatchedBy(func(req jsonrpc.Request[json.RawMessage]) bool {
return req.Method == vaulttypes.MethodSecretsCreate && req.ID == "1"
})).Return(authResult("org-1", "0xworkflow"), nil)
})).Return(authResult("org-1", gwTestOwnerC), nil)
ss.EXPECT().CreateSecrets(mock.Anything, mock.MatchedBy(func(req *vaultcommon.CreateSecretsRequest) bool {
return len(req.EncryptedSecrets) == 1 &&
req.EncryptedSecrets[0].Id.Key == "test-secret" &&
req.EncryptedSecrets[0].Id.Owner == "0xworkflow" &&
req.RequestId == "0xworkflow"+vaulttypes.RequestIDSeparator+"1"
req.EncryptedSecrets[0].Id.Owner == gwTestOwnerC &&
req.RequestId == gwTestOwnerC+vaulttypes.RequestIDSeparator+"1"
})).Return(&vaulttypes.Response{ID: "test-secret"}, nil)

gc.On("SendToGateway", mock.Anything, "gateway-1", mock.MatchedBy(func(resp *jsonrpc.Response[json.RawMessage]) bool {
Expand All @@ -107,7 +114,7 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
{
Id: &vaultcommon.SecretIdentifier{
Key: "test-secret",
Owner: "0xworkflow",
Owner: gwTestOwnerC,
},
EncryptedValue: "encrypted-value",
},
Expand All @@ -127,12 +134,12 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
req.ID == "1" &&
req.Auth == "" &&
req.Params != nil
})).Return(authResult("org-1", "0xworkflow"), nil)
})).Return(authResult("org-1", gwTestOwnerC), nil)
ss.EXPECT().CreateSecrets(mock.Anything, mock.MatchedBy(func(req *vaultcommon.CreateSecretsRequest) bool {
return len(req.EncryptedSecrets) == 1 &&
req.EncryptedSecrets[0].Id.Key == "test-secret" &&
req.EncryptedSecrets[0].Id.Owner == "0xworkflow" &&
req.RequestId == "0xworkflow"+vaulttypes.RequestIDSeparator+"1"
req.EncryptedSecrets[0].Id.Owner == gwTestOwnerC &&
req.RequestId == gwTestOwnerC+vaulttypes.RequestIDSeparator+"1"
})).Return(&vaulttypes.Response{ID: "test-secret"}, nil)

gc.On("SendToGateway", mock.Anything, "gateway-1", mock.MatchedBy(func(resp *jsonrpc.Response[json.RawMessage]) bool {
Expand All @@ -145,8 +152,9 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
Params: func() *json.RawMessage {
rid := "org-1" + vaulttypes.RequestIDSeparator + "1"
raw := json.RawMessage(fmt.Sprintf(
`{"request_id":%q,"encrypted_secrets":[{"id":{"key":"test-secret","owner":"0xworkflow"},"encrypted_value":"encrypted-value"}]}`,
`{"request_id":%q,"encrypted_secrets":[{"id":{"key":"test-secret","owner":%q},"encrypted_value":"encrypted-value"}]}`,
rid,
gwTestOwnerC,
))
return &raw
}(),
Expand All @@ -156,7 +164,7 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
{
name: "failure - service error",
setupMocks: func(ss *vaulttypesmocks.SecretsService, gc *connector_mocks.GatewayConnector, ra *vaultcapmocks.Authorizer) {
ra.EXPECT().AuthorizeRequest(mock.Anything, mock.Anything).Return(authResult("", "0xabc"), nil)
ra.EXPECT().AuthorizeRequest(mock.Anything, mock.Anything).Return(authResult("", gwTestOwnerA), nil)
ss.EXPECT().CreateSecrets(mock.Anything, mock.Anything).Return(nil, errors.New("service error"))

gc.On("SendToGateway", mock.Anything, "gateway-1", mock.MatchedBy(func(resp *jsonrpc.Response[json.RawMessage]) bool {
Expand All @@ -174,7 +182,7 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
{
Id: &vaultcommon.SecretIdentifier{
Key: "test-secret",
Owner: "0xAbC",
Owner: gwTestOwnerA,
},
EncryptedValue: "encrypted-value",
},
Expand Down Expand Up @@ -223,13 +231,13 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
setupMocks: func(ss *vaulttypesmocks.SecretsService, gc *connector_mocks.GatewayConnector, ra *vaultcapmocks.Authorizer) {
ra.EXPECT().AuthorizeRequest(mock.Anything, mock.MatchedBy(func(req jsonrpc.Request[json.RawMessage]) bool {
return req.Method == vaulttypes.MethodSecretsDelete && req.ID == "1"
})).Return(authResult("", "0xabc"), nil)
})).Return(authResult("", gwTestOwnerA), nil)
ss.EXPECT().DeleteSecrets(mock.Anything, mock.MatchedBy(func(req *vaultcommon.DeleteSecretsRequest) bool {
return len(req.Ids) == 1 &&
req.Ids[0].Key == "Foo" &&
req.Ids[0].Namespace == "Bar" &&
req.Ids[0].Owner == "0xAbC" &&
req.RequestId == "0xabc"+vaulttypes.RequestIDSeparator+"1"
req.Ids[0].Owner == gwTestOwnerA &&
req.RequestId == gwTestOwnerA+vaulttypes.RequestIDSeparator+"1"
})).Return(&vaulttypes.Response{ID: "test-secret"}, nil)

gc.On("SendToGateway", mock.Anything, "gateway-1", mock.MatchedBy(func(resp *jsonrpc.Response[json.RawMessage]) bool {
Expand All @@ -246,7 +254,7 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
{
Key: "Foo",
Namespace: "Bar",
Owner: "0xAbC",
Owner: gwTestOwnerA,
},
},
})
Expand All @@ -261,12 +269,12 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
setupMocks: func(ss *vaulttypesmocks.SecretsService, gc *connector_mocks.GatewayConnector, ra *vaultcapmocks.Authorizer) {
ra.EXPECT().AuthorizeRequest(mock.Anything, mock.MatchedBy(func(req jsonrpc.Request[json.RawMessage]) bool {
return req.Method == vaulttypes.MethodSecretsUpdate && req.ID == "1"
})).Return(authResult("org-1", "0xworkflow"), nil)
})).Return(authResult("org-1", gwTestOwnerC), nil)
ss.EXPECT().UpdateSecrets(mock.Anything, mock.MatchedBy(func(req *vaultcommon.UpdateSecretsRequest) bool {
return len(req.EncryptedSecrets) == 1 &&
req.EncryptedSecrets[0].Id.Key == "updated-secret" &&
req.EncryptedSecrets[0].Id.Owner == "0xworkflow" &&
req.RequestId == "0xworkflow"+vaulttypes.RequestIDSeparator+"1"
req.EncryptedSecrets[0].Id.Owner == gwTestOwnerC &&
req.RequestId == gwTestOwnerC+vaulttypes.RequestIDSeparator+"1"
})).Return(&vaulttypes.Response{ID: "updated-secret"}, nil)

gc.On("SendToGateway", mock.Anything, "gateway-1", mock.MatchedBy(func(resp *jsonrpc.Response[json.RawMessage]) bool {
Expand All @@ -282,7 +290,7 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
{
Id: &vaultcommon.SecretIdentifier{
Key: "updated-secret",
Owner: "0xworkflow",
Owner: gwTestOwnerC,
},
EncryptedValue: "encrypted-value",
},
Expand All @@ -299,13 +307,13 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
setupMocks: func(ss *vaulttypesmocks.SecretsService, gc *connector_mocks.GatewayConnector, ra *vaultcapmocks.Authorizer) {
ra.EXPECT().AuthorizeRequest(mock.Anything, mock.MatchedBy(func(req jsonrpc.Request[json.RawMessage]) bool {
return req.Method == vaulttypes.MethodSecretsDelete && req.ID == "1"
})).Return(authResult("org-1", "0xworkflow"), nil)
})).Return(authResult("org-1", gwTestOwnerC), nil)
ss.EXPECT().DeleteSecrets(mock.Anything, mock.MatchedBy(func(req *vaultcommon.DeleteSecretsRequest) bool {
return len(req.Ids) == 1 &&
req.Ids[0].Key == "Foo" &&
req.Ids[0].Namespace == "Bar" &&
req.Ids[0].Owner == "0xworkflow" &&
req.RequestId == "0xworkflow"+vaulttypes.RequestIDSeparator+"1"
req.Ids[0].Owner == gwTestOwnerC &&
req.RequestId == gwTestOwnerC+vaulttypes.RequestIDSeparator+"1"
})).Return(&vaulttypes.Response{ID: "test-secret"}, nil)

gc.On("SendToGateway", mock.Anything, "gateway-1", mock.MatchedBy(func(resp *jsonrpc.Response[json.RawMessage]) bool {
Expand All @@ -321,7 +329,7 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
{
Key: "Foo",
Namespace: "Bar",
Owner: "0xworkflow",
Owner: gwTestOwnerC,
},
},
})
Expand All @@ -336,10 +344,10 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
setupMocks: func(ss *vaulttypesmocks.SecretsService, gc *connector_mocks.GatewayConnector, ra *vaultcapmocks.Authorizer) {
ra.EXPECT().AuthorizeRequest(mock.Anything, mock.MatchedBy(func(req jsonrpc.Request[json.RawMessage]) bool {
return req.Method == vaulttypes.MethodSecretsList && req.ID == "1"
})).Return(authResult("org-1", "0xworkflow"), nil)
})).Return(authResult("org-1", gwTestOwnerC), nil)
ss.EXPECT().ListSecretIdentifiers(mock.Anything, mock.MatchedBy(func(req *vaultcommon.ListSecretIdentifiersRequest) bool {
return req.RequestId == "0xworkflow"+vaulttypes.RequestIDSeparator+"1" &&
req.Owner == "0xworkflow" &&
return req.RequestId == gwTestOwnerC+vaulttypes.RequestIDSeparator+"1" &&
req.Owner == gwTestOwnerC &&
req.Namespace == "ns"
})).Return(&vaulttypes.Response{ID: "test-secret"}, nil)

Expand All @@ -352,7 +360,7 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
ID: "1",
Params: func() *json.RawMessage {
params, _ := json.Marshal(vaultcommon.ListSecretIdentifiersRequest{
Owner: "0xworkflow",
Owner: gwTestOwnerC,
Namespace: "ns",
})
raw := json.RawMessage(params)
Expand Down Expand Up @@ -380,7 +388,7 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
{
Id: &vaultcommon.SecretIdentifier{
Key: "test-secret",
Owner: "0xAbC",
Owner: gwTestOwnerA,
},
EncryptedValue: "encrypted-value",
},
Expand Down Expand Up @@ -408,10 +416,10 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
return parsed.RequestId == "1" &&
len(parsed.EncryptedSecrets) == 1 &&
parsed.EncryptedSecrets[0].Id != nil &&
parsed.EncryptedSecrets[0].Id.Owner == "0xAbC"
})).Return(authResult("", "0xabc"), nil)
parsed.EncryptedSecrets[0].Id.Owner == gwTestOwnerA
})).Return(authResult("", gwTestOwnerA), nil)
ss.EXPECT().CreateSecrets(mock.Anything, mock.MatchedBy(func(req *vaultcommon.CreateSecretsRequest) bool {
return req.RequestId == "0xabc"+vaulttypes.RequestIDSeparator+"1"
return req.RequestId == gwTestOwnerA+vaulttypes.RequestIDSeparator+"1"
})).Return(&vaulttypes.Response{ID: "test-secret"}, nil)

gc.On("SendToGateway", mock.Anything, "gateway-1", mock.MatchedBy(func(resp *jsonrpc.Response[json.RawMessage]) bool {
Expand All @@ -420,15 +428,15 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
},
request: &jsonrpc.Request[json.RawMessage]{
Method: vaulttypes.MethodSecretsCreate,
ID: "0xDef" + vaulttypes.RequestIDSeparator + "1",
ID: gwTestOwnerB + vaulttypes.RequestIDSeparator + "1",
Params: func() *json.RawMessage {
params, _ := json.Marshal(vaultcommon.CreateSecretsRequest{
RequestId: "0xDef" + vaulttypes.RequestIDSeparator + "1",
RequestId: gwTestOwnerB + vaulttypes.RequestIDSeparator + "1",
EncryptedSecrets: []*vaultcommon.EncryptedSecret{
{
Id: &vaultcommon.SecretIdentifier{
Key: "test-secret",
Owner: "0xAbC",
Owner: gwTestOwnerA,
},
EncryptedValue: "encrypted-value",
},
Expand All @@ -443,7 +451,7 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
{
name: "failure - auth layer rejects cross-owner mutation",
setupMocks: func(ss *vaulttypesmocks.SecretsService, gc *connector_mocks.GatewayConnector, ra *vaultcapmocks.Authorizer) {
ra.EXPECT().AuthorizeRequest(mock.Anything, mock.Anything).Return(authResult("", "0xdef"), nil)
ra.EXPECT().AuthorizeRequest(mock.Anything, mock.Anything).Return(authResult("", gwTestOwnerB), nil)
gc.On("SendToGateway", mock.Anything, "gateway-1", mock.MatchedBy(func(resp *jsonrpc.Response[json.RawMessage]) bool {
return resp.Error != nil &&
resp.Error.Code == api.ToJSONRPCErrorCode(api.HandlerError) &&
Expand All @@ -459,7 +467,7 @@ func TestGatewayHandler_HandleGatewayMessage(t *testing.T) {
{
Id: &vaultcommon.SecretIdentifier{
Key: "test-secret",
Owner: "0xabc",
Owner: gwTestOwnerALower,
},
EncryptedValue: "encrypted-value",
},
Expand Down
Loading
Loading