Skip to content

Commit

Permalink
add openid offline_access token authentication
Browse files Browse the repository at this point in the history
  • Loading branch information
jameshawkes committed Apr 9, 2024
1 parent 96fe38c commit 9a9b126
Show file tree
Hide file tree
Showing 2 changed files with 117 additions and 0 deletions.
1 change: 1 addition & 0 deletions polytope_server/common/authentication/authentication.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ def name(self) -> str:
"keycloak": "KeycloakAuthentication",
"federation": "FederationAuthentication",
"jwt" : "JWTAuthentication",
"openid_offline_access" : "OpenIDOfflineAuthentication",
}


Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
#
# Copyright 2022 European Centre for Medium-Range Weather Forecasts (ECMWF)
#
# 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.
#
# In applying this licence, ECMWF does not waive the privileges and immunities
# granted to it by virtue of its status as an intergovernmental organisation nor
# does it submit to any jurisdiction.
#

import logging
import os
import requests
from jose import jwt

from ..auth import User
from ..caching import cache
from . import authentication
from ..exceptions import ForbiddenRequest


class OpenIDOfflineAuthentication(authentication.Authentication):
def __init__(self, name, realm, config):
self.config = config

self.certs_url = config["cert_url"]
self.public_client_id = config["public_client_id"]
self.private_client_id = config["private_client_id"]
self.private_client_secret = config["private_client_secret"]
self.iam_url = config["iam_url"]
self.iam_realm = config["iam_realm"]


super().__init__(name, realm, config)

def authentication_type(self):
return "Bearer"

def authentication_info(self):
return "Authenticate with OpenID offline_access token"

@cache(lifetime=120)
def get_certs(self):
return requests.get(self.certs_url).json()

@cache(lifetime=120)
def check_offline_access_token(self, token: str) -> bool:
"""
We check if the token is recognised by the IAM service, and we cache this result.
We cannot simply try to get the access token because we would spam the IAM server with invalid tokens, and the
failure at that point would not be cached.
"""
keycloak_token_introspection = self.iam_url + "/realms/" + self.iam_realm + "/protocol/openid-connect/token/introspect"
introspection_data = {
"token": token
}
b_auth = requests.auth.HTTPBasicAuth(self.private_client_id, self.private_client_secret)
resp = requests.post(url=keycloak_token_introspection, data=introspection_data, auth=b_auth).json()
if resp["active"] and resp["token_type"] == "Offline":
return True
else:
return False

@cache(lifetime=120)
def authenticate(self, credentials: str) -> User:

try:

# Check if this is a valid offline_access token
if not self.check_offline_access_token(credentials):
raise ForbiddenRequest("Not a valid offline_access token")

# Generate an access token from the offline_access token (like a refresh token)
refresh_data = {
"client_id": self.public_client_id,
"grant_type": "refresh_token",
"refresh_token": credentials
}
keycloak_token_endpoint = self.iam_url + "/realms/" + self.iam_realm + "/protocol/openid-connect/token"
resp = requests.post(url=keycloak_token_endpoint, data=refresh_data)
token = resp.json()['access_token']

certs = self.get_certs()
decoded_token = jwt.decode(token=token,
algorithms=jwt.get_unverified_header(token).get('alg'),
key=certs
)

logging.info("Decoded JWT: {}".format(decoded_token))

user = User(decoded_token["sub"], self.realm())

roles = decoded_token.get("resource_access", {}).get(self.public_client_id, {}).get("roles", [])
user.roles.extend(roles)

logging.info("Found user {} from openid offline_access token".format(user))

except Exception as e:
logging.info("Failed to authenticate user from openid offline_access token")
logging.info(e)
raise ForbiddenRequest("Could not authenticate user from openid offline_access token")
return user


def collect_metric_info(self):
return {}

0 comments on commit 9a9b126

Please sign in to comment.