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 "Pedro de la Cruz Ramos <pdelacruzramos@altran.com>"
28 __date__
= "$27-jul-2018 23:59:59$"
30 from http
import HTTPStatus
31 from osm_nbi
.base_topic
import BaseTopic
34 class AuthException(Exception):
36 Authentication error, because token, user password not recognized
38 def __init__(self
, message
, http_code
=HTTPStatus
.UNAUTHORIZED
):
39 super(AuthException
, self
).__init
__(message
)
40 self
.http_code
= http_code
43 class AuthExceptionUnauthorized(AuthException
):
45 Authentication error, because not having rights to make this operation
50 class AuthconnException(Exception):
52 Common and base class Exception for all authconn exceptions.
54 def __init__(self
, message
, http_code
=HTTPStatus
.UNAUTHORIZED
):
55 super(AuthconnException
, self
).__init
__(message
)
56 self
.http_code
= http_code
59 class AuthconnConnectionException(AuthconnException
):
61 Connectivity error with Auth backend.
63 def __init__(self
, message
, http_code
=HTTPStatus
.BAD_GATEWAY
):
64 super(AuthconnConnectionException
, self
).__init
__(message
, http_code
)
67 class AuthconnNotSupportedException(AuthconnException
):
69 The request is not supported by the Auth backend.
71 def __init__(self
, message
, http_code
=HTTPStatus
.NOT_IMPLEMENTED
):
72 super(AuthconnNotSupportedException
, self
).__init
__(message
, http_code
)
75 class AuthconnNotImplementedException(AuthconnException
):
77 The method is not implemented by the Auth backend.
79 def __init__(self
, message
, http_code
=HTTPStatus
.NOT_IMPLEMENTED
):
80 super(AuthconnNotImplementedException
, self
).__init
__(message
, http_code
)
83 class AuthconnOperationException(AuthconnException
):
85 The operation executed failed.
87 def __init__(self
, message
, http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
):
88 super(AuthconnOperationException
, self
).__init
__(message
, http_code
)
91 class AuthconnNotFoundException(AuthconnException
):
93 The operation executed failed because element not found.
95 def __init__(self
, message
, http_code
=HTTPStatus
.NOT_FOUND
):
96 super().__init
__(message
, http_code
)
99 class AuthconnConflictException(AuthconnException
):
101 The operation has conflicts.
103 def __init__(self
, message
, http_code
=HTTPStatus
.CONFLICT
):
104 super().__init
__(message
, http_code
)
109 Abstract base class for all the Auth backend connector plugins.
110 Each Auth backend connector plugin must be a subclass of
113 def __init__(self
, config
, db
, token_cache
):
115 Constructor of the Authconn class.
119 :param config: configuration dictionary containing all the
120 necessary configuration parameters.
124 def authenticate(self
, user
, password
, project
=None, token_info
=None):
126 Authenticate a user using username/password or token_info, plus project
127 :param user: user: name, id or None
128 :param password: password or None
129 :param project: name, id, or None. If None first found project will be used to get an scope token
130 :param token_info: previous token_info to obtain authorization
131 :return: the scoped token info or raises an exception. The token is a dictionary with:
132 _id: token string id,
134 project_id: scoped_token project_id,
135 project_name: scoped_token project_name,
136 expires: epoch time when it expires,
139 raise AuthconnNotImplementedException("Should have implemented this")
141 def validate_token(self
, token
):
143 Check if the token is valid.
145 :param token: token to validate
146 :return: dictionary with information associated with the token. If the
147 token is not valid, returns None.
149 raise AuthconnNotImplementedException("Should have implemented this")
151 def revoke_token(self
, token
):
155 :param token: token to be revoked
157 raise AuthconnNotImplementedException("Should have implemented this")
159 def create_user(self
, user_info
):
163 :param user_info: full user info.
164 :raises AuthconnOperationException: if user creation failed.
166 raise AuthconnNotImplementedException("Should have implemented this")
168 def update_user(self
, user_info
):
170 Change the user name and/or password.
172 :param user_info: user info modifications
173 :raises AuthconnNotImplementedException: if function not implemented
175 raise AuthconnNotImplementedException("Should have implemented this")
177 def delete_user(self
, user_id
):
181 :param user_id: user identifier.
182 :raises AuthconnOperationException: if user deletion failed.
184 raise AuthconnNotImplementedException("Should have implemented this")
186 def get_user_list(self
, filter_q
=None):
190 :param filter_q: dictionary to filter user list by name (username is also admited) and/or _id
191 :return: returns a list of users.
194 def get_user(self
, _id
, fail
=True):
197 :param _id: id or name
198 :param fail: True to raise exception on not found. False to return None on not found
199 :return: dictionary with the user information
201 filt
= {BaseTopic
.id_field("users", _id
): _id
}
202 users
= self
.get_user_list(filt
)
205 raise AuthconnNotFoundException("User with {} not found".format(filt
), http_code
=HTTPStatus
.NOT_FOUND
)
210 def create_role(self
, role_info
):
214 :param role_info: full role info.
215 :raises AuthconnOperationException: if role creation failed.
217 raise AuthconnNotImplementedException("Should have implemented this")
219 def delete_role(self
, role_id
):
223 :param role_id: role identifier.
224 :raises AuthconnOperationException: if user deletion failed.
226 raise AuthconnNotImplementedException("Should have implemented this")
228 def get_role_list(self
, filter_q
=None):
232 :param filter_q: dictionary to filter role list by _id and/or name.
233 :return: list of roles
235 raise AuthconnNotImplementedException("Should have implemented this")
237 def get_role(self
, _id
, fail
=True):
240 :param _id: id or name
241 :param fail: True to raise exception on not found. False to return None on not found
242 :return: dictionary with the role information
244 filt
= {BaseTopic
.id_field("roles", _id
): _id
}
245 roles
= self
.get_role_list(filt
)
248 raise AuthconnNotFoundException("Role with {} not found".format(filt
))
253 def update_role(self
, role_info
):
255 Change the information of a role
256 :param role_info: full role info
259 raise AuthconnNotImplementedException("Should have implemented this")
261 def create_project(self
, project_info
):
265 :param project_info: full project info.
266 :return: the internal id of the created project
267 :raises AuthconnOperationException: if project creation failed.
269 raise AuthconnNotImplementedException("Should have implemented this")
271 def delete_project(self
, project_id
):
275 :param project_id: project identifier.
276 :raises AuthconnOperationException: if project deletion failed.
278 raise AuthconnNotImplementedException("Should have implemented this")
280 def get_project_list(self
, filter_q
=None):
282 Get all the projects.
284 :param filter_q: dictionary to filter project list, by "name" and/or "_id"
285 :return: list of projects
287 raise AuthconnNotImplementedException("Should have implemented this")
289 def get_project(self
, _id
, fail
=True):
292 :param _id: id or name
293 :param fail: True to raise exception on not found. False to return None on not found
294 :return: dictionary with the project information
296 filt
= {BaseTopic
.id_field("projects", _id
): _id
}
297 projs
= self
.get_project_list(filt
)
300 raise AuthconnNotFoundException("project with {} not found".format(filt
))
305 def update_project(self
, project_id
, project_info
):
307 Change the information of a project
308 :param project_id: project to be changed
309 :param project_info: full project info
312 raise AuthconnNotImplementedException("Should have implemented this")