def setUp(self):
self.mock_validator = mock.MagicMock()
self.addCleanup(setattr, self, 'mock_validator', mock.MagicMock())
auth_code = AuthorizationCodeGrant(
request_validator=self.mock_validator)
auth_code.save_authorization_code = mock.MagicMock()
implicit = ImplicitGrant(request_validator=self.mock_validator)
implicit.save_token = mock.MagicMock()
openid_connect_auth = OpenIDConnectAuthCode(self.mock_validator)
openid_connect_implicit = OpenIDConnectImplicit(self.mock_validator)
response_types = {
'code': auth_code,
'token': implicit,
'id_token': openid_connect_implicit,
'id_token token': openid_connect_implicit,
'code token': openid_connect_auth,
'code id_token': openid_connect_auth,
'code token id_token': openid_connect_auth,
'none': auth_code
}
self.expires_in = 1800
token = tokens.BearerToken(self.mock_validator,
expires_in=self.expires_in)
self.endpoint = AuthorizationEndpoint(default_response_type='code',
default_token_type=token,
response_types=response_types)
def setUp(self):
self.mock_validator = mock.MagicMock()
self.addCleanup(setattr, self, 'mock_validator', mock.MagicMock())
auth_code = AuthorizationCodeGrant(
request_validator=self.mock_validator)
auth_code.save_authorization_code = mock.MagicMock()
implicit = ImplicitGrant(
request_validator=self.mock_validator)
implicit.save_token = mock.MagicMock()
openid_connect_auth = OpenIDConnectAuthCode(self.mock_validator)
openid_connect_implicit = OpenIDConnectImplicit(self.mock_validator)
response_types = {
'code': auth_code,
'token': implicit,
'id_token': openid_connect_implicit,
'id_token token': openid_connect_implicit,
'code token': openid_connect_auth,
'code id_token': openid_connect_auth,
'code token id_token': openid_connect_auth,
'none': auth_code
}
self.expires_in = 1800
token = tokens.BearerToken(self.mock_validator,
expires_in=self.expires_in)
self.endpoint = AuthorizationEndpoint(
default_response_type='code',
default_token_type=token,
response_types=response_types)
def setUp(self):
self.mock_validator = mock.MagicMock()
self.mock_validator.get_code_challenge.return_value = None
self.addCleanup(setattr, self, 'mock_validator', mock.MagicMock())
auth_code = AuthorizationCodeGrant(
request_validator=self.mock_validator)
auth_code.save_authorization_code = mock.MagicMock()
implicit = ImplicitGrant(
request_validator=self.mock_validator)
implicit.save_token = mock.MagicMock()
response_types = {
'code': auth_code,
'token': implicit,
'none': auth_code
}
self.expires_in = 1800
token = tokens.BearerToken(
self.mock_validator,
expires_in=self.expires_in
)
self.endpoint = AuthorizationEndpoint(
default_response_type='code',
default_token_type=token,
response_types=response_types
)
def setUp(self):
self.mock_validator = mock.MagicMock()
self.addCleanup(setattr, self, "mock_validator", mock.MagicMock())
auth_code = AuthorizationCodeGrant(request_validator=self.mock_validator)
auth_code.save_authorization_code = mock.MagicMock()
implicit = ImplicitGrant(request_validator=self.mock_validator)
implicit.save_token = mock.MagicMock()
response_types = {"code": auth_code, "token": implicit}
self.expires_in = 1800
token = tokens.BearerToken(self.mock_validator, expires_in=self.expires_in)
self.endpoint = AuthorizationEndpoint(
default_response_type="code", default_token_type=token, response_types=response_types
)
def setUp(self):
self.request = Request('http://a.b/path')
self.request.scopes = ('hello', 'world')
self.request.expires_in = 1800
self.request.client = 'batman'
self.request.client_id = 'abcdef'
self.request.code = '1234'
self.request.response_type = 'code'
self.request.grant_type = 'authorization_code'
self.request.redirect_uri = 'https://a.b/cb'
self.mock_validator = mock.MagicMock()
self.mock_validator.authenticate_client.side_effect = self.set_client
self.auth = AuthorizationCodeGrant(request_validator=self.mock_validator)
def __init__(self, request_validator, token_generator=None,
token_expires_in=None, refresh_token_generator=None, **kwargs):
"""Construct a new web application server.
:param request_validator: An implementation of
oauthlib.oauth2.RequestValidator.
:param token_expires_in: An int or a function to generate a token
expiration offset (in seconds) given a
oauthlib.common.Request object.
:param token_generator: A function to generate a token from a request.
:param refresh_token_generator: A function to generate a token from a
request for the refresh token.
:param kwargs: Extra parameters to pass to authorization-,
token-, resource-, and revocation-endpoint constructors.
"""
auth_grant = AuthorizationCodeGrant(request_validator)
refresh_grant = RefreshTokenGrant(request_validator)
bearer = BearerToken(request_validator, token_generator,
token_expires_in, refresh_token_generator)
AuthorizationEndpoint.__init__(self, default_response_type='code',
response_types={'code': auth_grant},
default_token_type=bearer)
TokenEndpoint.__init__(self, default_grant_type='authorization_code',
grant_types={
'authorization_code': auth_grant,
'refresh_token': refresh_grant,
},
default_token_type=bearer)
ResourceEndpoint.__init__(self, default_token='Bearer',
token_types={'Bearer': bearer})
RevocationEndpoint.__init__(self, request_validator)
def setUp(self):
def set_user(request):
request.user = mock.MagicMock()
request.client = mock.MagicMock()
request.client.client_id = 'mocked_client_id'
return True
self.mock_validator = mock.MagicMock()
self.mock_validator.authenticate_client.side_effect = set_user
self.addCleanup(setattr, self, 'mock_validator', mock.MagicMock())
auth_code = AuthorizationCodeGrant(
request_validator=self.mock_validator)
password = ResourceOwnerPasswordCredentialsGrant(
request_validator=self.mock_validator)
client = ClientCredentialsGrant(request_validator=self.mock_validator)
supported_types = {
'authorization_code': auth_code,
'password': password,
'client_credentials': client,
}
self.expires_in = 1800
token = tokens.BearerToken(self.mock_validator,
expires_in=self.expires_in)
self.endpoint = TokenEndpoint('authorization_code',
default_token_type=token,
grant_types=supported_types)
def setUp(self):
self.request = Request('http://a.b/path')
self.request.decoded_body = (
("client_id", "me"),
("code", "code"),
("redirect_url", "https://a.b/cb"),
)
self.request_validator = mock.MagicMock()
self.auth_grant = AuthorizationCodeGrant(self.request_validator)
self.openid_connect_auth = OpenIDConnectAuthCode(
self.request_validator)
def test_validate_token_request(self):
mock_validator = mock.MagicMock()
auth = AuthorizationCodeGrant(request_validator=mock_validator)
request = Request('http://a.b/path')
self.assertRaises(UnsupportedGrantTypeError,
auth.validate_token_request, request)
request.grant_type = 'authorization_code'
self.assertRaises(InvalidRequestError, auth.validate_token_request,
request)
mock_validator.authenticate_client.return_value = False
mock_validator.authenticate_client_id.return_value = False
request.code = 'waffles'
self.assertRaises(InvalidClientError, auth.validate_token_request,
request)
request.client = 'batman'
mock_validator.authenticate_client = self.set_client
mock_validator.validate_code.return_value = False
self.assertRaises(InvalidGrantError, auth.validate_token_request,
request)
class AuthorizationCodeGrantTest(TestCase):
def setUp(self):
self.request = Request('http://a.b/path')
self.request.scopes = ('hello', 'world')
self.request.expires_in = 1800
self.request.client = 'batman'
self.request.client_id = 'abcdef'
self.request.code = '1234'
self.request.response_type = 'code'
self.request.grant_type = 'authorization_code'
self.request_state = Request('http://a.b/path')
self.request_state.state = 'abc'
self.mock_validator = mock.MagicMock()
self.mock_validator.authenticate_client.side_effect = self.set_client
self.auth = AuthorizationCodeGrant(
request_validator=self.mock_validator)
def set_client(self, request):
request.client = mock.MagicMock()
request.client.client_id = 'mocked'
return True
def test_create_authorization_grant(self):
grant = self.auth.create_authorization_code(self.request)
self.assertIn('code', grant)
grant = self.auth.create_authorization_code(self.request_state)
self.assertIn('code', grant)
self.assertIn('state', grant)
def test_create_token_response(self):
bearer = BearerToken(self.mock_validator)
u, h, token, s = self.auth.create_token_response(self.request, bearer)
token = json.loads(token)
self.assertIn('access_token', token)
self.assertIn('refresh_token', token)
self.assertIn('expires_in', token)
self.assertIn('scope', token)
def test_validate_token_request(self):
mock_validator = mock.MagicMock()
auth = AuthorizationCodeGrant(request_validator=mock_validator)
request = Request('http://a.b/path')
self.assertRaises(UnsupportedGrantTypeError,
auth.validate_token_request, request)
request.grant_type = 'authorization_code'
self.assertRaises(InvalidRequestError, auth.validate_token_request,
request)
mock_validator.authenticate_client.return_value = False
mock_validator.authenticate_client_id.return_value = False
request.code = 'waffles'
self.assertRaises(InvalidClientError, auth.validate_token_request,
request)
request.client = 'batman'
mock_validator.authenticate_client = self.set_client
mock_validator.validate_code.return_value = False
self.assertRaises(InvalidGrantError, auth.validate_token_request,
request)
def __init__(self, request_validator, token_expires_in=None,
token_generator=None, refresh_token_generator=None,
*args, **kwargs):
"""Construct a new all-grants-in-one server.
:param request_validator: An implementation of
oauthlib.oauth2.RequestValidator.
:param token_expires_in: An int or a function to generate a token
expiration offset (in seconds) given a
oauthlib.common.Request object.
:param token_generator: A function to generate a token from a request.
:param refresh_token_generator: A function to generate a token from a
request for the refresh token.
:param kwargs: Extra parameters to pass to authorization-,
token-, resource-, and revocation-endpoint constructors.
"""
auth_grant = AuthorizationCodeGrant(request_validator)
implicit_grant = ImplicitGrant(request_validator)
password_grant = ResourceOwnerPasswordCredentialsGrant(
request_validator)
credentials_grant = ClientCredentialsGrant(request_validator)
refresh_grant = RefreshTokenGrant(request_validator)
openid_connect_auth = OpenIDConnectAuthCode(request_validator)
openid_connect_implicit = OpenIDConnectImplicit(request_validator)
bearer = BearerToken(request_validator, token_generator,
token_expires_in, refresh_token_generator)
auth_grant_choice = AuthCodeGrantDispatcher(
default_auth_grant=auth_grant,
oidc_auth_grant=openid_connect_auth)
# See http://openid.net/specs/oauth-v2-multiple-response-types-1_0.html#Combinations for valid combinations # noqa
# internally our AuthorizationEndpoint will ensure they can appear in any order for any valid combination # noqa
AuthorizationEndpoint.__init__(
self,
default_response_type='code',
response_types={
'code': auth_grant_choice,
'token': implicit_grant,
'id_token': openid_connect_implicit,
'id_token token': openid_connect_implicit,
'code token': openid_connect_auth,
'code id_token': openid_connect_auth,
'code token id_token': openid_connect_auth,
'none': auth_grant
},
default_token_type=bearer)
TokenEndpoint.__init__(
self,
default_grant_type='authorization_code',
grant_types={
'authorization_code': openid_connect_auth,
'password': password_grant,
'client_credentials': credentials_grant,
'refresh_token': refresh_grant,
'openid': openid_connect_auth
},
default_token_type=bearer)
ResourceEndpoint.__init__(
self,
default_token='Bearer',
token_types={'Bearer': bearer})
RevocationEndpoint.__init__(self, request_validator)
class AuthorizationCodeGrantTest(TestCase):
def setUp(self):
self.request = Request('http://a.b/path')
self.request.scopes = ('hello', 'world')
self.request.expires_in = 1800
self.request.client = 'batman'
self.request.client_id = 'abcdef'
self.request.code = '1234'
self.request.response_type = 'code'
self.request.grant_type = 'authorization_code'
self.request_state = Request('http://a.b/path')
self.request_state.state = 'abc'
self.mock_validator = mock.MagicMock()
self.mock_validator.authenticate_client.side_effect = self.set_client
self.auth = AuthorizationCodeGrant(request_validator=self.mock_validator)
def set_client(self, request):
request.client = mock.MagicMock()
request.client.client_id = 'mocked'
return True
def test_create_authorization_grant(self):
grant = self.auth.create_authorization_code(self.request)
self.assertIn('code', grant)
grant = self.auth.create_authorization_code(self.request_state)
self.assertIn('code', grant)
self.assertIn('state', grant)
def test_create_token_response(self):
bearer = BearerToken(self.mock_validator)
u, h, token, s = self.auth.create_token_response(self.request, bearer)
token = json.loads(token)
self.assertIn('access_token', token)
self.assertIn('refresh_token', token)
self.assertIn('expires_in', token)
self.assertIn('scope', token)
def test_validate_token_request(self):
mock_validator = mock.MagicMock()
auth = AuthorizationCodeGrant(request_validator=mock_validator)
request = Request('http://a.b/path')
self.assertRaises(UnsupportedGrantTypeError,
auth.validate_token_request, request)
request.grant_type = 'authorization_code'
self.assertRaises(InvalidRequestError,
auth.validate_token_request, request)
mock_validator.authenticate_client.return_value = False
mock_validator.authenticate_client_id.return_value = False
request.code = 'waffles'
self.assertRaises(InvalidClientError,
auth.validate_token_request, request)
request.client = 'batman'
mock_validator.authenticate_client = self.set_client
mock_validator.validate_code.return_value = False
self.assertRaises(InvalidGrantError,
auth.validate_token_request, request)
class AuthorizationCodeGrantTest(TestCase):
def setUp(self):
self.request = Request('http://a.b/path')
self.request.scopes = ('hello', 'world')
self.request.expires_in = 1800
self.request.client = 'batman'
self.request.client_id = 'abcdef'
self.request.code = '1234'
self.request.response_type = 'code'
self.request.grant_type = 'authorization_code'
self.request.redirect_uri = 'https://a.b/cb'
self.mock_validator = mock.MagicMock()
self.mock_validator.is_pkce_required.return_value = False
self.mock_validator.get_code_challenge.return_value = None
self.mock_validator.authenticate_client.side_effect = self.set_client
self.auth = AuthorizationCodeGrant(
request_validator=self.mock_validator)
def set_client(self, request):
request.client = mock.MagicMock()
request.client.client_id = 'mocked'
return True
def setup_validators(self):
self.authval1, self.authval2 = mock.Mock(), mock.Mock()
self.authval1.return_value = {}
self.authval2.return_value = {}
self.tknval1, self.tknval2 = mock.Mock(), mock.Mock()
self.tknval1.return_value = None
self.tknval2.return_value = None
self.auth.custom_validators.pre_token.append(self.tknval1)
self.auth.custom_validators.post_token.append(self.tknval2)
self.auth.custom_validators.pre_auth.append(self.authval1)
self.auth.custom_validators.post_auth.append(self.authval2)
def test_custom_auth_validators(self):
self.setup_validators()
bearer = BearerToken(self.mock_validator)
self.auth.create_authorization_response(self.request, bearer)
self.assertTrue(self.authval1.called)
self.assertTrue(self.authval2.called)
self.assertFalse(self.tknval1.called)
self.assertFalse(self.tknval2.called)
def test_custom_token_validators(self):
self.setup_validators()
bearer = BearerToken(self.mock_validator)
self.auth.create_token_response(self.request, bearer)
self.assertTrue(self.tknval1.called)
self.assertTrue(self.tknval2.called)
self.assertFalse(self.authval1.called)
self.assertFalse(self.authval2.called)
def test_create_authorization_grant(self):
bearer = BearerToken(self.mock_validator)
self.request.response_mode = 'query'
h, b, s = self.auth.create_authorization_response(self.request, bearer)
grant = dict(Request(h['Location']).uri_query_params)
self.assertIn('code', grant)
self.assertTrue(self.mock_validator.validate_redirect_uri.called)
self.assertTrue(self.mock_validator.validate_response_type.called)
self.assertTrue(self.mock_validator.validate_scopes.called)
def test_create_authorization_grant_no_scopes(self):
bearer = BearerToken(self.mock_validator)
self.request.response_mode = 'query'
self.request.scopes = []
self.auth.create_authorization_response(self.request, bearer)
def test_create_authorization_grant_state(self):
self.request.state = 'abc'
self.request.redirect_uri = None
self.request.response_mode = 'query'
self.mock_validator.get_default_redirect_uri.return_value = 'https://a.b/cb'
bearer = BearerToken(self.mock_validator)
h, b, s = self.auth.create_authorization_response(self.request, bearer)
grant = dict(Request(h['Location']).uri_query_params)
self.assertIn('code', grant)
self.assertIn('state', grant)
self.assertFalse(self.mock_validator.validate_redirect_uri.called)
self.assertTrue(self.mock_validator.get_default_redirect_uri.called)
self.assertTrue(self.mock_validator.validate_response_type.called)
self.assertTrue(self.mock_validator.validate_scopes.called)
@mock.patch('oauthlib.common.generate_token')
def test_create_authorization_response(self, generate_token):
generate_token.return_value = 'abc'
bearer = BearerToken(self.mock_validator)
self.request.response_mode = 'query'
h, b, s = self.auth.create_authorization_response(self.request, bearer)
self.assertURLEqual(h['Location'], 'https://a.b/cb?code=abc')
self.request.response_mode = 'fragment'
h, b, s = self.auth.create_authorization_response(self.request, bearer)
self.assertURLEqual(h['Location'], 'https://a.b/cb#code=abc')
def test_create_token_response(self):
bearer = BearerToken(self.mock_validator)
h, token, s = self.auth.create_token_response(self.request, bearer)
token = json.loads(token)
self.assertEqual(self.mock_validator.save_token.call_count, 1)
self.assertIn('access_token', token)
self.assertIn('refresh_token', token)
self.assertIn('expires_in', token)
self.assertIn('scope', token)
self.assertTrue(
self.mock_validator.client_authentication_required.called)
self.assertTrue(self.mock_validator.authenticate_client.called)
self.assertTrue(self.mock_validator.validate_code.called)
self.assertTrue(self.mock_validator.confirm_redirect_uri.called)
self.assertTrue(self.mock_validator.validate_grant_type.called)
self.assertTrue(
self.mock_validator.invalidate_authorization_code.called)
def test_create_token_response_without_refresh_token(self):
self.auth.refresh_token = False # Not to issue refresh token.
bearer = BearerToken(self.mock_validator)
h, token, s = self.auth.create_token_response(self.request, bearer)
token = json.loads(token)
self.assertEqual(self.mock_validator.save_token.call_count, 1)
self.assertIn('access_token', token)
self.assertNotIn('refresh_token', token)
self.assertIn('expires_in', token)
self.assertIn('scope', token)
self.assertTrue(
self.mock_validator.client_authentication_required.called)
self.assertTrue(self.mock_validator.authenticate_client.called)
self.assertTrue(self.mock_validator.validate_code.called)
self.assertTrue(self.mock_validator.confirm_redirect_uri.called)
self.assertTrue(self.mock_validator.validate_grant_type.called)
self.assertTrue(
self.mock_validator.invalidate_authorization_code.called)
def test_invalid_request(self):
del self.request.code
self.assertRaises(errors.InvalidRequestError,
self.auth.validate_token_request, self.request)
def test_invalid_request_duplicates(self):
request = mock.MagicMock(wraps=self.request)
request.grant_type = 'authorization_code'
request.duplicate_params = ['client_id']
self.assertRaises(errors.InvalidRequestError,
self.auth.validate_token_request, request)
def test_authentication_required(self):
"""
ensure client_authentication_required() is properly called
"""
self.auth.validate_token_request(self.request)
self.mock_validator.client_authentication_required.assert_called_once_with(
self.request)
def test_authenticate_client(self):
self.mock_validator.authenticate_client.side_effect = None
self.mock_validator.authenticate_client.return_value = False
self.assertRaises(errors.InvalidClientError,
self.auth.validate_token_request, self.request)
def test_client_id_missing(self):
self.mock_validator.authenticate_client.side_effect = None
request = mock.MagicMock(wraps=self.request)
request.grant_type = 'authorization_code'
del request.client.client_id
self.assertRaises(NotImplementedError,
self.auth.validate_token_request, request)
def test_invalid_grant(self):
self.request.client = 'batman'
self.mock_validator.authenticate_client = self.set_client
self.mock_validator.validate_code.return_value = False
self.assertRaises(errors.InvalidGrantError,
self.auth.validate_token_request, self.request)
def test_invalid_grant_type(self):
self.request.grant_type = 'foo'
self.assertRaises(errors.UnsupportedGrantTypeError,
self.auth.validate_token_request, self.request)
def test_authenticate_client_id(self):
self.mock_validator.client_authentication_required.return_value = False
self.mock_validator.authenticate_client_id.return_value = False
self.request.state = 'abc'
self.assertRaises(errors.InvalidClientError,
self.auth.validate_token_request, self.request)
def test_invalid_redirect_uri(self):
self.mock_validator.confirm_redirect_uri.return_value = False
self.assertRaises(errors.MismatchingRedirectURIError,
self.auth.validate_token_request, self.request)
# PKCE validate_authorization_request
def test_pkce_challenge_missing(self):
self.mock_validator.is_pkce_required.return_value = True
self.assertRaises(errors.MissingCodeChallengeError,
self.auth.validate_authorization_request,
self.request)
def test_pkce_default_method(self):
for required in [True, False]:
self.mock_validator.is_pkce_required.return_value = required
self.request.code_challenge = "present"
_, ri = self.auth.validate_authorization_request(self.request)
self.assertIn("code_challenge", ri)
self.assertIn("code_challenge_method", ri)
self.assertEqual(ri["code_challenge"], "present")
self.assertEqual(ri["code_challenge_method"], "plain")
def test_pkce_wrong_method(self):
for required in [True, False]:
self.mock_validator.is_pkce_required.return_value = required
self.request.code_challenge = "present"
self.request.code_challenge_method = "foobar"
self.assertRaises(errors.UnsupportedCodeChallengeMethodError,
self.auth.validate_authorization_request,
self.request)
# PKCE validate_token_request
def test_pkce_verifier_missing(self):
self.mock_validator.is_pkce_required.return_value = True
self.assertRaises(errors.MissingCodeVerifierError,
self.auth.validate_token_request, self.request)
# PKCE validate_token_request
def test_pkce_required_verifier_missing_challenge_missing(self):
self.mock_validator.is_pkce_required.return_value = True
self.request.code_verifier = None
self.mock_validator.get_code_challenge.return_value = None
self.assertRaises(errors.MissingCodeVerifierError,
self.auth.validate_token_request, self.request)
def test_pkce_required_verifier_missing_challenge_valid(self):
self.mock_validator.is_pkce_required.return_value = True
self.request.code_verifier = None
self.mock_validator.get_code_challenge.return_value = "foo"
self.assertRaises(errors.MissingCodeVerifierError,
self.auth.validate_token_request, self.request)
def test_pkce_required_verifier_valid_challenge_missing(self):
self.mock_validator.is_pkce_required.return_value = True
self.request.code_verifier = "foobar"
self.mock_validator.get_code_challenge.return_value = None
self.assertRaises(errors.InvalidGrantError,
self.auth.validate_token_request, self.request)
def test_pkce_required_verifier_valid_challenge_valid_method_valid(self):
self.mock_validator.is_pkce_required.return_value = True
self.request.code_verifier = "foobar"
self.mock_validator.get_code_challenge.return_value = "foobar"
self.mock_validator.get_code_challenge_method.return_value = "plain"
self.auth.validate_token_request(self.request)
def test_pkce_required_verifier_invalid_challenge_valid_method_valid(self):
self.mock_validator.is_pkce_required.return_value = True
self.request.code_verifier = "foobar"
self.mock_validator.get_code_challenge.return_value = "raboof"
self.mock_validator.get_code_challenge_method.return_value = "plain"
self.assertRaises(errors.InvalidGrantError,
self.auth.validate_token_request, self.request)
def test_pkce_required_verifier_valid_challenge_valid_method_wrong(self):
self.mock_validator.is_pkce_required.return_value = True
self.request.code_verifier = "present"
self.mock_validator.get_code_challenge.return_value = "foobar"
self.mock_validator.get_code_challenge_method.return_value = "cryptic_method"
self.assertRaises(errors.ServerError, self.auth.validate_token_request,
self.request)
def test_pkce_verifier_valid_challenge_valid_method_missing(self):
self.mock_validator.is_pkce_required.return_value = True
self.request.code_verifier = "present"
self.mock_validator.get_code_challenge.return_value = "foobar"
self.mock_validator.get_code_challenge_method.return_value = None
self.assertRaises(errors.InvalidGrantError,
self.auth.validate_token_request, self.request)
def test_pkce_optional_verifier_valid_challenge_missing(self):
self.mock_validator.is_pkce_required.return_value = False
self.request.code_verifier = "present"
self.mock_validator.get_code_challenge.return_value = None
self.auth.validate_token_request(self.request)
def test_pkce_optional_verifier_missing_challenge_valid(self):
self.mock_validator.is_pkce_required.return_value = False
self.request.code_verifier = None
self.mock_validator.get_code_challenge.return_value = "foobar"
self.assertRaises(errors.MissingCodeVerifierError,
self.auth.validate_token_request, self.request)
# PKCE functions
def test_wrong_code_challenge_method_plain(self):
self.assertFalse(
authorization_code.code_challenge_method_plain("foo", "bar"))
def test_correct_code_challenge_method_plain(self):
self.assertTrue(
authorization_code.code_challenge_method_plain("foo", "foo"))
def test_wrong_code_challenge_method_s256(self):
self.assertFalse(
authorization_code.code_challenge_method_s256("foo", "bar"))
def test_correct_code_challenge_method_s256(self):
# "abcd" as verifier gives a '+' to base64
self.assertTrue(
authorization_code.code_challenge_method_s256(
"abcd", "iNQmb9TmM40TuEX88olXnSCciXgjuSF9o-Fhk28DFYk"))
# "/" as verifier gives a '/' and '+' to base64
self.assertTrue(
authorization_code.code_challenge_method_s256(
"/", "il7asoJjJEMhngUeSt4tHVu8Zxx4EFG_FDeJfL3-oPE"))
# Example from PKCE RFCE
self.assertTrue(
authorization_code.code_challenge_method_s256(
"dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk",
"E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM"))
class AuthorizationCodeGrantTest(TestCase):
def setUp(self):
self.request = Request('http://a.b/path')
self.request.scopes = ('hello', 'world')
self.request.expires_in = 1800
self.request.client = 'batman'
self.request.client_id = 'abcdef'
self.request.code = '1234'
self.request.response_type = 'code'
self.request.grant_type = 'authorization_code'
self.request.redirect_uri = 'https://a.b/cb'
self.mock_validator = mock.MagicMock()
self.mock_validator.is_pkce_required.return_value = False
self.mock_validator.get_code_challenge.return_value = None
self.mock_validator.authenticate_client.side_effect = self.set_client
self.auth = AuthorizationCodeGrant(request_validator=self.mock_validator)
def set_client(self, request):
request.client = mock.MagicMock()
request.client.client_id = 'mocked'
return True
def setup_validators(self):
self.authval1, self.authval2 = mock.Mock(), mock.Mock()
self.authval1.return_value = {}
self.authval2.return_value = {}
self.tknval1, self.tknval2 = mock.Mock(), mock.Mock()
self.tknval1.return_value = None
self.tknval2.return_value = None
self.auth.custom_validators.pre_token.append(self.tknval1)
self.auth.custom_validators.post_token.append(self.tknval2)
self.auth.custom_validators.pre_auth.append(self.authval1)
self.auth.custom_validators.post_auth.append(self.authval2)
def test_custom_auth_validators(self):
self.setup_validators()
bearer = BearerToken(self.mock_validator)
self.auth.create_authorization_response(self.request, bearer)
self.assertTrue(self.authval1.called)
self.assertTrue(self.authval2.called)
self.assertFalse(self.tknval1.called)
self.assertFalse(self.tknval2.called)
def test_custom_token_validators(self):
self.setup_validators()
bearer = BearerToken(self.mock_validator)
self.auth.create_token_response(self.request, bearer)
self.assertTrue(self.tknval1.called)
self.assertTrue(self.tknval2.called)
self.assertFalse(self.authval1.called)
self.assertFalse(self.authval2.called)
def test_create_authorization_grant(self):
bearer = BearerToken(self.mock_validator)
self.request.response_mode = 'query'
h, b, s = self.auth.create_authorization_response(self.request, bearer)
grant = dict(Request(h['Location']).uri_query_params)
self.assertIn('code', grant)
self.assertTrue(self.mock_validator.validate_redirect_uri.called)
self.assertTrue(self.mock_validator.validate_response_type.called)
self.assertTrue(self.mock_validator.validate_scopes.called)
def test_create_authorization_grant_no_scopes(self):
bearer = BearerToken(self.mock_validator)
self.request.response_mode = 'query'
self.request.scopes = []
self.auth.create_authorization_response(self.request, bearer)
def test_create_authorization_grant_state(self):
self.request.state = 'abc'
self.request.redirect_uri = None
self.request.response_mode = 'query'
self.mock_validator.get_default_redirect_uri.return_value = 'https://a.b/cb'
bearer = BearerToken(self.mock_validator)
h, b, s = self.auth.create_authorization_response(self.request, bearer)
grant = dict(Request(h['Location']).uri_query_params)
self.assertIn('code', grant)
self.assertIn('state', grant)
self.assertFalse(self.mock_validator.validate_redirect_uri.called)
self.assertTrue(self.mock_validator.get_default_redirect_uri.called)
self.assertTrue(self.mock_validator.validate_response_type.called)
self.assertTrue(self.mock_validator.validate_scopes.called)
@mock.patch('oauthlib.common.generate_token')
def test_create_authorization_response(self, generate_token):
generate_token.return_value = 'abc'
bearer = BearerToken(self.mock_validator)
self.request.response_mode = 'query'
h, b, s = self.auth.create_authorization_response(self.request, bearer)
self.assertURLEqual(h['Location'], 'https://a.b/cb?code=abc')
self.request.response_mode = 'fragment'
h, b, s = self.auth.create_authorization_response(self.request, bearer)
self.assertURLEqual(h['Location'], 'https://a.b/cb#code=abc')
def test_create_token_response(self):
bearer = BearerToken(self.mock_validator)
h, token, s = self.auth.create_token_response(self.request, bearer)
token = json.loads(token)
self.assertEqual(self.mock_validator.save_token.call_count, 1)
self.assertIn('access_token', token)
self.assertIn('refresh_token', token)
self.assertIn('expires_in', token)
self.assertIn('scope', token)
self.assertTrue(self.mock_validator.client_authentication_required.called)
self.assertTrue(self.mock_validator.authenticate_client.called)
self.assertTrue(self.mock_validator.validate_code.called)
self.assertTrue(self.mock_validator.confirm_redirect_uri.called)
self.assertTrue(self.mock_validator.validate_grant_type.called)
self.assertTrue(self.mock_validator.invalidate_authorization_code.called)
def test_create_token_response_without_refresh_token(self):
self.auth.refresh_token = False # Not to issue refresh token.
bearer = BearerToken(self.mock_validator)
h, token, s = self.auth.create_token_response(self.request, bearer)
token = json.loads(token)
self.assertEqual(self.mock_validator.save_token.call_count, 1)
self.assertIn('access_token', token)
self.assertNotIn('refresh_token', token)
self.assertIn('expires_in', token)
self.assertIn('scope', token)
self.assertTrue(self.mock_validator.client_authentication_required.called)
self.assertTrue(self.mock_validator.authenticate_client.called)
self.assertTrue(self.mock_validator.validate_code.called)
self.assertTrue(self.mock_validator.confirm_redirect_uri.called)
self.assertTrue(self.mock_validator.validate_grant_type.called)
self.assertTrue(self.mock_validator.invalidate_authorization_code.called)
def test_invalid_request(self):
del self.request.code
self.assertRaises(errors.InvalidRequestError, self.auth.validate_token_request,
self.request)
def test_invalid_request_duplicates(self):
request = mock.MagicMock(wraps=self.request)
request.grant_type = 'authorization_code'
request.duplicate_params = ['client_id']
self.assertRaises(errors.InvalidRequestError, self.auth.validate_token_request,
request)
def test_authentication_required(self):
"""
ensure client_authentication_required() is properly called
"""
self.auth.validate_token_request(self.request)
self.mock_validator.client_authentication_required.assert_called_once_with(self.request)
def test_authenticate_client(self):
self.mock_validator.authenticate_client.side_effect = None
self.mock_validator.authenticate_client.return_value = False
self.assertRaises(errors.InvalidClientError, self.auth.validate_token_request,
self.request)
def test_client_id_missing(self):
self.mock_validator.authenticate_client.side_effect = None
request = mock.MagicMock(wraps=self.request)
request.grant_type = 'authorization_code'
del request.client.client_id
self.assertRaises(NotImplementedError, self.auth.validate_token_request,
request)
def test_invalid_grant(self):
self.request.client = 'batman'
self.mock_validator.authenticate_client = self.set_client
self.mock_validator.validate_code.return_value = False
self.assertRaises(errors.InvalidGrantError,
self.auth.validate_token_request, self.request)
def test_invalid_grant_type(self):
self.request.grant_type = 'foo'
self.assertRaises(errors.UnsupportedGrantTypeError,
self.auth.validate_token_request, self.request)
def test_authenticate_client_id(self):
self.mock_validator.client_authentication_required.return_value = False
self.mock_validator.authenticate_client_id.return_value = False
self.request.state = 'abc'
self.assertRaises(errors.InvalidClientError,
self.auth.validate_token_request, self.request)
def test_invalid_redirect_uri(self):
self.mock_validator.confirm_redirect_uri.return_value = False
self.assertRaises(errors.MismatchingRedirectURIError,
self.auth.validate_token_request, self.request)
# PKCE validate_authorization_request
def test_pkce_challenge_missing(self):
self.mock_validator.is_pkce_required.return_value = True
self.assertRaises(errors.MissingCodeChallengeError,
self.auth.validate_authorization_request, self.request)
def test_pkce_default_method(self):
for required in [True, False]:
self.mock_validator.is_pkce_required.return_value = required
self.request.code_challenge = "present"
_, ri = self.auth.validate_authorization_request(self.request)
self.assertIn("code_challenge", ri)
self.assertIn("code_challenge_method", ri)
self.assertEqual(ri["code_challenge"], "present")
self.assertEqual(ri["code_challenge_method"], "plain")
def test_pkce_wrong_method(self):
for required in [True, False]:
self.mock_validator.is_pkce_required.return_value = required
self.request.code_challenge = "present"
self.request.code_challenge_method = "foobar"
self.assertRaises(errors.UnsupportedCodeChallengeMethodError,
self.auth.validate_authorization_request, self.request)
# PKCE validate_token_request
def test_pkce_verifier_missing(self):
self.mock_validator.is_pkce_required.return_value = True
self.assertRaises(errors.MissingCodeVerifierError,
self.auth.validate_token_request, self.request)
# PKCE validate_token_request
def test_pkce_required_verifier_missing_challenge_missing(self):
self.mock_validator.is_pkce_required.return_value = True
self.request.code_verifier = None
self.mock_validator.get_code_challenge.return_value = None
self.assertRaises(errors.MissingCodeVerifierError,
self.auth.validate_token_request, self.request)
def test_pkce_required_verifier_missing_challenge_valid(self):
self.mock_validator.is_pkce_required.return_value = True
self.request.code_verifier = None
self.mock_validator.get_code_challenge.return_value = "foo"
self.assertRaises(errors.MissingCodeVerifierError,
self.auth.validate_token_request, self.request)
def test_pkce_required_verifier_valid_challenge_missing(self):
self.mock_validator.is_pkce_required.return_value = True
self.request.code_verifier = "foobar"
self.mock_validator.get_code_challenge.return_value = None
self.assertRaises(errors.InvalidGrantError,
self.auth.validate_token_request, self.request)
def test_pkce_required_verifier_valid_challenge_valid_method_valid(self):
self.mock_validator.is_pkce_required.return_value = True
self.request.code_verifier = "foobar"
self.mock_validator.get_code_challenge.return_value = "foobar"
self.mock_validator.get_code_challenge_method.return_value = "plain"
self.auth.validate_token_request(self.request)
def test_pkce_required_verifier_invalid_challenge_valid_method_valid(self):
self.mock_validator.is_pkce_required.return_value = True
self.request.code_verifier = "foobar"
self.mock_validator.get_code_challenge.return_value = "raboof"
self.mock_validator.get_code_challenge_method.return_value = "plain"
self.assertRaises(errors.InvalidGrantError,
self.auth.validate_token_request, self.request)
def test_pkce_required_verifier_valid_challenge_valid_method_wrong(self):
self.mock_validator.is_pkce_required.return_value = True
self.request.code_verifier = "present"
self.mock_validator.get_code_challenge.return_value = "foobar"
self.mock_validator.get_code_challenge_method.return_value = "cryptic_method"
self.assertRaises(errors.ServerError,
self.auth.validate_token_request, self.request)
def test_pkce_verifier_valid_challenge_valid_method_missing(self):
self.mock_validator.is_pkce_required.return_value = True
self.request.code_verifier = "present"
self.mock_validator.get_code_challenge.return_value = "foobar"
self.mock_validator.get_code_challenge_method.return_value = None
self.assertRaises(errors.InvalidGrantError,
self.auth.validate_token_request, self.request)
def test_pkce_optional_verifier_valid_challenge_missing(self):
self.mock_validator.is_pkce_required.return_value = False
self.request.code_verifier = "present"
self.mock_validator.get_code_challenge.return_value = None
self.auth.validate_token_request(self.request)
def test_pkce_optional_verifier_missing_challenge_valid(self):
self.mock_validator.is_pkce_required.return_value = False
self.request.code_verifier = None
self.mock_validator.get_code_challenge.return_value = "foobar"
self.assertRaises(errors.MissingCodeVerifierError,
self.auth.validate_token_request, self.request)
# PKCE functions
def test_wrong_code_challenge_method_plain(self):
self.assertFalse(authorization_code.code_challenge_method_plain("foo", "bar"))
def test_correct_code_challenge_method_plain(self):
self.assertTrue(authorization_code.code_challenge_method_plain("foo", "foo"))
def test_wrong_code_challenge_method_s256(self):
self.assertFalse(authorization_code.code_challenge_method_s256("foo", "bar"))
def test_correct_code_challenge_method_s256(self):
# "abcd" as verifier gives a '+' to base64
self.assertTrue(
authorization_code.code_challenge_method_s256("abcd",
"iNQmb9TmM40TuEX88olXnSCciXgjuSF9o-Fhk28DFYk")
)
# "/" as verifier gives a '/' and '+' to base64
self.assertTrue(
authorization_code.code_challenge_method_s256("/",
"il7asoJjJEMhngUeSt4tHVu8Zxx4EFG_FDeJfL3-oPE")
)
# Example from PKCE RFCE
self.assertTrue(
authorization_code.code_challenge_method_s256("dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk",
"E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM")
)
def __init__(self, request_validator, token_handler):
AuthorizationCodeGrant.__init__(self, request_validator)
self._oidc_token_handler = token_handler
class AuthorizationCodeGrantTest(TestCase):
def setUp(self):
self.request = Request('http://a.b/path')
self.request.scopes = ('hello', 'world')
self.request.expires_in = 1800
self.request.client = 'batman'
self.request.client_id = 'abcdef'
self.request.code = '1234'
self.request.response_type = 'code'
self.request.grant_type = 'authorization_code'
self.request.redirect_uri = 'https://a.b/cb'
self.mock_validator = mock.MagicMock()
self.mock_validator.authenticate_client.side_effect = self.set_client
self.auth = AuthorizationCodeGrant(request_validator=self.mock_validator)
def set_client(self, request):
request.client = mock.MagicMock()
request.client.client_id = 'mocked'
return True
def setup_validators(self):
self.authval1, self.authval2 = mock.Mock(), mock.Mock()
self.authval1.return_value = {}
self.authval2.return_value = {}
self.tknval1, self.tknval2 = mock.Mock(), mock.Mock()
self.tknval1.return_value = None
self.tknval2.return_value = None
self.auth.custom_validators.pre_token.append(self.tknval1)
self.auth.custom_validators.post_token.append(self.tknval2)
self.auth.custom_validators.pre_auth.append(self.authval1)
self.auth.custom_validators.post_auth.append(self.authval2)
def test_custom_auth_validators(self):
self.setup_validators()
bearer = BearerToken(self.mock_validator)
self.auth.create_authorization_response(self.request, bearer)
self.assertTrue(self.authval1.called)
self.assertTrue(self.authval2.called)
self.assertFalse(self.tknval1.called)
self.assertFalse(self.tknval2.called)
def test_custom_token_validators(self):
self.setup_validators()
bearer = BearerToken(self.mock_validator)
self.auth.create_token_response(self.request, bearer)
self.assertTrue(self.tknval1.called)
self.assertTrue(self.tknval2.called)
self.assertFalse(self.authval1.called)
self.assertFalse(self.authval2.called)
def test_create_authorization_grant(self):
bearer = BearerToken(self.mock_validator)
h, b, s = self.auth.create_authorization_response(self.request, bearer)
grant = dict(Request(h['Location']).uri_query_params)
self.assertIn('code', grant)
self.assertTrue(self.mock_validator.validate_redirect_uri.called)
self.assertTrue(self.mock_validator.validate_response_type.called)
self.assertTrue(self.mock_validator.validate_scopes.called)
def test_create_authorization_grant_state(self):
self.request.state = 'abc'
self.request.redirect_uri = None
self.mock_validator.get_default_redirect_uri.return_value = 'https://a.b/cb'
bearer = BearerToken(self.mock_validator)
h, b, s = self.auth.create_authorization_response(self.request, bearer)
grant = dict(Request(h['Location']).uri_query_params)
self.assertIn('code', grant)
self.assertIn('state', grant)
self.assertFalse(self.mock_validator.validate_redirect_uri.called)
self.assertTrue(self.mock_validator.get_default_redirect_uri.called)
self.assertTrue(self.mock_validator.validate_response_type.called)
self.assertTrue(self.mock_validator.validate_scopes.called)
@mock.patch('oauthlib.common.generate_token')
def test_create_authorization_response(self, generate_token):
generate_token.return_value = 'abc'
bearer = BearerToken(self.mock_validator)
h, b, s = self.auth.create_authorization_response(self.request, bearer)
self.assertURLEqual(h['Location'], 'https://a.b/cb?code=abc')
self.request.response_mode = 'fragment'
h, b, s = self.auth.create_authorization_response(self.request, bearer)
self.assertURLEqual(h['Location'], 'https://a.b/cb#code=abc')
def test_create_token_response(self):
bearer = BearerToken(self.mock_validator)
h, token, s = self.auth.create_token_response(self.request, bearer)
token = json.loads(token)
self.assertEqual(self.mock_validator.save_token.call_count, 1)
self.assertIn('access_token', token)
self.assertIn('refresh_token', token)
self.assertIn('expires_in', token)
self.assertIn('scope', token)
self.assertTrue(self.mock_validator.client_authentication_required.called)
self.assertTrue(self.mock_validator.authenticate_client.called)
self.assertTrue(self.mock_validator.validate_code.called)
self.assertTrue(self.mock_validator.confirm_redirect_uri.called)
self.assertTrue(self.mock_validator.validate_grant_type.called)
self.assertTrue(self.mock_validator.invalidate_authorization_code.called)
def test_create_token_response_without_refresh_token(self):
self.auth.refresh_token = False # Not to issue refresh token.
bearer = BearerToken(self.mock_validator)
h, token, s = self.auth.create_token_response(self.request, bearer)
token = json.loads(token)
self.assertEqual(self.mock_validator.save_token.call_count, 1)
self.assertIn('access_token', token)
self.assertNotIn('refresh_token', token)
self.assertIn('expires_in', token)
self.assertIn('scope', token)
self.assertTrue(self.mock_validator.client_authentication_required.called)
self.assertTrue(self.mock_validator.authenticate_client.called)
self.assertTrue(self.mock_validator.validate_code.called)
self.assertTrue(self.mock_validator.confirm_redirect_uri.called)
self.assertTrue(self.mock_validator.validate_grant_type.called)
self.assertTrue(self.mock_validator.invalidate_authorization_code.called)
def test_invalid_request(self):
del self.request.code
self.assertRaises(errors.InvalidRequestError, self.auth.validate_token_request,
self.request)
def test_invalid_request_duplicates(self):
request = mock.MagicMock(wraps=self.request)
request.grant_type = 'authorization_code'
request.duplicate_params = ['client_id']
self.assertRaises(errors.InvalidRequestError, self.auth.validate_token_request,
request)
def test_authentication_required(self):
"""
ensure client_authentication_required() is properly called
"""
self.auth.validate_token_request(self.request)
self.mock_validator.client_authentication_required.assert_called_once_with(self.request)
def test_authenticate_client(self):
self.mock_validator.authenticate_client.side_effect = None
self.mock_validator.authenticate_client.return_value = False
self.assertRaises(errors.InvalidClientError, self.auth.validate_token_request,
self.request)
def test_client_id_missing(self):
self.mock_validator.authenticate_client.side_effect = None
request = mock.MagicMock(wraps=self.request)
request.grant_type = 'authorization_code'
del request.client.client_id
self.assertRaises(NotImplementedError, self.auth.validate_token_request,
request)
def test_invalid_grant(self):
self.request.client = 'batman'
self.mock_validator.authenticate_client = self.set_client
self.mock_validator.validate_code.return_value = False
self.assertRaises(errors.InvalidGrantError,
self.auth.validate_token_request, self.request)
def test_invalid_grant_type(self):
self.request.grant_type = 'foo'
self.assertRaises(errors.UnsupportedGrantTypeError,
self.auth.validate_token_request, self.request)
def test_authenticate_client_id(self):
self.mock_validator.client_authentication_required.return_value = False
self.mock_validator.authenticate_client_id.return_value = False
self.request.state = 'abc'
self.assertRaises(errors.InvalidClientError,
self.auth.validate_token_request, self.request)
def test_invalid_redirect_uri(self):
self.mock_validator.confirm_redirect_uri.return_value = False
self.assertRaises(errors.AccessDeniedError,
self.auth.validate_token_request, self.request)
def create_token_response(self, request, token_handler):
return AuthorizationCodeGrant.create_token_response(
self, request, self._oidc_token_handler)
def create_token_response(self, request, token_handler):
return AuthorizationCodeGrant.create_token_response(self, request, self._oidc_token_handler)
def __init__(self, request_validator, token_handler):
AuthorizationCodeGrant.__init__(self, request_validator)
self._oidc_token_handler = token_handler
class AuthorizationCodeGrantTest(TestCase):
def setUp(self):
self.request = Request('http://a.b/path')
self.request.scopes = ('hello', 'world')
self.request.expires_in = 1800
self.request.client = 'batman'
self.request.client_id = 'abcdef'
self.request.code = '1234'
self.request.response_type = 'code'
self.request.grant_type = 'authorization_code'
self.request_state = Request('http://a.b/path')
self.request_state.state = 'abc'
self.mock_validator = mock.MagicMock()
self.mock_validator.authenticate_client.side_effect = self.set_client
self.auth = AuthorizationCodeGrant(
request_validator=self.mock_validator)
def set_client(self, request):
request.client = mock.MagicMock()
request.client.client_id = 'mocked'
return True
def test_create_authorization_grant(self):
grant = self.auth.create_authorization_code(self.request)
self.assertIn('code', grant)
grant = self.auth.create_authorization_code(self.request_state)
self.assertIn('code', grant)
self.assertIn('state', grant)
def test_create_token_response(self):
bearer = BearerToken(self.mock_validator)
h, token, s = self.auth.create_token_response(self.request, bearer)
token = json.loads(token)
self.assertIn('access_token', token)
self.assertIn('refresh_token', token)
self.assertIn('expires_in', token)
self.assertIn('scope', token)
def test_invalid_request(self):
del self.request.code
self.assertRaises(errors.InvalidRequestError,
self.auth.validate_token_request, self.request)
def test_invalid_request_duplicates(self):
request = mock.MagicMock(wraps=self.request)
request.grant_type = 'authorization_code'
request.duplicate_params = ['client_id']
self.assertRaises(errors.InvalidRequestError,
self.auth.validate_token_request, request)
def test_authentication_required(self):
"""
ensure client_authentication_required() is properly called
"""
self.auth.validate_token_request(self.request)
self.mock_validator.client_authentication_required.assert_called_once_with(
self.request)
def test_authenticate_client(self):
self.mock_validator.authenticate_client.side_effect = None
self.mock_validator.authenticate_client.return_value = False
self.assertRaises(errors.InvalidClientError,
self.auth.validate_token_request, self.request)
def test_client_id_missing(self):
self.mock_validator.authenticate_client.side_effect = None
request = mock.MagicMock(wraps=self.request)
request.grant_type = 'authorization_code'
del request.client.client_id
self.assertRaises(NotImplementedError,
self.auth.validate_token_request, request)
def test_invalid_grant(self):
self.request.client = 'batman'
self.mock_validator.authenticate_client = self.set_client
self.mock_validator.validate_code.return_value = False
self.assertRaises(errors.InvalidGrantError,
self.auth.validate_token_request, self.request)
def test_invalid_grant_type(self):
self.request.grant_type = 'foo'
self.assertRaises(errors.UnsupportedGrantTypeError,
self.auth.validate_token_request, self.request)
def test_authenticate_client_id(self):
self.mock_validator.client_authentication_required.return_value = False
self.mock_validator.authenticate_client_id.return_value = False
self.request.state = 'abc'
self.assertRaises(errors.InvalidClientError,
self.auth.validate_token_request, self.request)
def test_invalid_redirect_uri(self):
self.mock_validator.confirm_redirect_uri.return_value = False
self.assertRaises(errors.AccessDeniedError,
self.auth.validate_token_request, self.request)
class AuthorizationCodeGrantTest(TestCase):
def setUp(self):
self.request = Request('http://a.b/path')
self.request.scopes = ('hello', 'world')
self.request.expires_in = 1800
self.request.client = 'batman'
self.request.client_id = 'abcdef'
self.request.code = '1234'
self.request.response_type = 'code'
self.request.grant_type = 'authorization_code'
self.request.redirect_uri = 'https://a.b/cb'
self.mock_validator = mock.MagicMock()
self.mock_validator.authenticate_client.side_effect = self.set_client
self.auth = AuthorizationCodeGrant(
request_validator=self.mock_validator)
def set_client(self, request):
request.client = mock.MagicMock()
request.client.client_id = 'mocked'
return True
def setup_validators(self):
self.authval1, self.authval2 = mock.Mock(), mock.Mock()
self.authval1.return_value = {}
self.authval2.return_value = {}
self.tknval1, self.tknval2 = mock.Mock(), mock.Mock()
self.tknval1.return_value = None
self.tknval2.return_value = None
self.auth.custom_validators.pre_token.append(self.tknval1)
self.auth.custom_validators.post_token.append(self.tknval2)
self.auth.custom_validators.pre_auth.append(self.authval1)
self.auth.custom_validators.post_auth.append(self.authval2)
def test_custom_auth_validators(self):
self.setup_validators()
bearer = BearerToken(self.mock_validator)
self.auth.create_authorization_response(self.request, bearer)
self.assertTrue(self.authval1.called)
self.assertTrue(self.authval2.called)
self.assertFalse(self.tknval1.called)
self.assertFalse(self.tknval2.called)
def test_custom_token_validators(self):
self.setup_validators()
bearer = BearerToken(self.mock_validator)
self.auth.create_token_response(self.request, bearer)
self.assertTrue(self.tknval1.called)
self.assertTrue(self.tknval2.called)
self.assertFalse(self.authval1.called)
self.assertFalse(self.authval2.called)
def test_create_authorization_grant(self):
bearer = BearerToken(self.mock_validator)
self.request.response_mode = 'query'
h, b, s = self.auth.create_authorization_response(self.request, bearer)
grant = dict(Request(h['Location']).uri_query_params)
self.assertIn('code', grant)
self.assertTrue(self.mock_validator.validate_redirect_uri.called)
self.assertTrue(self.mock_validator.validate_response_type.called)
self.assertTrue(self.mock_validator.validate_scopes.called)
def test_create_authorization_grant_state(self):
self.request.state = 'abc'
self.request.redirect_uri = None
self.request.response_mode = 'query'
self.mock_validator.get_default_redirect_uri.return_value = 'https://a.b/cb'
bearer = BearerToken(self.mock_validator)
h, b, s = self.auth.create_authorization_response(self.request, bearer)
grant = dict(Request(h['Location']).uri_query_params)
self.assertIn('code', grant)
self.assertIn('state', grant)
self.assertFalse(self.mock_validator.validate_redirect_uri.called)
self.assertTrue(self.mock_validator.get_default_redirect_uri.called)
self.assertTrue(self.mock_validator.validate_response_type.called)
self.assertTrue(self.mock_validator.validate_scopes.called)
@mock.patch('oauthlib.common.generate_token')
def test_create_authorization_response(self, generate_token):
generate_token.return_value = 'abc'
bearer = BearerToken(self.mock_validator)
self.request.response_mode = 'query'
h, b, s = self.auth.create_authorization_response(self.request, bearer)
self.assertURLEqual(h['Location'], 'https://a.b/cb?code=abc')
self.request.response_mode = 'fragment'
h, b, s = self.auth.create_authorization_response(self.request, bearer)
self.assertURLEqual(h['Location'], 'https://a.b/cb#code=abc')
def test_create_token_response(self):
bearer = BearerToken(self.mock_validator)
h, token, s = self.auth.create_token_response(self.request, bearer)
token = json.loads(token)
self.assertEqual(self.mock_validator.save_token.call_count, 1)
self.assertIn('access_token', token)
self.assertIn('refresh_token', token)
self.assertIn('expires_in', token)
self.assertIn('scope', token)
self.assertTrue(
self.mock_validator.client_authentication_required.called)
self.assertTrue(self.mock_validator.authenticate_client.called)
self.assertTrue(self.mock_validator.validate_code.called)
self.assertTrue(self.mock_validator.confirm_redirect_uri.called)
self.assertTrue(self.mock_validator.validate_grant_type.called)
self.assertTrue(
self.mock_validator.invalidate_authorization_code.called)
def test_create_token_response_without_refresh_token(self):
self.auth.refresh_token = False # Not to issue refresh token.
bearer = BearerToken(self.mock_validator)
h, token, s = self.auth.create_token_response(self.request, bearer)
token = json.loads(token)
self.assertEqual(self.mock_validator.save_token.call_count, 1)
self.assertIn('access_token', token)
self.assertNotIn('refresh_token', token)
self.assertIn('expires_in', token)
self.assertIn('scope', token)
self.assertTrue(
self.mock_validator.client_authentication_required.called)
self.assertTrue(self.mock_validator.authenticate_client.called)
self.assertTrue(self.mock_validator.validate_code.called)
self.assertTrue(self.mock_validator.confirm_redirect_uri.called)
self.assertTrue(self.mock_validator.validate_grant_type.called)
self.assertTrue(
self.mock_validator.invalidate_authorization_code.called)
def test_invalid_request(self):
del self.request.code
self.assertRaises(errors.InvalidRequestError,
self.auth.validate_token_request, self.request)
def test_invalid_request_duplicates(self):
request = mock.MagicMock(wraps=self.request)
request.grant_type = 'authorization_code'
request.duplicate_params = ['client_id']
self.assertRaises(errors.InvalidRequestError,
self.auth.validate_token_request, request)
def test_authentication_required(self):
"""
ensure client_authentication_required() is properly called
"""
self.auth.validate_token_request(self.request)
self.mock_validator.client_authentication_required.assert_called_once_with(
self.request)
def test_authenticate_client(self):
self.mock_validator.authenticate_client.side_effect = None
self.mock_validator.authenticate_client.return_value = False
self.assertRaises(errors.InvalidClientError,
self.auth.validate_token_request, self.request)
def test_client_id_missing(self):
self.mock_validator.authenticate_client.side_effect = None
request = mock.MagicMock(wraps=self.request)
request.grant_type = 'authorization_code'
del request.client.client_id
self.assertRaises(NotImplementedError,
self.auth.validate_token_request, request)
def test_invalid_grant(self):
self.request.client = 'batman'
self.mock_validator.authenticate_client = self.set_client
self.mock_validator.validate_code.return_value = False
self.assertRaises(errors.InvalidGrantError,
self.auth.validate_token_request, self.request)
def test_invalid_grant_type(self):
self.request.grant_type = 'foo'
self.assertRaises(errors.UnsupportedGrantTypeError,
self.auth.validate_token_request, self.request)
def test_authenticate_client_id(self):
self.mock_validator.client_authentication_required.return_value = False
self.mock_validator.authenticate_client_id.return_value = False
self.request.state = 'abc'
self.assertRaises(errors.InvalidClientError,
self.auth.validate_token_request, self.request)
def test_invalid_redirect_uri(self):
self.mock_validator.confirm_redirect_uri.return_value = False
self.assertRaises(errors.MismatchingRedirectURIError,
self.auth.validate_token_request, self.request)
class AuthorizationCodeGrantTest(TestCase):
def setUp(self):
self.request = Request('http://a.b/path')
self.request.scopes = ('hello', 'world')
self.request.expires_in = 1800
self.request.client = 'batman'
self.request.client_id = 'abcdef'
self.request.code = '1234'
self.request.response_type = 'code'
self.request.grant_type = 'authorization_code'
self.request_state = Request('http://a.b/path')
self.request_state.state = 'abc'
self.mock_validator = mock.MagicMock()
self.mock_validator.authenticate_client.side_effect = self.set_client
self.auth = AuthorizationCodeGrant(request_validator=self.mock_validator)
def set_client(self, request):
request.client = mock.MagicMock()
request.client.client_id = 'mocked'
return True
def test_create_authorization_grant(self):
grant = self.auth.create_authorization_code(self.request)
self.assertIn('code', grant)
grant = self.auth.create_authorization_code(self.request_state)
self.assertIn('code', grant)
self.assertIn('state', grant)
def test_create_token_response(self):
bearer = BearerToken(self.mock_validator)
h, token, s = self.auth.create_token_response(self.request, bearer)
token = json.loads(token)
self.assertIn('access_token', token)
self.assertIn('refresh_token', token)
self.assertIn('expires_in', token)
self.assertIn('scope', token)
def test_invalid_request(self):
del self.request.code
self.assertRaises(errors.InvalidRequestError, self.auth.validate_token_request,
self.request)
def test_invalid_request_duplicates(self):
request = mock.MagicMock(wraps=self.request)
request.grant_type = 'authorization_code'
request.duplicate_params = ['client_id']
self.assertRaises(errors.InvalidRequestError, self.auth.validate_token_request,
request)
def test_authentication_required(self):
"""
ensure client_authentication_required() is properly called
"""
self.auth.validate_token_request(self.request)
self.mock_validator.client_authentication_required.assert_called_once_with(self.request)
def test_authenticate_client(self):
self.mock_validator.authenticate_client.side_effect = None
self.mock_validator.authenticate_client.return_value = False
self.assertRaises(errors.InvalidClientError, self.auth.validate_token_request,
self.request)
def test_client_id_missing(self):
self.mock_validator.authenticate_client.side_effect = None
request = mock.MagicMock(wraps=self.request)
request.grant_type = 'authorization_code'
del request.client.client_id
self.assertRaises(NotImplementedError, self.auth.validate_token_request,
request)
def test_invalid_grant(self):
self.request.client = 'batman'
self.mock_validator.authenticate_client = self.set_client
self.mock_validator.validate_code.return_value = False
self.assertRaises(errors.InvalidGrantError,
self.auth.validate_token_request, self.request)
def test_invalid_grant_type(self):
self.request.grant_type = 'foo'
self.assertRaises(errors.UnsupportedGrantTypeError,
self.auth.validate_token_request, self.request)
def test_authenticate_client_id(self):
self.mock_validator.client_authentication_required.return_value = False
self.mock_validator.authenticate_client_id.return_value = False
self.request.state = 'abc'
self.assertRaises(errors.InvalidClientError,
self.auth.validate_token_request, self.request)
def test_invalid_redirect_uri(self):
self.mock_validator.confirm_redirect_uri.return_value = False
self.assertRaises(errors.AccessDeniedError,
self.auth.validate_token_request, self.request)
