X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=juju%2Fclient%2Fconnection.py;h=77edda5038d938f0512c8e04c95b3f0d10e07942;hb=f1141c79947f1ba335c697be546761a1a1fc43b3;hp=69ac4253235fc6fdf2714034ecd613defffb7c18;hpb=2ed7314a9ea1240883655bc521b6e27f149aa485;p=osm%2FN2VC.git diff --git a/juju/client/connection.py b/juju/client/connection.py index 69ac425..77edda5 100644 --- a/juju/client/connection.py +++ b/juju/client/connection.py @@ -1,4 +1,4 @@ -import asyncio +import base64 import io import json import logging @@ -9,9 +9,14 @@ import ssl import string import subprocess import websockets +from http.client import HTTPSConnection +import asyncio import yaml +from juju import tag +from juju.errors import JujuAPIError, JujuConnectionError + log = logging.getLogger("websocket") @@ -30,28 +35,44 @@ class Connection: client = await Connection.connect_current() """ - def __init__(self, endpoint, uuid, username, password, cacert=None): + def __init__( + self, endpoint, uuid, username, password, cacert=None, + macaroons=None, loop=None): self.endpoint = endpoint self.uuid = uuid self.username = username self.password = password + self.macaroons = macaroons self.cacert = cacert + self.loop = loop or asyncio.get_event_loop() self.__request_id__ = 0 self.addr = None self.ws = None self.facades = {} - def _get_ssl(self, cert): + @property + def is_open(self): + if self.ws: + return self.ws.open + return False + + def _get_ssl(self, cert=None): return ssl.create_default_context( purpose=ssl.Purpose.CLIENT_AUTH, cadata=cert) - async def open(self, addr, cert=None): + async def open(self): + if self.uuid: + url = "wss://{}/model/{}/api".format(self.endpoint, self.uuid) + else: + url = "wss://{}/api".format(self.endpoint) + kw = dict() - if cert: - kw['ssl'] = self._get_ssl(cert) - self.addr = addr - self.ws = await websockets.connect(addr, **kw) + kw['ssl'] = self._get_ssl(self.cacert) + kw['loop'] = self.loop + self.addr = url + self.ws = await websockets.connect(url, **kw) + log.info("Driver connected to juju %s", url) return self async def close(self): @@ -73,12 +94,56 @@ class Connection: outgoing = json.dumps(msg, indent=2, cls=encoder) await self.ws.send(outgoing) result = await self.recv() - #log.debug("Send: %s", outgoing) - #log.debug("Recv: %s", result) if result and 'error' in result: - raise RuntimeError(result) + raise JujuAPIError(result) return result + def http_headers(self): + """Return dictionary of http headers necessary for making an http + connection to the endpoint of this Connection. + + :return: Dictionary of headers + + """ + if not self.username: + return {} + + creds = u'{}:{}'.format( + tag.user(self.username), + self.password or '' + ) + token = base64.b64encode(creds.encode()) + return { + 'Authorization': 'Basic {}'.format(token.decode()) + } + + def https_connection(self): + """Return an https connection to this Connection's endpoint. + + Returns a 3-tuple containing:: + + 1. The :class:`HTTPSConnection` instance + 2. Dictionary of auth headers to be used with the connection + 3. The root url path (str) to be used for requests. + + """ + endpoint = self.endpoint + host, remainder = endpoint.split(':', 1) + port = remainder + if '/' in remainder: + port, _ = remainder.split('/', 1) + + conn = HTTPSConnection( + host, int(port), + context=self._get_ssl(self.cacert), + ) + + path = ( + "/model/{}".format(self.uuid) + if self.uuid else "" + ) + return conn, self.http_headers(), path + async def clone(self): """Return a new Connection, connected to the same websocket endpoint as this one. @@ -90,6 +155,8 @@ class Connection: self.username, self.password, self.cacert, + self.macaroons, + self.loop, ) async def controller(self): @@ -102,77 +169,134 @@ class Connection: self.username, self.password, self.cacert, + self.macaroons, + self.loop, ) @classmethod - async def connect(cls, endpoint, uuid, username, password, cacert=None): + async def connect( + cls, endpoint, uuid, username, password, cacert=None, + macaroons=None, loop=None): """Connect to the websocket. If uuid is None, the connection will be to the controller. Otherwise it will be to the model. """ - if uuid: - url = "wss://{}/model/{}/api".format(endpoint, uuid) - else: - url = "wss://{}/api".format(endpoint) - client = cls(endpoint, uuid, username, password, cacert) - await client.open(url, cacert) - server_info = await client.login(username, password) - client.build_facades(server_info['facades']) - log.info("Driver connected to juju %s", url) - - return client + client = cls(endpoint, uuid, username, password, cacert, macaroons, + loop) + await client.open() + + redirect_info = await client.redirect_info() + if not redirect_info: + await client.login(username, password, macaroons) + return client + + await client.close() + servers = [ + s for servers in redirect_info['servers'] + for s in servers if s["scope"] == 'public' + ] + for server in servers: + client = cls( + "{value}:{port}".format(**server), uuid, username, + password, redirect_info['ca-cert'], macaroons) + await client.open() + try: + result = await client.login(username, password, macaroons) + if 'discharge-required-error' in result: + continue + return client + except Exception as e: + await client.close() + log.exception(e) + + raise Exception( + "Couldn't authenticate to %s", endpoint) @classmethod - async def connect_current(cls): + async def connect_current(cls, loop=None): """Connect to the currently active model. """ jujudata = JujuData() controller_name = jujudata.current_controller() + models = jujudata.models()[controller_name] + model_name = models['current-model'] + + return await cls.connect_model( + '{}:{}'.format(controller_name, model_name), loop) + + @classmethod + async def connect_current_controller(cls, loop=None): + """Connect to the currently active controller. + + """ + jujudata = JujuData() + controller_name = jujudata.current_controller() + if not controller_name: + raise JujuConnectionError('No current controller') + + return await cls.connect_controller(controller_name, loop) + + @classmethod + async def connect_controller(cls, controller_name, loop=None): + """Connect to a controller by name. + + """ + jujudata = JujuData() controller = jujudata.controllers()[controller_name] endpoint = controller['api-endpoints'][0] cacert = controller.get('ca-cert') accounts = jujudata.accounts()[controller_name] username = accounts['user'] - password = accounts['password'] - models = jujudata.models()[controller_name] - model_name = models['current-model'] - model_uuid = models['models'][model_name]['uuid'] + password = accounts.get('password') + macaroons = get_macaroons() if not password else None return await cls.connect( - endpoint, model_uuid, username, password, cacert) + endpoint, None, username, password, cacert, macaroons, loop) @classmethod - async def connect_model(cls, model): + async def connect_model(cls, model, loop=None): """Connect to a model by name. - :param str model: : + :param str model: [:] """ - controller_name, model_name = model.split(':') - jujudata = JujuData() + + if ':' in model: + controller_name, model_name = model.split(':') + else: + controller_name = jujudata.current_controller() + model_name = model + controller = jujudata.controllers()[controller_name] endpoint = controller['api-endpoints'][0] cacert = controller.get('ca-cert') accounts = jujudata.accounts()[controller_name] username = accounts['user'] - password = accounts['password'] + password = accounts.get('password') models = jujudata.models()[controller_name] + if '/' not in model_name: + model_name = '{}/{}'.format(username, model_name) model_uuid = models['models'][model_name]['uuid'] + macaroons = get_macaroons() if not password else None return await cls.connect( - endpoint, model_uuid, username, password, cacert) + endpoint, model_uuid, username, password, cacert, macaroons, loop) def build_facades(self, info): self.facades.clear() for facade in info: self.facades[facade['name']] = facade['versions'][-1] - async def login(self, username, password): - if not username.startswith('user-'): + async def login(self, username, password, macaroons=None): + if macaroons: + username = '' + password = '' + + if username and not username.startswith('user-'): username = 'user-{}'.format(username) result = await self.rpc({ @@ -183,7 +307,24 @@ class Connection: "auth-tag": username, "credentials": password, "nonce": "".join(random.sample(string.printable, 12)), + "macaroons": macaroons or [] }}) + response = result['response'] + self.build_facades(response.get('facades', {})) + self.info = response.copy() + return response + + async def redirect_info(self): + try: + result = await self.rpc({ + "type": "Admin", + "request": "RedirectInfo", + "version": 3, + }) + except JujuAPIError as e: + if e.message == 'not redirected': + return None + raise return result['response'] @@ -193,10 +334,10 @@ class JujuData: self.path = os.path.abspath(os.path.expanduser(self.path)) def current_controller(self): - cmd = shlex.split('juju show-controller --format yaml') + cmd = shlex.split('juju list-controllers --format yaml') output = subprocess.check_output(cmd) output = yaml.safe_load(output) - return list(output.keys())[0] + return output.get('current-controller', '') def controllers(self): return self._load_yaml('controllers.yaml', 'controllers') @@ -211,3 +352,26 @@ class JujuData: filepath = os.path.join(self.path, filename) with io.open(filepath, 'rt') as f: return yaml.safe_load(f)[key] + + +def get_macaroons(): + """Decode and return macaroons from default ~/.go-cookies + + """ + try: + cookie_file = os.path.expanduser('~/.go-cookies') + with open(cookie_file, 'r') as f: + cookies = json.load(f) + except (OSError, ValueError): + log.warn("Couldn't load macaroons from %s", cookie_file) + return [] + + base64_macaroons = [ + c['Value'] for c in cookies + if c['Name'].startswith('macaroon-') and c['Value'] + ] + + return [ + json.loads(base64.b64decode(value).decode('utf-8')) + for value in base64_macaroons + ]