File: //usr/local/CyberCP/lib/python3.10/site-packages/asyncssh/__pycache__/channel.cpython-310.pyc
o
�h�> � @ s� U d Z ddlZddlZddlZddlZddlZddlZddlZddl m
Z
ddl m Z m
Z
mZmZmZ ddl mZmZmZmZmZmZ ddl mZmZmZmZ ddlm Z dd l m Z m Z dd
l m Z m Z dd l m!Z!m"Z" dd l m#Z#m$Z$m%Z% dd
l m&Z&m'Z' ddl m(Z(m)Z)m*Z* ddl m+Z+ ddl m,Z,m-Z- ddl.m/Z/m0Z0 ddl1m2Z2 ddl3m4Z4m5Z5m6Z6m7Z7 ddl3m8Z8m9Z9m:Z: ddl3m;Z;m<Z<m=Z=m>Z> ddl?m@Z@mAZAmBZBmCZCmDZDmEZE ddlFmGZGmHZHmIZI ddlFmJZJmKZKmLZL ddlFmMZMmNZN ddlFmOZOmPZP ddlFmQZQ dd lRmSZS dd lTmUZUmVZV dd lTmWZWmXZX e �r(dd lYmZZZm[Z[ dd lYm\Z\ e j]Z^ee_e`f ead!< e=e^d"d#�Zbe=e^d$d%�Zce�dd&�Zed'd(� efe��g� D �Zhd)d(� eh�g� D �Ziee_eje_e_f ZkeeeDgeej f ZlG d*d+� d+ee eE�ZmG d,d-� d-emee �ZnG d.d/� d/emee �ZoG d0d1� d1emee �ZpG d2d3� d3epee �ZqG d4d5� d5epee �ZrG d6d7� d7epes �ZtG d8d9� d9epes �ZuG d:d;� d;epes �ZvdS )<z SSH channel and session handlers� N)�MappingProxyType)�
TYPE_CHECKING�Any�AnyStr� Awaitable�Callable)�Dict�Generic�Iterable�List�Mapping�Optional)�Set�Tuple�Union�cast� )� constants)� DEFAULT_LANG�EXTENDED_DATA_STDERR)�MSG_CHANNEL_OPEN�MSG_CHANNEL_WINDOW_ADJUST)�MSG_CHANNEL_DATA�MSG_CHANNEL_EXTENDED_DATA)�MSG_CHANNEL_EOF�MSG_CHANNEL_CLOSE�MSG_CHANNEL_REQUEST)�MSG_CHANNEL_SUCCESS�MSG_CHANNEL_FAILURE)�OPEN_CONNECT_FAILED�PTY_OP_RESERVED�
PTY_OP_END)�"OPEN_REQUEST_X11_FORWARDING_FAILED)�OPEN_REQUEST_PTY_FAILED�OPEN_REQUEST_SESSION_FAILED)�SSHLineEditorChannel�SSHLineEditorSession)� SSHLogger)�ChannelOpenError�EnvMap�
MaybeAwait�
ProtocolError)� TermModes�TermSize� TermSizeArg)�
decode_env�
encode_env�get_symbol_names�map_handler_name)�Boolean�Byte�String�UInt32� SSHPacket�SSHPacketHandler)�
SSHSession�SSHClientSession�SSHServerSession)�
SSHTCPSession�SSHUNIXSession�SSHTunTapSession)�SSHSessionFactory�SSHClientSessionFactory)�SSHTCPSessionFactory�SSHUNIXSessionFactory)�SSHTunTapSessionFactory)�DataType)�SSH_TUN_MODE_POINTTOPOINT�SSH_TUN_UNIT_ANY)�SSH_TUN_AF_INET�SSH_TUN_AF_INET6)�
SSHConnection�SSHClientConnection)�SSHServerConnection� _const_dict�PTY_� �EXTENDED_DATA_� zSIG[^_]c C s, i | ]\}}t �|�r|d d� t|��qS )� N)�
_signal_regex�match�int��.0�k�v� rY �C/usr/local/CyberCP/lib/python3.10/site-packages/asyncssh/channel.py�
<dictcomp>N s �r[ c C s i | ]\}}||�qS rY rY rU rY rY rZ r[ P s c @ s� e Zd ZU dZee� d�Ze� Ze e
e d< e� Z e e
e d< ddde
jdee d ed
e
d e
f d d
�Zedefdd��Zd�dd�Zde
jfdd�Zdeee ef fdd�Z d�dee d eddfdd�Zde
fdd �Zde e
fd d �Zde e
fd d �Z d�d!ee ddfd"d#�Z d�d$d%�Z d�d&d'�Z d�d(d)�Z!d�d*d+�Z"d�d,d-�Z#d�d!ee ddfd.d/�Z$d0e%d1e&ddfd2d3�Z'd�d0e%d1e&ddfd4d5�Z(d�d6d7�Z)d8e*ddfd9d:�Z+d!ee ddfd;d<�Z,d=e
d>e
d?e
d@e-e.e/ ddf
dAdB�Z0d@e.e/ dedCe.e/ f fdDdE�Z1d8e-e.e/ ddfdFdG�Z2d=e
d>e
d?e
dHe3ddf
dIdJ�Z4dKe
dLedMeddfdNdO�Z5dPe
dQe
dHe3ddfdRdS�Z6dPe
dQe
dHe3ddfdTdU�Z7dPe
dQe
dHe3ddfdVdW�Z8dPe
dQe
dHe3ddfdXdY�Z9dPe
dQe
dHe3ddfdZd[�Z:dPe
dQe
dHe3ddfd\d]�Z;d^e
dQe
dHe3ddfd_d`�Z<dHe3de*fdadb�Z=e>e6e?e7e@e8eAe9eBe:eCe;eDe<eEe<iZFdce%dde%de3fdedf�ZGd^e
dde%ddfdgdh�ZHdidj�dke%dde%dle*ddfdmdn�ZIdke%dde%dee* fdodp�ZJd�dqdr�ZKd�dsdt�ZLde*fdudv�ZMd�dwdx�ZNd�dyedzeOdeOfd{d|�ZPd}eOddfd~d�ZQde*fd�d��ZRde
fd�d��ZS d�d�ee
d�ee
ddfd�d��ZTd�d0e/d1e&ddfd�d��ZU d�d�eVe/ d1e&ddfd�d��ZWd�d�d��ZXd�d�d��ZYd�d�d��ZZde[eef fd�d��Z\de[e%e%f fd�d��Z]dee fd�d��Z^dee fd�d��Z_dS )��
SSHChannelz Parent class for SSH channels� MSG_CHANNEL_�_read_datatypes�_write_datatypes�connrI �loop�encoding�errors�window� max_pktsizec C s� || _ || _d| _d|i| _| | | | i | _d| _d| _d| _d| _d| _ d| _
d| _ d| _ g | _
d| _d| _|| _|| _|| _d| _g | _g | _d| _g | _t�� | _|�| �| _ |j j d| j � �d�| _ | � ||� | �!� dS ) a� Initialize an SSH channel
If encoding is set, data sent and received will be in the form
of strings, converted on the wire to bytes using the specified
encoding. If encoding is None, data sent and received must be
provided as bytes.
Window specifies the initial receive window size.
Max_pktsize specifies the maximum length of a single data packet.
N�
connection�closedr F�startingzchan=)�context)"�_conn�_loop�_session�_extra�_env�_str_env�_command�
_subsystem� _send_state�
_send_chan� _send_window�
_send_pktsize� _send_paused� _send_buf�
_send_buf_len� _recv_state�_init_recv_window� _recv_window�
_recv_pktsize� _recv_paused� _recv_buf�_request_queue� _open_waiter�_request_waiters�asyncio�Event� _close_event� add_channel�
_recv_chan�logger� get_child�_logger� set_encoding�set_write_buffer_limits��selfr` ra rb rc rd re rY rY rZ �__init__^ sB
zSSHChannel.__init__�returnc C � | j S )z%A logger associated with this channel)r� �r� rY rY rZ r� � s zSSHChannel.loggerc C s | j dusJ �| j S )z*Return the connection used by this channelN)rj r� rY rY rZ �get_connection� s zSSHChannel.get_connectionc C r� )z*Return the event loop used by this channel)rk r� rY rY rZ �get_loop� � zSSHChannel.get_loopc C s | j | jfS )z(Return the encoding used by this channel)� _encoding�_errorsr� rY rY rZ � get_encoding� s zSSHChannel.get_encoding�strictNc C sD || _ || _|rt�|�|�| _t�|�|�| _dS d| _d| _dS )z Set the encoding on this channelN)r� r� �codecs�getincrementalencoder�_encoder�getincrementaldecoder�_decoder)r� rb rc rY rY rZ r� � s � �
zSSHChannel.set_encodingc C r� )z5Return the configured receive window for this channel)rz r� rY rY rZ �get_recv_window� r� zSSHChannel.get_recv_windowc C r� )z1Return the legal read data types for this channel)r^ r� rY rY rZ �get_read_datatypes� r� z SSHChannel.get_read_datatypesc C r� )z2Return the legal write data types for this channel)r_ r� rY rY rZ �get_write_datatypes� r� z SSHChannel.get_write_datatypes�excc C s | j r| j �� s| j �ttd�� d| _ | jr1| jD ]}|�� s-|r(|�|� q|�d� qg | _| jdurTz| j�|� W n t yP | j
j dt j
d� Y nw d| _| j�� | jr�| j
�d|rhdt|� nd� | j�| � | jdusxJ �| j�| j� d| _d| _d| _dS dS ) zClean up this channel�SSH connection closedNFz%Uncaught exception in session ignored)�exc_infozChannel closed%sz: � )r� � cancelled�
set_exceptionr( r r� �
set_resultrl �connection_lost� Exceptionr� �debug1�sysr� r� �setrj �info�str�detach_x11_listenerr� �remove_channelrs )r� r� �waiterrY rY rZ �_cleanup� sJ
��
�
��
�
�zSSHChannel._cleanupc C s4 g | _ d| _| jdkr| �t� d| _d| _dS dS )z5Discard unsent data and close the channel for sendingr rg N)rw rx rr � send_packetr rs r� rY rY rZ � _close_send� s
�zSSHChannel._close_sendc C s2 g | _ d| _| jdkrd| _| j�| j� dS dS )z6Discard unreceived data and clean up if close receivedF�
close_pendingrg N)r~ r} ry rk � call_soonr� r� rY rY rZ �
_discard_recv s
�zSSHChannel._discard_recvc � s. �| j dkr| j�d� d| _ | �� dS dS )z)Start processing data on a new connectionrh z Reading from channel startedFN�r} r� �debug2�_flush_recv_bufr� rY rY rZ �_start_reading s �
�zSSHChannel._start_readingc C s� | j r"| j| jkr | j�d� d| _ | jdusJ �| j�� dS dS | j| jkr?| j�d� d| _ | jdus8J �| j�� dS dS )zAPause or resume writing based on send buffer low/high water marksz Writing from session resumedFNzWriting from session pausedT) rv rx �_send_low_waterr� r� rl �resume_writing�_send_high_water�
pause_writingr� rY rY rZ �_pause_resume_writing s � �z SSHChannel._pause_resume_writingc C s | j r\| jr\t| j| j�}| j d \}}t|�|kr&|d|� }|d|�= n|}| j d= | jt|�8 _| jt|�8 _|du rK| �tt|�� n | �t t
|�t|�� | j r\| js| � � | j s}| j dkrr| �t
� d| _ dS | j dkr| �� dS dS dS )z;Flush as much data in send buffer as the send window allowsr N� eof_pending�eofr� )rw rt �minru �lenrx r� r r5 r r6 r� rr r r� )r� �pktsize�buf�datatype�datarY rY rZ �_flush_send_buf1 s2 � �
�zSSHChannel._flush_send_bufc
C s | j r| js| j| j �d�� | j r| jr| j sh| jdkrh| jrK|sK| jdv rKz| jdus/J �| j�dd� W n tyJ } zt t
|��d�d}~ww | jdkrhd| _| j dusZJ �| j � � sh| j
d krh| �� | j s}| jd
krd | _| j�| j|� dS dS dS ) z?Flush as much data in the recv buffer as the application allowsr rh )r� r� N� Tr� r� �openr� rg )r~ r} �
_deliver_data�popr� ry r� �decode�UnicodeDecodeErrorr+ r� rl � eof_receivedrr � write_eofrk r� r� )r� r� � unicode_excrY rY rZ r� Q s. �
��
�zSSHChannel._flush_recv_bufr� r� c
C s� | j t|�8 _ | j | jd k r,| j| j }| j�d|| j� | �tt|�� | j| _ | jrUz| j dus7J �t
t | j � |��}W n t
yT } ztt|��d�d}~ww t
t |�}| jdurh| j�||� dS dS )z$Deliver incoming data to the session� z0Sending window adjust of %d bytes, new window %dN)r{ r� rz r� r� r� r r6 r� r� r r r� r� r+ r� rl �
data_received)r� r� r� �adjust� decoded_datar� rY rY rZ r� m s( ���
�zSSHChannel._deliver_datac C s@ |sdS | j dv r dS | jr| j�||f� dS | �||� dS )aX Accept new data on the channel
This method accepts new data on the channel, immediately
delivering it to the session if it hasn't paused reading.
If it has paused, data is buffered until reading is resumed.
Data sent after the channel has been closed by the session
is dropped.
N> rg r� )rr r} r~ �appendr� �r� r� r� rY rY rZ � _accept_data� s
zSSHChannel._accept_datac C sv | j d \}}}dt|� d }ttt| |d��}|r%ttt ||��}n | j�d|� d}|dur9| � |� dS dS )z*Process next item on channel request queuer � _process_�_requestNz$Received unknown channel request: %sF)
r r2 r �_RequestHandler�getattrr
�boolr� r� �_report_response)r� �request�packet�_�name�handler�resultrY rY rZ �_service_next_request� s �z SSHChannel._service_next_requestr� c C s| | j �d�\}}}|r | jdvr |r| �t� n| �t� |r3|dv r3| jdus*J �| j�� | �� | j r<| � � dS dS )z?Report back the response to a previously issued channel requestr > rg r� > �exec�shell� subsystemN)
r r� rr r� r r rl �session_started�resume_readingr� )r� r� r� r� �
want_replyrY rY rZ r� � s
�zSSHChannel._report_responsec C s( | j �d� d| _| �� | �|� dS )z"Process the SSH connection closingz'Closing channel due to connection closerg N)r� r� rr r� r� )r� r� rY rY rZ �process_connection_close� s z#SSHChannel.process_connection_close� send_chan� send_window� send_pktsize�sessionc C sJ || _ || _|| _| j�d||� | jdusJ �| j�| �|�| j� dS )z Process a channel open request�( Initial send window %d, packet size %dN)rs rt ru r� r� rj � create_task�_finish_open_request)r� r� r� r� r� rY rY rZ � process_open� s �zSSHChannel.process_openzSSHChannel[AnyStr]c C s | |fS )z3Hook to optionally wrap channel and session objectsrY )r� r� rY rY rZ �
_wrap_session� s zSSHChannel._wrap_sessionc
� s �z]t �|�rtttt |�I dH }nttt |�}| js#ttd��| � |�\}| _
| j � d| j
| j� | jdus<J �| jdusCJ �| j�| j| j| j
| j� d| _d| _| j
�|� W dS ty� } z%| jr}| jduspJ �| j�| j|j|j|j� | j�| j� W Y d}~dS d}~ww )z(Finish processing a channel open requestNr� �( Initial recv window %d, packet size %dr� ) �inspect� isawaitabler r r9 r rj r( r r� rl r� r� r{ r| rs r� � send_channel_open_confirmationrr ry �connection_made�send_channel_open_failure�code�reason�langrk r� r� )r� r� r� �chanr� rY rY rZ r� � s@ �
��
�� ��z SSHChannel._finish_open_requestr� c C s\ | j std��|| _|| _|| _| j�d||� d| _d| _| j � � s)| j �
|� d| _ dS )z#Process a channel open confirmation�Channel not being openedr� r� N) r� r+ rs rt ru r� r� rr ry r� r� )r� r� r� r� r� rY rY rZ �process_open_confirmation s �
z$SSHChannel.process_open_confirmationr� r� r� c C sD | j std��| j �� s| j �t|||�� d| _ | j�| j� dS )z Process a channel open failurer N)r� r+ r� r� r( rk r� r� )r� r� r� r� rY rY rZ �process_open_failure s
�z SSHChannel.process_open_failure�_pkttype�_pktidc C sN | j dvr td��|�� }|�� | j|7 _| j�d|| j� | �� dS )z Process a send window adjustment> r� r� r� �Channel not openz1Received window adjust of %d bytes, new window %dN)ry r+ �
get_uint32� check_endrt r� r� r� )r� r r r� r� rY rY rZ �_process_window_adjust* s
� z!SSHChannel._process_window_adjustc C sf | j dkr td��|�� }|�� t|�}|| jkr td��| j�d||dkr)dnd� | �|� dS ) zProcess incoming datar� � Channel not open for sending�Window exceededzReceived %d data byte%sr �sr� N) ry r+ �
get_stringr r� r{ r� r� r� )r� r r r� r� �datalenrY rY rZ �
_process_data; s
�zSSHChannel._process_datac C s� | j dkr td��|�� }|�� }|�� || jvr td��t|�}|| jkr+td��| j� d||dkr6dndt
| � | � ||� d S )
z Process incoming extended datar� r
�Invalid extended data typer z Received %d data byte%s from %sr r r� N) ry r+ r r
r r^ r� r{ r� r� �_data_type_namesr� )r� r r r� r� r� r rY rY rZ �_process_extended_dataO s
�z!SSHChannel._process_extended_datac C s8 | j dkr td��|�� | j�d� d| _ | �� dS )z Process an incoming end of filer� r
z Received EOFr� N)ry r+ r r� r� r� �r� r r r� rY rY rZ � _process_eofh s
zSSHChannel._process_eofc C s@ | j dvr td��|�� | j�d� | �� d| _ | �� dS )z!Process an incoming channel close> r� r� r� r zReceived channel closer� N)ry r+ r r� r� r� r� r rY rY rZ �_process_closev s
zSSHChannel._process_closec C sz | j dvr td��|�� }|�� }z|�d�}W n ty$ td�d�w | j�|||f� t| j�dkr;| � � dS dS )z#Process an incoming channel request> r� r� r� r �asciizInvalid channel requestNr )
ry r+ r
� get_booleanr� r� r r� r� r� )r� r r r� �
request_bytesr� r� rY rY rZ �_process_request� s
� �zSSHChannel._process_request�pkttypec C s@ |� � | jr | j�d�}|�� s|�|tk� dS dS td��)z%Process a success or failure responser zUnexpected channel responseN)r r� r� r� r� r r+ )r� r r r� r� rY rY rZ �_process_response� s �z SSHChannel._process_responsec C s |� � | j�d� dS )z-Process an incoming OpenSSH keepalive requestz*Received OpenSSH keepalive channel requestF)r r� r� �r� r� rY rY rZ �-_process_keepalive_at_openssh_dot_com_request� s z8SSHChannel._process_keepalive_at_openssh_dot_com_request�chantype�argsc � s� �| j dkr
td��| j�� | _| j�d| j| j� | j dus!J �| j
dus(J �| j j t t
|�t| j
�t| j�t| j�g|�R d| i� | jI dH S )z"Make a request to open the channelrg zChannel already openr� Nr� )rr �OSErrorrk �
create_futurer� r� r� r{ r| rj r� r� r r5 r6 )r� r r rY rY rZ �_open� s& �
���� zSSHChannel._openc G sF | j du rdS t| j �d�|� }| jdusJ �| jj||| d� dS )z Send a packet on the channelNr� )r� )rs r6 �joinrj r� )r� r r �payloadrY rY rZ r� � s
zSSHChannel.send_packetF)r� r� r� c G s" | j tt|�t|�g|�R � dS )zSend a channel requestN)r� r r5 r3 )r� r� r� r rY rY rZ �
_send_request� s
� �zSSHChannel._send_requestc � sH �| j du rdS | j�� }| j�|� | j|g|�R ddi� |I dH S )z0Make a channel request and wait for the responseNFr� T)rs rk r! r� r� r% )r� r� r r� rY rY rZ �
_make_request� s �
zSSHChannel._make_requestc C s8 | j �d� | jdvr| �� | jdkr| �� dS dS )z�Forcibly close the channel
This method can be called to forcibly close the channel, after
which no more data can be sent or received. Any unsent buffered
data and any incoming data in flight will be discarded.
zAborting channel> rg r� rg N)r� r� rr r� ry r� r� rY rY rZ �abort� s
�zSSHChannel.abortc C s> | j �d� | jdvrd| _| �� | jdkr | �� dS dS )a Cleanly close the channel
This method can be called to cleanly close the channel, after
which no more data can be sent or received. Any unsent buffered
data will be flushed asynchronously before the channel is
closed.
zClosing channel> rg r� r� rg N)r� r� rr r� ry r� r� rY rY rZ �close s
�zSSHChannel.closec C s
| j dkS )z-Return if the channel is closing or is closedr� )rr r� rY rY rZ �
is_closing �
zSSHChannel.is_closingc � s �| j �� I dH dS )z�Wait for this channel to close
This method is a coroutine which can be called to block until
this channel has finished closing.
N)r� �waitr� rY rY rZ � wait_closed s �zSSHChannel.wait_closedr� �defaultc C s$ | j �|| jr| j�||��S |�S )ao Get additional information about the channel
This method returns extra information about the channel once
it is established. Supported values include `'connection'`
to return the SSH connection this channel is running over plus
all of the values supported on that connection.
For TCP channels, the values `'local_peername'` and
`'remote_peername'` are added to return the local and remote
host and port information for the tunneled TCP connection.
For UNIX channels, the values `'local_peername'` and
`'remote_peername'` are added to return the local and remote
path information for the tunneled UNIX domain socket connection.
Since UNIX domain sockets provide no "source" address, only
one of these will be filled in.
See :meth:`get_extra_info() <SSHClientConnection.get_extra_info>`
on :class:`SSHClientConnection` for more information.
Additional information stored on the channel by calling
:meth:`set_extra_info` can also be returned here.
)rm �getrj �get_extra_info)r� r� r- rY rY rZ r/ $ s
��zSSHChannel.get_extra_info�kwargsc K s | j jdi |�� dS )as Store additional information associated with the channel
This method allows extra information to be associated with the
channel. The information to store should be passed in as
keyword parameters and can later be returned by calling
:meth:`get_extra_info` with one of the keywords as the name
to retrieve.
NrY )rm �update)r� r0 rY rY rZ �set_extra_infoA s zSSHChannel.set_extra_infoc C s dS )znReturn whether the channel supports :meth:`write_eof`
This method always returns `True`.
TrY r� rY rY rZ �
can_write_eofN s zSSHChannel.can_write_eofc C r� )z�Return the current size of the channel's output buffer
This method returns how many bytes are currently in the
channel's output buffer waiting to be written.
)rx r� rY rY rZ �get_write_buffer_sizeX s z SSHChannel.get_write_buffer_size�high�lowc C sz |du r|dur d| nd}|du r|d }d| kr |ks)n t d|� d���| j�d||� || _|| _| �� dS )a� Set the high- and low-water limits for write flow control
This method sets the limits used when deciding when to call
the :meth:`pause_writing() <SSHClientSession.pause_writing>`
and :meth:`resume_writing() <SSHClientSession.resume_writing>`
methods on SSH sessions. Writing will be paused when the write
buffer size exceeds the high-water mark, and resumed when the
write buffer size equals or drops below the low-water mark.
NrN i r z high (high) must be >= low (z) must be >= 0z4Set write buffer limits: low-water=%d, high-water=%d)�
ValueErrorr� r� r� r� r� )r� r5 r6 rY rY rZ r� b s
� z"SSHChannel.set_write_buffer_limitsc C s� | j dkr td��|dur|| jvrtd��|sdS | jr.| jdus$J �| j�tt|��}ntt |�}t
|�}|rAdt | � �}nd}| j �
d||dkrNd nd|� | j�t|�|f� | j|7 _| �� dS )
a� Write data on the channel
This method can be called to send data on the channel. If
an encoding was specified when the channel was created, the
data should be provided as a string and will be converted
using that encoding. Otherwise, the data should be provided
as bytes.
An extended data type can optionally be provided. For
instance, this is used from a :class:`SSHServerSession`
to write data to `stderr`.
:param data:
The data to send on the channel
:param datatype: (optional)
The extended data type of the data, from :ref:`extended
data types <ExtendedDataTypes>`
:type data: `str` or `bytes`
:type datatype: `int`
:raises: :exc:`OSError` if the channel isn't open for sending
or the extended data type is not valid for this type
of channel
r� r
Nr z to r� zSending %d data byte%s%sr r )rr �BrokenPipeErrorr_ r r� r� �encoder r� �bytesr� r r� r� rw r� � bytearrayrx r� )r� r� r� � encoded_datar �typenamerY rY rZ �write� s(
� zSSHChannel.write� list_of_datac C sH | j rttd�ttt |���}n
ttd�ttt |���}| �||�S )a Write a list of data bytes on the channel
This method can be called to write a list (or any iterable) of
data bytes to the channel. It is functionality equivalent to
calling :meth:`write` on each element in the list.
:param list_of_data:
The data to send on the channel
:param datatype: (optional)
The extended data type of the data, from :ref:`extended
data types <ExtendedDataTypes>`
:type list_of_data: iterable of `str` or `bytes`
:type datatype: `int`
:raises: :exc:`OSError` if the channel isn't open for sending
or the extended data type is not valid for this type
of channel
r� r� )r� r r r# r
r� r: r> )r� r? r� r� rY rY rZ �
writelines� s zSSHChannel.writelinesc C s, | j �d� | jdkrd| _| �� dS dS )aP Write EOF on the channel
This method sends an end-of-file indication on the
channel, after which no more data can be sent. The
channel remains open, though, and data may still be
sent in the other direction.
:raises: :exc:`OSError` if the channel isn't open for sending
z Sending EOFr� r� N)r� r� rr r� r� rY rY rZ r� � s
�zSSHChannel.write_eofc C s | j �d� d| _dS )a� Pause delivery of incoming data
This method is used to temporarily suspend delivery of incoming
channel data. After this call, incoming data will no longer
be delivered until :meth:`resume_reading` is called. Data will be
buffered locally up to the configured SSH channel window size,
but window updates will no longer be sent, eventually causing
back pressure on the remote system.
.. note:: Channel close notifications are not suspended by this
call. If the remote system closes the channel while
delivery is suspended, the channel will be closed even
though some buffered data may not have been delivered.
zReading from channel pausedTN)r� r� r} r� rY rY rZ �
pause_reading� s
zSSHChannel.pause_readingc C s( | j r| j�d� d| _ | �� dS dS )a� Resume delivery of incoming data
This method can be called to resume delivery of incoming data
which was suspended by a call to :meth:`pause_reading`. As soon
as this method is called, any buffered data will be delivered
immediately. A pending end-of-file notification may also be
delivered if one was queued while reading was paused.
z Reading from channel resumedFNr� r� rY rY rZ r� � s
�zSSHChannel.resume_readingc C s$ | j du r
tt| j��| _ t| j �S )a� Return the environment for this session
This method returns the environment set by the client when
the session was opened. Keys and values are of type `str`
and this object only provides access to keys and values sent
as valid UTF-8 strings. Use :meth:`get_environment_bytes`
if you need to access environment variables with keys or
values containing binary data or non-UTF-8 encodings.
On the server, calls to this method should only be made after
:meth:`session_started <SSHServerSession.session_started>` has
been called on the :class:`SSHServerSession`. When using the
stream-based API, calls to this can be made at any time after
the handler function has started up.
:returns: A dictionary containing the environment variables
set by the client
N)ro �dictr/ rn r r� rY rY rZ �get_environment
s
zSSHChannel.get_environmentc C �
t | j�S )a� Return the environment for this session
This method returns the environment set by the client when
the session was opened. Keys and values are of type `bytes`
and can include arbitrary binary data, with the exception
of NUL ( ) bytes.
On the server, calls to this method should only be made after
:meth:`session_started <SSHServerSession.session_started>` has
been called on the :class:`SSHServerSession`. When using the
stream-based API, calls to this can be made at any time after
the handler function has started up.
:returns: A dictionary containing the environment variables
set by the client
)r rn r� rY rY rZ �get_environment_bytes' s
z SSHChannel.get_environment_bytesc C r� )a� Return the command the client requested to execute, if any
This method returns the command the client requested to
execute when the session was opened, if any. If the client
did not request that a command be executed, this method
will return `None`. On the server, calls to this method
should only be made after :meth:`session_started
<SSHServerSession.session_started>` has been called on the
:class:`SSHServerSession`. When using the stream-based API,
calls to this can be made at any time after the handler
function has started up.
)rp r� rY rY rZ � get_command< � zSSHChannel.get_commandc C r� )a� Return the subsystem the client requested to open, if any
This method returns the subsystem the client requested to
open when the session was opened, if any. If the client
did not request that a subsystem be opened, this method will
return `None`. On the server, calls to this method should
only be made after :meth:`session_started
<SSHServerSession.session_started>` has been called on the
:class:`SSHServerSession`. When using the stream-based API,
calls to this can be made at any time after the handler
function has started up.
)rq r� rY rY rZ �
get_subsystemM rG zSSHChannel.get_subsystem)r� rI )r� �N�r� N�NN)`�__name__�
__module__� __qualname__�__doc__r1 �globals�_handler_namesr� r^ r rT �__annotations__r_ r� �AbstractEventLoopr
r� r� �propertyr' r� r� r� r r� r� r� r� r� r� r� r� r� r� r� r� r� r: rD r� r� r� r� r� r� r* r9 r r� r� r� r7 r r r r r r r r r r r r r r r r r r �_packet_handlersr" r� r% r& r' r( r) r, r r/ r2 r3 r4 r� r> r
r@ r� rA r� r rC rE rF rH rY rY rY rZ r\ V s4
����
�<
��
�
-
�
�
�
�
�
'��
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
�
� ��
��
�
��
� 9 ��
�
r\ c s� e Zd ZU dZded< ee ed< ehZddde j
de e de d e
d
e
f � fd d � Zd
ee de e de e deeef dede e dededeee f de e de e dededee f dd �Zd edefd d �Zd edefd d!�Zd edefd"d#�Zde e
fd$d%�Zde e fd&d'�Z de e
fd(d)�Z *d<d+e
d,e
d-e
d.e
dd/f
d0d1�Z d2e
dd/fd3d4�Z d5ee e
f dd/fd6d7�Z!d=d8d9�Z"d=d:d;�Z#� Z$S )>�SSHClientChannelzSSH client channelrJ rj rl r` ra rb rc rd re c s& t � �||||||� d | _d | _d S rI )�superr� � _exit_status� _exit_signalr� �� __class__rY rZ r� g s
zSSHClientChannel.__init__�session_factory�commandr� �env� request_pty� term_type� term_size�
term_modes�x11_forwarding� x11_display�
x11_auth_path�x11_single_connection�agent_forwardingr� c
� s� �| j �d� | �d�I dH }|�� |� | _| j�| � || _|| _|| _|� � D ]-\}}| j �
d||� t |t t
f�sAt
|�}t |t t
f�sLt
|�}| �dt|�t|�� q*|�r | j �
d|pbd� |sod } } }}n<t|�d kr�ttttf |�\}}d }}| j �
d
||� n t|�d kr�tt|�\}}}}| j �
d ||||� ntd
��d}|� � D ]-\}}|tks�|tkr�td|� ���t�|t
|��}| j �d||� |t|�t |� 7 }q�|tt�7 }| � dt|p�d�t |�t |�t |�t |�t|��I dH �s | � � t t d��| �r�| j �
d� z| j!�"| |
| | �I dH }W n( t�yJ } z| dk�r8t t#t
|��d�d}| j �d� W Y d}~nd}~ww |�r�|\}} } | � dt$| �t|�tt%�&| ��t | ��I dH } | �s�| j!�rw| j!�'| � | dk�r�t t#d��| j �d� |
�r�| j �
d� | �d� |�r�| j �d |� | � d t|��I dH } n$|�r�| j �d |� | � d t|��I dH } n| j �d � | � d!�I dH } | �s�| � � t t(d"��| j�)� | j!�*| �+� | j � | jS )#z Create an SSH client sessionzRequesting new SSH sessions sessionN� Env: %s=%ss env� Terminal type: %s�Noner r� � Terminal size: %sx%srN �% Terminal size: %sx%s (%sx%s pixels)z8If set, terminal size must be a tuple of 2 or 4 integersr� zInvalid pty mode: z
Mode %s: %ds pty-reqr� zPTY request failed� X11 forwarding enabled�ignore_failurez' X11 forwarding attach failure ignoreds x11-reqz X11 forwarding request failedz( X11 forwarding request failure ignored� Agent forwarding enableds auth-agent-req@openssh.com�
Command: %ss exec� Subsystem: %ss subsystem� Interactive shell requesteds shellzSession request failed),r� r� r" r rl r� rn rp rq �itemsr� �
isinstancer: r� r% r5 r� r r rT r- r7 r! r �_pty_mode_namesr. r� r4 r6 r& r( r( r# rj �attach_x11_listenerr" r3 �binascii�b2a_hexr� r$ r� r� r� ) r� r\ r] r� r^ r_ r` ra rb rc rd re rf rg r� �key�value�width�height�pixwidth� pixheight�modes�mode�
mode_valuer� �
attach_resultr� �
auth_proto� remote_auth�screenr� rY rY rZ �createo s� �
�
�� ��
����
�
��
�
zSSHClientChannel.creater� c C s6 |� � }|�� | j�d|rdnd� | j�|� dS )z/Process a request to set up XON/XOFF processingz)Received XON/XOFF flow control %s request�enable�disableT)r r r� r� rl �xon_xoff_requested)r� r� �
client_can_dorY rY rZ �_process_xon_xoff_request� s
� z*SSHClientChannel._process_xon_xoff_requestc C s8 |� � d@ }|�� | j�d|� || _| j�|� dS )z(Process a request to deliver exit status� zReceived exit status %dT)r r r� r� rX rl �exit_status_received)r� r� �statusrY rY rZ � _process_exit_status_request� s z-SSHClientChannel._process_exit_status_requestc C s� |� � }|�� }|� � }|� � }|�� z|�d�}|�d�}|�d�}W n ty1 td�d�w | j�d|� | j�d|� | j�d|� ||||f| _ | j
� ||||� dS ) z+Process a request to deliver an exit signalr �utf-8zInvalid exit signal requestNzReceived exit signal %s� Core dumped: %s�
Message: %sT) r
r r r� r� r+ r� r� r� rY rl �exit_signal_received) r� r� � signal_bytes� core_dumped� msg_bytes�
lang_bytes�signal�msgr� rY rY rZ � _process_exit_signal_request s$
�z-SSHClientChannel._process_exit_signal_requestc C s | j dur| j S | jr
dS dS )ai Return the session's exit status
This method returns the exit status of the session if one has
been sent. If an exit signal was sent, this method returns -1
and the exit signal information can be collected by calling
:meth:`get_exit_signal`. If neither has been sent, this method
returns `None`.
N���)rX rY r� rY rY rZ �get_exit_status# s
z SSHClientChannel.get_exit_statusc C r� )a� Return the session's exit signal, if one was sent
This method returns information about the exit signal sent on
this session. If an exit signal was sent, a tuple is returned
containing the signal name, a boolean for whether a core dump
occurred, a message associated with the signal, and the language
the message was in. Otherwise, this method returns `None`.
)rY r� rY rY rZ �get_exit_signal5 s z SSHClientChannel.get_exit_signalc C s. | j dur| j S | jrt�| jd d� S dS )a� Return the session's exit status or signal
This method returns the exit status of the session if one has
been sent. If an exit signal was sent, this method returns
the negative of the numeric value of that signal, matching
the behavior of :meth:`asyncio.SubprocessTransport.get_returncode`.
If neither has been sent, this method returns `None`.
:returns: `int` or `None`
Nr �c )rX rY �_signal_numbersr. r� rY rY rZ �get_returncodeB s
z SSHClientChannel.get_returncoder r{ r| r} r~ Nc C sT |s|r| j �d||||� n| j �d||� | �dt|�t|�t|�t|�� dS )a� Change the terminal window size for this session
This method changes the width and height of the terminal
associated with this session.
:param width:
The width of the terminal in characters
:param height:
The height of the terminal in characters
:param pixwidth: (optional)
The width of the terminal in pixels
:param pixheight: (optional)
The height of the terminal in pixels
:type width: `int`
:type height: `int`
:type pixwidth: `int`
:type pixheight: `int`
z0Sending window size change: %sx%s (%sx%s pixels)z!Sending window size change: %sx%ss
window-changeN�r� r� r% r6 )r� r{ r| r} r~ rY rY rZ �change_terminal_sizeV s � �z%SSHClientChannel.change_terminal_size�msecc C s" | j �d|� | �dt|�� dS )ay Send a break to the remote process
This method requests that the server perform a break
operation on the remote process or service as described in
:rfc:`4335`.
:param msec:
The duration of the break in milliseconds
:type msec: `int`
:raises: :exc:`OSError` if the channel is not open
zSending %d msec breaks breakNr� )r� r� rY rY rZ �
send_breaku s zSSHClientChannel.send_breakr� c C sX t |t�rzt| }W n ty td|� ��d�w | j�d|� | �dt|�� dS )a} Send a signal to the remote process
This method can be called to deliver a signal to the remote
process or service. Signal names should be as described in
section 6.10 of :rfc:`RFC 4254 <4254#section-6.10>`, or
can be integer values as defined in the :mod:`signal`
module, in which case they will be translated to their
corresponding signal name before being sent.
.. note:: OpenSSH's SSH server implementation prior to version
7.9 does not support this message, so attempts to
use :meth:`send_signal`, :meth:`terminate`, or
:meth:`kill` with an older OpenSSH SSH server will
end up being ignored. This was tracked in OpenSSH
`bug 1424`__.
__ https://bugzilla.mindrot.org/show_bug.cgi?id=1424
:param signal:
The signal to deliver
:type signal: `str` or `int`
:raises: | :exc:`OSError` if the channel is not open
| :exc:`ValueError` if the signal number is unknown
zUnknown signal: NzSending %s signals signal) rt rT �
_signal_names�KeyErrorr7 r� r� r% r5 )r� r� rY rY rZ � send_signal� s
�z SSHClientChannel.send_signalc C � | � d� dS )a� Terminate the remote process
This method can be called to terminate the remote process or
service by sending it a `TERM` signal.
:raises: :exc:`OSError` if the channel is not open
.. note:: If your server-side runs on OpenSSH,
this might be ineffective;
for more details, see the note in
:meth:`send_signal`
�TERMN�r� r� rY rY rZ � terminate� � zSSHClientChannel.terminatec C r� )a� Forcibly kill the remote process
This method can be called to forcibly stop the remote process
or service by sending it a `KILL` signal.
:raises: :exc:`OSError` if the channel is not open
.. note:: If your server-side runs on OpenSSH,
this might be ineffective;
for more details, see the note in
:meth:`send_signal`
�KILLNr� r� rY rY rZ �kill� r� zSSHClientChannel.kill)r r rJ )%rL rM rN rO rR r: r r r^ r� rS r
r� rT r� r@ r r: r� r. r, r r� r7 r� r� r� r� � _ExitSignalr� r� r� r� r� r� r� �
__classcell__rY rY rZ rZ rV _ s|
�����
��
�����
�����
�
���
�
&rV c sp e Zd ZU dZded< ee ed< ehZddde j
de de d e d
e d e d e
e d
ede de f� fdd� Zdee deee ee f fdd�Zdede fdd�Zdede
e fdd�Zded ed e dd fd d �Zdedd fd!d"�ZdXd#d$�Zdede fd%d&�Z dYd'e
e d(e
e de fd)d*�Z dede fd+d,�Z dede fd-d.�Z dede fd/d0�Z dede fd1d2�Z dede fd3d4�Z!dede fd5d6�Z"de
e fd7d8�Z#de$fd9d:�Z%d;e de
e fd<d=�Z&de'fd>d?�Z(de
e fd@dA�Z)de
e fdBdC�Z*dDe dd fdEdF�Z+dGedd fdHdI�Z,dJe-e dd fdKdL�Z.dMe dd fdNdO�Z/dPdQe0fdRedSe dTedUedd f
dVdW�Z1� Z2S )Z�SSHServerChannelzSSH server channelrK rj rl r` ra � allow_pty� line_editor� line_echo� line_history�max_line_lengthrb rc rd re c
s| t � �|||| |
| � tt|�di ��} tt| ��| _|| _|| _ || _
|| _ || _ d| _
d| _i | _d| _| j�d� dS )z Initialize an SSH server channel� environmentN)r r r r zNew SSH session requested)rW r� r r) �get_key_optionrB r0 rn �
_allow_pty� _line_editor�
_line_echo�
_line_history�_max_line_length�
_term_type�
_term_size� _term_modes� _x11_displayr� r� )
r� r` ra r� r� r� r� r� rb rc rd re �env_optrZ rY rZ r� � s zSSHServerChannel.__init__r� r� c C sr | j r3ttt | �}ttt |�}t||| j| j| j�}t ||�}tt
t |�}tt t |�}||fS | }||fS )z0Wrap a line editor around the session if enabled)
r� r r� r� r; r% r� r� r� r& r\ r r9 )r� r� � server_chan�server_session� editor_chan�editor_sessionr rY rY rZ r� � s �
�z SSHServerChannel._wrap_sessionr� c C s� |� � }|�� }|�� }|�� }|�� }|� � }|�� | jr+| j�d�r+| j�d�s3| j�d� dS z|� d�}W n t
yF t d�d�w ||||f} i }
| j� d|� |sZ|re| j� d||||� n| j� d ||� d
} | t
|�k r�|| } | d 7 } | tks�| tkr�n7| d t
|�kr�t�| t| ��}
t�|| | d � d
�}| j�d|
|� ||
| < | d 7 } nt d��| t
|�k su| j�|| |
�}|r�| j�d� | jr�| j�d� || _| | _|
| _|S | j�d� |S )z+Process a request to open a pseudo-terminal�ptyz%PTY request denied: PTY not permittedFr zInvalid pty requestNri rl rk r r rN �bigz
Mode %s: %szInvalid pty modes stringz
PTY createdz Line editor enabledz PTY creation failed) r
r r r� rj �check_key_permission� check_certificate_permissionr� r� r� r� r+ r� r� r! r ru r. r� rT �
from_bytesr� rl �
pty_requestedr� r� r� r� )r� r� �term_type_bytesr{ r| r} r~ r r` ra rb �idxr� r� rz r� rY rY rZ �_process_pty_req_request sh
�
�
� �
� �z)SSHServerChannel._process_pty_req_requestc C sx |� � }|�� }|�� }|�� }|�� zt�|�}W n tjy, | j�d� Y dS w | j �
| � |||�| j� dS )z(Process request to enable X11 forwardingz Invalid X11 auth dataFN) r r
r r rw �a2b_hex�Errorr� r� rj r� �_finish_x11_req_request)r� r� r� r� � auth_datar� rY rY rZ �_process_x11_req_requestG s" � ��z)SSHServerChannel._process_x11_req_requestr� r� r� Nc � sV �| j �| |||�I dH | _| jr | j�d� | �d� dS | j�d� | �d� dS )z2Finish processing request to enable X11 forwardingNrm Tz X11 forwarding failedF)rj rv r� r� r� r� )r� r� r� r� rY rY rZ r� [ s � � z(SSHServerChannel._finish_x11_req_requestc C s |� � | j�| �� | j� dS )z0Process a request to enable ssh-agent forwardingN)r rj r� �_finish_agent_req_requestr� r rY rY rZ �2_process_auth_agent_req_at_openssh_dot_com_requesti s zCSSHServerChannel._process_auth_agent_req_at_openssh_dot_com_requestc � sF �| j �� I dH r| j�d� | �d� dS | j�d� | �d� dS )z4Finish processing request to enable agent forwardingNro Tz Agent forwarding failedF)rj �create_agent_listenerr� r� r� r� rY rY rZ r� q s � z*SSHServerChannel._finish_agent_req_requestc C s6 |� � }|� � }|�� | j�d||� || j|< dS )z0Process a request to set an environment variablerh T)r
r r� r� rn )r� r� ry rz rY rY rZ �_process_env_request{ s
z%SSHServerChannel._process_env_requestr] r� c C s� t t| j�d��}|du rt t| j�d��}|dur#| j�d|� |}|dur2|| _| j� |�}|S |durA|| _
| j� |�}|S | j� � }|S )z8Tell the session what type of channel is being requestedz
force-commandNr] z Forced command override: %s)
r r� rj �get_certificate_optionr� r� r� rp rl �exec_requestedrq �subsystem_requested�shell_requested)r� r] r� �forced_commandr� rY rY rZ �_start_session� s" � �
�z SSHServerChannel._start_sessionc C s |� � | j�d� | �� S )z!Process a request to open a shellrr )r r� r� r� r rY rY rZ �_process_shell_request� s z'SSHServerChannel._process_shell_requestc C �N |� � }|�� z|�d�}W n
ty Y dS w | j�d|� | j|d�S )z&Process a request to execute a commandr� Frp )r] �r
r r� r� r� r� r� )r� r� �
command_bytesr] rY rY rZ �_process_exec_request� � � z&SSHServerChannel._process_exec_requestc C r� )z%Process a request to open a subsystemr Frq )r� r� )r� r� �subsystem_bytesr� rY rY rZ �_process_subsystem_request� r� z+SSHServerChannel._process_subsystem_requestc C sz |� � }|� � }|� � }|� � }|�� |s|r#| j�d||||� n| j�d||� ||||f| _| j�||||� dS )z+Process a request to change the window sizez,Received window change: %sx%s (%sx%s pixels)z Received window change: %sx%sT)r r r� r� r� rl �terminal_size_changed)r� r� r{ r| r} r~ rY rY rZ � _process_window_change_request� s �z/SSHServerChannel._process_window_change_requestc C sR |� � }|�� z|�d�}W n
ty Y dS w | j�d|� | j�|� dS )z"Process a request to send a signalr FzReceived %s signalT)r
r r� r� r� r� rl �signal_received)r� r� r� r� rY rY rZ �_process_signal_request� s � z(SSHServerChannel._process_signal_requestc C s* |� � }|�� | j�d|� | j�|�S )z!Process a request to send a breakzReceived %d msec break)r r r� r� rl �break_received)r� r� r� rY rY rZ �_process_break_request� s z'SSHServerChannel._process_break_requestc C r� )a� Return the terminal type for this session
This method returns the terminal type set by the client
when the session was opened. If the client didn't request
a pseudo-terminal, this method will return `None`. Calls
to this method should only be made after :meth:`session_started
<SSHServerSession.session_started>` has been called on the
:class:`SSHServerSession`. When using the stream-based API,
calls to this can be made at any time after the handler
function has started up.
:returns: A `str` containing the terminal type or `None` if
no pseudo-terminal was requested
)r� r� rY rY rZ �get_terminal_type� s z"SSHServerChannel.get_terminal_typec C r� )a� Return terminal size information for this session
This method returns the latest terminal size information set
by the client. If the client didn't set any terminal size
information, all values returned will be zero. Calls to
this method should only be made after :meth:`session_started
<SSHServerSession.session_started>` has been called on the
:class:`SSHServerSession`. When using the stream-based API,
calls to this can be made at any time after the handler
function has started up.
Also see :meth:`terminal_size_changed()
<SSHServerSession.terminal_size_changed>` or the
:exc:`TerminalSizeChanged` exception for how to get notified
when the terminal size changes.
:returns: A tuple of four `int` values containing the width and
height of the terminal in characters and the width
and height of the terminal in pixels
)r� r� rY rY rZ �get_terminal_size s z"SSHServerChannel.get_terminal_sizer� c C s | j �|�S )a� Return the requested TTY mode for this session
This method looks up the value of a POSIX terminal mode
set by the client when the session was opened. If the client
didn't request a pseudo-terminal or didn't set the requested
TTY mode opcode, this method will return `None`. Calls to
this method should only be made after :meth:`session_started
<SSHServerSession.session_started>` has been called on the
:class:`SSHServerSession`. When using the stream-based API,
calls to this can be made at any time after the handler
function has started up.
:param mode:
POSIX terminal mode taken from :ref:`POSIX terminal modes
<PTYModes>` to look up
:type mode: `int`
:returns: An `int` containing the value of the requested
POSIX terminal mode or `None` if the requested
mode was not set
)r� r. �r� r� rY rY rZ �get_terminal_mode s z"SSHServerChannel.get_terminal_modec C rD )a Return the TTY modes for this session
This method returns a mapping of all the POSIX terminal modes
set by the client when the session was opened. If the client
didn't request a pseudo-terminal, this method will return an
empty mapping. Calls to this method should only be made after
:meth:`session_started <SSHServerSession.session_started>`
has been called on the :class:`SSHServerSession`. When using
the stream-based API, calls to this can be made at any time
after the handler function has started up.
:returns: A mapping containing all the POSIX terminal modes
set by the client or an empty mapping if no
pseudo-terminal was requested
)r r� r� rY rY rZ �get_terminal_modes7 s
z#SSHServerChannel.get_terminal_modesc C r� )a� Return the display to use for X11 forwarding
When X11 forwarding has been requested by the client, this
method returns the X11 display which should be used to open
a forwarded connection. If the client did not request X11
forwarding, this method returns `None`.
:returns: A `str` containing the X11 display or `None` if
X11 forwarding was not requested
)r� r� rY rY rZ �get_x11_displayK s
z SSHServerChannel.get_x11_displayc C s
| j �� S )a� Return the path of the ssh-agent listening socket
When agent forwarding has been requested by the client,
this method returns the path of the listening socket which
should be used to open a forwarded agent connection. If the
client did not request agent forwarding, this method returns
`None`.
:returns: A `str` containing the ssh-agent socket path or
`None` if agent forwarding was not requested
)rj �get_agent_pathr� rY rY rZ r� Z s
z SSHServerChannel.get_agent_pathr� c C s* | j �d|rdnd� | �dt|�� dS )a� Set whether the client should enable XON/XOFF flow control
This method can be called to tell the client whether or not
to enable XON/XOFF flow control, indicating that it should
intercept Control-S and Control-Q coming from its local
terminal to pause and resume output, respectively.
Applications should set client_can_do to `True` to
enable this functionality or to `False` to tell the client
to forward Control-S and Control-Q through as normal input.
:param client_can_do:
Whether or not the client should enable XON/XOFF flow control
:type client_can_do: `bool`
z Sending XON/XOFF flow control %sr� r� s xon-xoffN)r� r� r% r3 )r� r� rY rY rZ � set_xon_xoffj s
�z SSHServerChannel.set_xon_xoffr� c C � | � |t� dS )a0 Write output to stderr
This method can be called to send output to the client which
is intended to be displayed on stderr. If an encoding was
specified when the channel was created, the data should be
provided as a string and will be converted using that
encoding. Otherwise, the data should be provided as bytes.
:param data:
The data to send to stderr
:type data: `str` or `bytes`
:raises: :exc:`OSError` if the channel isn't open for sending
N)r> r )r� r� rY rY rZ � write_stderr� s z SSHServerChannel.write_stderrr? c C r� )a Write a list of data bytes to stderr
This method can be called to write a list (or any iterable) of
data bytes to the channel. It is functionality equivalent to
calling :meth:`write_stderr` on each element in the list.
N)r@ r )r� r? rY rY rZ �writelines_stderr� s z"SSHServerChannel.writelines_stderrr� c C s@ |dM }| j dvr | j�d|� | �dt|�� | �� dS dS )a Send exit status and close the channel
This method can be called to report an exit status for the
process back to the client and close the channel. A zero
exit status is generally returned when the operation was
successful. After reporting the status, the channel is
closed.
:param status:
The exit status to report to the client
:type status: `int`
:raises: :exc:`OSError` if the channel isn't open
r� > rg r� zSending exit status %ds exit-statusN)rr r� r� r% r6 r( )r� r� rY rY rZ �exit� s
�zSSHServerChannel.exitFr� r� r� r� r� c C sf | j �d|� | j �d|� | j �d|� | jdvr1| �dt|�t|�t|�t|�� | �� dS dS )a� Send exit signal and close the channel
This method can be called to report that the process
terminated abnormslly with a signal. A more detailed
error message may also provided, along with an indication
of whether or not the process dumped core. After
reporting the signal, the channel is closed.
:param signal:
The signal which caused the process to exit
:param core_dumped: (optional)
Whether or not the process dumped core
:param msg: (optional)
Details about what error occurred
:param lang: (optional)
The language the error message is in
:type signal: `str`
:type core_dumped: `bool`
:type msg: `str`
:type lang: `str`
:raises: :exc:`OSError` if the channel isn't open
zSending exit signal %sr� r� > rg r� s exit-signalN)r� r� r� rr r% r5 r3 r( )r� r� r� r� r� rY rY rZ �exit_with_signal� s
� �z!SSHServerChannel.exit_with_signalrJ rK )3rL rM rN rO rR r; r r r_ r� rS r� rT r
r� r� r9 r r\ r� r7 r� r� r: r� r� r� r� r� r� r� r� r� r� r� r� r- r� r� r, r� r� r� r� r� r
r� r� r r� r� rY rY rZ rZ r� � s�
����������
�A��
��
�
��
�
����r� c sX e Zd ZdZdeee ddf� fdd� Zdee de d e dee f� fd
d � Z
� Z S ) �SSHForwardChannelz:SSH channel for forwarding TCP and UNIX domain connectionsr� r� Nc � s8 �t � �|�I dH | jdur| j�� | �� dS dS )z0Finish processing a forward channel open requestN)rW r� rl r� r� )r� r� rZ rY rZ r� � s �
�z&SSHForwardChannel._finish_open_requestr\ r r c � sj �t � j|g|�R � I dH }|�� |� | _| j�| � | j�� | jdus(J �| j�| �� | j � | jS )zOpen a forward channelN)
rW r" r rl r� r� rj r� r� r� )r� r\ r r r� rZ rY rZ �
_open_forward� s �
z SSHForwardChannel._open_forward) rL rM rN rO r* r9 r r� r? r: r� r� rY rY rZ rZ r� � s
��
���r� c @ s� e Zd ZdZdee dededededede e fd d
�Z
dee dedededede e f d d �Z dee dedededede e f d
d�Z dededededdf
dd�Z
dS )�
SSHTCPChannelzSSH TCP channelr\ r �host�port� orig_host� orig_portr� c � sN �| j d||f||fd� ttt | �||t|�t|�t|�t|��I dH �S )zOpen a TCP channel�r� r ��peername�local_peername�remote_peernameN)r2 r r< r r� r5 r6 )r� r\ r r� r� r� r rY rY rZ � _open_tcp s �� ��zSSHTCPChannel._open_tcpc � � �| � |d||||�I dH S )z!Create a new outbound TCP sessions direct-tcpipN�r �r� r\ r� r� r� r rY rY rZ �connect � �
�zSSHTCPChannel.connectc � r )z"Create a new forwarded TCP sessions forwarded-tcpipNr r rY rY rZ �accept r zSSHTCPChannel.accept� dest_host� dest_portNc C s | j d||f||fd� dS )�7Set local and remote peer names for inbound connectionsr r N�r2 )r� r
r r� r rY rY rZ �set_inbound_peer_names s
�z$SSHTCPChannel.set_inbound_peer_names)rL rM rN rO rA r r: r� rT r< r r
r r rY rY rY rZ r� � sX
�����
�
����
�
����
�
���r� c @ s� e Zd ZdZdee dedededee f
dd�Z dee dedee fd d
�Z
dee dedee fd d �Z d
eddfdd�Z dS )�SSHUNIXChannelzSSH UNIX channelr\ r �pathr r� c � s: �| j d|d� ttt | j||t|�g|�R � I dH �S )zOpen a UNIX channelr� �r r N)r2 r r= r r� r5 )r� r\ r r r rY rY rZ �
_open_unix+ s �� ��zSSHUNIXChannel._open_unixc � s" �| � |d|td�td��I dH S )z"Create a new outbound UNIX sessions direct-streamlocal@openssh.comr� r N)r r5 r6 �r� r\ r rY rY rZ r
6 s
�
�zSSHUNIXChannel.connectc � s �| � |d|td��I dH S )z#Create a new forwarded UNIX sessions! forwarded-streamlocal@openssh.comr� N)r r5 r rY rY rZ r A s
�
�zSSHUNIXChannel.accept� dest_pathNc C s | j |dd� dS )r r� r Nr )r� r rY rY rZ r I s z%SSHUNIXChannel.set_inbound_peer_names)
rL rM rN rO rB r r: r� r= r r
r r rY rY rY rZ r ( s,
���
�
�
�
�
�r c s� e Zd ZdZdddejdee dededef � fd d
� Z dd e
d
e dd f� fdd�
Z dd e
d
e dd f� fdd�
Z
dededee defdd�Zdedd fdd�Z� ZS )�SSHTunTapChannelzSSH TunTap channelr` rI ra rb rc rd re c s t � �||||||� d | _d S rI )rW r� �_moder� rZ rY rZ r� R s
zSSHTunTapChannel.__init__Nr� r� r� c s( | j tkr |dd� }t� �||� dS )z8Strip off address family on incoming packets in TUN moderN N)r rE rW r� r� rZ rY rZ r� Y s
z SSHTunTapChannel._accept_datac sD | j tkr|d d? }|dkrtnt}t|�| }t� �||� dS )z2Add address family in outbound packets in TUN moder rN N)r rE rG rH r6 rW r> )r� r� r� �version�familyrZ rY rZ r> a s
zSSHTunTapChannel.writer\ r� �unitc � s8 �|| _ |du r
t}tt| �|dt|�t|��I dH �S )zOpen a TUN/TAP channelNs tun@openssh.com)r rF r r> r� r6 )r� r\ r� r rY rY rZ r� k s � ��zSSHTunTapChannel.openc C s
|| _ dS )z Set mode for inbound connectionsN)r r� rY rY rZ �set_modey r* zSSHTunTapChannel.set_moderI )rL rM rN rO r� rS r
r� rT r� r: rD r� r> rC r> r� r r� rY rY rZ rZ r O s. �����
��
�r c @ sH e Zd ZdZdee dededee fdd�Z dededdfd d
�Z
dS ) �
SSHX11ChannelzSSH X11 channelr\ r� r r� c � s< �| j ||fdd� ttt | �|dt|�t|��I dH �S )zOpen an SSH X11 channelr r s x11N)r2 r r< r: r� r5 r6 )r� r\ r� r rY rY rZ r� � s �
���zSSHX11Channel.openNc C s | j d||fd� dS )z6Set local and remote peer name for inbound connectionsr r Nr )r� r� r rY rY rZ r � s
�z$SSHX11Channel.set_inbound_peer_names) rL rM rN rO rA r: r� rT r< r� r rY rY rY rZ r s
��
� r c @ s* e Zd ZdZdee dee fdd�ZdS )�SSHAgentChannelzSSH agent channelr\ r� c � s �t tt | �|d�I dH �S )zOpen an SSH agent channels auth-agent@openssh.comN)r r= r: r� )r� r\ rY rY rZ r� � s ���zSSHAgentChannel.openN)rL rM rN rO rB r: r= r� rY rY rY rZ r � s
�r )wrO r� rw r� r� �rer� �_signalr� �typesr �typingr r r r r r r r
r r r
r r r r r� r r r r r r r r r r r r r r r! r" r# r$ �editorr% r& �loggingr' �miscr( r) r* r+ r, r- r. r/ r0 r1 r2 r� r3 r4 r5 r6 r7 r8 r� r9 r: r; r< r= r> r? r@ rA rB rC �streamrD �tuntaprE rF rG rH rf rI rJ rK �__dict__rL r� rT rR ru r �compilerR �varsrs r� r� r� r� r� r\ rV r� r� r� r r: r r r rY rY rY rZ �<module> s�
t !+'0