File: //lib/python3/dist-packages/twisted/conch/ssh/__pycache__/connection.cpython-310.pyc
o
�b�c � @ s" d Z ddlZddlZddlZddlmZ ddlmZm Z ddl
m Z ddl m
Z
ddlmZmZ G dd � d e j�Zd
Zd Zd Zd
ZdZdZdZdZdZdZ dZ dZ dZ dZ dZ!dZ"dZ#dZ$dZ%i Z&e'� �(� �)� D ]\Z*Z+e*dd� d krxe*e&e+< qheej,ej- �Z.e/d d � e0d �D ��Z1e&e_2dS ) z�
This module contains the implementation of the ssh-connection service, which
allows access to the shell and port-forwarding.
Maintainer: Paul Swartz
� N)�error)�common�service)�defer)�Logger)� nativeString�
networkStringc @ s e Zd ZdZdZe� Zdd� Zdd� Zdd� Z d d
� Z
d d � Z d
d� Z dd� Z
dd� Zdd� Zdd� Zdd� Zdd� Zdd � Zd d � Zd d � Zd!d"� Zd#d$� Zd%d&� Zd'd(� Zd)d*� ZdDd,d-�ZdEd/d0�Z dDd1d2�Z d3d4� Z d5d6� Z d7d8� Z d9d:� Z!d;d<� Z"d=d>� Z#d?d@� Z$dAdB� Z%dCS )F�
SSHConnectionao
An implementation of the 'ssh-connection' service. It is used to
multiplex multiple channels over the single SSH connection.
@ivar localChannelID: the next number to use as a local channel ID.
@type localChannelID: L{int}
@ivar channels: a L{dict} mapping a local channel ID to C{SSHChannel}
subclasses.
@type channels: L{dict}
@ivar localToRemoteChannel: a L{dict} mapping a local channel ID to a
remote channel ID.
@type localToRemoteChannel: L{dict}
@ivar channelsToRemoteChannel: a L{dict} mapping a C{SSHChannel} subclass
to remote channel ID.
@type channelsToRemoteChannel: L{dict}
@ivar deferreds: a L{dict} mapping a local channel ID to a C{list} of
C{Deferreds} for outstanding channel requests. Also, the 'global'
key stores the C{list} of pending global request C{Deferred}s.
s ssh-connectionc C s, d| _ i | _i | _i | _dg i| _d | _d S )Nr �global)�localChannelID�localToRemoteChannel�channels�channelsToRemoteChannel� deferreds� transport��self� r �>/usr/lib/python3/dist-packages/twisted/conch/ssh/connection.py�__init__/ s
zSSHConnection.__init__c C s t | jd�r
| | jj_d S d S )N�avatar)�hasattrr r �connr r r r �serviceStarted= s �z SSHConnection.serviceStartedc C sV t | j�� �D ]}| �|� q| jr%| j�� \}}|�tjj �
� � | js| � � dS )z8
Called when the connection is stopped.
N) �listr �keys�
channelClosedr
�popitem�
openFailed�twisted�internetr �ConnectionLost�_cleanupGlobalDeferreds)r �channel�_r r r �serviceStoppedA s � z SSHConnection.serviceStoppedc C s4 | j d D ]
}|�t�d�� q| j d dd�= dS )z�
All pending requests that have returned a deferred must be errbacked
when this service is stopped, otherwise they might be left uncalled and
uncallable.
r
zConnection stopped.N)r �errbackr �
ConchError)r �dr r r r" P s z%SSHConnection._cleanupGlobalDeferredsc C sx t �|�\}}t|dd� �|dd� }}| �||�}|r:t}d}|r1t}t|ttf�r1|d }| j �
||� dS dS )z�
The other side has made a global request. Payload::
string request type
bool want reply
<request specific data>
This dispatches to self.gotGlobalRequest.
r � N� ) r �getNS�ord�gotGlobalRequest�MSG_REQUEST_FAILURE�MSG_REQUEST_SUCCESS�
isinstance�tupler r �
sendPacket)r �packet� requestType�rest� wantReply�ret�reply�datar r r �ssh_GLOBAL_REQUEST[ s �z SSHConnection.ssh_GLOBAL_REQUESTc C s& | j �d� | jd �d��|� dS )z�
Our global request succeeded. Get the appropriate Deferred and call
it back with the packet we received.
zglobal request successr
r N)�_log�debugr �pop�callback�r r3 r r r �ssh_REQUEST_SUCCESSp s z!SSHConnection.ssh_REQUEST_SUCCESSc C s. | j �d� | jd �d��t�d|�� dS )z~
Our global request failed. Get the appropriate Deferred and errback
it with the packet we received.
zglobal request failurer
r zglobal request failedN)r; r< r r= r& r r' r? r r r �ssh_REQUEST_FAILUREx s
�z!SSHConnection.ssh_REQUEST_FAILUREc
C sN t �|�\}}t�d|dd� �\}}}|dd� }zA| �||||�}| j}| jd7 _||_|| j|< || j|< || j |< t�
d|||j |j �|j
} | j�t| � |�|� W dS ty� }
z?| j�d� t|
tj�r|
j\} } t| t�r~| | } } nt} d} | j�tt�
d|| �t � t | �� t � d � � W Y d}
~
dS d}
~
ww )
a�
The other side wants to get a channel. Payload::
string channel name
uint32 remote channel number
uint32 remote window size
uint32 remote maximum packet size
<channel specific data>
We get a channel from self.getChannel(), give it a local channel number
and notify the other side. Then notify the channel by calling its
channelOpen method.
�>3LN� r) �>4Lzchannel open failedzunknown failure�>2Lr* ) r r+ �struct�unpack�
getChannelr �idr
r r �pack�localWindowSize�localMaxPacket� specificDatar r2 � MSG_CHANNEL_OPEN_CONFIRMATION� channelOpen� Exceptionr; �failurer0 r r' �args�int�OPEN_CONNECT_FAILED�MSG_CHANNEL_OPEN_FAILURE�NSr )
r r3 � channelTyper5 �
senderChannel�
windowSize� maxPacketr# � localChannel�openConfirmPacket�e� textualInfo�reasonr r r �ssh_CHANNEL_OPEN� sT
���
� �����z SSHConnection.ssh_CHANNEL_OPENc C sf t �d|dd� �\}}}}|dd� }| j| }| |_|| j|< || j|< ||_||_|�|� dS )a�
The other side accepted our MSG_CHANNEL_OPEN request. Payload::
uint32 local channel number
uint32 remote channel number
uint32 remote window size
uint32 remote maximum packet size
<channel specific data>
Find the channel using the local channel number and notify its
channelOpen method.
rD N� ) rF rG r
r r r �remoteWindowLeft�remoteMaxPacketrO )r r3 r[ �
remoteChannelrY rZ rM r# r r r � ssh_CHANNEL_OPEN_CONFIRMATION� s �
z+SSHConnection.ssh_CHANNEL_OPEN_CONFIRMATIONc C s` t �d|dd� �\}}t�|dd� �d }| j| }| j|= | |_t�||�}|�|� dS )a;
The other side did not accept our MSG_CHANNEL_OPEN request. Payload::
uint32 local channel number
uint32 reason code
string reason description
Find the channel using the local channel number and notify it by
calling its openFailed() method.
rE N� r ) rF rG r r+ r
r r r' r )r r3 r[ �
reasonCode�
reasonDescr# r_ r r r �ssh_CHANNEL_OPEN_FAILURE� s
z&SSHConnection.ssh_CHANNEL_OPEN_FAILUREc C s0 t �d|dd� �\}}| j| }|�|� dS )z�
The other side is adding bytes to its window. Payload::
uint32 local channel number
uint32 bytes to add
Call the channel's addWindowBytes() method to add new bytes to the
remote window.
rE Nrf )rF rG r
�addWindowBytes)r r3 r[ �
bytesToAddr# r r r �ssh_CHANNEL_WINDOW_ADJUST� s
z'SSHConnection.ssh_CHANNEL_WINDOW_ADJUSTc C s� t �d|dd� �\}}| j| }||jks||jkr(| j�d� | �|� dS t� |dd� �d }| j|8 _|j|j
d k rL| � ||j
|j � |� |� dS )a�
The other side is sending us data. Payload::
uint32 local channel number
string data
Check to make sure the other side hasn't sent too much data (more
than what's in the window, or more than the maximum packet size). If
they have, close the channel. Otherwise, decrease the available
window and pass the data to the channel's dataReceived().
rE Nrf z
too much data� r � )
rF rG r
�localWindowLeftrL r; r � sendCloser r+ rK � adjustWindow� dataReceived)r r3 r[ �
dataLengthr# r9 r r r �ssh_CHANNEL_DATA� s
�z SSHConnection.ssh_CHANNEL_DATAc C s� t �d|dd� �\}}}| j| }||jks ||jkr)| j�d� | �|� dS t� |dd� �d }| j|8 _|j|j
d k rM| � ||j
|j � |� ||� dS )a�
The other side is sending us exteneded data. Payload::
uint32 local channel number
uint32 type code
string data
Check to make sure the other side hasn't sent too much data (more
than what's in the window, or than the maximum packet size). If
they have, close the channel. Otherwise, decrease the available
window and pass the data and type code to the channel's
extReceived().
rB NrC ztoo much extdatarf r rn )
rF rG r
ro rL r; r rp r r+ rK rq � extReceived)r r3 r[ �typeCoders r# r9 r r r �ssh_CHANNEL_EXTENDED_DATA s
�z'SSHConnection.ssh_CHANNEL_EXTENDED_DATAc C s. t �d|dd� �d }| j| }|�� dS )z�
The other side is not sending any more data. Payload::
uint32 local channel number
Notify the channel by calling its eofReceived() method.
�>LNrm r )rF rG r
� eofReceived�r r3 r[ r# r r r �ssh_CHANNEL_EOF& s
z SSHConnection.ssh_CHANNEL_EOFc C sR t �d|dd� �d }| j| }|�� d|_|jr%|jr'| �|� dS dS dS )a1
The other side is closing its end; it does not want to receive any
more data. Payload::
uint32 local channel number
Notify the channnel by calling its closeReceived() method. If
the channel has also sent a close message, call self.channelClosed().
rx Nrm r T)rF rG r
�
closeReceived� remoteClosed� localClosedr rz r r r �ssh_CHANNEL_CLOSE1 s
�z SSHConnection.ssh_CHANNEL_CLOSEc C s� t �d|dd� �d }t�|dd� �\}}t|dd� �}| j| }t�|j||dd� �}|rB|� | j
|� |� | j |� |S dS )ay
The other side is sending a request to a channel. Payload::
uint32 local channel number
string request name
bool want reply
<request specific data>
Pass the message to the channel's requestReceived method. If the
other side wants a reply, add callbacks which will send the
reply.
rx Nrm r r) )
rF rG r r+ r, r
r �
maybeDeferred�requestReceived� addCallback�_cbChannelRequest�
addErrback�_ebChannelRequest)r r3 r[ r4 r5 r6 r# r( r r r �ssh_CHANNEL_REQUESTA s
�z!SSHConnection.ssh_CHANNEL_REQUESTc C s. |st �d��| j�tt�d| j| �� dS )a)
Called back if the other side wanted a reply to a channel request. If
the result is true, send a MSG_CHANNEL_SUCCESS. Otherwise, raise
a C{error.ConchError}
@param result: the value returned from the channel's requestReceived()
method. If it's False, the request failed.
@type result: L{bool}
@param localChannel: the local channel ID of the channel to which the
request was made.
@type localChannel: L{int}
@raises ConchError: if the result is False.
zfailed requestrx N)r r' r r2 �MSG_CHANNEL_SUCCESSrF rJ r �r �resultr[ r r r r� W s
�z SSHConnection._cbChannelRequestc C s | j �tt�d| j| �� dS )a?
Called if the other wisde wanted a reply to the channel requeset and
the channel request failed.
@param result: a Failure, but it's not used.
@param localChannel: the local channel ID of the channel to which the
request was made.
@type localChannel: L{int}
rx N)r r2 �MSG_CHANNEL_FAILURErF rJ r r� r r r r� l s
�z SSHConnection._ebChannelRequestc C sF t �d|dd� �d }| j�|�r!| j| �d�}|�d� dS dS )z�
Our channel request to the other side succeeded. Payload::
uint32 local channel number
Get the C{Deferred} out of self.deferreds and call it back.
rx Nrm r � )rF rG r �getr= r> �r r3 r[ r( r r r �ssh_CHANNEL_SUCCESS{ s
�z!SSHConnection.ssh_CHANNEL_SUCCESSc C sL t �d|dd� �d }| j�|�r$| j| �d�}|�t�d�� dS dS )z�
Our channel request to the other side failed. Payload::
uint32 local channel number
Get the C{Deferred} out of self.deferreds and errback it with a
C{error.ConchError}.
rx Nrm r zchannel request failed)rF rG r r� r= r& r r' r� r r r �ssh_CHANNEL_FAILURE� s
�z!SSHConnection.ssh_CHANNEL_FAILUREr c C sH | j �tt�|�|r dp
d | � |r"t�� }| jd �|� |S dS )a
Send a global request for this connection. Current this is only used
for remote->local TCP forwarding.
@type request: L{bytes}
@type data: L{bytes}
@type wantReply: L{bool}
@rtype: C{Deferred}/L{None}
� �� r
N) r r2 �MSG_GLOBAL_REQUESTr rV r �Deferredr �append)r �requestr9 r6 r( r r r �sendGlobalRequest� s
��z SSHConnection.sendGlobalRequestr* c
C sp | j jd| j|j|jd� | j�tt� |j
�t � d| j|j|j� | � | j|_
|| j| j< | jd7 _dS )z�
Open a new channel on this connection.
@type channel: subclass of C{SSHChannel}
@type extra: L{bytes}
z<opening channel {id} with {localWindowSize} {localMaxPacket})rI rK rL rB r) N)r; �infor rK rL r r2 �MSG_CHANNEL_OPENr rV �namerF rJ rI r
)r r# �extrar r r � openChannel� s, �
���� zSSHConnection.openChannelc C sz |j rdS | jjd|d� | j�tt�d| j| �t �
|� |r"dnd | � |r;t � � }| j
�|jg ��|� |S dS )a
Send a request to a channel.
@type channel: subclass of C{SSHChannel}
@type requestType: L{bytes}
@type data: L{bytes}
@type wantReply: L{bool}
@rtype: C{Deferred}/L{None}
Nz sending request {requestType}�r4 rx � r� )r~ r; r< r r2 �MSG_CHANNEL_REQUESTrF rJ r r rV r r� r �
setdefaultrI r� )r r# r4 r9 r6 r( r r r � sendRequest� s$
�
����zSSHConnection.sendRequestc C sV |j rdS t�d| j| |�}| j�t|� | jjd||j |j
d� | j |7 _ dS )z�
Tell the other side that we will receive more data. This should not
normally need to be called as it is managed automatically.
@type channel: subclass of L{SSHChannel}
@type bytesToAdd: L{int}
NrE z8adding {bytesToAdd} to {localWindowLeft} in channel {id})rk ro rI ) r~ rF rJ r r r2 �MSG_CHANNEL_WINDOW_ADJUSTr; r< ro rI )r r# rk r3 r r r rq � s �zSSHConnection.adjustWindowc C s4 |j rdS | j�tt�d| j| �t�|� � dS )z�
Send data to a channel. This should not normally be used: instead use
channel.write(data) as it manages the window automatically.
@type channel: subclass of L{SSHChannel}
@type data: L{bytes}
Nrx ) r~ r r2 �MSG_CHANNEL_DATArF rJ r r rV )r r# r9 r r r �sendData� s �zSSHConnection.sendDatac C s6 |j rdS | j�tt�d| j| |�t�|� � dS )a6
Send extended data to a channel. This should not normally be used:
instead use channel.writeExtendedData(data, dataType) as it manages
the window automatically.
@type channel: subclass of L{SSHChannel}
@type dataType: L{int}
@type data: L{bytes}
NrE ) r~ r r2 �MSG_CHANNEL_EXTENDED_DATArF rJ r r rV )r r# �dataTyper9 r r r �sendExtendedData s
��z SSHConnection.sendExtendedDatac C s6 |j rdS | j�d� | j�tt�d| j| �� dS )zm
Send an EOF (End of File) for a channel.
@type channel: subclass of L{SSHChannel}
Nz sending eofrx ) r~ r; r< r r2 �MSG_CHANNEL_EOFrF rJ r �r r# r r r �sendEOF s �zSSHConnection.sendEOFc C s` |j rdS | jjd|jd� | j�tt�d| j | �� d|_ |j r,|j
r.| � |� dS dS dS )zU
Close a channel.
@type channel: subclass of L{SSHChannel}
Nzsending close {id})rI rx T) r~ r; r� rI r r2 �MSG_CHANNEL_CLOSErF rJ r r} r r� r r r rp s � �zSSHConnection.sendClosec C s� | j jd|d� t| jd�r| jj�||||�}n |�t�}dt|� }t | |d�}|dur5||||�}nd}|du rAt
� dt ��| |_
|S )ab
The other side requested a channel of some sort.
channelType is the type of channel being requested,
windowSize is the initial size of the remote window,
maxPacket is the largest packet we should send,
data is any other packet data (often nothing).
We return a subclass of L{SSHChannel}.
By default, this dispatches to a method 'channel_channelType' with any
non-alphanumerics in the channelType replace with _'s. If it cannot
find a suitable method, it returns an OPEN_UNKNOWN_CHANNEL_TYPE error.
The method is called with arguments of windowSize, maxPacket, data.
@type channelType: L{bytes}
@type windowSize: L{int}
@type maxPacket: L{int}
@type data: L{bytes}
@rtype: subclass of L{SSHChannel}/L{tuple}
z#got channel {channelType!r} request)rW r z
channel_%sNzunknown channel)r; r< r r r �
lookupChannel� translate�TRANSLATE_TABLEr �getattrr r' �OPEN_UNKNOWN_CHANNEL_TYPEr )r rW rY rZ r9 �chan�attr�fr r r rH 1 s �
zSSHConnection.getChannelc C s\ | j jd|d� t| jd�r| jj�||�S t|�dd��}t| d| d�}|s*dS ||�S ) a�
We got a global request. pretty much, this is just used by the client
to request that we forward a port from the server to the client.
Returns either:
- 1: request accepted
- 1, <data>: request accepted with request specific data
- 0: request denied
By default, this dispatches to a method 'global_requestType' with
-'s in requestType replaced with _'s. The found method is passed data.
If this method cannot be found, this method returns 0. Otherwise, it
returns the return value of that method.
@type requestType: L{bytes}
@type data: L{bytes}
@rtype: L{int}/L{tuple}
z got global {requestType} requestr� r � -� _z global_%sNr ) r; r< r r r r- r �replacer� )r r4 r9 r� r r r r- Y s z SSHConnection.gotGlobalRequestc C sh || j v r2d |_|_| j|j= | j|j= | j |= | j�|jg �D ]
}|�t �
d�� q!|� � dS dS )a;
Called when a channel is closed.
It clears the local state related to the channel, and calls
channel.closed().
MAKE SURE YOU CALL THIS METHOD, even if you subclass L{SSHConnection}.
If you don't, things will break mysteriously.
@type channel: L{SSHChannel}
TzChannel closed.N) r r~ r} r rI r
r r= r& r r' �closed)r r# r( r r r r u s
�zSSHConnection.channelClosedN)r )r* )&�__name__�
__module__� __qualname__�__doc__r� r r; r r r% r" r: r@ rA r` re ri rl rt rw r{ r r� r� r� r� r� r� r� r� rq r� r� r� rp rH r- r r r r r r sF
5
( r �P �Q �R �Z �[ �\ �] �^ �_ �` �a �b �c �d r) rn � rm �MSG_c c s$ � | ]
}|t v r
|ntd �V qdS )r$ N)� alphanumsr, )�.0�ir r r � <genexpr>� s �" r� � )3r� �stringrF �twisted.internet.errorr �
twisted.conchr �twisted.conch.sshr r �twisted.internetr �twisted.loggerr �twisted.python.compatr r �
SSHServicer r� r/ r. r� rN rU r� r� r� r� r� r� r� r� � OPEN_ADMINISTRATIVELY_PROHIBITEDrT r� �OPEN_RESOURCE_SHORTAGE�EXTENDED_DATA_STDERR�messages�locals�copy�itemsr� �value�
ascii_letters�digitsr� �bytes�ranger� �protocolMessagesr r r r �<module> sR v�