/usr/lib/python3/dist-packages/asyncssh/stream.py is in python3-asyncssh 1.11.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 | # Copyright (c) 2013-2017 by Ron Frederick <ronf@timeheart.net>.
# All rights reserved.
#
# This program and the accompanying materials are made available under
# the terms of the Eclipse Public License v1.0 which accompanies this
# distribution and is available at:
#
# http://www.eclipse.org/legal/epl-v10.html
#
# Contributors:
# Ron Frederick - initial implementation, API, and documentation
"""SSH stream handlers"""
import asyncio
from .constants import EXTENDED_DATA_STDERR
from .misc import BreakReceived, SignalReceived, TerminalSizeChanged
from .misc import async_iterator, python35
from .session import SSHClientSession, SSHServerSession
from .session import SSHTCPSession, SSHUNIXSession
from .sftp import run_sftp_server
from .scp import run_scp_server
_NEWLINE = object()
class SSHReader:
"""SSH read stream handler"""
def __init__(self, session, chan, datatype=None):
self._session = session
self._chan = chan
self._datatype = datatype
if python35:
@async_iterator
def __aiter__(self):
"""Allow SSHReader to be an async iterator"""
return self
@asyncio.coroutine
def __anext__(self):
"""Return one line at a time when used as an async iterator"""
line = yield from self.readline()
if line:
return line
else:
raise StopAsyncIteration
@property
def channel(self):
"""The SSH channel associated with this stream"""
return self._chan
def get_extra_info(self, name, default=None):
"""Return additional information about this stream
This method returns extra information about the channel
associated with this stream. See :meth:`get_extra_info()
<SSHClientChannel.get_extra_info>` on :class:`SSHClientChannel`
for additional information.
"""
return self._chan.get_extra_info(name, default)
@asyncio.coroutine
def read(self, n=-1):
"""Read data from the stream
This method is a coroutine which reads up to ``n`` bytes
or characters from the stream. If ``n`` is not provided or
set to ``-1``, it reads until EOF or a signal is received.
If EOF is received and the receive buffer is empty, an
empty bytes or str object is returned.
If the next data in the stream is a signal, the signal is
delivered as a raised exception.
.. note:: Unlike traditional ``asyncio`` stream readers,
the data will be delivered as either bytes or
a str depending on whether an encoding was
specified when the underlying channel was opened.
"""
return self._session.read(n, self._datatype, exact=False)
@asyncio.coroutine
def readline(self):
"""Read one line from the stream
This method is a coroutine which reads one line, ending in
``'\\n'``.
If EOF is received before ``'\\n'`` is found, the partial
line is returned. If EOF is received and the receive buffer
is empty, an empty bytes or str object is returned.
If the next data in the stream is a signal, the signal is
delivered as a raised exception.
.. note:: In Python 3.5 and later, :class:`SSHReader` objects
can also be used as async iterators, returning input
data one line at a time.
"""
try:
return (yield from self.readuntil(_NEWLINE))
except asyncio.IncompleteReadError as exc:
return exc.partial
@asyncio.coroutine
def readuntil(self, separator):
"""Read data from the stream until ``separator`` is seen
This method is a coroutine which reads from the stream until
the requested separator is seen. If a match is found, the
returned data will include the separator at the end.
If EOF or a signal is received before a match occurs, an
:exc:`IncompleteReadError <asyncio.IncompleteReadError>`
is raised and its ``partial`` attribute will contain the
data in the stream prior to the EOF or signal.
If the next data in the stream is a signal, the signal is
delivered as a raised exception.
"""
return self._session.readuntil(separator, self._datatype)
@asyncio.coroutine
def readexactly(self, n):
"""Read an exact amount of data from the stream
This method is a coroutine which reads exactly n bytes or
characters from the stream.
If EOF or a signal is received in the stream before ``n``
bytes are read, an :exc:`IncompleteReadError
<asyncio.IncompleteReadError>` is raised and its ``partial``
attribute will contain the data before the EOF or signal.
If the next data in the stream is a signal, the signal is
delivered as a raised exception.
"""
return self._session.read(n, self._datatype, exact=True)
def at_eof(self):
"""Return whether the stream is at EOF
This method returns ``True`` when EOF has been received and
all data in the stream has been read.
"""
return self._session.at_eof(self._datatype)
def get_redirect_info(self):
"""Get information needed to redirect from this SSHReader"""
return self._session, self._datatype
class SSHWriter:
"""SSH write stream handler"""
def __init__(self, session, chan, datatype=None):
self._session = session
self._chan = chan
self._datatype = datatype
@property
def channel(self):
"""The SSH channel associated with this stream"""
return self._chan
def get_extra_info(self, name, default=None):
"""Return additional information about this stream
This method returns extra information about the channel
associated with this stream. See :meth:`get_extra_info()
<SSHClientChannel.get_extra_info>` on :class:`SSHClientChannel`
for additional information.
"""
return self._chan.get_extra_info(name, default)
def can_write_eof(self):
"""Return whether the stream supports :meth:`write_eof`"""
return self._chan.can_write_eof()
def close(self):
"""Close the channel
.. note:: After this is called, no data can be read or written
from any of the streams associated with this channel.
"""
return self._chan.close()
@asyncio.coroutine
def drain(self):
"""Wait until the write buffer on the channel is flushed
This method is a coroutine which blocks the caller if the
stream is currently paused for writing, returning when
enough data has been sent on the channel to allow writing
to resume. This can be used to avoid buffering an excessive
amount of data in the channel's send buffer.
"""
return (yield from self._session.drain(self._datatype))
def write(self, data):
"""Write data to the stream
This method writes bytes or characters to the stream.
.. note:: Unlike traditional ``asyncio`` stream writers,
the data must be supplied as either bytes or
a str depending on whether an encoding was
specified when the underlying channel was opened.
"""
return self._chan.write(data, self._datatype)
def writelines(self, list_of_data):
"""Write a collection of data to the stream"""
return self._chan.writelines(list_of_data, self._datatype)
def write_eof(self):
"""Write EOF on the channel
This method sends an end-of-file indication on the channel,
after which no more data can be written.
.. note:: On an :class:`SSHServerChannel` where multiple
output streams are created, writing EOF on one
stream signals EOF for all of them, since it
applies to the channel as a whole.
"""
return self._chan.write_eof()
def get_redirect_info(self):
"""Get information needed to redirect to this SSHWriter"""
return self._session, self._datatype
class SSHStreamSession:
"""SSH stream session handler"""
def __init__(self):
self._chan = None
self._conn = None
self._encoding = None
self._loop = None
self._limit = None
self._exception = None
self._eof_received = False
self._connection_lost = False
self._recv_buf = {None: []}
self._recv_buf_len = 0
self._read_waiters = {None: None}
self._read_paused = False
self._write_paused = False
self._drain_waiters = {None: set()}
@asyncio.coroutine
def _block_read(self, datatype):
"""Wait for more data to arrive on the stream"""
if self._read_waiters[datatype]:
raise RuntimeError('read called while another coroutine is '
'already waiting to read')
try:
waiter = asyncio.Future(loop=self._loop)
self._read_waiters[datatype] = waiter
yield from waiter
finally:
self._read_waiters[datatype] = None
def _unblock_read(self, datatype):
"""Signal that more data has arrived on the stream"""
waiter = self._read_waiters[datatype]
if waiter and not waiter.done():
waiter.set_result(None)
def _should_block_drain(self, datatype):
"""Return whether output is still being written to the channel"""
# pylint: disable=unused-argument
return self._write_paused and not self._connection_lost
def _unblock_drain(self, datatype):
"""Signal that more data can be written on the stream"""
if not self._should_block_drain(datatype):
for waiter in self._drain_waiters[datatype]:
if not waiter.done(): # pragma: no branch
waiter.set_result(None)
def _should_pause_reading(self):
"""Return whether to pause reading from the channel"""
return self._limit and self._recv_buf_len >= self._limit
def _maybe_pause_reading(self):
"""Pause reading if necessary"""
if not self._read_paused and self._should_pause_reading():
self._read_paused = True
self._chan.pause_reading()
return True
else:
return False
def _maybe_resume_reading(self):
"""Resume reading if necessary"""
if self._read_paused and not self._should_pause_reading():
self._read_paused = False
self._chan.resume_reading()
return True
else:
return False
def connection_made(self, chan):
"""Handle a newly opened channel"""
self._chan = chan
self._conn = chan.get_connection()
self._encoding = chan.get_encoding()
self._loop = chan.get_loop()
self._limit = self._chan.get_recv_window()
for datatype in chan.get_read_datatypes():
self._recv_buf[datatype] = []
self._read_waiters[datatype] = None
for datatype in chan.get_write_datatypes():
self._drain_waiters[datatype] = set()
def connection_lost(self, exc):
"""Handle an incoming channel close"""
self._connection_lost = True
self._exception = exc
if not self._eof_received:
if exc:
for datatype in self._read_waiters:
self._recv_buf[datatype].append(exc)
self.eof_received()
for datatype in self._drain_waiters:
self._unblock_drain(datatype)
def data_received(self, data, datatype):
"""Handle incoming data on the channel"""
self._recv_buf[datatype].append(data)
self._recv_buf_len += len(data)
self._unblock_read(datatype)
self._maybe_pause_reading()
def eof_received(self):
"""Handle an incoming end of file on the channel"""
self._eof_received = True
for datatype in self._read_waiters:
self._unblock_read(datatype)
return True
def at_eof(self, datatype):
"""Return whether end of file has been received on the channel"""
return self._eof_received and not self._recv_buf[datatype]
def pause_writing(self):
"""Handle a request to pause writing on the channel"""
self._write_paused = True
def resume_writing(self):
"""Handle a request to resume writing on the channel"""
self._write_paused = False
for datatype in self._drain_waiters:
self._unblock_drain(datatype)
@asyncio.coroutine
def read(self, n, datatype, exact):
"""Read data from the channel"""
recv_buf = self._recv_buf[datatype]
buf = '' if self._encoding else b''
data = []
while True:
while recv_buf and n != 0:
if isinstance(recv_buf[0], Exception):
if data:
break
else:
raise recv_buf.pop(0)
l = len(recv_buf[0])
if n > 0 and l > n:
data.append(recv_buf[0][:n])
recv_buf[0] = recv_buf[0][n:]
self._recv_buf_len -= n
n = 0
break
data.append(recv_buf.pop(0))
self._recv_buf_len -= l
n -= l
if self._maybe_resume_reading():
continue
if n == 0 or (n > 0 and data and not exact) or self._eof_received:
break
yield from self._block_read(datatype)
buf = buf.join(data)
if n > 0 and exact:
raise asyncio.IncompleteReadError(buf, len(buf) + n)
return buf
@asyncio.coroutine
def readuntil(self, separator, datatype):
"""Read data from the channel until a separator is seen"""
if separator is _NEWLINE:
separator = '\n' if self._encoding else b'\n'
elif not separator:
raise ValueError('Separator cannot be empty')
seplen = len(separator)
recv_buf = self._recv_buf[datatype]
buf = '' if self._encoding else b''
buflen = 0
while True:
while recv_buf:
if isinstance(recv_buf[0], Exception):
if buf:
raise asyncio.IncompleteReadError(buf, None)
else:
raise recv_buf.pop(0)
buf += recv_buf[0]
start = max(buflen + 1 - seplen, 0)
idx = buf.find(separator, start)
if idx >= 0:
idx += seplen
recv_buf[0] = buf[idx:]
buf = buf[:idx]
self._recv_buf_len -= idx
if not recv_buf[0]:
recv_buf.pop(0)
self._maybe_resume_reading()
return buf
l = len(recv_buf[0])
buflen += l
self._recv_buf_len -= l
recv_buf.pop(0)
if self._maybe_resume_reading():
continue
if self._eof_received:
raise asyncio.IncompleteReadError(buf, None)
yield from self._block_read(datatype)
@asyncio.coroutine
def drain(self, datatype):
"""Wait for data written to the channel to drain"""
while self._should_block_drain(datatype):
try:
waiter = asyncio.Future(loop=self._loop)
self._drain_waiters[datatype].add(waiter)
yield from waiter
finally:
self._drain_waiters[datatype].remove(waiter)
if self._connection_lost:
exc = self._exception
if not exc and self._write_paused:
exc = BrokenPipeError()
if exc:
raise exc # pylint: disable=raising-bad-type
class SSHClientStreamSession(SSHStreamSession, SSHClientSession):
"""SSH client stream session handler"""
class SSHServerStreamSession(SSHStreamSession, SSHServerSession):
"""SSH server stream session handler"""
def __init__(self, session_factory, sftp_factory, allow_scp):
super().__init__()
self._session_factory = session_factory
self._sftp_factory = sftp_factory
self._allow_scp = allow_scp and bool(sftp_factory)
def shell_requested(self):
"""Return whether a shell can be requested"""
return bool(self._session_factory)
def exec_requested(self, command):
"""Return whether execution of a command can be requested"""
return ((self._allow_scp and command.startswith('scp ')) or
bool(self._session_factory))
def subsystem_requested(self, subsystem):
"""Return whether starting a subsystem can be requested"""
if subsystem == 'sftp':
return bool(self._sftp_factory)
else:
return bool(self._session_factory)
def session_started(self):
"""Start a session for this newly opened server channel"""
command = self._chan.get_command()
stdin = SSHReader(self, self._chan)
stdout = SSHWriter(self, self._chan)
stderr = SSHWriter(self, self._chan, EXTENDED_DATA_STDERR)
if self._chan.get_subsystem() == 'sftp':
self._chan.set_encoding(None)
self._encoding = None
handler = run_sftp_server(self._sftp_factory(self._conn),
stdin, stdout)
elif self._allow_scp and command and command.startswith('scp '):
self._chan.set_encoding(None)
self._encoding = None
handler = run_scp_server(self._sftp_factory(self._conn),
command, stdin, stdout, stderr)
else:
handler = self._session_factory(stdin, stdout, stderr)
if asyncio.iscoroutine(handler):
self._conn.create_task(handler)
def break_received(self, msec):
"""Handle an incoming break on the channel"""
self._recv_buf[None].append(BreakReceived(msec))
self._unblock_read(None)
return True
def signal_received(self, signal):
"""Handle an incoming signal on the channel"""
self._recv_buf[None].append(SignalReceived(signal))
self._unblock_read(None)
def terminal_size_changed(self, *args):
"""Handle an incoming terminal size change on the channel"""
self._recv_buf[None].append(TerminalSizeChanged(*args))
self._unblock_read(None)
class SSHSocketStreamSession(SSHStreamSession):
"""Socket stream session handler"""
def __init__(self, handler_factory=None):
super().__init__()
self._handler_factory = handler_factory
def session_started(self):
"""Start a session for this newly opened socket channel"""
if self._handler_factory:
handler = self._handler_factory(SSHReader(self, self._chan),
SSHWriter(self, self._chan))
if asyncio.iscoroutine(handler):
self._conn.create_task(handler)
class SSHTCPStreamSession(SSHSocketStreamSession, SSHTCPSession):
"""TCP stream session handler"""
class SSHUNIXStreamSession(SSHSocketStreamSession, SSHUNIXSession):
"""UNIX stream session handler"""
|