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
)
84 Abstract base class for all the Auth backend connector plugins.
85 Each Auth backend connector plugin must be a subclass of
88 def __init__(self
, config
):
90 Constructor of the Authconn class.
94 :param config: configuration dictionary containing all the
95 necessary configuration parameters.
99 def authenticate(self
, user
, password
, project
=None, token
=None):
101 Authenticate a user using username/password or token, plus project
102 :param user: user: name, id or None
103 :param password: password or None
104 :param project: name, id, or None. If None first found project will be used to get an scope token
105 :param token: previous token to obtain authorization
106 :return: the scoped token info or raises an exception. The token is a dictionary with:
107 _id: token string id,
109 project_id: scoped_token project_id,
110 project_name: scoped_token project_name,
111 expires: epoch time when it expires,
114 raise AuthconnNotImplementedException("Should have implemented this")
116 # def authenticate_with_token(self, token, project=None):
118 # Authenticate a user using a token. Can be used to revalidate the token
119 # or to get a scoped token.
121 # :param token: a valid token.
122 # :param project: (optional) project for a scoped token.
123 # :return: return a revalidated token, scoped if a project was passed or
124 # the previous token was already scoped.
126 # raise AuthconnNotImplementedException("Should have implemented this")
128 def validate_token(self
, token
):
130 Check if the token is valid.
132 :param token: token to validate
133 :return: dictionary with information associated with the token. If the
134 token is not valid, returns None.
136 raise AuthconnNotImplementedException("Should have implemented this")
138 def revoke_token(self
, token
):
142 :param token: token to be revoked
144 raise AuthconnNotImplementedException("Should have implemented this")
146 def get_user_project_list(self
, token
):
148 Get all the projects associated with a user.
150 :param token: valid token
151 :return: list of projects
153 raise AuthconnNotImplementedException("Should have implemented this")
155 def get_user_role_list(self
, token
):
157 Get role list for a scoped project.
159 :param token: scoped token.
160 :return: returns the list of roles for the user in that project. If
161 the token is unscoped it returns None.
163 raise AuthconnNotImplementedException("Should have implemented this")
165 def create_user(self
, user
, password
):
169 :param user: username.
170 :param password: password.
171 :raises AuthconnOperationException: if user creation failed.
173 raise AuthconnNotImplementedException("Should have implemented this")
175 def change_password(self
, user
, new_password
):
177 Change the user password.
179 :param user: username.
180 :param new_password: new password.
181 :raises AuthconnOperationException: if user password change failed.
183 raise AuthconnNotImplementedException("Should have implemented this")
185 def delete_user(self
, user_id
):
189 :param user_id: user identifier.
190 :raises AuthconnOperationException: if user deletion failed.
192 raise AuthconnNotImplementedException("Should have implemented this")
194 def get_user_list(self
, filter_q
={}):
198 :param filter_q: dictionary to filter user list.
199 :return: returns a list of users.
202 def create_role(self
, role
):
206 :param role: role name.
207 :raises AuthconnOperationException: if role creation failed.
209 raise AuthconnNotImplementedException("Should have implemented this")
211 def delete_role(self
, role_id
):
215 :param role_id: role identifier.
216 :raises AuthconnOperationException: if user deletion failed.
218 raise AuthconnNotImplementedException("Should have implemented this")
220 def get_role_list(self
):
224 :return: list of roles
226 raise AuthconnNotImplementedException("Should have implemented this")
228 def create_project(self
, project
):
232 :param project: project name.
233 :return: the internal id of the created project
234 :raises AuthconnOperationException: if project creation failed.
236 raise AuthconnNotImplementedException("Should have implemented this")
238 def delete_project(self
, project_id
):
242 :param project_id: project identifier.
243 :raises AuthconnOperationException: if project deletion failed.
245 raise AuthconnNotImplementedException("Should have implemented this")
247 def get_project_list(self
, filter_q
=None):
249 Get all the projects.
251 :param filter_q: dictionary to filter project list, by "name" and/or "_id"
252 :return: list of projects
254 raise AuthconnNotImplementedException("Should have implemented this")
256 def update_project(self
, project_id
, new_name
):
258 Change the name of a project
259 :param project_id: project to be changed
260 :param new_name: new name
263 raise AuthconnNotImplementedException("Should have implemented this")
265 def assign_role_to_user(self
, user
, project
, role
):
267 Assigning a role to a user in a project.
269 :param user: username.
270 :param project: project name.
271 :param role: role name.
272 :raises AuthconnOperationException: if role assignment failed.
274 raise AuthconnNotImplementedException("Should have implemented this")
276 def remove_role_from_user(self
, user
, project
, role
):
278 Remove a role from a user in a project.
280 :param user: username.
281 :param project: project name.
282 :param role: role name.
283 :raises AuthconnOperationException: if role assignment revocation failed.
285 raise AuthconnNotImplementedException("Should have implemented this")