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.

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

pipeline/authn: add unit test for token_from->cookie for both jwt and oauth2_introspection authenticators (#330) #331

Merged
merged 1 commit into from
Jan 9, 2020
Merged

pipeline/authn: add unit test for token_from->cookie for both jwt and oauth2_introspection authenticators (#330) #331

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
19 changes: 16 additions & 3 deletions .schemas/authenticators.jwt.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
},
"token_from": {
"title": "Token From",
"description": "The location of the token.\n If not configured, the token will be received from a default location - 'Authorization' header.\n One and only one location (header or query) must be specified.",
"description": "The location of the token.\n If not configured, the token will be received from a default location - 'Authorization' header.\n One and only one location (header, query, or cookie) must be specified.",
"oneOf": [
{
"type": "object",
Expand All @@ -63,7 +63,7 @@
"header": {
"title": "Header",
"type": "string",
"description": "The header (case insensitive) that must contain a token for request authentication. It can't be set along with query_parameter."
"description": "The header (case insensitive) that must contain a token for request authentication. It can't be set along with query_parameter or cookie."
}
}
},
Expand All @@ -76,7 +76,20 @@
"query_parameter": {
"title": "Query Parameter",
"type": "string",
"description": "The query parameter (case sensitive) that must contain a token for request authentication. It can't be set along with header."
"description": "The query parameter (case sensitive) that must contain a token for request authentication. It can't be set along with header or cookie."
}
}
},
{
"type": "object",
"required": [
"cookie"
],
"properties": {
"cookie": {
"title": "Cookie",
"type": "string",
"description": "The cookie (case sensitive) that must contain a token for request authentication. It can't be set along with header or query_parameter."
}
}
}
Expand Down
19 changes: 16 additions & 3 deletions .schemas/authenticators.oauth2_introspection.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
},
"token_from": {
"title": "Token From",
"description": "The location of the token.\n If not configured, the token will be received from a default location - 'Authorization' header.\n One and only one location (header or query) must be specified.",
"description": "The location of the token.\n If not configured, the token will be received from a default location - 'Authorization' header.\n One and only one location (header, query, or cookie) must be specified.",
"oneOf": [
{
"type": "object",
Expand All @@ -115,7 +115,7 @@
"header": {
"title": "Header",
"type": "string",
"description": "The header (case insensitive) that must contain a token for request authentication.\n It can't be set along with query_parameter."
"description": "The header (case insensitive) that must contain a token for request authentication.\n It can't be set along with query_parameter or cookie."
}
}
},
Expand All @@ -128,7 +128,20 @@
"query_parameter": {
"title": "Query Parameter",
"type": "string",
"description": "The query parameter (case sensitive) that must contain a token for request authentication.\n It can't be set along with header."
"description": "The query parameter (case sensitive) that must contain a token for request authentication.\n It can't be set along with header or cookie."
}
}
},
{
"type": "object",
"required": [
"cookie"
],
"properties": {
"cookie": {
"title": "Cookie",
"type": "string",
"description": "The cookie (case sensitive) that must contain a token for request authentication.\n It can't be set along with header or query_parameter."
}
}
}
Expand Down
15 changes: 13 additions & 2 deletions .schemas/config.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,7 +425,7 @@
"header": {
"title": "Header",
"type": "string",
"description": "The header (case insensitive) that must contain a token for request authentication. It can't be set along with query_parameter."
"description": "The header (case insensitive) that must contain a token for request authentication.\n It can't be set along with query_parameter or cookie."
}
}
},
Expand All @@ -436,7 +436,18 @@
"query_parameter": {
"title": "Query Parameter",
"type": "string",
"description": "The query parameter (case sensitive) that must contain a token for request authentication. It can't be set along with header."
"description": "The query parameter (case sensitive) that must contain a token for request authentication.\n It can't be set along with header or cookie."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"cookie": {
"title": "Cookie",
"type": "string",
"description": "The cookie (case sensitive) that must contain a token for request authentication.\n It can't be set along with header or query_parameter."
}
}
}
Expand Down
19 changes: 19 additions & 0 deletions pipeline/authn/authenticator_jwt_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,16 @@ func TestAuthenticatorJWT(t *testing.T) {
expectErr: true,
expectExactErr: ErrAuthenticatorNotResponsible,
},
{
d: "should return error saying that authenticator is not responsible for validating the request, as the token was not provided in a proper location (cookie)",
r: &http.Request{Header: http.Header{"Cookie": []string{"biscuit=" + gen(keys[1], jwt.MapClaims{
"sub": "sub",
"exp": now.Add(time.Hour).Unix(),
})}}},
config: `{"token_from": {"cookie": "cake"}}`,
expectErr: true,
expectExactErr: ErrAuthenticatorNotResponsible,
},
{
d: "should pass because the valid JWT token was provided in a proper location (custom header)",
r: &http.Request{Header: http.Header{"X-Custom-Header": []string{gen(keys[1], jwt.MapClaims{
Expand All @@ -149,6 +159,15 @@ func TestAuthenticatorJWT(t *testing.T) {
config: `{"token_from": {"query_parameter": "token"}}`,
expectErr: false,
},
{
d: "should pass because the valid JWT token was provided in a proper location (cookie)",
r: &http.Request{Header: http.Header{"Cookie": []string{"biscuit=" + gen(keys[1], jwt.MapClaims{
"sub": "sub",
"exp": now.Add(time.Hour).Unix(),
})}}},
config: `{"token_from": {"cookie": "biscuit"}}`,
expectErr: false,
},
{
d: "should pass because JWT is valid",
r: &http.Request{Header: http.Header{"Authorization": []string{"bearer " + gen(keys[1], jwt.MapClaims{
Expand Down
26 changes: 24 additions & 2 deletions pipeline/authn/authenticator_oauth2_introspection_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,14 @@ func TestAuthenticatorOAuth2Introspection(t *testing.T) {
expectExactErr: ErrAuthenticatorNotResponsible,
},
{
d: "should pass because the valid JWT token was provided in a proper location (custom header)",
d: "should return error saying that authenticator is not responsible for validating the request, as the token was not provided in a proper location (cookie)",
r: &http.Request{Header: http.Header{"Cookie": {"biscuit=bearer token"}}},
config: []byte(`{"token_from": {"cookie": "cake"}}`),
expectErr: true,
expectExactErr: ErrAuthenticatorNotResponsible,
},
{
d: "should pass because the valid token was provided in a proper location (custom header)",
r: &http.Request{Header: http.Header{"X-Custom-Header": {"token"}}},
config: []byte(`{"token_from": {"header": "X-Custom-Header"}}`),
expectErr: false,
Expand All @@ -117,7 +124,7 @@ func TestAuthenticatorOAuth2Introspection(t *testing.T) {
},
},
{
d: "should pass because the valid JWT token was provided in a proper location (custom query parameter)",
d: "should pass because the valid token was provided in a proper location (custom query parameter)",
r: &http.Request{
Form: map[string][]string{
"token": []string{"token"},
Expand All @@ -135,6 +142,21 @@ func TestAuthenticatorOAuth2Introspection(t *testing.T) {
})
},
},
{
d: "should pass because the valid token was provided in a proper location (cookie)",
r: &http.Request{Header: http.Header{"Cookie": {"biscuit=token"}}},
config: []byte(`{"token_from": {"cookie": "biscuit"}}`),
expectErr: false,
setup: func(t *testing.T, m *httprouter.Router) {
m.POST("/oauth2/introspect", func(w http.ResponseWriter, r *http.Request, _ httprouter.Params) {
require.NoError(t, r.ParseForm())
require.Equal(t, "token", r.Form.Get("token"))
require.NoError(t, json.NewEncoder(w).Encode(&AuthenticatorOAuth2IntrospectionResult{
Active: true,
}))
})
},
},
{
d: "should fail because not active",
r: &http.Request{Header: http.Header{"Authorization": {"bearer token"}}},
Expand Down