Source code for flash_services.auth

"""Mix-in classes for implementing service authentication."""
# pylint: disable=too-few-public-methods

from base64 import b64encode

from .core import MixinMeta


class AuthMixin(metaclass=MixinMeta):
    """Root class for all authentication mix-ins."""


class Unauthenticated(AuthMixin):
    """No-op mix-in class for unauthenticated services."""


class TokenAuthMixin(AuthMixin):
    """Mix-in class for implementing token authentication."""

    TOKEN_ENV_VAR = None
    """:py:class:`str`: The environment variable holding the token."""

    def __init__(self, *, api_token, **kwargs):
        self.api_token = api_token
        super().__init__(**kwargs)


class UrlParamMixin(TokenAuthMixin):
    """Mix-in class for implementing URL parameter authentication."""

    AUTH_PARAM = None
    """:py:class:`str`: The name of the URL parameter."""

    @property
    def url_params(self):
        params = super().url_params
        params[self.AUTH_PARAM] = self.api_token
        return params


class HeaderMixin(TokenAuthMixin):
    """Mix-in class for implementing header authentication."""

    AUTH_HEADER = 'Authorization'
    """:py:class:`str`: The name of the request header."""

    @property
    def headers(self):
        """Add authentication header."""
        headers = super().headers
        headers.update({self.AUTH_HEADER: self.api_token})
        return headers


class BasicAuthHeaderMixin(HeaderMixin):
    """Mix-in class for HTTP Basic auth."""

    PROVIDED = {'api_token'}

    def __init__(self, *, username, password, **kwargs):
        api_token = self._generate_api_token(username, password)
        super().__init__(api_token=api_token, **kwargs)

    @staticmethod
    def _generate_api_token(username, password):
        encoding = 'utf8'
        token = b64encode(bytes('{}:{}'.format(username, password), encoding))
        return 'Basic {}'.format(str(token, encoding))


class BearerAuthHeaderMixin(HeaderMixin):
    """Mix-in class for bearer token authentication."""

    def __init__(self, *, api_token, **kwargs):
        api_token = 'Bearer {}'.format(api_token)
        super().__init__(api_token=api_token, **kwargs)