1 # -*- coding: utf-8 -*-
3 # Copyright 2018 Whitestack, LLC
5 # Licensed under the Apache License, Version 2.0 (the "License"); you may
6 # not use this file except in compliance with the License. You may obtain
7 # a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 # License for the specific language governing permissions and limitations
17 # For those usages not covered by the Apache License, Version 2.0 please
18 # contact: esousa@whitestack.com or glavado@whitestack.com
22 Authconn implements an Abstract class for the Auth backend connector
23 plugins with the definition of the methods to be implemented.
26 __author__
= "Eduardo Sousa <esousa@whitestack.com>"
27 __date__
= "$27-jul-2018 23:59:59$"
29 from http
import HTTPStatus
32 class AuthException(Exception):
36 def __init__(self
, message
, http_code
=HTTPStatus
.UNAUTHORIZED
):
37 super(AuthException
, self
).__init
__(message
)
38 self
.http_code
= http_code
41 class AuthconnException(Exception):
43 Common and base class Exception for all authconn exceptions.
45 def __init__(self
, message
, http_code
=HTTPStatus
.UNAUTHORIZED
):
46 super(AuthconnException
, self
).__init
__(message
)
47 self
.http_code
= http_code
50 class AuthconnConnectionException(AuthconnException
):
52 Connectivity error with Auth backend.
54 def __init__(self
, message
, http_code
=HTTPStatus
.BAD_GATEWAY
):
55 super(AuthconnConnectionException
, self
).__init
__(message
, http_code
)
58 class AuthconnNotSupportedException(AuthconnException
):
60 The request is not supported by the Auth backend.
62 def __init__(self
, message
, http_code
=HTTPStatus
.NOT_IMPLEMENTED
):
63 super(AuthconnNotSupportedException
, self
).__init
__(message
, http_code
)
66 class AuthconnNotImplementedException(AuthconnException
):
68 The method is not implemented by the Auth backend.
70 def __init__(self
, message
, http_code
=HTTPStatus
.NOT_IMPLEMENTED
):
71 super(AuthconnNotImplementedException
, self
).__init
__(message
, http_code
)
74 class AuthconnOperationException(AuthconnException
):
76 The operation executed failed.
78 def __init__(self
, message
, http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
):
79 super(AuthconnOperationException
, self
).__init
__(message
, http_code
)
82 class AuthconnNotFoundException(AuthconnException
):
84 The operation executed failed because element not found.
86 def __init__(self
, message
, http_code
=HTTPStatus
.NOT_FOUND
):
87 super().__init
__(message
, http_code
)
90 class AuthconnConflictException(AuthconnException
):
92 The operation has conflicts.
94 def __init__(self
, message
, http_code
=HTTPStatus
.CONFLICT
):
95 super().__init
__(message
, http_code
)
100 Abstract base class for all the Auth backend connector plugins.
101 Each Auth backend connector plugin must be a subclass of
104 def __init__(self
, config
):
106 Constructor of the Authconn class.
110 :param config: configuration dictionary containing all the
111 necessary configuration parameters.
115 def authenticate(self
, user
, password
, project
=None, token
=None):
117 Authenticate a user using username/password or token, plus project
118 :param user: user: name, id or None
119 :param password: password or None
120 :param project: name, id, or None. If None first found project will be used to get an scope token
121 :param token: previous token to obtain authorization
122 :return: the scoped token info or raises an exception. The token is a dictionary with:
123 _id: token string id,
125 project_id: scoped_token project_id,
126 project_name: scoped_token project_name,
127 expires: epoch time when it expires,
130 raise AuthconnNotImplementedException("Should have implemented this")
132 # def authenticate_with_token(self, token, project=None):
134 # Authenticate a user using a token. Can be used to revalidate the token
135 # or to get a scoped token.
137 # :param token: a valid token.
138 # :param project: (optional) project for a scoped token.
139 # :return: return a revalidated token, scoped if a project was passed or
140 # the previous token was already scoped.
142 # raise AuthconnNotImplementedException("Should have implemented this")
144 def validate_token(self
, token
):
146 Check if the token is valid.
148 :param token: token to validate
149 :return: dictionary with information associated with the token. If the
150 token is not valid, returns None.
152 raise AuthconnNotImplementedException("Should have implemented this")
154 def revoke_token(self
, token
):
158 :param token: token to be revoked
160 raise AuthconnNotImplementedException("Should have implemented this")
162 def get_user_project_list(self
, token
):
164 Get all the projects associated with a user.
166 :param token: valid token
167 :return: list of projects
169 raise AuthconnNotImplementedException("Should have implemented this")
171 def get_user_role_list(self
, token
):
173 Get role list for a scoped project.
175 :param token: scoped token.
176 :return: returns the list of roles for the user in that project. If
177 the token is unscoped it returns None.
179 raise AuthconnNotImplementedException("Should have implemented this")
181 def create_user(self
, user
, password
):
185 :param user: username.
186 :param password: password.
187 :raises AuthconnOperationException: if user creation failed.
189 raise AuthconnNotImplementedException("Should have implemented this")
191 def update_user(self
, user
, new_name
=None, new_password
=None):
193 Change the user name and/or password.
195 :param user: username or user_id
196 :param new_name: new name
197 :param new_password: new password.
198 :raises AuthconnOperationException: if change failed.
200 raise AuthconnNotImplementedException("Should have implemented this")
202 def delete_user(self
, user_id
):
206 :param user_id: user identifier.
207 :raises AuthconnOperationException: if user deletion failed.
209 raise AuthconnNotImplementedException("Should have implemented this")
211 def get_user_list(self
, filter_q
=None):
215 :param filter_q: dictionary to filter user list by name (username is also admited) and/or _id
216 :return: returns a list of users.
219 def create_role(self
, role
):
223 :param role: role name.
224 :raises AuthconnOperationException: if role creation failed.
226 raise AuthconnNotImplementedException("Should have implemented this")
228 def delete_role(self
, role_id
):
232 :param role_id: role identifier.
233 :raises AuthconnOperationException: if user deletion failed.
235 raise AuthconnNotImplementedException("Should have implemented this")
237 def get_role_list(self
, filter_q
=None):
241 :param filter_q: dictionary to filter role list by _id and/or name.
242 :return: list of roles
244 raise AuthconnNotImplementedException("Should have implemented this")
246 def update_role(self
, role
, new_name
):
248 Change the name of a role
249 :param role: role name or id to be changed
250 :param new_name: new name
253 raise AuthconnNotImplementedException("Should have implemented this")
255 def create_project(self
, project
):
259 :param project: project name.
260 :return: the internal id of the created project
261 :raises AuthconnOperationException: if project creation failed.
263 raise AuthconnNotImplementedException("Should have implemented this")
265 def delete_project(self
, project_id
):
269 :param project_id: project identifier.
270 :raises AuthconnOperationException: if project deletion failed.
272 raise AuthconnNotImplementedException("Should have implemented this")
274 def get_project_list(self
, filter_q
=None):
276 Get all the projects.
278 :param filter_q: dictionary to filter project list, by "name" and/or "_id"
279 :return: list of projects
281 raise AuthconnNotImplementedException("Should have implemented this")
283 def update_project(self
, project_id
, new_name
):
285 Change the name of a project
286 :param project_id: project to be changed
287 :param new_name: new name
290 raise AuthconnNotImplementedException("Should have implemented this")
292 def assign_role_to_user(self
, user
, project
, role
):
294 Assigning a role to a user in a project.
296 :param user: username.
297 :param project: project name.
298 :param role: role name.
299 :raises AuthconnOperationException: if role assignment failed.
301 raise AuthconnNotImplementedException("Should have implemented this")
303 def remove_role_from_user(self
, user
, project
, role
):
305 Remove a role from a user in a project.
307 :param user: username.
308 :param project: project name.
309 :param role: role name.
310 :raises AuthconnOperationException: if role assignment revocation failed.
312 raise AuthconnNotImplementedException("Should have implemented this")