# Copyright 2012-2013 OpenStack, LLC. # # 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. # """ Command-line interface to the OpenStack APIs """ import getpass import logging import os import sys from cliff.app import App from cliff.commandmanager import CommandManager from openstackclient.common import clientmanager from openstackclient.common import exceptions as exc from openstackclient.common import openstackkeyring from openstackclient.common import utils VERSION = '0.1' KEYRING_SERVICE = 'openstack' 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. """ for v in vars: value = os.environ.get(v, None) if value: return value return kwargs.get('default', '') class OpenStackShell(App): CONSOLE_MESSAGE_FORMAT = '%(levelname)s: %(name)s %(message)s' log = logging.getLogger(__name__) def __init__(self): super(OpenStackShell, self).__init__( description=__doc__.strip(), version=VERSION, command_manager=CommandManager('openstack.cli'), ) # This is instantiated in initialize_app() only when using # password flow auth self.auth_client = None def build_option_parser(self, description, version): parser = super(OpenStackShell, self).build_option_parser( description, version, ) # Global arguments parser.add_argument('--os-auth-url', metavar='', default=env('OS_AUTH_URL'), help='Authentication URL (Env: OS_AUTH_URL)') parser.add_argument('--os-tenant-name', metavar='', default=env('OS_TENANT_NAME'), help='Authentication tenant name (Env: OS_TENANT_NAME)') parser.add_argument('--os-tenant-id', metavar='', default=env('OS_TENANT_ID'), help='Authentication tenant ID (Env: OS_TENANT_ID)') parser.add_argument('--os-username', metavar='', default=utils.env('OS_USERNAME'), help='Authentication username (Env: OS_USERNAME)') parser.add_argument('--os-password', metavar='', default=utils.env('OS_PASSWORD'), help='Authentication password (Env: OS_PASSWORD)') parser.add_argument('--os-region-name', metavar='', default=env('OS_REGION_NAME'), help='Authentication region name (Env: OS_REGION_NAME)') parser.add_argument('--os-identity-api-version', metavar='', default=env('OS_IDENTITY_API_VERSION', default='2.0'), help='Identity API version, default=2.0 ' '(Env: OS_IDENTITY_API_VERSION)') parser.add_argument('--os-compute-api-version', metavar='', default=env('OS_COMPUTE_API_VERSION', default='2'), help='Compute API version, default=2 ' '(Env: OS_COMPUTE_API_VERSION)') parser.add_argument('--os-image-api-version', metavar='', default=env('OS_IMAGE_API_VERSION', default='1.0'), help='Image API version, default=1.0 ' '(Env: OS_IMAGE_API_VERSION)') parser.add_argument('--os-token', metavar='', default=env('OS_TOKEN'), help='Defaults to env[OS_TOKEN]') parser.add_argument('--os-url', metavar='', default=env('OS_URL'), help='Defaults to env[OS_URL]') env_os_keyring = env('OS_USE_KEYRING', default=False) if type(env_os_keyring) == str: if env_os_keyring.lower() in ['true', '1']: env_os_keyring = True else: env_os_keyring = False parser.add_argument('--os-use-keyring', default=env_os_keyring, action='store_true', help='Use keyring to store password, ' 'default=False (Env: OS_USE_KEYRING)') return parser def authenticate_user(self): """Make sure the user has provided all of the authentication info we need. """ self.log.debug('validating authentication options') if self.options.os_token or self.options.os_url: # Token flow auth takes priority if not self.options.os_token: raise exc.CommandError( "You must provide a token via" " either --os-token or env[OS_TOKEN]") if not self.options.os_url: raise exc.CommandError( "You must provide a service URL via" " either --os-url or env[OS_URL]") else: # Validate password flow auth if not self.options.os_username: raise exc.CommandError( "You must provide a username via" " either --os-username or env[OS_USERNAME]") self.get_password_from_keyring() if not self.options.os_password: # No password, if we've got a tty, try prompting for it if hasattr(sys.stdin, 'isatty') and sys.stdin.isatty(): # Check for Ctl-D try: self.options.os_password = getpass.getpass() self.set_password_in_keyring() except EOFError: pass # No password because we did't have a tty or the # user Ctl-D when prompted? if not self.options.os_password: raise exc.CommandError( "You must provide a password via" " either --os-password, or env[OS_PASSWORD], " " or prompted response") if not (self.options.os_tenant_id or self.options.os_tenant_name): raise exc.CommandError( "You must provide a tenant_id via" " either --os-tenant-id or via env[OS_TENANT_ID]") if not self.options.os_auth_url: raise exc.CommandError( "You must provide an auth url via" " either --os-auth-url or via env[OS_AUTH_URL]") self.client_manager = clientmanager.ClientManager( token=self.options.os_token, url=self.options.os_url, auth_url=self.options.os_auth_url, tenant_name=self.options.os_tenant_name, tenant_id=self.options.os_tenant_id, username=self.options.os_username, password=self.options.os_password, region_name=self.options.os_region_name, api_version=self.api_version, ) return def init_keyring_backend(self): """Initialize openstack backend to use for keyring""" return openstackkeyring.os_keyring() def get_password_from_keyring(self): """Get password from keyring, if it's set""" if self.options.os_use_keyring: service = KEYRING_SERVICE backend = self.init_keyring_backend() if not self.options.os_password: password = backend.get_password(service, self.options.os_username) self.options.os_password = password def set_password_in_keyring(self): """Set password in keyring for this user""" if self.options.os_use_keyring: service = KEYRING_SERVICE backend = self.init_keyring_backend() if self.options.os_password: password = backend.get_password(service, self.options.os_username) # either password is not set in keyring, or it is different if password != self.options.os_password: backend.set_password(service, self.options.os_username, self.options.os_password) def initialize_app(self, argv): """Global app init bits: * set up API versions * validate authentication info * authenticate against Identity if requested """ super(OpenStackShell, self).initialize_app(argv) # stash selected API versions for later # TODO(dtroyer): how do extenstions add their version requirements? self.api_version = { 'compute': self.options.os_compute_api_version, 'identity': self.options.os_identity_api_version, 'image': self.options.os_image_api_version, } # If the user is not asking for help, make sure they # have given us auth. cmd_name = None if argv: cmd_info = self.command_manager.find_command(argv) cmd_factory, cmd_name, sub_argv = cmd_info if self.interactive_mode or cmd_name != 'help': self.authenticate_user() def prepare_to_run_command(self, cmd): """Set up auth and API versions""" self.log.debug('prepare_to_run_command %s', cmd.__class__.__name__) self.log.debug("api: %s" % cmd.api if hasattr(cmd, 'api') else None) return def clean_up(self, cmd, result, err): self.log.debug('clean_up %s', cmd.__class__.__name__) if err: self.log.debug('got an error: %s', err) def main(argv=sys.argv[1:]): try: return OpenStackShell().run(argv) except: return 1 if __name__ == "__main__": sys.exit(main(sys.argv[1:]))