# Copyright (c) 2013 Rackspace, Inc. # # 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. import importlib import logging import os import sys import warnings from keystoneauth1 import adapter from keystoneauth1 import session as ks_session from oslo_utils import importutils from barbicanclient import exceptions LOG = logging.getLogger(__name__) DEFAULT_SERVICE_TYPE = 'key-manager' DEFAULT_SERVICE_INTERFACE = 'public' _DEFAULT_API_VERSION = 'v1' _SUPPORTED_API_VERSION_MAP = {'v1': 'barbicanclient.v1.client.Client'} class _HTTPClient(adapter.Adapter): def __init__(self, session, microversion, project_id=None, **kwargs): endpoint = kwargs.pop('endpoint', None) if endpoint: kwargs['endpoint_override'] = "{}/{}/".format( endpoint.rstrip('/'), kwargs.get('version') ) super().__init__(session, **kwargs) self.microversion = microversion if project_id is None: self._default_headers = dict() else: # If provided we'll include the project ID in all requests. self._default_headers = {'X-Project-Id': project_id} def request(self, *args, **kwargs): headers = kwargs.setdefault('headers', {}) headers.update(self._default_headers) # Set raise_exc=False by default so that we handle request exceptions kwargs.setdefault('raise_exc', False) resp = super(_HTTPClient, self).request(*args, **kwargs) self._check_status_code(resp) return resp def get(self, *args, **kwargs): headers = kwargs.setdefault('headers', {}) headers.setdefault('Accept', 'application/json') return super(_HTTPClient, self).get(*args, **kwargs).json() def post(self, path, *args, **kwargs): path = self._fix_path(path) return super(_HTTPClient, self).post(path, *args, **kwargs).json() def _fix_path(self, path): if not path[-1] == '/': path += '/' return path def _get_raw(self, path, *args, **kwargs): return self.request(path, 'GET', *args, **kwargs).content def _check_status_code(self, resp): status = resp.status_code LOG.debug('Response status {0}'.format(status)) if status == 401: LOG.error('Auth error: {0}'.format(self._get_error_message(resp))) raise exceptions.HTTPAuthError( '{0}'.format(self._get_error_message(resp)) ) if not status or status >= 500: LOG.error('5xx Server error: {0}'.format( self._get_error_message(resp) )) raise exceptions.HTTPServerError( '{0}'.format(self._get_error_message(resp)), status ) if status >= 400: LOG.error('4xx Client error: {0}'.format( self._get_error_message(resp) )) raise exceptions.HTTPClientError( '{0}'.format(self._get_error_message(resp)), status ) def _get_error_message(self, resp): try: response_data = resp.json() message = response_data['title'] description = response_data.get('description') if description: message = '{0}: {1}'.format(message, description) except ValueError: message = resp.content return message def Client(version=None, session=None, *args, **kwargs): """Barbican client used to interact with barbican service. :param session: An instance of keystoneauth1.session.Session that can be either authenticated, or not authenticated. When using a non-authenticated Session, you must provide some additional parameters. When no session is provided it will default to a non-authenticated Session. (optional) :param endpoint: Barbican endpoint url override. Required when a session is not given, or when using a non-authenticated session. When using an authenticated session, the client will attempt to get the endpoint from the Keystone service catalog. (optional) :param project_id: The project ID used for context in Barbican. Required when a session is not given, or when using a non-authenticated session. When using an authenticated session, the project ID will be provided by the authentication mechanism and this parameter will be ignored. (optional) :param verify: When a session is not given, the client will create a non-authenticated session. This parameter is passed to the session that is created. If set to False, it allows barbicanclient to perform "insecure" TLS (https) requests. The server's certificate will not be verified against any certificate authorities. (optional) WARNING: This option should be used with caution. :param version: Used as an endpoint filter when using an authenticated keystone session. When using a non-authenticated keystone session, this value is appended to the required endpoint url override. Defaults to 'v1'. :param service_type: Used as an endpoint filter when using an authenticated keystone session. Defaults to 'key-manager'. :param service_name: Used as an endpoint filter when using an authenticated keystone session. :param interface: Used as an endpoint filter when using an authenticated keystone session. Defaults to 'public'. :param region_name: Used as an endpoint filter when using an authenticated keystone session. :param microversion: Specifiy an API Microversion to be used. Defaults to '1.1'. """ LOG.debug("Creating Client object") if not session: session = ks_session.Session(verify=kwargs.pop('verify', True)) if session.auth is None: if kwargs.get('auth') is None: if not kwargs.get('endpoint'): raise ValueError('Barbican endpoint url must be provided when' ' not using auth in the Keystone Session.') if kwargs.get('project_id') is None: raise ValueError('Project ID must be provided when not using ' 'auth in the Keystone Session') else: session.auth = kwargs['auth'] kwargs['version'] = version or _DEFAULT_API_VERSION kwargs.setdefault('service_type', DEFAULT_SERVICE_TYPE) kwargs.setdefault('interface', DEFAULT_SERVICE_INTERFACE) try: client_path = _SUPPORTED_API_VERSION_MAP[kwargs['version']] client_class = importutils.import_class(client_path) return client_class(session=session, *args, **kwargs) except (KeyError, ValueError): supported_versions = ', '.join(_SUPPORTED_API_VERSION_MAP.keys()) msg = ("Invalid client version %(version)s; must be one of: " "%(versions)s") % {'version': kwargs.get('version'), 'versions': supported_versions} raise exceptions.UnsupportedVersion(msg) def env(*vars, **kwargs): """Search for the first defined of possibly many env vars Returns the first environment variable defined in vars, or returns the default defined in kwargs. Source: Keystone's shell.py """ for v in vars: value = os.environ.get(v, None) if value: return value return kwargs.get('default', '') class _LazyImporter(object): def __init__(self, module): self._module = module def __getattr__(self, name): # This is only called until the import has been done. lazy_submodules = [ 'acls', 'cas', 'containers', 'orders', 'secrets', ] if name in lazy_submodules: warnings.warn("The %s module is moved to barbicanclient/v1 " "directory, direct import of " "barbicanclient.client.%s " "will be deprecated. Please import " "barbicanclient.v1.%s instead." % (name, name, name)) return importlib.import_module('barbicanclient.v1.%s' % name) # Return module attributes like __all__ etc. return getattr(self._module, name) sys.modules[__name__] = _LazyImporter(sys.modules[__name__])