File: http_basic.py

package info (click to toggle)
python-keystoneauth1 5.12.0-2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 2,280 kB
  • sloc: python: 23,506; xml: 285; makefile: 93; sh: 2
file content (55 lines) | stat: -rw-r--r-- 1,788 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# 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.

import base64
import typing as ty

from keystoneauth1 import plugin

if ty.TYPE_CHECKING:
    from keystoneauth1 import session as ks_session

AUTH_HEADER_NAME = 'Authorization'


class HTTPBasicAuth(plugin.FixedEndpointPlugin):
    """A provider that will always use HTTP Basic authentication.

    This is useful to unify session/adapter loading for services
    that might be deployed in standalone mode.
    """

    def __init__(
        self,
        endpoint: str | None = None,
        username: str | None = None,
        password: str | None = None,
    ):
        super().__init__(endpoint)
        self.username = username
        self.password = password

    def get_token(self, session: 'ks_session.Session') -> str | None:
        if self.username is None or self.password is None:
            return None
        token = bytes(f'{self.username}:{self.password}', encoding='utf-8')
        encoded = base64.b64encode(token)
        return str(encoded, encoding='utf-8')

    def get_headers(
        self, session: 'ks_session.Session'
    ) -> dict[str, str] | None:
        token = self.get_token(session)
        if not token:
            return None
        auth = f'Basic {token}'
        return {AUTH_HEADER_NAME: auth}