/usr/lib/python3/dist-packages/sushy/auth.py is in python3-sushy 1.3.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 | # 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.
# Sushy Redfish Authentication Modes
import abc
import logging
import six
from sushy import exceptions
LOG = logging.getLogger(__name__)
@six.add_metaclass(abc.ABCMeta)
class AuthBase(object):
def __init__(self, username=None, password=None):
"""A class representing a base Sushy authentication mechanism
:param username: User account with admin/server-profile
access privilege.
:param password: User account password.
"""
self._username = username
self._password = password
self._root_resource = None
self._connector = None
def set_context(self, root_resource, connector):
"""Set the context of the authentication object.
:param root_resource: Root sushy object
:param connector: Connector for http connections
"""
self._root_resource = root_resource
self._connector = connector
self._connector.set_auth(self)
def authenticate(self):
"""Perform authentication.
:raises: RuntimeError
"""
if self._root_resource is None or self._connector is None:
raise RuntimeError('_root_resource / _connector is missing. '
'Forgot to call set_context()?')
self._do_authenticate()
@abc.abstractmethod
def _do_authenticate(self):
"""Method to establish a session to a Redfish controller.
Needs to be implemented by extending auth class,
because each authentication type will authenticate in its own way.
"""
@abc.abstractmethod
def can_refresh_session(self):
"""Method to assert if session based refresh can be done."""
def __enter__(self):
"""Allow object to be called with the 'with' statement."""
return self
def __exit__(self, exception_type, exception_value, traceback):
"""Allow object to be called with the 'with' statement.
Allow object to be called with the 'with' statement but
also ensure we call close method on exit.
"""
self.close()
class BasicAuth(AuthBase):
"""Basic Authentication class.
This is a class used to encapsulate a basic authentication session.
:param username: User account with admin/server-profile
access privilege.
:param password: User account password.
"""
def _do_authenticate(self):
"""Attempts to establish a Basic Authentication Session.
"""
self._connector.set_http_basic_auth(self._username, self._password)
def can_refresh_session(self):
"""Method to assert if session based refresh can be done."""
return False
class SessionAuth(AuthBase):
"""Session Authentication class.
This is a class used to encapsulate a redfish session.
"""
def __init__(self, username=None, password=None):
"""A class representing a Session Authentication object.
:param username: User account with admin/server-profile access
privilege.
:param password: User account password.
"""
self._session_key = None
"""Our Sessions Key"""
self._session_resource_id = None
"""Our Sessions Unique Resource ID or URL"""
super(SessionAuth, self).__init__(username,
password)
def get_session_key(self):
"""Returns the session key.
:returns: The session key.
"""
return self._session_key
def get_session_resource_id(self):
"""Returns the session resource id.
:returns: The session resource id.
"""
return self._session_resource_id
def _do_authenticate(self):
"""Establish a redfish session.
:raises: MissingXAuthToken
:raises: ConnectionError
:raises: AccessError
:raises: HTTPError
"""
session_service = self._root_resource.get_session_service()
session_auth_token, session_uri = (
session_service.create_session(self._username,
self._password))
self._session_key = session_auth_token
self._session_resource_id = session_uri
self._connector.set_http_session_auth(session_auth_token)
def can_refresh_session(self):
"""Method to assert if session based refresh can be done."""
return (self._session_key is not None and
self._session_resource_id is not None)
def refresh_session(self):
"""Method to refresh a session to a Redfish controller.
This method is called to create a new session after
a session that has already been established
has timed-out or expired.
:raises: MissingXAuthToken
:raises: ConnectionError
:raises: AccessError
:raises: HTTPError
"""
self.reset_session_attrs()
self._do_authenticate()
def close(self):
"""Close the Redfish Session.
Attempts to close an established RedfishSession by
deleting it from the remote Redfish controller.
"""
if self._session_resource_id is not None:
try:
self._connector.delete(self._session_resource_id)
except (exceptions.AccessError,
exceptions.ServerSideError) as exc:
LOG.warning('Received exception "%(exception)s" while '
'attempting to delete the active session: '
'%(session_id)s',
{'exception': exc,
'session_id': self._session_resource_id})
self.reset_session_attrs()
def reset_session_attrs(self):
"""Reset active session related attributes."""
self._session_key = None
self._session_resource_id = None
class SessionOrBasicAuth(SessionAuth):
def __init__(self, username=None, password=None):
super(SessionOrBasicAuth, self).__init__(username, password)
self.basic_auth = BasicAuth(username=username, password=password)
def _do_authenticate(self):
"""Establish a RedfishSession.
We will attempt to establish a redfish session. If we are unable
to establish one, fallback to basic authentication.
"""
try:
# Attempt session based authentication
super(SessionOrBasicAuth, self)._do_authenticate()
except exceptions.SushyError as e:
LOG.debug('Received exception "%(exception)s" while '
'attempting to establish a session. '
'Falling back to basic authentication.',
{'exception': e})
# Fall back to basic authentication
self.reset_session_attrs()
self.basic_auth.set_context(self._root_resource, self._connector)
self.basic_auth.authenticate()
def refresh_session(self):
"""Method to refresh a session to a Redfish controller.
This method is called to create a new RedfishSession
if we have previously established a RedfishSession and
the previous session has timed-out or expired.
If we did not previously have an established session,
we simply return our BasicAuthentication requests.Session.
"""
if self.can_refresh_session():
super(SessionOrBasicAuth, self).refresh_session()
|