286 lines
10 KiB
Python
286 lines
10 KiB
Python
import logging
|
|
|
|
from joserfc import jwk
|
|
from joserfc import jws
|
|
from joserfc import jwt
|
|
from joserfc.errors import JoseError
|
|
from joserfc.util import to_bytes
|
|
|
|
from authlib._joserfc_helpers import import_any_key
|
|
from authlib.common.encoding import json_loads
|
|
from authlib.deprecate import deprecate
|
|
|
|
from ..rfc6749 import BaseGrant
|
|
from ..rfc6749 import InvalidClientError
|
|
from ..rfc6749 import InvalidGrantError
|
|
from ..rfc6749 import InvalidRequestError
|
|
from ..rfc6749 import TokenEndpointMixin
|
|
from ..rfc6749 import UnauthorizedClientError
|
|
from .assertion import sign_jwt_bearer_assertion
|
|
|
|
log = logging.getLogger(__name__)
|
|
JWT_BEARER_GRANT_TYPE = "urn:ietf:params:oauth:grant-type:jwt-bearer"
|
|
|
|
|
|
class JWTBearerGrant(BaseGrant, TokenEndpointMixin):
|
|
GRANT_TYPE = JWT_BEARER_GRANT_TYPE
|
|
|
|
#: Options for verifying JWT payload claims. Developers MAY
|
|
#: overwrite this constant to create a more strict options.
|
|
CLAIMS_OPTIONS = {
|
|
"iss": {"essential": True},
|
|
"aud": {"essential": True},
|
|
"exp": {"essential": True},
|
|
}
|
|
|
|
# A small allowance of time, typically no more than a few minutes,
|
|
# to account for clock skew. The default is 60 seconds.
|
|
LEEWAY = 60
|
|
|
|
@staticmethod
|
|
def sign(
|
|
key,
|
|
issuer,
|
|
audience,
|
|
subject=None,
|
|
issued_at=None,
|
|
expires_at=None,
|
|
claims=None,
|
|
**kwargs,
|
|
):
|
|
return sign_jwt_bearer_assertion(
|
|
key, issuer, audience, subject, issued_at, expires_at, claims, **kwargs
|
|
)
|
|
|
|
def verify_claims(self, claims: jwt.Claims):
|
|
options = dict(self.CLAIMS_OPTIONS)
|
|
audiences = self.get_audiences()
|
|
if audiences:
|
|
options["aud"] = {"essential": True, "values": audiences}
|
|
else:
|
|
deprecate(
|
|
"'get_audiences' must return a non-empty list. "
|
|
"Audience validation will become mandatory.",
|
|
version="1.8",
|
|
)
|
|
|
|
claims_requests = jwt.JWTClaimsRegistry(leeway=self.LEEWAY, **options)
|
|
try:
|
|
claims_requests.validate(claims)
|
|
except JoseError as e:
|
|
log.debug("Assertion Error: %r", e)
|
|
raise InvalidGrantError(description=e.description) from e
|
|
|
|
def process_assertion_claims(self, assertion):
|
|
"""Extract JWT payload claims from request "assertion", per
|
|
`Section 3.1`_.
|
|
|
|
:param assertion: assertion string value in the request
|
|
:return: JWTClaims
|
|
:raise: InvalidGrantError
|
|
|
|
.. _`Section 3.1`: https://tools.ietf.org/html/rfc7523#section-3.1
|
|
"""
|
|
headers, claims = self.extract_assertion(assertion)
|
|
# "iss" is read before the signature and the claims are verified, so it
|
|
# cannot be assumed to be present nor to be a string.
|
|
if "iss" not in claims:
|
|
raise InvalidGrantError(description="Missing claim: 'iss'")
|
|
|
|
issuer = claims["iss"]
|
|
if not isinstance(issuer, str):
|
|
raise InvalidGrantError(description="Invalid claim: 'iss'")
|
|
|
|
client = self.resolve_issuer_client(issuer)
|
|
if not client:
|
|
raise InvalidGrantError(
|
|
description="The client does not exist on this server."
|
|
)
|
|
|
|
if hasattr(self, "resolve_client_key"): # pragma: no cover
|
|
key = import_any_key(self.resolve_client_key(client, headers, claims))
|
|
deprecate(
|
|
"Use resolve_client_public_key instead of resolve_client_key.",
|
|
version="1.8",
|
|
)
|
|
else:
|
|
key = import_any_key(self.resolve_client_public_key(client))
|
|
|
|
try:
|
|
token = jwt.decode(assertion, key)
|
|
except JoseError as e:
|
|
log.debug("Assertion Error: %r", e)
|
|
raise InvalidGrantError(description=e.description) from e
|
|
except ValueError as e:
|
|
log.debug("Assertion Error: %r", e)
|
|
raise InvalidGrantError("Invalid JWT assertion") from None
|
|
|
|
self.verify_claims(token.claims)
|
|
return token.claims
|
|
|
|
def extract_assertion(self, assertion: str):
|
|
try:
|
|
obj = jws.extract_compact(to_bytes(assertion))
|
|
except JoseError as e:
|
|
log.debug("Assertion Error: %r", e)
|
|
raise InvalidGrantError(description="Invalid JWT assertion.") from e
|
|
|
|
try:
|
|
claims = json_loads(obj.payload)
|
|
except ValueError:
|
|
raise InvalidGrantError(description="Invalid JWT payload.") from None
|
|
|
|
if not isinstance(claims, dict):
|
|
raise InvalidGrantError(description="Invalid JWT payload.")
|
|
|
|
return obj.headers(), claims
|
|
|
|
def validate_token_request(self):
|
|
"""The client makes a request to the token endpoint by sending the
|
|
following parameters using the "application/x-www-form-urlencoded"
|
|
format per `Section 2.1`_:
|
|
|
|
grant_type
|
|
REQUIRED. Value MUST be set to
|
|
"urn:ietf:params:oauth:grant-type:jwt-bearer".
|
|
|
|
assertion
|
|
REQUIRED. Value MUST contain a single JWT.
|
|
|
|
scope
|
|
OPTIONAL.
|
|
|
|
The following example demonstrates an access token request with a JWT
|
|
as an authorization grant:
|
|
|
|
.. code-block:: http
|
|
|
|
POST /token.oauth2 HTTP/1.1
|
|
Host: as.example.com
|
|
Content-Type: application/x-www-form-urlencoded
|
|
|
|
grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Ajwt-bearer
|
|
&assertion=eyJhbGciOiJFUzI1NiIsImtpZCI6IjE2In0.
|
|
eyJpc3Mi[...omitted for brevity...].
|
|
J9l-ZhwP[...omitted for brevity...]
|
|
|
|
.. _`Section 2.1`: https://tools.ietf.org/html/rfc7523#section-2.1
|
|
"""
|
|
assertion = self.request.form.get("assertion")
|
|
if not assertion:
|
|
raise InvalidRequestError("Missing 'assertion' in request")
|
|
|
|
claims = self.process_assertion_claims(assertion)
|
|
client = self.resolve_issuer_client(claims["iss"])
|
|
log.debug("Validate token request of %s", client)
|
|
|
|
if not client.check_grant_type(self.GRANT_TYPE):
|
|
raise UnauthorizedClientError(
|
|
f"The client is not authorized to use 'grant_type={self.GRANT_TYPE}'"
|
|
)
|
|
|
|
self.request.client = client
|
|
self.validate_requested_scope()
|
|
|
|
subject = claims.get("sub")
|
|
if subject:
|
|
user = self.authenticate_user(subject)
|
|
if not user:
|
|
raise InvalidGrantError(description="Invalid 'sub' value in assertion")
|
|
|
|
log.debug("Check client(%s) permission to User(%s)", client, user)
|
|
if not self.has_granted_permission(client, user):
|
|
raise InvalidClientError(
|
|
description="Client has no permission to access user data"
|
|
)
|
|
self.request.user = user
|
|
|
|
def create_token_response(self):
|
|
"""If valid and authorized, the authorization server issues an access
|
|
token.
|
|
"""
|
|
token = self.generate_token(
|
|
scope=self.request.payload.scope,
|
|
user=self.request.user,
|
|
include_refresh_token=False,
|
|
)
|
|
log.debug("Issue token %r to %r", token, self.request.client)
|
|
self.save_token(token)
|
|
return 200, token, self.TOKEN_RESPONSE_HEADER
|
|
|
|
def resolve_issuer_client(self, issuer):
|
|
"""Fetch client via "iss" in assertion claims. Developers MUST
|
|
implement this method in subclass, e.g.::
|
|
|
|
def resolve_issuer_client(self, issuer):
|
|
return Client.query_by_iss(issuer)
|
|
|
|
:param issuer: "iss" value in assertion
|
|
:return: Client instance, or ``None`` when no client matches the
|
|
issuer. In that case an ``invalid_grant`` error is returned.
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
def resolve_client_public_key(self, client) -> jwk.Key | jwk.KeySet:
|
|
"""Resolve client key to decode assertion data. Developers MUST
|
|
implement this method in subclass. For instance, there is a
|
|
"jwks" column on client table, e.g.::
|
|
|
|
def resolve_client_public_key(self, client):
|
|
from joserfc import KeySet
|
|
|
|
key_set = KeySet.import_key_set(client.jwks)
|
|
return key_set
|
|
|
|
:param client: instance of OAuth client model
|
|
:return: OctKey, RSAKey, ECKey, OKPKey or KeySet instance
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
def authenticate_user(self, subject):
|
|
"""Authenticate user with the given assertion claims. Developers MUST
|
|
implement it in subclass, e.g.::
|
|
|
|
def authenticate_user(self, subject):
|
|
return User.get_by_sub(subject)
|
|
|
|
:param subject: "sub" value in claims
|
|
:return: User instance
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
def get_audiences(self):
|
|
"""Return a list of valid audience identifiers for this authorization
|
|
server. Per RFC 7523 Section 3:
|
|
|
|
The authorization server MUST reject any JWT that does not
|
|
contain its own identity as the intended audience.
|
|
|
|
Developers SHOULD implement this method to return the list of valid
|
|
audience values, typically including the token endpoint URL and/or
|
|
the issuer identifier. For example::
|
|
|
|
def get_audiences(self):
|
|
return ["https://example.com/oauth/token", "https://example.com"]
|
|
|
|
If this method returns an empty list, audience value validation is
|
|
skipped (only presence is checked).
|
|
|
|
:return: list of valid audience strings
|
|
"""
|
|
return []
|
|
|
|
def has_granted_permission(self, client, user):
|
|
"""Check if the client has permission to access the given user's resource.
|
|
Developers MUST implement it in subclass, e.g.::
|
|
|
|
def has_granted_permission(self, client, user):
|
|
permission = ClientUserGrant.query(client=client, user=user)
|
|
return permission.granted
|
|
|
|
:param client: instance of OAuth client model
|
|
:param user: instance of User model
|
|
:return: bool
|
|
"""
|
|
raise NotImplementedError()
|