Source code for airflow.providers.keycloak.auth_manager.routes.login

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you 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.

from __future__ import annotations

import logging

from fastapi import Request  # noqa: TC002
from keycloak import KeycloakOpenID
from starlette.responses import HTMLResponse, RedirectResponse

from airflow.api_fastapi.app import get_auth_manager
from airflow.api_fastapi.auth.managers.base_auth_manager import COOKIE_NAME_JWT_TOKEN
from airflow.api_fastapi.common.router import AirflowRouter
from airflow.configuration import conf
from airflow.providers.keycloak.auth_manager.user import KeycloakAuthManagerUser


[docs]
log = logging.getLogger(__name__)


[docs]
login_router = AirflowRouter(tags=["KeycloakAuthManagerLogin"])



@login_router.get("/login")

[docs]
def login(request: Request) -> RedirectResponse:
    """Initiate the authentication."""
    client = _get_keycloak_client()
    redirect_uri = request.url_for("login_callback")
    auth_url = client.auth_url(redirect_uri=str(redirect_uri), scope="openid")
    return RedirectResponse(auth_url)



@login_router.get("/login_callback")

[docs]
def login_callback(request: Request):
    """Authenticate the user."""
    code = request.query_params.get("code")
    if not code:
        return HTMLResponse("Missing code", status_code=400)

    client = _get_keycloak_client()
    redirect_uri = request.url_for("login_callback")

    tokens = client.token(
        grant_type="authorization_code",
        code=code,
        redirect_uri=str(redirect_uri),
    )
    userinfo = client.userinfo(tokens["access_token"])
    user = KeycloakAuthManagerUser(
        user_id=userinfo["sub"],
        name=userinfo["preferred_username"],
        access_token=tokens["access_token"],
        refresh_token=tokens["refresh_token"],
    )
    token = get_auth_manager().generate_jwt(user)

    response = RedirectResponse(url=conf.get("api", "base_url", fallback="/"), status_code=303)
    secure = bool(conf.get("api", "ssl_cert", fallback=""))
    response.set_cookie(COOKIE_NAME_JWT_TOKEN, token, secure=secure)
    return response



def _get_keycloak_client() -> KeycloakOpenID:
    client_id = conf.get("keycloak_auth_manager", "client_id")
    client_secret = conf.get("keycloak_auth_manager", "client_secret")
    realm = conf.get("keycloak_auth_manager", "realm")
    server_url = conf.get("keycloak_auth_manager", "server_url")

    return KeycloakOpenID(
        server_url=server_url,
        client_id=client_id,
        client_secret_key=client_secret,
        realm_name=realm,
    )