tests/api_connexion/test_auth.py

# 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

from base64 import b64encode

import pytest
from flask_login import current_user

from tests.test_utils.api_connexion_utils import assert_401
from tests.test_utils.config import conf_vars
from tests.test_utils.db import clear_db_pools
from tests.test_utils.www import client_with_login


class BaseTestAuth:
    @pytest.fixture(autouse=True)
    def set_attrs(self, minimal_app_for_api):
        self.app = minimal_app_for_api

        sm = self.app.appbuilder.sm
        tester = sm.find_user(username="test")
        if not tester:
            role_admin = sm.find_role("Admin")
            sm.add_user(
                username="test",
                first_name="test",
                last_name="test",
                email="test@fab.org",
                role=role_admin,
                password="test",
            )


class TestBasicAuth(BaseTestAuth):
    @pytest.fixture(autouse=True, scope="class")
    def with_basic_auth_backend(self, minimal_app_for_api):
        from airflow.www.extensions.init_security import init_api_experimental_auth

        old_auth = getattr(minimal_app_for_api, "api_auth")

        try:
            with conf_vars({("api", "auth_backends"): "airflow.api.auth.backend.basic_auth"}):
                init_api_experimental_auth(minimal_app_for_api)
                yield
        finally:
            setattr(minimal_app_for_api, "api_auth", old_auth)

    def test_success(self):
        token = "Basic " + b64encode(b"test:test").decode()
        clear_db_pools()

        with self.app.test_client() as test_client:
            response = test_client.get("/api/v1/pools", headers={"Authorization": token})
            assert current_user.email == "test@fab.org"

        assert response.status_code == 200
        assert response.json == {
            "pools": [
                {
                    "name": "default_pool",
                    "slots": 128,
                    "occupied_slots": 0,
                    "running_slots": 0,
                    "queued_slots": 0,
                    "scheduled_slots": 0,
                    "open_slots": 128,
                    "description": "Default pool",
                },
            ],
            "total_entries": 1,
        }

    @pytest.mark.parametrize(
        "token",
        [
            "basic",
            "basic ",
            "bearer",
            "test:test",
            b64encode(b"test:test").decode(),
            "bearer ",
            "basic: ",
            "basic 123",
        ],
    )
    def test_malformed_headers(self, token):
        with self.app.test_client() as test_client:
            response = test_client.get("/api/v1/pools", headers={"Authorization": token})
            assert response.status_code == 401
            assert response.headers["Content-Type"] == "application/problem+json"
            assert response.headers["WWW-Authenticate"] == "Basic"
            assert_401(response)

    @pytest.mark.parametrize(
        "token",
        [
            "basic " + b64encode(b"test").decode(),
            "basic " + b64encode(b"test:").decode(),
            "basic " + b64encode(b"test:123").decode(),
            "basic " + b64encode(b"test test").decode(),
        ],
    )
    def test_invalid_auth_header(self, token):
        with self.app.test_client() as test_client:
            response = test_client.get("/api/v1/pools", headers={"Authorization": token})
            assert response.status_code == 401
            assert response.headers["Content-Type"] == "application/problem+json"
            assert response.headers["WWW-Authenticate"] == "Basic"
            assert_401(response)


class TestSessionAuth(BaseTestAuth):
    @pytest.fixture(autouse=True, scope="class")
    def with_session_backend(self, minimal_app_for_api):
        from airflow.www.extensions.init_security import init_api_experimental_auth

        old_auth = getattr(minimal_app_for_api, "api_auth")

        try:
            with conf_vars({("api", "auth_backends"): "airflow.api.auth.backend.session"}):
                init_api_experimental_auth(minimal_app_for_api)
                yield
        finally:
            setattr(minimal_app_for_api, "api_auth", old_auth)

    def test_success(self):
        clear_db_pools()

        admin_user = client_with_login(self.app, username="test", password="test")
        response = admin_user.get("/api/v1/pools")
        assert response.status_code == 200
        assert response.json == {
            "pools": [
                {
                    "name": "default_pool",
                    "slots": 128,
                    "occupied_slots": 0,
                    "running_slots": 0,
                    "queued_slots": 0,
                    "scheduled_slots": 0,
                    "open_slots": 128,
                    "description": "Default pool",
                },
            ],
            "total_entries": 1,
        }

    def test_failure(self):
        with self.app.test_client() as test_client:
            response = test_client.get("/api/v1/pools")
            assert response.status_code == 401
            assert response.headers["Content-Type"] == "application/problem+json"
            assert_401(response)


class TestSessionWithBasicAuthFallback(BaseTestAuth):
    @pytest.fixture(autouse=True, scope="class")
    def with_basic_auth_backend(self, minimal_app_for_api):
        from airflow.www.extensions.init_security import init_api_experimental_auth

        old_auth = getattr(minimal_app_for_api, "api_auth")

        try:
            with conf_vars(
                {
                    (
                        "api",
                        "auth_backends",
                    ): "airflow.api.auth.backend.session,airflow.api.auth.backend.basic_auth"
                }
            ):
                init_api_experimental_auth(minimal_app_for_api)
                yield
        finally:
            setattr(minimal_app_for_api, "api_auth", old_auth)

    def test_basic_auth_fallback(self):
        token = "Basic " + b64encode(b"test:test").decode()
        clear_db_pools()

        # request uses session
        admin_user = client_with_login(self.app, username="test", password="test")
        response = admin_user.get("/api/v1/pools")
        assert response.status_code == 200

        # request uses basic auth
        with self.app.test_client() as test_client:
            response = test_client.get("/api/v1/pools", headers={"Authorization": token})
            assert response.status_code == 200

        # request without session or basic auth header
        with self.app.test_client() as test_client:
            response = test_client.get("/api/v1/pools")
            assert response.status_code == 401