1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
|
# Copyright 2010 Jacob Kaplan-Moss
# Copyright 2011 OpenStack Foundation
# Copyright 2012 Grid Dynamics
# Copyright 2013 OpenStack Foundation
# 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.
import errno
import fcntl
import os
from oslo_log import log as logging
import select
import signal
import socket
import ssl
import struct
import sys
import termios
import time
import tty
from urllib import parse as urlparse
import websocket
from zunclient.common.apiclient import exceptions as acexceptions
from zunclient.common.websocketclient import exceptions
LOG = logging.getLogger(__name__)
DEFAULT_API_VERSION = '1'
DEFAULT_ENDPOINT_TYPE = 'publicURL'
DEFAULT_SERVICE_TYPE = 'container'
class BaseClient(object):
def __init__(self, zunclient, url, id, escape='~',
close_wait=0.5):
self.url = url
self.id = id
self.escape = escape
self.close_wait = close_wait
self.cs = zunclient
def connect(self):
raise NotImplementedError()
def fileno(self):
raise NotImplementedError()
def send(self, data):
raise NotImplementedError()
def recv(self):
raise NotImplementedError()
def tty_resize(self, height, width):
"""Resize the tty session
Get the client and send the tty size data to zun api server
The environment variables need to get when implement sending
operation.
"""
raise NotImplementedError()
def start_loop(self):
self.poll = select.poll()
self.poll.register(sys.stdin,
select.POLLIN | select.POLLHUP
| select.POLLPRI | select.POLLNVAL)
self.poll.register(self.fileno(),
select.POLLIN | select.POLLHUP |
select.POLLPRI | select.POLLNVAL)
self.start_of_line = False
self.read_escape = False
with WINCHHandler(self):
try:
self.setup_tty()
self.run_forever()
except socket.error as e:
raise exceptions.ConnectionFailed(e)
except websocket.WebSocketConnectionClosedException as e:
raise exceptions.Disconnected(e)
finally:
self.restore_tty()
def run_forever(self):
LOG.debug('starting main loop in client')
self.quit = False
quitting = False
when = None
while True:
try:
for fd, event in self.poll.poll(500):
if fd == self.fileno():
self.handle_socket(event)
elif fd == sys.stdin.fileno():
self.handle_stdin(event)
except select.error as e:
# POSIX signals interrupt select()
no = e.errno
if no == errno.EINTR:
continue
else:
raise e
if self.quit and not quitting:
LOG.debug('entering close_wait')
quitting = True
when = time.time() + self.close_wait
if quitting and time.time() > when:
LOG.debug('quitting')
break
def setup_tty(self):
if os.isatty(sys.stdin.fileno()):
LOG.debug('putting tty into raw mode')
self.old_settings = termios.tcgetattr(sys.stdin)
tty.setraw(sys.stdin)
def restore_tty(self):
if os.isatty(sys.stdin.fileno()):
LOG.debug('restoring tty configuration')
termios.tcsetattr(sys.stdin, termios.TCSADRAIN,
self.old_settings)
def handle_stdin(self, event):
if event in (select.POLLHUP, select.POLLNVAL):
LOG.debug('event %d on stdin', event)
LOG.debug('eof on stdin')
self.poll.unregister(sys.stdin)
self.quit = True
data = os.read(sys.stdin.fileno(), 1024)
if not data:
return
if self.start_of_line and data == self.escape:
self.read_escape = True
return
if self.read_escape and data == '.':
LOG.debug('exit by local escape code')
raise exceptions.UserExit()
elif self.read_escape:
self.read_escape = False
self.send(self.escape)
self.send(data)
if data == '\r':
self.start_of_line = True
else:
self.start_of_line = False
def handle_socket(self, event):
if event in (select.POLLHUP, select.POLLNVAL):
self.poll.unregister(self.fileno())
self.quit = True
data = self.recv()
if not data:
self.poll.unregister(self.fileno())
self.quit = True
return
if isinstance(data, bytes):
data = data.decode("utf-8")
sys.stdout.write(data)
sys.stdout.flush()
def handle_resize(self):
"""send the POST to resize the tty session size in container.
Resize the container's PTY.
If `size` is not None, it must be a tuple of (height,width), otherwise
it will be determined by the size of the current TTY.
"""
size = self.tty_size(sys.stdout)
if size is not None:
rows, cols = size
try:
self.tty_resize(height=rows, width=cols)
except IOError: # Container already exited
pass
except acexceptions.BadRequest:
pass
def tty_size(self, fd):
"""Get the tty size
Return a tuple (rows,cols) representing the size of the TTY `fd`.
The provided file descriptor should be the stdout stream of the TTY.
If the TTY size cannot be determined, returns None.
"""
if not os.isatty(fd.fileno()):
return None
try:
dims = struct.unpack('hh', fcntl.ioctl(fd,
termios.TIOCGWINSZ,
'hhhh'))
except Exception:
try:
dims = (os.environ['LINES'], os.environ['COLUMNS'])
except Exception:
return None
return dims
class WebSocketClient(BaseClient):
def __init__(self, zunclient, url, id, escape='~',
close_wait=0.5):
super(WebSocketClient, self).__init__(
zunclient, url, id, escape, close_wait)
def connect(self):
url = self.url
LOG.debug('connecting to: %s', url)
try:
self.ws = websocket.create_connection(
url, skip_utf8_validation=True,
origin=self._compute_origin_header(url),
sslopt={'cert_reqs': ssl.CERT_REQUIRED,
'ca_certs': self.get_system_ca_file()},
subprotocols=["binary", "base64"])
print('connected to %s, press Enter to continue' % self.id)
print('type %s. to disconnect' % self.escape)
except socket.error as e:
raise exceptions.ConnectionFailed(e)
except websocket.WebSocketConnectionClosedException as e:
raise exceptions.ConnectionFailed(e)
except websocket.WebSocketBadStatusException as e:
raise exceptions.ConnectionFailed(e)
def _compute_origin_header(self, url):
origin = urlparse.urlparse(url)
if origin.scheme == 'wss':
return "https://%s:%s" % (origin.hostname, origin.port)
else:
return "http://%s:%s" % (origin.hostname, origin.port)
def fileno(self):
return self.ws.fileno()
def send(self, data):
self.ws.send_binary(data)
def recv(self):
return self.ws.recv()
@staticmethod
def get_system_ca_file():
"""Return path to system default CA file."""
# Standard CA file locations for Debian/Ubuntu, RedHat/Fedora,
# Suse, FreeBSD/OpenBSD
ca_path = ['/etc/ssl/certs/ca-certificates.crt',
'/etc/pki/tls/certs/ca-bundle.crt',
'/etc/ssl/ca-bundle.pem',
'/etc/ssl/cert.pem']
for ca in ca_path:
if os.path.exists(ca):
return ca
return None
class AttachClient(WebSocketClient):
def tty_resize(self, height, width):
"""Resize the tty session
Get the client and send the tty size data to zun api server
The environment variables need to get when implement sending
operation.
"""
height = str(height)
width = str(width)
self.cs.containers.resize(self.id, width, height)
class ExecClient(WebSocketClient):
def __init__(self, zunclient, url, exec_id, id, escape='~',
close_wait=0.5):
super(ExecClient, self).__init__(zunclient, url, id, escape,
close_wait)
self.exec_id = exec_id
def tty_resize(self, height, width):
"""Resize the tty session
Get the client and send the tty size data to zun api server
The environment variables need to get when implement sending
operation.
"""
height = str(height)
width = str(width)
self.cs.containers.execute_resize(self.id, self.exec_id, width, height)
class WINCHHandler(object):
"""WINCH Signal handler
WINCH Signal handler to keep the PTY correctly sized.
"""
def __init__(self, client):
"""Initialize a new WINCH handler for the given PTY.
Initializing a handler has no immediate side-effects. The `start()`
method must be invoked for the signals to be trapped.
"""
self.client = client
self.original_handler = None
def __enter__(self):
"""Enter
Invoked on entering a `with` block.
"""
self.start()
return self
def __exit__(self, *_):
"""Exit
Invoked on exiting a `with` block.
"""
self.stop()
def start(self):
"""Start
Start trapping WINCH signals and resizing the PTY.
This method saves the previous WINCH handler so it can be restored on
`stop()`.
"""
def handle(signum, frame):
if signum == signal.SIGWINCH:
LOG.debug("Send command to resize the tty session")
self.client.handle_resize()
self.original_handler = signal.signal(signal.SIGWINCH, handle)
def stop(self):
"""stop
Stop trapping WINCH signals and restore the previous WINCH handler.
"""
if self.original_handler is not None:
signal.signal(signal.SIGWINCH, self.original_handler)
def do_attach(zunclient, url, container_id, escape, close_wait):
if url.startswith("ws://") or url.startswith("wss://"):
try:
wscls = AttachClient(zunclient=zunclient, url=url,
id=container_id, escape=escape,
close_wait=close_wait)
wscls.connect()
wscls.handle_resize()
wscls.start_loop()
except exceptions.ContainerWebSocketException as e:
print("%(e)s:%(container)s" %
{'e': e, 'container': container_id})
else:
raise exceptions.InvalidWebSocketLink(container_id)
def do_exec(zunclient, url, container_id, exec_id, escape, close_wait):
if url.startswith("ws://") or url.startswith("wss://"):
try:
wscls = ExecClient(zunclient=zunclient, url=url,
exec_id=exec_id,
id=container_id, escape=escape,
close_wait=close_wait)
wscls.connect()
wscls.handle_resize()
wscls.start_loop()
except exceptions.ContainerWebSocketException as e:
print("%(e)s:%(container)s" %
{'e': e, 'container': container_id})
else:
raise exceptions.InvalidWebSocketLink(container_id)
|