|
1
|
|
|
# Licensed to the StackStorm, Inc ('StackStorm') under one or more |
|
2
|
|
|
# contributor license agreements. See the NOTICE file distributed with |
|
3
|
|
|
# this work for additional information regarding copyright ownership. |
|
4
|
|
|
# The ASF licenses this file to You under the Apache License, Version 2.0 |
|
5
|
|
|
# (the "License"); you may not use this file except in compliance with |
|
6
|
|
|
# the License. You may obtain a copy of the License at |
|
7
|
|
|
# |
|
8
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0 |
|
9
|
|
|
# |
|
10
|
|
|
# Unless required by applicable law or agreed to in writing, software |
|
11
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS, |
|
12
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
13
|
|
|
# See the License for the specific language governing permissions and |
|
14
|
|
|
# limitations under the License. |
|
15
|
|
|
|
|
16
|
|
|
import abc |
|
17
|
|
|
|
|
18
|
|
|
import six |
|
19
|
|
|
|
|
20
|
|
|
from st2auth.backends.constants import AuthBackendCapability |
|
21
|
|
|
|
|
22
|
|
|
__all__ = [ |
|
23
|
|
|
'BaseAuthenticationBackend' |
|
24
|
|
|
] |
|
25
|
|
|
|
|
26
|
|
|
|
|
27
|
|
|
@six.add_metaclass(abc.ABCMeta) |
|
28
|
|
|
class BaseAuthenticationBackend(object): |
|
29
|
|
|
""" |
|
30
|
|
|
Base authentication class. |
|
31
|
|
|
""" |
|
32
|
|
|
|
|
33
|
|
|
# Capabilities offered by the auth backend |
|
34
|
|
|
CAPABILITIES = ( |
|
35
|
|
|
AuthBackendCapability.CAN_AUTHENTICATE_USER |
|
36
|
|
|
) |
|
37
|
|
|
|
|
38
|
|
|
@abc.abstractmethod |
|
39
|
|
|
def authenticate(self, username, password): |
|
40
|
|
|
pass |
|
41
|
|
|
|
|
42
|
|
|
def get_user(self, username): |
|
43
|
|
|
""" |
|
44
|
|
|
Retrieve information (user account) for a particular user. |
|
45
|
|
|
|
|
46
|
|
|
Note: Not all the auth backends may implement this. |
|
47
|
|
|
|
|
48
|
|
|
:rtype: ``dict`` |
|
49
|
|
|
""" |
|
50
|
|
|
raise NotImplementedError('get_user() not implemented for this backend') |
|
51
|
|
|
|
|
52
|
|
|
def get_user_groups(self, username): |
|
53
|
|
|
""" |
|
54
|
|
|
Retrieve a list of groups a particular user is a member of. |
|
55
|
|
|
|
|
56
|
|
|
Note: Not all the auth backends may implement this. |
|
57
|
|
|
|
|
58
|
|
|
:rtype: ``list`` of ``str`` |
|
59
|
|
|
""" |
|
60
|
|
|
raise NotImplementedError('get_groups() not implemented for this backend') |
|
61
|
|
|
|
StackStorm /
st2
