project_config_mgt.py

# Copyright 2023 Google Inc.
#
# 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.
"""Firebase project configuration management module.

This module contains functions for managing projects.
"""

import requests

import firebase_admin
from firebase_admin import _auth_utils
from firebase_admin import _http_client
from firebase_admin import _utils
from firebase_admin.multi_factor_config_mgt import MultiFactorConfig
from firebase_admin.multi_factor_config_mgt import MultiFactorServerConfig
from firebase_admin.email_privacy_config_mgt import EmailPrivacyConfig
from firebase_admin.email_privacy_config_mgt import EmailPrivacyServerConfig

_PROJECT_CONFIG_MGT_ATTRIBUTE = '_project_config_mgt'

__all__ = [
    'ProjectConfig',
    'get_project_config',
    'update_project_config',
]


def get_project_config(app=None):
    """Gets the project config corresponding to the current project_id.

    Args:
        app: An App instance (optional).

    Returns:
        Project: A project object.

    Raises:
        ValueError: If the project ID is None, empty or not a string.
        ProjectNotFoundError: If no project exists by the given ID.
        FirebaseError: If an error occurs while retrieving the project.
    """
    project_config_mgt_service = _get_project_config_mgt_service(app)
    return project_config_mgt_service.get_project_config()

def update_project_config(multi_factor_config: MultiFactorConfig = None,
                          email_privacy_config: EmailPrivacyConfig = None,
                          app=None):
    """Update the Project Config with the given options.
    Args:
        multi_factor_config: Updated multi-factor authentication configuration
                    (optional)
        email_privacy_config: Updated Email Privacy configuration (optional).
        app: An App instance (optional).
    Returns:
        Project: An updated ProjectConfig object.
    Raises:
        ValueError: If any of the given arguments are invalid.
        FirebaseError: If an error occurs while updating the project.
    """
    project_config_mgt_service = _get_project_config_mgt_service(app)
    return project_config_mgt_service.update_project_config(multi_factor_config=multi_factor_config,
                                                            email_privacy_config=
                                                            email_privacy_config)


def _get_project_config_mgt_service(app):
    return _utils.get_app_service(app, _PROJECT_CONFIG_MGT_ATTRIBUTE,
                                  _ProjectConfigManagementService)

class ProjectConfig:
    """Represents a project config in an application.
    """

    def __init__(self, data):
        if not isinstance(data, dict):
            raise ValueError(
                'Invalid data argument in Project constructor: {0}'.format(data))
        self._data = data

    @property
    def multi_factor_config(self):
        data = self._data.get('mfa')
        if data:
            return MultiFactorServerConfig(data)
        return None

    @property
    def email_privacy_config(self):
        data = self._data.get('emailPrivacyConfig')
        if data:
            return EmailPrivacyServerConfig(data)
        return None

class _ProjectConfigManagementService:
    """Firebase project management service."""

    PROJECT_CONFIG_MGT_URL = 'https://identitytoolkit.googleapis.com/v2/projects'

    def __init__(self, app):
        credential = app.credential.get_credential()
        version_header = 'Python/Admin/{0}'.format(firebase_admin.__version__)
        base_url = '{0}/{1}/config'.format(
            self.PROJECT_CONFIG_MGT_URL, app.project_id)
        self.app = app
        self.client = _http_client.JsonHttpClient(
            credential=credential, base_url=base_url, headers={'X-Client-Version': version_header})

    def get_project_config(self) -> ProjectConfig:
        """Gets the project config"""
        try:
            body = self.client.body('get', url='')
        except requests.exceptions.RequestException as error:
            raise _auth_utils.handle_auth_backend_error(error)
        else:
            return ProjectConfig(body)

    def update_project_config(self, multi_factor_config: MultiFactorConfig = None,
                              email_privacy_config: EmailPrivacyConfig = None) -> ProjectConfig:
        """Updates the specified project with the given parameters."""

        payload = {}
        if multi_factor_config is not None:
            if not isinstance(multi_factor_config, MultiFactorConfig):
                raise ValueError('multi_factor_config must be of type MultiFactorConfig.')
            payload['mfa'] = multi_factor_config.build_server_request()

        if email_privacy_config is not None:
            if not isinstance(email_privacy_config, EmailPrivacyConfig):
                raise ValueError('email_privacy_config must be of type EmailPrivacyConfig.')
            payload['emailPrivacyConfig'] = email_privacy_config.build_server_request()

        if not payload:
            raise ValueError(
                'At least one parameter must be specified for update.')

        update_mask = ','.join(_auth_utils.build_update_mask(payload))
        params = 'updateMask={0}'.format(update_mask)
        try:
            body = self.client.body(
                'patch', url='', json=payload, params=params)
        except requests.exceptions.RequestException as error:
            raise _auth_utils.handle_auth_backend_error(error)
        else:
            return ProjectConfig(body)