1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
|
package security
import (
"bytes"
"context"
"fmt"
"mime/multipart"
"net/http"
"net/url"
"strings"
"testing"
"github.com/go-openapi/errors"
"github.com/go-openapi/runtime"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
const (
owners = "owners_auth"
validToken = "token123"
invalidToken = "token124"
principal = "admin"
authPath = "/blah"
invalidParam = "access_toke"
)
type authExpectation uint8
const (
expectIsAuthorized authExpectation = iota
expectInvalidAuthorization
expectNoAuthorization
)
func TestBearerAuth(t *testing.T) {
bearerAuth := ScopedTokenAuthentication(func(token string, _ []string) (interface{}, error) {
if token == validToken {
return principal, nil
}
return nil, errors.Unauthenticated("bearer")
})
ba := BearerAuth(owners, bearerAuth)
ctx := context.Background()
t.Run("with valid bearer auth", func(t *testing.T) {
t.Run("token in query param",
testAuthenticateBearerInQuery(ctx, ba, "", validToken, expectIsAuthorized),
)
t.Run("token in header",
testAuthenticateBearerInHeader(ctx, ba, "", validToken, expectIsAuthorized),
)
t.Run("token in urlencoded form",
testAuthenticateBearerInForm(ctx, ba, "", validToken, expectIsAuthorized),
)
t.Run("token in multipart form",
testAuthenticateBearerInMultipartForm(ctx, ba, "", validToken, expectIsAuthorized),
)
})
t.Run("with invalid token", func(t *testing.T) {
t.Run("token in query param",
testAuthenticateBearerInQuery(ctx, ba, "", invalidToken, expectInvalidAuthorization),
)
t.Run("token in header",
testAuthenticateBearerInHeader(ctx, ba, "", invalidToken, expectInvalidAuthorization),
)
t.Run("token in urlencoded form",
testAuthenticateBearerInForm(ctx, ba, "", invalidToken, expectInvalidAuthorization),
)
t.Run("token in multipart form",
testAuthenticateBearerInMultipartForm(ctx, ba, "", invalidToken, expectInvalidAuthorization),
)
})
t.Run("with missing auth", func(t *testing.T) {
t.Run("token in query param",
testAuthenticateBearerInQuery(ctx, ba, invalidParam, validToken, expectNoAuthorization),
)
t.Run("token in header",
testAuthenticateBearerInHeader(ctx, ba, "Beare", validToken, expectNoAuthorization),
)
t.Run("token in urlencoded form",
testAuthenticateBearerInForm(ctx, ba, invalidParam, validToken, expectNoAuthorization),
)
t.Run("token in multipart form",
testAuthenticateBearerInMultipartForm(ctx, ba, invalidParam, validToken, expectNoAuthorization),
)
})
}
func TestBearerAuthCtx(t *testing.T) {
bearerAuthCtx := ScopedTokenAuthenticationCtx(func(ctx context.Context, token string, _ []string) (context.Context, interface{}, error) {
if token == validToken {
return context.WithValue(ctx, extra, extraWisdom), principal, nil
}
return context.WithValue(ctx, reason, expReason), nil, errors.Unauthenticated("bearer")
})
ba := BearerAuthCtx(owners, bearerAuthCtx)
ctx := context.WithValue(context.Background(), original, wisdom)
assertContextOK := func(requestContext context.Context, t *testing.T) {
// when authorized, we have an "extra" key in context
assert.Equal(t, wisdom, requestContext.Value(original))
assert.Equal(t, extraWisdom, requestContext.Value(extra))
assert.Nil(t, requestContext.Value(reason))
}
assertContextKO := func(requestContext context.Context, t *testing.T) {
// when not authorized, we have a "reason" key in context
assert.Equal(t, wisdom, requestContext.Value(original))
assert.Nil(t, requestContext.Value(extra))
assert.Equal(t, expReason, requestContext.Value(reason))
}
assertContextNone := func(requestContext context.Context, t *testing.T) {
// when missing authorization, we only have the original context
assert.Equal(t, wisdom, requestContext.Value(original))
assert.Nil(t, requestContext.Value(extra))
assert.Nil(t, requestContext.Value(reason))
}
t.Run("with valid bearer auth", func(t *testing.T) {
t.Run("token in query param",
testAuthenticateBearerInQuery(ctx, ba, "", validToken, expectIsAuthorized, assertContextOK),
)
t.Run("token in header",
testAuthenticateBearerInHeader(ctx, ba, "", validToken, expectIsAuthorized, assertContextOK),
)
t.Run("token in urlencoded form",
testAuthenticateBearerInForm(ctx, ba, "", validToken, expectIsAuthorized, assertContextOK),
)
t.Run("token in multipart form",
testAuthenticateBearerInMultipartForm(ctx, ba, "", validToken, expectIsAuthorized, assertContextOK),
)
})
t.Run("with invalid token", func(t *testing.T) {
t.Run("token in query param",
testAuthenticateBearerInQuery(ctx, ba, "", invalidToken, expectInvalidAuthorization, assertContextKO),
)
t.Run("token in header",
testAuthenticateBearerInHeader(ctx, ba, "", invalidToken, expectInvalidAuthorization, assertContextKO),
)
t.Run("token in urlencoded form",
testAuthenticateBearerInForm(ctx, ba, "", invalidToken, expectInvalidAuthorization, assertContextKO),
)
t.Run("token in multipart form",
testAuthenticateBearerInMultipartForm(ctx, ba, "", invalidToken, expectInvalidAuthorization, assertContextKO),
)
})
t.Run("with missing auth", func(t *testing.T) {
t.Run("token in query param",
testAuthenticateBearerInQuery(ctx, ba, invalidParam, validToken, expectNoAuthorization, assertContextNone),
)
t.Run("token in header",
testAuthenticateBearerInHeader(ctx, ba, "Beare", validToken, expectNoAuthorization, assertContextNone),
)
t.Run("token in urlencoded form",
testAuthenticateBearerInForm(ctx, ba, invalidParam, validToken, expectNoAuthorization, assertContextNone),
)
t.Run("token in multipart form",
testAuthenticateBearerInMultipartForm(ctx, ba, invalidParam, validToken, expectNoAuthorization, assertContextNone),
)
})
}
func testIsAuthorized(_ context.Context, req *http.Request, authorizer runtime.Authenticator, expectAuthorized authExpectation, extraAsserters ...func(context.Context, *testing.T)) func(*testing.T) {
return func(t *testing.T) {
hasToken, usr, err := authorizer.Authenticate(&ScopedAuthRequest{Request: req})
switch expectAuthorized {
case expectIsAuthorized:
require.NoError(t, err)
assert.True(t, hasToken)
assert.Equal(t, principal, usr)
assert.Equal(t, owners, OAuth2SchemeName(req))
case expectInvalidAuthorization:
require.Error(t, err)
require.ErrorContains(t, err, "unauthenticated")
assert.True(t, hasToken)
assert.Nil(t, usr)
assert.Equal(t, owners, OAuth2SchemeName(req))
case expectNoAuthorization:
require.NoError(t, err)
assert.False(t, hasToken)
assert.Nil(t, usr)
assert.Empty(t, OAuth2SchemeName(req))
}
for _, contextAsserter := range extraAsserters {
contextAsserter(req.Context(), t)
}
}
}
func shouldAuthorizeOrNot(expectAuthorized authExpectation) string {
if expectAuthorized == expectIsAuthorized {
return "should authorize"
}
return "should not authorize"
}
func testAuthenticateBearerInQuery(
// build a request with the token as a query parameter, then check against the authorizer
//
// the request context after authorization may be checked with the extraAsserters.
ctx context.Context, authorizer runtime.Authenticator, parameter, token string, expectAuthorized authExpectation,
extraAsserters ...func(context.Context, *testing.T),
) func(*testing.T) {
if parameter == "" {
parameter = accessTokenParam
}
return func(t *testing.T) {
req, err := http.NewRequestWithContext(
ctx, http.MethodGet,
fmt.Sprintf("%s?%s=%s", authPath, parameter, token),
nil,
)
require.NoError(t, err)
t.Run(
shouldAuthorizeOrNot(expectAuthorized),
testIsAuthorized(ctx, req, authorizer, expectAuthorized, extraAsserters...),
)
}
}
func testAuthenticateBearerInHeader(
// build a request with the token as a header, then check against the authorizer
ctx context.Context, authorizer runtime.Authenticator, parameter, token string, expectAuthorized authExpectation,
extraAsserters ...func(context.Context, *testing.T),
) func(*testing.T) {
if parameter == "" {
parameter = "Bearer"
}
return func(t *testing.T) {
req, err := http.NewRequestWithContext(ctx, http.MethodGet, authPath, nil)
require.NoError(t, err)
req.Header.Set(runtime.HeaderAuthorization, fmt.Sprintf("%s %s", parameter, token))
t.Run(
shouldAuthorizeOrNot(expectAuthorized),
testIsAuthorized(ctx, req, authorizer, expectAuthorized, extraAsserters...),
)
}
}
func testAuthenticateBearerInForm(
// build a request with the token as a form field, then check against the authorizer
ctx context.Context, authorizer runtime.Authenticator, parameter, token string, expectAuthorized authExpectation,
extraAsserters ...func(context.Context, *testing.T),
) func(*testing.T) {
if parameter == "" {
parameter = accessTokenParam
}
return func(t *testing.T) {
body := url.Values(map[string][]string{})
body.Set(parameter, token)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, authPath, strings.NewReader(body.Encode()))
require.NoError(t, err)
req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
t.Run(
shouldAuthorizeOrNot(expectAuthorized),
testIsAuthorized(ctx, req, authorizer, expectAuthorized, extraAsserters...),
)
}
}
func testAuthenticateBearerInMultipartForm(
// build a request with the token as a multipart form field, then check against the authorizer
ctx context.Context, authorizer runtime.Authenticator, parameter, token string, expectAuthorized authExpectation,
extraAsserters ...func(context.Context, *testing.T),
) func(*testing.T) {
if parameter == "" {
parameter = accessTokenParam
}
return func(t *testing.T) {
body := bytes.NewBuffer(nil)
writer := multipart.NewWriter(body)
require.NoError(t, writer.WriteField(parameter, token))
require.NoError(t, writer.Close())
req, err := http.NewRequestWithContext(ctx, http.MethodPost, authPath, body)
require.NoError(t, err)
req.Header.Set("Content-Type", writer.FormDataContentType())
t.Run(
shouldAuthorizeOrNot(expectAuthorized),
testIsAuthorized(ctx, req, authorizer, expectAuthorized, extraAsserters...),
)
}
}
|