// Copyright 2015 go-swagger maintainers // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package security import ( "context" "net/http" "testing" "github.com/go-openapi/errors" "github.com/stretchr/testify/assert" ) var tokenAuth = TokenAuthentication(func(token string) (interface{}, error) { if token == "token123" { return "admin", nil } return nil, errors.Unauthenticated("token") }) var tokenAuthCtx = TokenAuthenticationCtx(func(ctx context.Context, token string) (context.Context, interface{}, error) { if token == "token123" { return context.WithValue(ctx, extra, extraWisdom), "admin", nil } return context.WithValue(ctx, reason, expReason), nil, errors.Unauthenticated("token") }) func TestInvalidApiKeyAuthInitialization(t *testing.T) { assert.Panics(t, func() { APIKeyAuth("api_key", "qery", tokenAuth) }) } func TestValidApiKeyAuth(t *testing.T) { ta := APIKeyAuth("api_key", "query", tokenAuth) ta2 := APIKeyAuth("X-API-KEY", "header", tokenAuth) req1, _ := http.NewRequest("GET", "/blah?api_key=token123", nil) ok, usr, err := ta.Authenticate(req1) assert.True(t, ok) assert.Equal(t, "admin", usr) assert.NoError(t, err) req2, _ := http.NewRequest("GET", "/blah", nil) req2.Header.Set("X-API-KEY", "token123") ok, usr, err = ta2.Authenticate(req2) assert.True(t, ok) assert.Equal(t, "admin", usr) assert.NoError(t, err) } func TestInvalidApiKeyAuth(t *testing.T) { ta := APIKeyAuth("api_key", "query", tokenAuth) ta2 := APIKeyAuth("X-API-KEY", "header", tokenAuth) req1, _ := http.NewRequest("GET", "/blah?api_key=token124", nil) ok, usr, err := ta.Authenticate(req1) assert.True(t, ok) assert.Equal(t, nil, usr) assert.Error(t, err) req2, _ := http.NewRequest("GET", "/blah", nil) req2.Header.Set("X-API-KEY", "token124") ok, usr, err = ta2.Authenticate(req2) assert.True(t, ok) assert.Equal(t, nil, usr) assert.Error(t, err) } func TestMissingApiKeyAuth(t *testing.T) { ta := APIKeyAuth("api_key", "query", tokenAuth) ta2 := APIKeyAuth("X-API-KEY", "header", tokenAuth) req1, _ := http.NewRequest("GET", "/blah", nil) req1.Header.Set("X-API-KEY", "token123") ok, usr, err := ta.Authenticate(req1) assert.False(t, ok) assert.Equal(t, nil, usr) assert.NoError(t, err) req2, _ := http.NewRequest("GET", "/blah?api_key=token123", nil) ok, usr, err = ta2.Authenticate(req2) assert.False(t, ok) assert.Equal(t, nil, usr) assert.NoError(t, err) } func TestInvalidApiKeyAuthInitializationCtx(t *testing.T) { assert.Panics(t, func() { APIKeyAuthCtx("api_key", "qery", tokenAuthCtx) }) } func TestValidApiKeyAuthCtx(t *testing.T) { ta := APIKeyAuthCtx("api_key", "query", tokenAuthCtx) ta2 := APIKeyAuthCtx("X-API-KEY", "header", tokenAuthCtx) req1, _ := http.NewRequest("GET", "/blah?api_key=token123", nil) req1 = req1.WithContext(context.WithValue(req1.Context(), original, wisdom)) ok, usr, err := ta.Authenticate(req1) assert.True(t, ok) assert.Equal(t, "admin", usr) assert.NoError(t, err) assert.Equal(t, wisdom, req1.Context().Value(original)) assert.Equal(t, extraWisdom, req1.Context().Value(extra)) assert.Nil(t, req1.Context().Value(reason)) req2, _ := http.NewRequest("GET", "/blah", nil) req2 = req2.WithContext(context.WithValue(req2.Context(), original, wisdom)) req2.Header.Set("X-API-KEY", "token123") ok, usr, err = ta2.Authenticate(req2) assert.True(t, ok) assert.Equal(t, "admin", usr) assert.NoError(t, err) assert.Equal(t, wisdom, req2.Context().Value(original)) assert.Equal(t, extraWisdom, req2.Context().Value(extra)) assert.Nil(t, req2.Context().Value(reason)) } func TestInvalidApiKeyAuthCtx(t *testing.T) { ta := APIKeyAuthCtx("api_key", "query", tokenAuthCtx) ta2 := APIKeyAuthCtx("X-API-KEY", "header", tokenAuthCtx) req1, _ := http.NewRequest("GET", "/blah?api_key=token124", nil) req1 = req1.WithContext(context.WithValue(req1.Context(), original, wisdom)) ok, usr, err := ta.Authenticate(req1) assert.True(t, ok) assert.Equal(t, nil, usr) assert.Error(t, err) assert.Equal(t, wisdom, req1.Context().Value(original)) assert.Equal(t, expReason, req1.Context().Value(reason)) assert.Nil(t, req1.Context().Value(extra)) req2, _ := http.NewRequest("GET", "/blah", nil) req2 = req2.WithContext(context.WithValue(req2.Context(), original, wisdom)) req2.Header.Set("X-API-KEY", "token124") ok, usr, err = ta2.Authenticate(req2) assert.True(t, ok) assert.Equal(t, nil, usr) assert.Error(t, err) assert.Equal(t, wisdom, req2.Context().Value(original)) assert.Equal(t, expReason, req2.Context().Value(reason)) assert.Nil(t, req2.Context().Value(extra)) } func TestMissingApiKeyAuthCtx(t *testing.T) { ta := APIKeyAuthCtx("api_key", "query", tokenAuthCtx) ta2 := APIKeyAuthCtx("X-API-KEY", "header", tokenAuthCtx) req1, _ := http.NewRequest("GET", "/blah", nil) req1 = req1.WithContext(context.WithValue(req1.Context(), original, wisdom)) req1.Header.Set("X-API-KEY", "token123") ok, usr, err := ta.Authenticate(req1) assert.False(t, ok) assert.Equal(t, nil, usr) assert.NoError(t, err) assert.Equal(t, wisdom, req1.Context().Value(original)) assert.Nil(t, req1.Context().Value(reason)) assert.Nil(t, req1.Context().Value(extra)) req2, _ := http.NewRequest("GET", "/blah?api_key=token123", nil) req2 = req2.WithContext(context.WithValue(req2.Context(), original, wisdom)) ok, usr, err = ta2.Authenticate(req2) assert.False(t, ok) assert.Equal(t, nil, usr) assert.NoError(t, err) assert.Equal(t, wisdom, req2.Context().Value(original)) assert.Nil(t, req2.Context().Value(reason)) assert.Nil(t, req2.Context().Value(extra)) }