Skip to content
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.

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

update csrf key generation #21154

Merged
merged 3 commits into from
Nov 15, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
11 changes: 9 additions & 2 deletions src/server/middleware/csrf/csrf.go
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,16 @@ func attach(handler http.Handler) http.Handler {
func Middleware() func(handler http.Handler) http.Handler {
once.Do(func() {
key := os.Getenv(csrfKeyEnv)
if len(key) != 32 {
log.Warningf("Invalid CSRF key from environment: %s, generating random key...", key)
if len(key) == 0 {
key = utils.GenerateRandomString()
} else if len(key) != 32 {
log.Errorf("Invalid CSRF key length from the environment: %s. Please ensure the key length is 32 characters.", key)
protect = func(_ http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
lib_http.SendError(w, errors.New("Invalid CSRF key length from the environment. Please ensure the key length is 32 characters."))
})
}
return
}
secureFlag = secureCookie()
protect = csrf.Protect([]byte(key), csrf.RequestHeader(tokenHeader),
Expand Down
28 changes: 18 additions & 10 deletions src/server/middleware/csrf/csrf_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"github.com/stretchr/testify/assert"

"github.com/goharbor/harbor/src/common"
"github.com/goharbor/harbor/src/common/utils"
"github.com/goharbor/harbor/src/common/utils/test"
"github.com/goharbor/harbor/src/lib/config"
_ "github.com/goharbor/harbor/src/pkg/config/inmemory"
Expand All @@ -32,50 +33,57 @@ func (h *handler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
}

func TestMiddleware(t *testing.T) {
srv := Middleware()(&handler{})
cases := []struct {
req *http.Request
statusCode int
returnToken bool
validKey bool
}{
{
req: httptest.NewRequest(http.MethodGet, "/", nil),
statusCode: http.StatusOK,
returnToken: true,
validKey: true,
},
{
req: httptest.NewRequest(http.MethodDelete, "/", nil),
statusCode: http.StatusForbidden,
returnToken: true,
validKey: true,
},
{
req: httptest.NewRequest(http.MethodGet, "/api/2.0/projects", nil), // should be skipped
statusCode: http.StatusOK,
returnToken: false,
validKey: true,
},
{
req: httptest.NewRequest(http.MethodDelete, "/v2/library/hello-world/manifests/latest", nil), // should be skipped
statusCode: http.StatusOK,
returnToken: false,
validKey: true,
},
{
req: httptest.NewRequest(http.MethodGet, "/", nil),
statusCode: http.StatusInternalServerError,
returnToken: false,
validKey: false,
},
}
for _, c := range cases {
if c.validKey {
os.Setenv(csrfKeyEnv, utils.GenerateRandomStringWithLen(32))
} else {
os.Setenv(csrfKeyEnv, utils.GenerateRandomStringWithLen(10))
}
srv := Middleware()(&handler{})
rec := httptest.NewRecorder()
srv.ServeHTTP(rec, c.req)
assert.Equal(t, c.statusCode, rec.Result().StatusCode)
assert.Equal(t, c.returnToken, rec.Result().Header.Get(tokenHeader) != "")
}
}

func hasCookie(resp *http.Response, name string) bool {
for _, c := range resp.Cookies() {
if c != nil && c.Name == name {
return true
}
}
return false
}

func TestSecureCookie(t *testing.T) {
assert.True(t, secureCookie())
conf := map[string]interface{}{
Expand Down
Loading