deb-python-castellan/castellan/common/credentials/keystone_token.py
Fernando Diaz db3c7a4e02 Introduce Castellan Credential Objects
This patch introduces the credential class in Castellan. It
includes Credential, Token, Password, Keystone Token, and
Keystone Password classes.
It is the first of several patches which will implement the
"Allow different Keystone Auth Support in Castellan" blueprint.

Other patches will add:
1.) credential factory
2.) barbican key manager logic and tests
3.) documentation on usage

Implements: blueprint remove-keystone-dependency
Change-Id: I4a4a85a108403d832e2bba91c901aaede605168d
2016-02-05 16:46:01 +00:00

113 lines
4.0 KiB
Python

# Copyright (c) 2015 IBM
# All Rights Reserved.
#
# 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.
"""
Keystone Token Credential
This module defines the Keystone Token credential.
"""
from castellan.common.credentials import token
class KeystoneToken(token.Token):
"""This class represents a keystone token credential."""
def __init__(self, token, trust_id=None, domain_id=None, domain_name=None,
project_id=None, project_name=None, project_domain_id=None,
project_domain_name=None, reauthenticate=True):
"""Create a new Keystone Token Credential.
:param string token: Token for authentication. The type of token
formats accepted are UUID, PKI, and Fernet.
:param string trust_id: Trust ID for trust scoping.
:param string domain_id: Domain ID for domain scoping.
:param string domain_name: Domain name for domain scoping.
:param string project_id: Project ID for project scoping.
:param string project_name: Project name for project scoping.
:param string project_domain_id: Project's domain ID for project.
:param string project_domain_name: Project's domain name for project.
:param bool reauthenticate: Allow fetching a new token if the current
one is going to expire. (optional) default True
"""
self._trust_id = trust_id
self._domain_id = domain_id
self._domain_name = domain_name
self._project_id = project_id
self._project_name = project_name
self._project_domain_id = project_domain_id
self._project_domain_name = project_domain_name
self._reauthenticate = reauthenticate
super(KeystoneToken, self).__init__(token)
@property
def trust_id(self):
"""This method returns a trust_id."""
return self._trust_id
@property
def domain_id(self):
"""This method returns a domain_id."""
return self._domain_id
@property
def domain_name(self):
"""This method returns a domain_name."""
return self._domain_name
@property
def project_id(self):
"""This method returns a project_id."""
return self._project_id
@property
def project_name(self):
"""This method returns a project_name."""
return self._project_name
@property
def project_domain_id(self):
"""This method returns a project_domain_id."""
return self._project_domain_id
@property
def project_domain_name(self):
"""This method returns a project_domain_name."""
return self._project_domain_name
@property
def reauthenticate(self):
"""This method returns reauthenticate."""
return self._reauthenticate
def __eq__(self, other):
if isinstance(other, KeystoneToken):
return (
self._token == other._token and
self._trust_id == other._trust_id and
self._domain_id == other._domain_id and
self._domain_name == other._domain_name and
self._project_id == other._project_id and
self._project_name == other._project_name and
self._project_domain_id == other._project_domain_id and
self._project_domain_name == other._project_domain_name and
self._reauthenticate == other._reauthenticate)
else:
return False
def __ne__(self, other):
result = self.__eq__(other)
return not result