File: _loading.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 (96 lines) | stat: -rw-r--r-- 3,221 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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# 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 typing as ty

from keystoneauth1 import exceptions
from keystoneauth1.extras import kerberos
from keystoneauth1 import loading
from keystoneauth1.loading import opts


class Kerberos(loading.BaseV3Loader[kerberos.Kerberos]):
    @property
    def plugin_class(self) -> type[kerberos.Kerberos]:
        return kerberos.Kerberos

    @property
    def available(self) -> bool:
        return kerberos.requests_kerberos is not None

    def get_options(self) -> list[opts.Opt]:
        options = super().get_options()

        options.extend(
            [
                loading.Opt(
                    'mutual-auth',
                    required=False,
                    default='optional',
                    help='Configures Kerberos Mutual Authentication',
                )
            ]
        )

        return options

    def load_from_options(self, **kwargs: ty.Any) -> kerberos.Kerberos:
        if kwargs.get('mutual_auth'):
            value = kwargs['mutual_auth']
            if value.lower() not in ['required', 'optional', 'disabled']:
                m = (
                    'You need to provide a valid value for kerberos mutual '
                    'authentication. It can be one of the following: '
                    '(required, optional, disabled)'
                )
                raise exceptions.OptionError(m)

        return super().load_from_options(**kwargs)


class MappedKerberos(loading.BaseFederationLoader[kerberos.MappedKerberos]):
    @property
    def plugin_class(self) -> type[kerberos.MappedKerberos]:
        return kerberos.MappedKerberos

    @property
    def available(self) -> bool:
        return kerberos.requests_kerberos is not None

    def get_options(self) -> list[opts.Opt]:
        options = super().get_options()

        options.extend(
            [
                loading.Opt(
                    'mutual-auth',
                    required=False,
                    default='optional',
                    help='Configures Kerberos Mutual Authentication',
                )
            ]
        )

        return options

    def load_from_options(self, **kwargs: ty.Any) -> kerberos.MappedKerberos:
        if kwargs.get('mutual_auth'):
            value = kwargs['mutual_auth']
            if value.lower() not in ['required', 'optional', 'disabled']:
                m = (
                    'You need to provide a valid value for kerberos mutual '
                    'authentication. It can be one of the following: '
                    '(required, optional, disabled)'
                )
                raise exceptions.OptionError(m)

        return super().load_from_options(**kwargs)