Skip to content

transit: warn when context is ignored on non-derived keys #32076

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
SashaMIT wants to merge 1 commit into
base: main
Choose a base branch
from
+180 −0
Open

transit: warn when context is ignored on non-derived keys #32076

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 5 additions & 0 deletions builtin/logical/transit/path_decrypt.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@ func (b *backend) pathDecryptWrite(ctx context.Context, req *logical.Request, d
}
defer p.Unlock()

warnAboutUnusedContext := contextSet && !p.Derived
successesInBatch := false
successfulRequests := 0
for i, item := range batchInputItems {
Expand Down Expand Up @@ -273,6 +274,10 @@ func (b *backend) pathDecryptWrite(ctx context.Context, req *logical.Request, d
b.Logger().Error("failed to track transit decrypt request count", "error", err.Error())
}

if warnAboutUnusedContext {
resp.AddWarning("context was supplied but this key does not have derivation enabled; the supplied context was ignored")
}

return batchRequestResponse(d, resp, req, successesInBatch, userErrorInBatch, internalErrorInBatch)
}

Expand Down
5 changes: 5 additions & 0 deletions builtin/logical/transit/path_encrypt.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -526,6 +526,7 @@ func (b *backend) pathEncryptWrite(ctx context.Context, req *logical.Request, d
// item fails, respectively mark the error in the response
// collection and continue to process other items.
warnAboutNonceUsage := false
warnAboutUnusedContext := contextSet && !p.Derived
successesInBatch := false
successfulRequests := 0
for i, item := range batchInputItems {
Expand Down Expand Up @@ -637,6 +638,10 @@ func (b *backend) pathEncryptWrite(ctx context.Context, req *logical.Request, d
resp.AddWarning("A provided nonce value was used within FIPS mode, this violates FIPS 140 compliance.")
}

if warnAboutUnusedContext {
resp.AddWarning("context was supplied but this key does not have derivation enabled; the supplied context was ignored")
}

if req.Operation == logical.CreateOperation && !upserted {
resp.AddWarning("Attempted creation of the key during the encrypt operation, but it was created beforehand")
}
Expand Down
170 changes: 170 additions & 0 deletions builtin/logical/transit/path_encrypt_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,6 +391,176 @@ func TestTransit_BatchEncryptionCase5(t *testing.T) {
require.Equal(t, uint64(4), b.billingDataCounts.Transit.Load())
}



func TestTransit_EncryptNoWarnWhenDerivedUsesContext(t *testing.T) {
b, s := createBackendWithStorage(t)

req := &logical.Request{
Operation: logical.UpdateOperation,
Path: "keys/derived",
Storage: s,
Data: map[string]interface{}{
"type": "aes256-gcm96",
"derived": true,
},
}
resp, err := b.HandleRequest(context.Background(), req)
if err != nil || (resp != nil && resp.IsError()) {
t.Fatalf("create key err:%v resp:%#v", err, resp)
}

encReq := &logical.Request{
Operation: logical.UpdateOperation,
Path: "encrypt/derived",
Storage: s,
Data: map[string]interface{}{
"plaintext": "dGhlIHF1aWNrIGJyb3duIGZveA==",
"context": "Y29udGV4dC1h",
},
}
resp, err = b.HandleRequest(context.Background(), encReq)
if err != nil || (resp != nil && resp.IsError()) {
t.Fatalf("encrypt err:%v resp:%#v", err, resp)
}
for _, w := range resp.Warnings {
if strings.Contains(w, "context was supplied but this key does not have derivation") {
t.Fatalf("unexpected unused-context warning on derived key: %#v", resp.Warnings)
}
}
}

func TestTransit_EncryptWarnsOnUnusedContext(t *testing.T) {
b, s := createBackendWithStorage(t)

// Create a non-derived key explicitly.
req := &logical.Request{
Operation: logical.UpdateOperation,
Path: "keys/plain",
Storage: s,
Data: map[string]interface{}{
"type": "aes256-gcm96",
},
}
resp, err := b.HandleRequest(context.Background(), req)
if err != nil || (resp != nil && resp.IsError()) {
t.Fatalf("create key err:%v resp:%#v", err, resp)
}

plaintext := "dGhlIHF1aWNrIGJyb3duIGZveA=="
contextA := "Y29udGV4dC1h"
contextB := "Y29udGV4dC1i"

encReq := &logical.Request{
Operation: logical.UpdateOperation,
Path: "encrypt/plain",
Storage: s,
Data: map[string]interface{}{
"plaintext": plaintext,
"context": contextA,
},
}
resp, err = b.HandleRequest(context.Background(), encReq)
if err != nil || (resp != nil && resp.IsError()) {
t.Fatalf("encrypt err:%v resp:%#v", err, resp)
}
ciphertext := resp.Data["ciphertext"].(string)

found := false
for _, w := range resp.Warnings {
if strings.Contains(w, "context") {
found = true
break
}
}
if !found {
t.Fatalf("expected unused-context warning, got %#v", resp.Warnings)
}

// Decrypt without context must succeed (context was ignored at encrypt).
decReq := &logical.Request{
Operation: logical.UpdateOperation,
Path: "decrypt/plain",
Storage: s,
Data: map[string]interface{}{
"ciphertext": ciphertext,
},
}
resp, err = b.HandleRequest(context.Background(), decReq)
if err != nil || (resp != nil && resp.IsError()) {
t.Fatalf("decrypt without context err:%v resp:%#v", err, resp)
}
if resp.Data["plaintext"] != plaintext {
t.Fatalf("bad plaintext: got %q want %q", resp.Data["plaintext"], plaintext)
}

// Decrypt with a different context also succeeds (proves context was unused).
decReq.Data["context"] = contextB
resp, err = b.HandleRequest(context.Background(), decReq)
if err != nil || (resp != nil && resp.IsError()) {
t.Fatalf("decrypt with other context err:%v resp:%#v", err, resp)
}
if resp.Data["plaintext"] != plaintext {
t.Fatalf("bad plaintext with other context: got %q want %q", resp.Data["plaintext"], plaintext)
}
}


func TestTransit_DecryptWarnsOnUnusedContext(t *testing.T) {
b, s := createBackendWithStorage(t)

req := &logical.Request{
Operation: logical.UpdateOperation,
Path: "keys/plain-dec",
Storage: s,
Data: map[string]interface{}{
"type": "aes256-gcm96",
},
}
resp, err := b.HandleRequest(context.Background(), req)
if err != nil || (resp != nil && resp.IsError()) {
t.Fatalf("create key err:%v resp:%#v", err, resp)
}

encReq := &logical.Request{
Operation: logical.UpdateOperation,
Path: "encrypt/plain-dec",
Storage: s,
Data: map[string]interface{}{
"plaintext": "dGhlIHF1aWNrIGJyb3duIGZveA==",
},
}
resp, err = b.HandleRequest(context.Background(), encReq)
if err != nil || (resp != nil && resp.IsError()) {
t.Fatalf("encrypt err:%v resp:%#v", err, resp)
}
ciphertext := resp.Data["ciphertext"].(string)

decReq := &logical.Request{
Operation: logical.UpdateOperation,
Path: "decrypt/plain-dec",
Storage: s,
Data: map[string]interface{}{
"ciphertext": ciphertext,
"context": "Y29udGV4dC1h",
},
}
resp, err = b.HandleRequest(context.Background(), decReq)
if err != nil || (resp != nil && resp.IsError()) {
t.Fatalf("decrypt err:%v resp:%#v", err, resp)
}
found := false
for _, w := range resp.Warnings {
if strings.Contains(w, "context was supplied but this key does not have derivation") {
found = true
break
}
}
if !found {
t.Fatalf("expected unused-context warning on decrypt, got %#v", resp.Warnings)
}
}

// Case6: Test batch encryption with an upserted non-derived key
func TestTransit_BatchEncryptionCase6(t *testing.T) {
var resp *logical.Response
Expand Down
Loading