Skip to content

fix: fail loud when enable-csrf is set but csrf-key annotation is missing #440

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
shreemaan-abhishek wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: fail loud when enable-csrf is set but csrf-key annotation is missing #440

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
7 changes: 6 additions & 1 deletion internal/adc/translator/annotations/plugins/csrf.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
package plugins

import (
"fmt"

adctypes "github.com/apache/apisix-ingress-controller/api/adc"
"github.com/apache/apisix-ingress-controller/internal/adc/translator/annotations"
)
Expand All @@ -39,7 +41,10 @@ func (c *csrf) Handle(e annotations.Extractor) (any, error) {

key := e.GetStringAnnotation(annotations.AnnotationsCsrfKey)
if key == "" {
return nil, nil
// csrf requested but the key is missing: fail loud instead of
// silently dropping the plugin and programming the route unprotected.
return nil, fmt.Errorf("annotation %q is enabled but %q is missing or empty",
annotations.AnnotationsEnableCsrf, annotations.AnnotationsCsrfKey)
}

return &adctypes.CSRFConfig{
Expand Down
10 changes: 8 additions & 2 deletions internal/adc/translator/annotations/plugins/csrf_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,16 @@ func TestCSRFHandler(t *testing.T) {
assert.Nil(t, err, "checking given error")
assert.Nil(t, out, "checking given output")

// Test with enable-csrf true but no key
// Test with enable-csrf true but no key: must fail loud, not drop silently
anno[annotations.AnnotationsEnableCsrf] = "true"
delete(anno, annotations.AnnotationsCsrfKey)
out, err = p.Handle(annotations.NewExtractor(anno))
assert.Nil(t, err, "checking given error")
assert.Error(t, err, "expecting an error when csrf-key is missing")
assert.Nil(t, out, "checking given output when key is missing")

// Test with enable-csrf true but empty key: same fail-loud behavior
anno[annotations.AnnotationsCsrfKey] = ""
out, err = p.Handle(annotations.NewExtractor(anno))
assert.Error(t, err, "expecting an error when csrf-key is empty")
assert.Nil(t, out, "checking given output when key is empty")
}
Loading