mirror of
https://github.com/alerta/alerta.git
synced 2025-01-24 09:19:40 +00:00
206 lines
8.6 KiB
Python
206 lines
8.6 KiB
Python
import json
|
|
from datetime import datetime, timedelta
|
|
from uuid import uuid4
|
|
|
|
import jwt
|
|
import requests
|
|
from flask import current_app, jsonify, request
|
|
from flask_cors import cross_origin
|
|
from jwt.algorithms import RSAAlgorithm # type: ignore
|
|
|
|
from alerta.auth.utils import create_token, get_customers, not_authorized
|
|
from alerta.exceptions import ApiError
|
|
from alerta.models.permission import Permission
|
|
from alerta.models.user import User
|
|
from alerta.utils.audit import auth_audit_trail
|
|
|
|
from . import auth
|
|
|
|
|
|
def get_oidc_configuration(app):
|
|
|
|
OIDC_ISSUER_URL_BY_PROVIDER = {
|
|
'azure': f"https://login.microsoftonline.com/{app.config['AZURE_TENANT']}/v2.0",
|
|
'cognito': f"https://cognito-idp.{app.config['AWS_REGION']}.amazonaws.com/{app.config['COGNITO_USER_POOL_ID']}",
|
|
'gitlab': app.config['GITLAB_URL'],
|
|
'google': 'https://accounts.google.com',
|
|
'keycloak': f"{app.config['KEYCLOAK_URL']}/realms/{app.config['KEYCLOAK_REALM']}"
|
|
}
|
|
|
|
issuer_url = OIDC_ISSUER_URL_BY_PROVIDER.get(app.config['AUTH_PROVIDER']) or app.config['OIDC_ISSUER_URL']
|
|
if not issuer_url:
|
|
raise ApiError('Must define Issuer URL (OIDC_ISSUER_URL) in server configuration to use OpenID Connect.', 503)
|
|
discovery_doc_url = issuer_url.strip('/') + '/.well-known/openid-configuration'
|
|
|
|
try:
|
|
r = requests.get(discovery_doc_url, timeout=2)
|
|
config = r.json()
|
|
except Exception as e:
|
|
raise ApiError(f'Could not get OpenID configuration from well known URL: {str(e)}', 503)
|
|
|
|
if 'issuer' not in config:
|
|
error = config.get('error') or config.get('message') or config
|
|
raise ApiError(f'OpenID Connect issuer response invalid: {error}')
|
|
|
|
if config['issuer'].format(tenantid=app.config['AZURE_TENANT']) != issuer_url:
|
|
raise ApiError('Issuer Claim does not match Issuer URL used to retrieve OpenID configuration', 503)
|
|
|
|
if app.config['OIDC_VERIFY_TOKEN']:
|
|
try:
|
|
jwks_uri = config['jwks_uri']
|
|
r = requests.get(jwks_uri, timeout=2)
|
|
keys = {k['kid']: RSAAlgorithm.from_jwk(json.dumps(k)) for k in r.json()['keys']}
|
|
except Exception as e:
|
|
raise ApiError(f'Could not get OpenID JWT Key Set from JWKS URL: {str(e)}', 503)
|
|
else:
|
|
keys = {}
|
|
|
|
return config, keys
|
|
|
|
|
|
@auth.route('/auth/openid', methods=['OPTIONS', 'POST'])
|
|
@auth.route('/auth/azure', methods=['OPTIONS', 'POST'])
|
|
@auth.route('/auth/gitlab', methods=['OPTIONS', 'POST'])
|
|
@auth.route('/auth/google', methods=['OPTIONS', 'POST'])
|
|
@auth.route('/auth/keycloak', methods=['OPTIONS', 'POST'])
|
|
@cross_origin(supports_credentials=True)
|
|
def openid():
|
|
|
|
oidc_configuration, jwt_key_set = get_oidc_configuration(current_app)
|
|
token_endpoint = oidc_configuration['token_endpoint']
|
|
userinfo_endpoint = oidc_configuration['userinfo_endpoint']
|
|
|
|
data = {
|
|
'grant_type': 'authorization_code',
|
|
'code': request.json['code'],
|
|
'redirect_uri': request.json['redirectUri'],
|
|
}
|
|
|
|
token_endpoint_auth_methods = oidc_configuration.get(
|
|
'token_endpoint_auth_methods_supported',
|
|
['client_secret_basic'])
|
|
if not isinstance(token_endpoint_auth_methods, list):
|
|
token_endpoint_auth_methods = [token_endpoint_auth_methods]
|
|
|
|
preferred_token_auth_method = 'client_secret_post'
|
|
for token_auth_method in current_app.config['OIDC_TOKEN_AUTH_METHODS']:
|
|
if token_auth_method in token_endpoint_auth_methods:
|
|
preferred_token_auth_method = token_auth_method
|
|
break
|
|
|
|
if preferred_token_auth_method == 'client_secret_basic':
|
|
auth = (request.json['clientId'], current_app.config['OAUTH2_CLIENT_SECRET'])
|
|
r = requests.post(token_endpoint, data, auth=auth)
|
|
elif preferred_token_auth_method == 'client_secret_post':
|
|
data['client_id'] = request.json['clientId']
|
|
data['client_secret'] = current_app.config['OAUTH2_CLIENT_SECRET']
|
|
r = requests.post(token_endpoint, data)
|
|
elif preferred_token_auth_method == 'client_secret_jwt':
|
|
now = datetime.utcnow()
|
|
payload = dict(
|
|
iss=request.json['clientId'],
|
|
sub=request.json['clientId'],
|
|
aud=token_endpoint,
|
|
jti=str(uuid4()),
|
|
exp=(now + timedelta(minutes=5)),
|
|
iat=now
|
|
)
|
|
client_assertion = jwt.encode(
|
|
payload=payload,
|
|
key=current_app.config['OAUTH2_CLIENT_SECRET'],
|
|
algorithm='HS256'
|
|
)
|
|
data['client_assertion_type'] = 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer'
|
|
data['client_assertion'] = client_assertion
|
|
r = requests.post(token_endpoint, data)
|
|
else:
|
|
raise ApiError(f"Token endpoint auth method '{preferred_token_auth_method}' is not supported by Alerta.", 400)
|
|
token = r.json()
|
|
|
|
if 'error' in token:
|
|
error_text = token.get('error_description') or token['error']
|
|
raise ApiError(error_text)
|
|
|
|
try:
|
|
jwt_header = jwt.get_unverified_header(token['id_token'])
|
|
if current_app.config['OIDC_VERIFY_TOKEN']:
|
|
public_key = jwt_key_set[jwt_header['kid']]
|
|
|
|
id_token = jwt.decode(
|
|
token['id_token'],
|
|
key=public_key,
|
|
algorithms=jwt_header['alg']
|
|
)
|
|
else:
|
|
id_token = jwt.decode(
|
|
token['id_token'],
|
|
algorithms=jwt_header['alg'],
|
|
options={'verify_signature': False}
|
|
)
|
|
except Exception:
|
|
current_app.logger.warning('No ID token in OpenID Connect token response.')
|
|
id_token = {}
|
|
|
|
try:
|
|
headers = {'Authorization': f"{token.get('token_type', 'Bearer')} {token['access_token']}"}
|
|
r = requests.get(userinfo_endpoint, headers=headers)
|
|
userinfo = r.json()
|
|
except Exception:
|
|
raise ApiError('No access token in OpenID Connect token response.')
|
|
|
|
subject = userinfo['sub']
|
|
name = userinfo.get('name') or id_token.get('name')
|
|
username = userinfo.get('preferred_username') or id_token.get('preferred_username')
|
|
nickname = userinfo.get('nickname') or id_token.get('nickname')
|
|
email = userinfo.get('email') or id_token.get('email')
|
|
email_verified = userinfo.get('email_verified', id_token.get('email_verified', bool(email)))
|
|
email_verified = True if email_verified == 'true' else email_verified # Cognito returns string boolean
|
|
picture = userinfo.get('picture') or id_token.get('picture')
|
|
|
|
role_claim = current_app.config['OIDC_ROLE_CLAIM']
|
|
group_claim = current_app.config['OIDC_GROUP_CLAIM']
|
|
custom_claims = {
|
|
role_claim: userinfo.get(role_claim) or id_token.get(role_claim, []),
|
|
group_claim: userinfo.get(group_claim) or id_token.get(group_claim, []),
|
|
}
|
|
|
|
login = username or nickname or email
|
|
if not login:
|
|
raise ApiError("Must support one of the following OpenID claims: 'preferred_username', 'nickname' or 'email'", 400)
|
|
|
|
if current_app.config['OIDC_LINK_USER_EMAIL'] and email and email_verified:
|
|
user = User.find_by_email(email=email)
|
|
else:
|
|
user = User.find_by_id(id=subject)
|
|
|
|
if not user:
|
|
user = User(id=subject, name=name, login=login, password='', email=email,
|
|
roles=current_app.config['USER_ROLES'], text='', email_verified=email_verified)
|
|
user.create()
|
|
else:
|
|
user.update(login=login, email=email, email_verified=email_verified)
|
|
|
|
roles = custom_claims[role_claim] + user.roles
|
|
groups = custom_claims[group_claim]
|
|
|
|
if user.id != subject:
|
|
custom_claims['oid'] = user.id # if subject differs store the original subject as "oid" claim
|
|
|
|
if user.status != 'active':
|
|
raise ApiError(f'User {login} is not active', 403)
|
|
|
|
if not_authorized('ALLOWED_OIDC_ROLES', roles) or not_authorized('ALLOWED_EMAIL_DOMAINS', groups=[user.domain]):
|
|
raise ApiError(f'User {login} is not authorized', 403)
|
|
user.update_last_login()
|
|
|
|
scopes = Permission.lookup(login, roles=roles)
|
|
customers = get_customers(login, groups=groups + ([user.domain] if user.domain else []))
|
|
|
|
auth_audit_trail.send(current_app._get_current_object(), event='openid-login', message='user login via OpenID Connect',
|
|
user=login, customers=customers, scopes=scopes, **custom_claims,
|
|
resource_id=subject, type='user', request=request)
|
|
|
|
token = create_token(user_id=subject, name=name, login=login, provider=current_app.config['AUTH_PROVIDER'],
|
|
customers=customers, scopes=scopes, **custom_claims,
|
|
email=email, email_verified=email_verified, picture=picture)
|
|
return jsonify(token=token.tokenize())
|