Source code for SoftLayer.auth

"""
    SoftLayer.auth
    ~~~~~~~~~~~~~~
    Module with the supported auth mechanisms for the SoftLayer API

    :license: MIT, see LICENSE for more details.
"""
# pylint: disable=no-self-use

__all__ = [
    'BasicAuthentication',
    'TokenAuthentication',
    'BasicHTTPAuthentication',
    'AuthenticationBase',
]


class AuthenticationBase(object):
    """A base authentication class intended to be overridden."""

    def get_request(self, request):
        """Receives request options and returns request options.

            :param options dict: dictionary of request options

        """
        return request

    def get_headers(self):
        """Return a dictionary of headers to be inserted for authentication.

        .. deprecated:: 3.3.0
           Use :func:`get_options` instead.
        """
        return {}


class TokenAuthentication(AuthenticationBase):
    """Token-based authentication class.

        :param user_id int: a user's id
        :param auth_token str: a user's auth token, attained through
                               User_Customer::getPortalLoginToken
    """
    def __init__(self, user_id, auth_token):
        self.user_id = user_id
        self.auth_token = auth_token

    def get_request(self, request):
        """Sets token-based auth headers."""
        request.headers['authenticate'] = {
            'complexType': 'PortalLoginToken',
            'userId': self.user_id,
            'authToken': self.auth_token,
        }
        return request

    def __repr__(self):
        return "TokenAuthentication(%r)" % self.user_id


[docs]class BasicAuthentication(AuthenticationBase): """Token-based authentication class. :param username str: a user's username :param api_key str: a user's API key """ def __init__(self, username, api_key): self.username = username self.api_key = api_key
[docs] def get_request(self, request): """Sets token-based auth headers.""" request.headers['authenticate'] = { 'username': self.username, 'apiKey': self.api_key, } return request
def __repr__(self): return "BasicAuthentication(username=%r)" % self.username
class BasicHTTPAuthentication(AuthenticationBase): """Token-based authentication class. :param username str: a user's username :param api_key str: a user's API key """ def __init__(self, username, api_key): self.username = username self.api_key = api_key def get_request(self, request): """Sets token-based auth headers.""" request.transport_user = self.username request.transport_password = self.api_key return request def __repr__(self): return "BasicHTTPAuthentication(username=%r)" % self.username