File: //opt/saltstack/salt/lib/python3.10/site-packages/tornado/__pycache__/websocket.cpython-310.pyc
o
;j� � @ s� d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl
Z
ddl m Z ddl
Z
ddlZddlmZmZ ddlmZmZmZ ddl
mZmZmZ ddlmZ ddlm Z m Z dd l m Z m Z dd
l!m"Z" dd l
m#Z# dd l$m%Z% dd
l&m'Z' ddl(m)Z) ddl*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5 ddl6m7Z7 e+r�ddl8m9Z9 G dd� de9�Z:G dd� de9�Z;G dd� de9�Z<dZ=e�>e j?�Z@G dd� deA�ZBG dd � d eB�ZCG d d � d eA�ZDG d d � d �ZEG d!d"� d"e
jFjG�ZHd#e-d$e-d%dfd&d'�ZIG d(d)� d)ejJ�ZKG d*d+� d+�ZLG d,d-� d-�ZMG d.d/� d/eK�ZNG d0d1� d1e#jO�ZPdddddde=ddf d2e0eQejRf d3e.e3d4gdf d5e.eS d6e.e3e0deQeTf gdf d7e.e/eQe-f d8e.eS d9e.eS d:eUd;e.e1eQ d<e.e" d%d=fd>d?�ZVdS )@a� Implementation of the WebSocket protocol.
`WebSockets <http://dev.w3.org/html5/websockets/>`_ allow for bidirectional
communication between the browser and server. WebSockets are supported in the
current versions of all major browsers.
This module implements the final version of the WebSocket protocol as
defined in `RFC 6455 <http://tools.ietf.org/html/rfc6455>`_.
.. versionchanged:: 4.0
Removed support for the draft 76 protocol version.
� N)�urlparse)�Future�"future_set_result_unless_cancelled)�utf8�
native_str�
to_unicode)�gen�
httpclient�httputil)�IOLoop)�StreamClosedError�IOStream)�gen_log�app_log)�Resolver)�simple_httpclient)�Queue)� TCPClient)�_websocket_mask) �
TYPE_CHECKING�cast�Any�Optional�Dict�Union�List� Awaitable�Callable�Tuple�Type)�
TracebackType)�Protocolc @ s0 e Zd Zdedefdd�Zdedefdd�ZdS ) � _Compressor�data�returnc C � d S �N� ��selfr# r' r' �E/opt/saltstack/salt/lib/python3.10/site-packages/tornado/websocket.py�compress= � z_Compressor.compress�modec C r% r& r' )r) r- r' r' r* �flush@ r, z_Compressor.flushN)�__name__�
__module__� __qualname__�bytesr+ �intr. r' r' r' r* r" < s r" c @ s& e Zd ZdZdededefdd�ZdS )�
_Decompressor� r# �
max_lengthr$ c C r% r& r' )r) r# r6 r' r' r* �
decompressF r, z_Decompressor.decompressN)r/ r0 r1 �unconsumed_tailr2 r3 r7 r' r' r' r* r4 C s r4 c @ s� e Zd Z ddee dee ddfdd�Zdeeef ded fd d
�Z d eddfd d
�Z
d eddfdd�Z dee e
dee
dee ddfdd�ZdS )�_WebSocketDelegateN�
close_code� close_reasonr$ c C r% r& r' �r) r: r; r' r' r* �on_ws_connection_closeM s z)_WebSocketDelegate.on_ws_connection_close�messagezAwaitable[None]c C r% r& r' �r) r> r' r' r* �
on_messageR r, z _WebSocketDelegate.on_messager# c C r% r& r' r( r' r' r* �on_pingU r, z_WebSocketDelegate.on_pingc C r% r& r' r( r' r' r* �on_pongX r, z_WebSocketDelegate.on_pong�typ�value�tbc C r% r& r' �r) rC rD rE r' r' r* �
log_exception[ s z _WebSocketDelegate.log_exception�NN)r/ r0 r1 r r3 �strr= r r2 r@ rA rB r �
BaseExceptionr rG r' r' r' r* r9 I s* ���
�
����r9 i � c @ � e Zd ZdS )�WebSocketErrorN�r/ r0 r1 r' r' r' r* rL j � rL c @ s e Zd ZdZdS )�WebSocketClosedErrorzLRaised by operations on a closed connection.
.. versionadded:: 3.2
N)r/ r0 r1 �__doc__r' r' r' r* rO n s rO c @ rK )�_DecompressTooLargeErrorNrM r' r' r' r* rQ w rN rQ c @ sH e Zd Zddedfdee dee dedeeee f ddf
dd�Z
dS ) �_WebSocketParamsN�
ping_interval� ping_timeout�max_message_size�compression_optionsr$ c C s || _ || _|| _|| _d S r& �rS rT rU rV )r) rS rT rU rV r' r' r* �__init__| s
z_WebSocketParams.__init__) r/ r0 r1 �_default_max_message_sizer �floatr3 r rI r rX r' r' r' r* rR { s ������rR c s* e Zd ZdZdejjdejde ddf� fdd� Z
d e de ddfd
d �Z e de
e fd d
��Ze de
e fdd��Ze defdd��Z dDdeeeeee f f deddfdd�Zdee de
e fdd�Ze de
e fdd ��Zde
eee f fd d �Z d edede
e d fd d �Z deeef de
e d fd!d"�Z dEd$eeef ddfd%d&�Z d$eddfd'd(�Z!d$eddfd)d*�Z"dFd+d,�Z#dGd-e
e d.e
e ddfd/d0�Z$d1edefd2d3�Z%d4eddfd5d6�Z&dFd7d8�Z' dGd9e
e d:e
e ddfd;d<�Z(dF� fd=d>� Z)de
d? fd@dA�Z*de+fdBdC�Z,� Z-S )H�WebSocketHandleraN
Subclass this class to create a basic WebSocket handler.
Override `on_message` to handle incoming messages, and use
`write_message` to send messages to the client. You can also
override `open` and `on_close` to handle opened and closed
connections.
Custom upgrade response headers can be sent by overriding
`~tornado.web.RequestHandler.set_default_headers` or
`~tornado.web.RequestHandler.prepare`.
See http://dev.w3.org/html5/websockets/ for details on the
JavaScript interface. The protocol is specified at
http://tools.ietf.org/html/rfc6455.
Here is an example WebSocket handler that echos back all received messages
back to the client:
.. testcode::
class EchoWebSocket(tornado.websocket.WebSocketHandler):
def open(self):
print("WebSocket opened")
def on_message(self, message):
self.write_message(u"You said: " + message)
def on_close(self):
print("WebSocket closed")
WebSockets are not standard HTTP connections. The "handshake" is
HTTP, but after the handshake, the protocol is
message-based. Consequently, most of the Tornado HTTP facilities
are not available in handlers of this type. The only communication
methods available to you are `write_message()`, `ping()`, and
`close()`. Likewise, your request handler class should implement
`open()` method rather than ``get()`` or ``post()``.
If you map the handler above to ``/websocket`` in your application, you can
invoke it in JavaScript with::
var ws = new WebSocket("ws://localhost:8888/websocket");
ws.onopen = function() {
ws.send("Hello, world");
};
ws.onmessage = function (evt) {
alert(evt.data);
};
This script pops up an alert box that says "You said: Hello, world".
Web browsers allow any site to open a websocket connection to any other,
instead of using the same-origin policy that governs other network
access from JavaScript. This can be surprising and is a potential
security hole, so since Tornado 4.0 `WebSocketHandler` requires
applications that wish to receive cross-origin websockets to opt in
by overriding the `~WebSocketHandler.check_origin` method (see that
method's docs for details). Failure to do so is the most likely
cause of 403 errors when making a websocket connection.
When using a secure websocket connection (``wss://``) with a self-signed
certificate, the connection from a browser may fail because it wants
to show the "accept this certificate" dialog but has nowhere to show it.
You must first visit a regular HTML page using the same certificate
to accept it before the websocket connection will succeed.
If the application setting ``websocket_ping_interval`` has a non-zero
value, a ping will be sent periodically, and the connection will be
closed if a response is not received before the ``websocket_ping_timeout``.
Both settings are in seconds; floating point values are allowed.
The default timeout is equal to the interval.
Messages larger than the ``websocket_max_message_size`` application setting
(default 10MiB) will not be accepted.
.. versionchanged:: 4.5
Added ``websocket_ping_interval``, ``websocket_ping_timeout``, and
``websocket_max_message_size``.
� application�request�kwargsr$ Nc s2 t � j||fi |�� d | _d | _d | _d| _d S �NF)�superrX �
ws_connectionr: r; �_on_close_called)r) r\ r] r^ �� __class__r' r* rX � s
zWebSocketHandler.__init__�argsc � sD �|| _ || _| jj�dd��� dkr&| �d� d}| �|� t� |� d S | jj}t
dd� |�dd�� d ��}d
|vrO| �d� d }| �|� t� |� d S d | jjv r]| jj�d �}n| jj�d
d �}|d ur�| � |�s�| �d� d}| �|� t� |� d S | �
� | _| jr�| j�| �I d H d S | �dd� | �dd� d S )N�Upgrade� � websocket� z"Can "Upgrade" only to "WebSocket".c S s | � � �� S r& )�strip�lower)�sr' r' r* �<lambda>� s z&WebSocketHandler.get.<locals>.<lambda>�
Connection�,�upgradez "Connection" must be "Upgrade".ZOriginzSec-Websocket-Origini� z#Cross origin websockets not allowedi� zUpgrade Required�Sec-WebSocket-Versionz7, 8, 13)� open_args� open_kwargsr] �headers�getrk �
set_status�finishr �debug�map�split� check_origin�get_websocket_protocolra �accept_connection�
set_header)r) re r^ �log_msgrt �
connection�originr' r' r* ru � sB �
�
zWebSocketHandler.getc C � | j �dd�S )a� The interval for sending websocket pings.
If this is non-zero, the websocket will send a ping every
ping_interval seconds.
The client will respond with a "pong". The connection can be configured
to timeout on late pong delivery using ``websocket_ping_timeout``.
Set ``websocket_ping_interval = 0`` to disable pings.
Default: ``0``
Zwebsocket_ping_intervalN��settingsru �r) r' r' r* rS s
z WebSocketHandler.ping_intervalc C r� )a- Timeout if no pong is received in this many seconds.
To be used in combination with ``websocket_ping_interval > 0``.
If a ping response (a "pong") is not received within
``websocket_ping_timeout`` seconds, then the websocket connection
will be closed.
This can help to clean up clients which have disconnected without
cleanly closing the websocket connection.
Note, the ping timeout cannot be longer than the ping interval.
Set ``websocket_ping_timeout = 0`` to disable the ping timeout.
Default: equal to the ``ping_interval``.
.. versionchanged:: 6.5.0
Default changed from the max of 3 pings or 30 seconds.
The ping timeout can no longer be configured longer than the
ping interval.
Zwebsocket_ping_timeoutNr� r� r' r' r* rT ) s z WebSocketHandler.ping_timeoutc C s | j �dt�S )z�Maximum allowed message size.
If the remote peer sends a message larger than this, the connection
will be closed.
Default is 10MiB.
Zwebsocket_max_message_size)r� ru rY r� r' r' r* rU B s �z!WebSocketHandler.max_message_sizeFr> �binary� Future[None]c C s@ | j du s
| j �� r
t� �t|t�rtj�|�}| j j||d�S )aH Sends the given message to the client of this Web Socket.
The message may be either a string or a dict (which will be
encoded as json). If the ``binary`` argument is false, the
message will be sent as utf8; in binary mode any byte string
is allowed.
If the connection is already closed, raises `WebSocketClosedError`.
Returns a `.Future` which can be used for flow control.
.. versionchanged:: 3.2
`WebSocketClosedError` was added (previously a closed connection
would raise an `AttributeError`)
.. versionchanged:: 4.3
Returns a `.Future` which can be used for flow control.
.. versionchanged:: 5.0
Consistently raises `WebSocketClosedError`. Previously could
sometimes raise `.StreamClosedError`.
N�r� ) ra �
is_closingrO �
isinstance�dict�tornado�escape� json_encode�
write_message�r) r> r� r' r' r* r� O s
z WebSocketHandler.write_message� subprotocolsc C � dS )a� Override to implement subprotocol negotiation.
``subprotocols`` is a list of strings identifying the
subprotocols proposed by the client. This method may be
overridden to return one of those strings to select it, or
``None`` to not select a subprotocol.
Failure to select a subprotocol does not automatically abort
the connection, although clients may close the connection if
none of their proposed subprotocols was selected.
The list may be empty, in which case this method must return
None. This method is always called exactly once even if no
subprotocols were proposed so that the handler can be advised
of this fact.
.. versionchanged:: 5.1
Previously, this method was called with a list containing
an empty string instead of an empty list if no subprotocols
were proposed by the client.
Nr' )r) r� r' r' r* �select_subprotocolm s z#WebSocketHandler.select_subprotocolc C s | j dusJ �| j jS )zYThe subprotocol returned by `select_subprotocol`.
.. versionadded:: 5.1
N)ra �selected_subprotocolr� r' r' r* r� � s z%WebSocketHandler.selected_subprotocolc C r� )a� Override to return compression options for the connection.
If this method returns None (the default), compression will
be disabled. If it returns a dict (even an empty one), it
will be enabled. The contents of the dict may be used to
control the following compression options:
``compression_level`` specifies the compression level.
``mem_level`` specifies the amount of memory used for the internal compression state.
These parameters are documented in detail here:
https://docs.python.org/3.13/library/zlib.html#zlib.compressobj
.. versionadded:: 4.1
.. versionchanged:: 4.5
Added ``compression_level`` and ``mem_level``.
Nr' r� r' r' r* �get_compression_options� s z(WebSocketHandler.get_compression_optionsc O r� )a� Invoked when a new WebSocket is opened.
The arguments to `open` are extracted from the `tornado.web.URLSpec`
regular expression, just like the arguments to
`tornado.web.RequestHandler.get`.
`open` may be a coroutine. `on_message` will not be called until
`open` has returned.
.. versionchanged:: 5.1
``open`` may be a coroutine.
Nr' )r) re r^ r' r' r* �open� s zWebSocketHandler.openc C s t �)z�Handle incoming messages on the WebSocket
This method must be overridden.
.. versionchanged:: 4.5
``on_message`` can be a coroutine.
��NotImplementedErrorr? r' r' r* r@ � s zWebSocketHandler.on_messager5 r# c C s2 t |�}| jdu s| j�� rt� �| j�|� dS )a� Send ping frame to the remote end.
The data argument allows a small amount of data (up to 125
bytes) to be sent as a part of the ping message. Note that not
all websocket implementations expose this data to
applications.
Consider using the ``websocket_ping_interval`` application
setting instead of sending pings manually.
.. versionchanged:: 5.1
The data argument is now optional.
N)r ra r� rO �
write_pingr( r' r' r* �ping� s zWebSocketHandler.pingc C r� )z6Invoked when the response to a ping frame is received.Nr' r( r' r' r* rB � � zWebSocketHandler.on_pongc C r� )z*Invoked when the a ping frame is received.Nr' r( r' r' r* rA � r� zWebSocketHandler.on_pingc C r� )a` Invoked when the WebSocket is closed.
If the connection was closed cleanly and a status code or reason
phrase was supplied, these values will be available as the attributes
``self.close_code`` and ``self.close_reason``.
.. versionchanged:: 4.0
Added ``close_code`` and ``close_reason`` attributes.
Nr' r� r' r' r* �on_close� s zWebSocketHandler.on_close�code�reasonc C s" | j r| j �||� d| _ dS dS )aC Closes this Web Socket.
Once the close handshake is successful the socket will be closed.
``code`` may be a numeric status code, taken from the values
defined in `RFC 6455 section 7.4.1
<https://tools.ietf.org/html/rfc6455#section-7.4.1>`_.
``reason`` may be a textual message about why the connection is
closing. These values are made available to the client, but are
not otherwise interpreted by the websocket protocol.
.. versionchanged:: 4.0
Added the ``code`` and ``reason`` arguments.
N)ra �close�r) r� r� r' r' r* r� � s
�zWebSocketHandler.closer� c C s, t |�}|j}|�� }| jj�d�}||kS )a� Override to enable support for allowing alternate origins.
The ``origin`` argument is the value of the ``Origin`` HTTP
header, the url responsible for initiating this request. This
method is not called for clients that do not send this header;
such requests are always allowed (because all browsers that
implement WebSockets support this header, and non-browser
clients do not have the same cross-site security concerns).
Should return ``True`` to accept the request or ``False`` to
reject it. By default, rejects all requests with an origin on
a host other than this one.
This is a security protection against cross site scripting attacks on
browsers, since WebSockets are allowed to bypass the usual same-origin
policies and don't use CORS headers.
.. warning::
This is an important security measure; don't disable it
without understanding the security implications. In
particular, if your authentication is cookie-based, you
must either restrict the origins allowed by
``check_origin()`` or implement your own XSRF-like
protection for websocket connections. See `these
<https://www.christian-schneider.net/CrossSiteWebSocketHijacking.html>`_
`articles
<https://devcenter.heroku.com/articles/websocket-security>`_
for more.
To accept all cross-origin traffic (which was the default prior to
Tornado 4.0), simply override this method to always return ``True``::
def check_origin(self, origin):
return True
To allow connections from any subdomain of your site, you might
do something like::
def check_origin(self, origin):
parsed_origin = urllib.parse.urlparse(origin)
return parsed_origin.netloc.endswith(".mydomain.com")
.. versionadded:: 4.0
�Host)r �netlocrk r] rt ru )r) r� Z
parsed_origin�hostr' r' r* r{ s
/z WebSocketHandler.check_originrD c C s | j dusJ �| j �|� dS )a1 Set the no-delay flag for this stream.
By default, small messages may be delayed and/or combined to minimize
the number of packets sent. This can sometimes cause 200-500ms delays
due to the interaction between Nagle's algorithm and TCP delayed
ACKs. To reduce this delay (at the expense of possibly increasing
bandwidth usage), call ``self.set_nodelay(True)`` once the websocket
connection is established.
See `.BaseIOStream.set_nodelay` for additional details.
.. versionadded:: 3.1
N)ra � set_nodelay�r) rD r' r' r* r� 8 s z WebSocketHandler.set_nodelayc C s: | j r | j �� d | _ | jsd| _| �� | �� d S d S )NT)ra �on_connection_closerb r� �
_break_cyclesr� r' r' r* r� I s
�z$WebSocketHandler.on_connection_closer: r; c C � || _ || _| �� d S r& �r: r; r� r< r' r' r* r= R � z'WebSocketHandler.on_ws_connection_closec s$ | � � dks | jrt� �� d S d S �N�e )Z
get_statusrb r` r� r� rc r' r* r� Y s �z WebSocketHandler._break_cycles�WebSocketProtocolc C s@ | j j�d�}|dv r t| j| j| j| �� d�}t| d|�S d S )Nrq )�7�8�13rW F) r] rt ru rR rS rT rU r� �WebSocketProtocol13)r) Zwebsocket_version�paramsr' r' r* r| b s � z'WebSocketHandler.get_websocket_protocolc C s dD ]}t | |t� q| �� S )N)�writeZredirectr~ Z
set_cookierv r. rw )�setattr�#_raise_not_supported_for_websockets�detach)r) �methodr' r' r* �_detach_streamn s z WebSocketHandler._detach_stream�F�r5 �r$ NrH ).r/ r0 r1 rP r� �webZ Applicationr
ZHTTPServerRequestr rX ru �propertyr rZ rS rT r3 rU r r2 rI r �boolr� r r� r� r� r r� r@ r� rB rA r� r� r{ r� r� r= r� r| r
r� �
__classcell__r' r' rc r* r[ � sf P���� 4
���
� "
8
���
� r[ re r^ r$ c O s t d��)Nz$Method not supported for Web Sockets)� RuntimeError)re r^ r' r' r* r� } s r� c @ s^ e Zd ZdZd0dd�Zded ed
edd fd d
�Zd1dd�Zd1dd�Z e
j d2de e
de e ddfdd��Ze
j defdd��Ze
j deddfdd��Ze
j d3deeeeeef f d edd fd d ��Zee
j de e fd d!���Ze
j d"eddfd#d$��Ze
j d%eeef d&ej ddfd'd(��Z e
j d1d)d*��Z e
j d1d+d,��Z e
j d-eddfd.d/��Z dS )4r� z+Base class for WebSocket protocol versions.�handlerr9 r$ Nc C s || _ d | _d| _d| _d S r_ )r� �stream�client_terminated�server_terminated�r) r� r' r' r* rX � s
zWebSocketProtocol.__init__�callbackre r^ zOptional[Future[Any]]c O sx z ||i |��}W n t y | jjt�� � | �� Y dS w |dur:t�|�}| jdus0J �| jj �
|dd� � |S )z�Runs the given callback with exception handling.
If the callback is a coroutine, returns its Future. On error, aborts the
websocket connection and returns None.
Nc S s | � � S r& )�result��fr' r' r* rm � s z1WebSocketProtocol._run_callback.<locals>.<lambda>) � Exceptionr� rG �sys�exc_info�_abortr Zconvert_yieldedr� �io_loop�
add_future)r) r� re r^ r� r' r' r* �
_run_callback� s �
z WebSocketProtocol._run_callbackc C s | � � d S r& )r� r� r' r' r* r� � s z%WebSocketProtocol.on_connection_closec C s, d| _ d| _| jdur| j�� | �� dS )z?Instantly aborts the WebSocket connection by closing the socketTN)r� r� r� r� r� r' r' r* r� � s
zWebSocketProtocol._abortr� r� c C � t � �r& r� r� r' r' r* r� � � zWebSocketProtocol.closec C r� r& r� r� r' r' r* r� � r� z WebSocketProtocol.is_closingc � � �t � �r& r� r� r' r' r* r} � � �z#WebSocketProtocol.accept_connectionFr> r� r� c C r� r& r� r� r' r' r* r� � � z WebSocketProtocol.write_messagec C r� r& r� r� r' r' r* r� � s z&WebSocketProtocol.selected_subprotocolr# c C r� r& r� r( r' r' r* r� � r� z WebSocketProtocol.write_ping�keyrt c C r� r& r� )r) r� rt r' r' r* �_process_server_headers� r� z)WebSocketProtocol._process_server_headersc C r� r& r� r� r' r' r* �
start_pinging� r� z WebSocketProtocol.start_pingingc � r� r& r� r� r' r' r* �_receive_frame_loop� r� z%WebSocketProtocol._receive_frame_loop�xc C r� r& r� �r) r� r' r' r* r� � r� z WebSocketProtocol.set_nodelay)r� r9 r$ Nr� rH r� )!r/ r0 r1 rP rX r r r� r� r� �abc�abstractmethodr r3 rI r� r� r� r[ r} r r2 r r� r� r� r� r
� HTTPHeadersr� r� r� r� r' r' r' r* r� � s`
���
�
"��� �
�� � r� c
@ sV e Zd Z ddedee deeeef ddfdd�Z dd d
�Z
d e de fd d
�Z dS )� _PerMessageDeflateCompressorN�
persistent� max_wbitsrV r$ c C s� |d u rt j}d| krt jksn td|t j��|| _|d u s%d|vr,tjjj| _n|d | _|d u s9d|vr=d| _ n|d | _ |rK| �
� | _ d S d | _ d S )N� �.Invalid max_wbits value %r; allowed range 8-%dZcompression_levelZ mem_level) �zlib� MAX_WBITS�
ValueError�
_max_wbitsr� r� ZGZipContentEncodingZ
GZIP_LEVEL�_compression_level�
_mem_level�_create_compressor� _compressor)r) r� r� rV r' r' r* rX � s& �
z%_PerMessageDeflateCompressor.__init__r" c C s t �| jt j| j | j�S r& )r� � compressobjr� �DEFLATEDr� r� r� r' r' r* r� � �z/_PerMessageDeflateCompressor._create_compressorr# c C s> | j p| �� }|�|�|�tj� }|�d�sJ �|d d� S )N� �����)r� r� r+ r. r� � Z_SYNC_FLUSH�endswith)r) r# Z
compressorr' r' r* r+ s z%_PerMessageDeflateCompressor.compressr& )r$ r" )
r/ r0 r1 r� r r3 r rI r rX r� r2 r+ r' r' r' r* r� � s ����
�
#r� c @ sZ e Zd Z ddedee dedeeeef ddf
dd�Z dd
d �Z
d e de fd
d�Z dS )� _PerMessageDeflateDecompressorNr� r� rU rV r$ c C s\ || _ |d u r
tj}d| krtjks n td|tj��|| _|r)| �� | _d S d | _d S )Nr� r� )�_max_message_sizer� r� r� r� �_create_decompressor�
_decompressor)r) r� r� rU rV r' r' r* rX
s ��
z'_PerMessageDeflateDecompressor.__init__r4 c C s t �| j �S r& )r� �
decompressobjr� r� r' r' r* r� % s z3_PerMessageDeflateDecompressor._create_decompressorr# c C s0 | j p| �� }|�|d | j�}|jrt� �|S )Nr� )r� r� r7 r� r8 rQ )r) r# Z decompressorr� r' r' r* r7 ( s
�z)_PerMessageDeflateDecompressor.decompressr& )r$ r4 )
r/ r0 r1 r� r r3 r rI r rX r� r2 r7 r' r' r' r* r� s �����
�
r� c @ s� e Zd ZdZdZdZdZdZeeB eB ZdZ dZ
dd d
e d e d dfd
d�Z
ed ee fdd��Zejdee d dfdd��Zded dfdd�Zded dfdd�Zedeeef d efdd��Zded efdd�Zded dfd d �Zd e j d e e ee eef f fd d �Z!deeef d e j d dfd!d"�Z" dYd#ed$e ee#f d%ee ee#f d e ee#f fd&d'�Z$ dYd#ed$e ee#f d%ee ee#f d dfd(d)�Z% *dZd+e d,e&d-ed.e&d d/f
d0d1�Z' 2d[d3eeee ee#f f d4e d d/fd5d6�Z(d-ed dfd7d8�Z)d\d9d:�Z*d;e&d efd<d=�Z+d\d>d?�Z,d,e&d-ed d@fdAdB�Z-d]dCee& dDee d dfdEdF�Z.d e fdGdH�Z/dIe d dfdJdK�Z0ed e1fdLdM��Z2ed e1fdNdO��Z3d\dPdQ�Z4edRe1dSe1dTe1d e1fdUdV��Z5d\dWdX�Z6dS )^r� z�Implementation of the WebSocket protocol from RFC 6455.
This class supports versions 7 and 8 of the protocol in addition to the
final version 13.
� �@ � � � Nr� r9 �
mask_outgoingr� r$ c C s� t �| |� || _|| _d| _d | _d | _d | _d | _d | _ d | _
d | _ |j | _
d | _d | _d | _d| _d| _d| _d| _d| _d | _d | _d | _d S )NFr )r� rX r� r� Z _final_frameZ
_frame_opcodeZ
_masked_frame� _frame_mask�
_frame_length�_fragmented_message_buffer�_fragmented_message_opcode�_waitingrV �_compression_optionsr� r� �_frame_compressed�_message_bytes_in�_message_bytes_out�_wire_bytes_in�_wire_bytes_out�_received_pongr: r; �_ping_coroutine)r) r� r� r� r' r' r* rX C s.
z WebSocketProtocol13.__init__c C s | j S r& �Z_selected_subprotocolr� r' r' r* r� g r� z(WebSocketProtocol13.selected_subprotocolrD c C s
|| _ d S r& r r� r' r' r* r� k s
c � s� �z| � |� W n ty# |�d� d}|�|� t�|� Y d S w z | �|�I d H W d S tjy> | � � Y d S tyR tjddd� | � � Y d S w )Nri �!Missing/Invalid WebSocket headersz$Malformed WebSocket request receivedT�r� )
�_handle_websocket_headersr� rv rw r rx �_accept_connection�asyncioZCancelledErrorr� )r) r� r r' r' r* r} o s( �
� �z%WebSocketProtocol13.accept_connectionc s& d}t t� fdd�|��std��dS )z�Verifies all invariant- and required headers
If a header is missing or have an incorrect value ValueError will be
raised
)r� �Sec-Websocket-KeyzSec-Websocket-Versionc s � j j�| �S r& )r] rt ru r� �r� r' r* rm � s z?WebSocketProtocol13._handle_websocket_headers.<locals>.<lambda>r N)�allry r� )r) r� �fieldsr' r r* r � s �z-WebSocketProtocol13._handle_websocket_headersr� c C s2 t �� }|�t| �� |�d� tt�|�� ��S )zoComputes the value for the Sec-WebSocket-Accept header,
given the value for Sec-WebSocket-Key.
s$ 258EAFA5-E914-47DA-95CA-C5AB0DC85B11)�hashlib�sha1�updater r �base64� b64encode�digest)r� r r' r' r* �compute_accept_value� s
z(WebSocketProtocol13.compute_accept_valuec C s t �tt|jj�d���S )Nr )r� r r rI r] rt ru r� r' r' r* �_challenge_response� r� z'WebSocketProtocol13._challenge_responsec � s� �|j j�d�}|rdd� |�d�D �}ng }|�|�| _| jr.| j|v s'J �|�d| j� | �|j j�}|D ]8}|d dkro| jd uro| � d|d | j� d |d v ra|d d d u ra|d d = |�d
t
� d|d �� nq7|� d � |�
d � |�d
d� |�dd
� |�d| �|�� |�� |�� | _| �� z|j|ji |j��}|d ur�|I d H W n ty� |jt�� � | �� Y d S w | �� I d H d S )N�Sec-WebSocket-Protocolc S s g | ]}|� � �qS r' )rj )�.0rl r' r' r* �
<listcomp>� s z:WebSocketProtocol13._accept_connection.<locals>.<listcomp>ro r �permessage-deflate�server� �client_max_window_bits�Sec-WebSocket-Extensionsz Content-Typer� rf rh rn zSec-WebSocket-Accept) r] rt ru rz r� r� r~ �_parse_extensions_headerr �_create_compressorsr
Z_encode_headerZ clear_headerrv r rw r� r� r� r� rr rs r� rG r� r� r� r� )r) r� Zsubprotocol_headerr� �
extensions�extZ open_resultr' r' r* r � sR �
��
� �z&WebSocketProtocol13._accept_connectionrt c C s( |� dd�}|rdd� |�d�D �S g S )Nr$ rg c S s g | ] }t �|�� ��qS r' )r
Z
_parse_headerrj )r �er' r' r* r � s z@WebSocketProtocol13._parse_extensions_header.<locals>.<listcomp>ro )ru rz )r) rt r' r' r' r* r% � s z,WebSocketProtocol13._parse_extensions_headerc C s� |d � � dks
J �|d � � dksJ �| �|�}|d |ks!J �| �|�}|D ]}|d dkr>| jdur>| �d |d
� q(td |��|�d d�| _dS )
z�Process the headers sent by the server to this client connection.
'key' is the websocket handshake challenge/response key.
rf rh rn rp zSec-Websocket-Acceptr r N�clientr" zunsupported extension %rr )rk r r% r r& r� ru r� )r) r� rt �acceptr' r( r' r' r* r� � s
z+WebSocketProtocol13._process_server_headers�side�agreed_parametersrV c C sN t |d |vd�}|�|d d�}|du rtj|d< nt|�|d< ||d< |S )zlConverts a websocket agreed_parameters set to keyword arguments
for our compressor objects.
Z_no_context_takeover)r� Z_max_window_bitsNr� rV )r� ru r� r� r3 )r) r, r- rV �optionsZ wbits_headerr' r' r* �_get_compressor_options� s
� z+WebSocketProtocol13._get_compressor_optionsc C sv h d�}|D ] }||vrt d| ��q|dkrdnd}tdi | �|||���| _tdd| jji| �|||���| _d S )N> r# Zclient_no_context_takeoverZserver_max_window_bitsZserver_no_context_takeoverz$unsupported compression parameter %rr! r* rU r' )r� r� r/ r� r� r� rU r� )r) r, r- rV Z allowed_keysr� Z
other_sider' r' r* r& s � ��� �z'WebSocketProtocol13._create_compressorsr �fin�opcoder# �flagsr� c
C s� t |�}|d@ r|std��|dkrtd��|r | j}nd}t�d||B |B �}| jr.d}nd}|dk r?|t�d||B �7 }n|d krO|t�d
d|B |�7 }n |t�d d |B |�7 }| jrit�d
�} | t| |� }||7 }| j t |�7 _ | j
� |�S )Nr� z$control frames may not be fragmented�} z/control frame payloads may not exceed 125 bytesr �Br� �~ i�� z!BHz!BQ� � ) �lenr� �FIN�struct�packr� �os�urandomr r r� r� )
r) r0 r1 r# r2 Zdata_lenZfinbit�frameZmask_bit�maskr' r' r* � _write_frame s0
z WebSocketProtocol13._write_frameFr> r� c s� |rd}nd}t |t�rtj�|�}tj�|�}t |t�s J �| jt|�7 _d}| j r8| j �
|�}|| j O }z | j d|||d�� W n
t
yM t� �w d
� fdd � }t�|� �S ) z9Sends the given message to the client of this Web Socket.� r" r T)r2 r$ Nc � s( �z� I d H W d S t y t� �w r& )r rO r' �Zfutr' r* �wrapperW s � �z2WebSocketProtocol13.write_message.<locals>.wrapperr� )r� r� r� r� r� r r2 r r8 r� r+ �RSV1r@ r rO r �
ensure_future)r) r> r� r1 r2 rC r' rB r* r� < s&
� z!WebSocketProtocol13.write_messagec C s t |t�sJ �| �dd|� dS )zSend ping frame.T� N)r� r2 r@ r( r' r' r* r� _ s z WebSocketProtocol13.write_pingc � sR �z| j s| �� I d H | j rW n
ty | �� Y nw | j�| j| j� d S r& )r� �_receive_framer r� r� r= r: r; r� r' r' r* r� d s ��� �z'WebSocketProtocol13._receive_frame_loop�nc � s& �| j �|�I d H }| j|7 _|S r& )r� �
read_bytesr )r) rH r# r' r' r* � _read_bytesl s �z WebSocketProtocol13._read_bytesc � sT �| � d�I d H }t�d|�\}}|| j@ }|| j@ }|| j@ }|d@ }| jd ur;|dkr;t|| j@ �| _ || j M }|rC| �
� d S t|d@ �}|d@ } |rY| dkrY| �
� d S | dk ra| | _ n)| dkrv| � d�I d H }t�d|�d } n| dkr�| � d�I d H }t�d |�d } | }
| j d ur�|
t
| j �7 }
|
| jjkr�| �d
d � | �
� d S |r�| � d �I d H | _| � | �I d H }|r�| jd us�J �t| j|�}|r�|s�| �
� d S n:|dkr�| j d u r�| �
� d S | j �|� |r�| j}t| j �}d | _ n| j d u�r| �
� d S |�s|| _t|�| _ |�r&| �||�} | d u�r(| I d H d S d S d S )
NrA ZBBr� r r� r6 r5 z!Hz!Q�� zmessage too bigr7 )rJ r: �unpackr9 �RSV_MASK� OPCODE_MASKr� r� rD r r� r� r r8 r� rU r� r� r �extendr r2 � bytearray�_handle_message) r) r# �headerZmask_payloadlenZis_final_frameZ
reserved_bitsr1 Zopcode_is_controlZ is_maskedZ
payloadlenZnew_lenZhandled_futurer' r' r* rG q s� �
�
�
�z"WebSocketProtocol13._receive_framezOptional[Future[None]]c C s� | j rdS | jr,| jdusJ �z| j�|�}W n ty+ | �dd� | �� Y dS w |dkrW| jt|�7 _z|� d�}W n t
yN | �� Y dS w | � | j j
|�S |dkrl| jt|�7 _| � | j j
|�S |dkr�d| _ t|�dkr�t�d |dd� �d
| _t|�dkr�t|dd� �| _| �| j� dS |d kr�z | �dd |� W n
ty� | �� Y nw | � | j j|� dS |d kr�d| _| � | j j|�S | �� dS )
z>Execute on_message, returning its Future if it is a coroutine.NrK z#message too big after decompressionr" zutf-8rA r� T�>Hr rF �
)r� r r� r7 rQ r� r� r r8 �decode�UnicodeDecodeErrorr� r� r@ r: rL r: r r; r@ r rA r rB )r) r1 r# �decodedr' r' r* rQ � sX � � � ��z#WebSocketProtocol13._handle_messager� r� c C s | j sC| j�� s@|du r|durd}|du rd}nt�d|�}|dur)|t|�7 }z | �dd|� W n
ty? | �� Y nw d| _ | j r\| j
durV| jj � | j
� d| _
| j�
� n| j
du rq| jj �| jj �� d | j�| _
| jr~| j�� d| _dS dS )z Closes the WebSocket connection.Ni� r5 rS Tr� � )r� r� �closedr: r; r r@ r r� r� r r� �remove_timeoutr� Z add_timeout�timer
�cancel)r) r� r� Z
close_datar' r' r* r� � s8
�
�
�zWebSocketProtocol13.closec C s | j �� p
| jp
| jS )z�Return ``True`` if this connection is closing.
The connection is considered closing if either side has
initiated its closing handshake or if the stream has been
shut down uncleanly.
)r� rY r� r� r� r' r' r* r� s z WebSocketProtocol13.is_closingr� c C s | j �|� d S r& )r� r� r� r' r' r* r� � z WebSocketProtocol13.set_nodelayc C s | j j}|d ur
|S dS )Nr )r� rS )r) �intervalr' r' r* rS # s z!WebSocketProtocol13.ping_intervalc C sR | j j}|d ur&| jr$|| jkr$ttjd|� d| j� d| j� �� | jS |S | jS )Nz The websocket_ping_timeout (z5) cannot be longer than the websocket_ping_interval (z").
Setting websocket_ping_timeout=)r� rT rS �de_dupe_gen_log�logging�WARNING)r) �timeoutr' r' r* rT * s ���z WebSocketProtocol13.ping_timeoutc C s, | j s| jdkrt�| �� �| _ dS dS dS )z9Start sending periodic pings to keep the connection aliver N)r
rS r Z create_task�
periodic_pingr� r' r' r* r� ; s �
�z!WebSocketProtocol13.start_pinging�last_ping_timer^ �nowc C s t d| | | �S )z<Calculate the sleep time until the next ping should be sent.r )�max�rd r^ re r' r' r* �ping_sleep_timeE s z#WebSocketProtocol13.ping_sleep_timec � s� �| j }| j}t�|�I dH d| _t�� �� }| �d� t�|�I dH |dkr5| js5| j dd� dS t�| j
||t�� �� d��I dH q) z�Send a ping and wait for a pong if ping_timeout is configured.
Called periodically if the websocket_ping_interval is set and non-zero.
NTFr5 r zping timed out)r� rg ) rS rT r �sleepr r �currentr[ r� r� rh )r) r^ rb Z ping_timer' r' r* rc J s( �
�
��z!WebSocketProtocol13.periodic_pingr& )r r� r� rH )7r/ r0 r1 rP r9 rD ZRSV2ZRSV3rM rN r� r� rR rX r� r rI r� �setterr[ r} r � staticmethodr r2 r r r r
r� r r r r% r� r r/ r& r3 r@ r� r� r� rJ rG rQ r� r� r� rZ rS rT r� rh rc r' r' r' r* r� 2 s� ���
�$
3�
�
��
���
��
���
��
� �����
�"���
�#
S 3
r� c sL e Zd ZdZdZddddeddfdejdee e
de e f gdf dee
e ef dee dee ded eee d
ee d df� fd d
�
ZdAdd�ZdBdee dee d dfdd�ZdA� fdd� Z dBdee dee d dfdd�Zdejd dfdd �Zd e
ejej f d ej d df� fd d � Z !dCd"e
e e e
e ef f d#e d d$fd%d&�Z dDd'ee d(gdf d e!e
de e f fd)d*�Z"d"e
e e f d ee!d fd+d,�Z#d"e
de e f d ee!d fd-d.�Z$dEd0e d dfd1d2�Z%d0e d dfd3d4�Z&d0e d dfd5d6�Z'd e(fd7d8�Z)e*d ee fd9d:��Z+d;d<d=ee, d>ee- d dfd?d@�Z.� Z/S )F�WebSocketClientConnectionz�WebSocket client connection.
This class should not be instantiated directly; use the
`websocket_connect` function instead.
Nr] �on_message_callbackrV rS rT rU r� �resolverr$ c
s� t � | _td�| _t�t�d��| _|| _ d | _
d | _ t ||||d�| _
|j�d�\} }
} ddd�| } | |
| |_|j�dd t| j�d
d �� |d urUd �|�|jd
< |d ur^d|jd< d|_t|d�| _t� �d |dd� | jd| jdd� d S )Nr" r� rW �:�http�https)�ws�wssrh rf r� )rf rn zSec-WebSocket-Keyrq ro r z*permessage-deflate; client_max_window_bitsr$ F)ro c S r% r& r' r' r' r' r* rm � s z4WebSocketClientConnection.__init__.<locals>.<lambda>i @i )r �connect_futurer �
read_queuer r r< r= r� �_on_message_callbackr: r; rR r� �url� partitionrt r r �joinZfollow_redirectsr �
tcp_clientr` rX �_on_http_response) r) r] rn rV rS rT rU r� ro �scheme�sep�restrc r' r* rX u sN
���� �z"WebSocketClientConnection.__init__c C s | j d ur
t�dt� d S d S )Nz"Unclosed WebSocketClientConnection)�protocol�warnings�warn�ResourceWarningr� r' r' r* �__del__� s
�z!WebSocketClientConnection.__del__r� r� c C s& | j dur| j �||� d| _ dS dS )z�Closes the websocket connection.
``code`` and ``reason`` are documented under
`WebSocketHandler.close`.
.. versionadded:: 3.2
.. versionchanged:: 4.0
Added the ``code`` and ``reason`` arguments.
N)r� r� r� r' r' r* r� � s
�z WebSocketClientConnection.closec s: | j �� s | j �t� � | �d � | j�� t� �� d S r& ) ru �done�
set_exceptionr � _on_messager{ r� r` r� r� rc r' r* r� � s
z-WebSocketClientConnection.on_connection_closer: r; c C r� r& r� r< r' r' r* r= � r� z0WebSocketClientConnection.on_ws_connection_close�responsec C s: | j �� s|jr| j �|j� d S | j �td�� d S d S )NzNon-websocket response)ru r� �errorr� rL )r) r� r' r' r* r| � s
��z+WebSocketClientConnection._on_http_response�
start_linert c � s� �t |tj�s J �|jdkrt� �||�I d H d S | jd ur)| j�| j� d | _|| _ | �
� | _ | j � | j
| j � | j�� | j _t�� �| j j� | j �� d | _t| j| � d S r� )r� r
�ResponseStartLiner� r` �headers_received�_timeoutr� rZ rt r| r� r� r� r� r� r� r rj Z add_callbackr� r� Zfinal_callbackr ru )r) r� rt rc r' r* r� � s �
z*WebSocketClientConnection.headers_receivedFr> r� r� c C s" | j du r td��| j j||d�S )aJ Sends a message to the WebSocket server.
If the stream is closed, raises `WebSocketClosedError`.
Returns a `.Future` which can be used for flow control.
.. versionchanged:: 5.0
Exception raised on a closed stream changed from `.StreamClosedError`
to `WebSocketClosedError`.
Nz!Client connection has been closedr� )r� rO r� r� r' r' r* r� s
z'WebSocketClientConnection.write_messager� z Future[Union[None, str, bytes]]c C s* | j �� }|dur| j�t�|�|� |S )ax Reads a message from the WebSocket server.
If on_message_callback was specified at WebSocket
initialization, this function will never return messages
Returns a future whose result is the message, or None
if the connection is closed. If a callback argument
is given it will be called with the future when it is
ready.
N)rv ru r� r� r rE )r) r� Z awaitabler' r' r* � read_message s
z&WebSocketClientConnection.read_messagec C s
| � |�S r& )r� r? r' r' r* r@ % s
z$WebSocketClientConnection.on_messagec C s | j r
| � |� d S | j�|�S r& )rw rv �putr? r' r' r* r� ( s
z%WebSocketClientConnection._on_messager5 r# c C s( t |�}| jdu r t� �| j�|� dS )a� Send ping frame to the remote end.
The data argument allows a small amount of data (up to 125
bytes) to be sent as a part of the ping message. Note that not
all websocket implementations expose this data to
applications.
Consider using the ``ping_interval`` argument to
`websocket_connect` instead of sending pings manually.
.. versionadded:: 5.1
N)r r� rO r� r( r' r' r* r� 1 s
z WebSocketClientConnection.pingc C r% r& r' r( r' r' r* rB D r, z!WebSocketClientConnection.on_pongc C r% r& r' r( r' r' r* rA G r, z!WebSocketClientConnection.on_pingc C s t | d| jd�S )NT)r� r� )r� r� r� r' r' r* r| J r] z0WebSocketClientConnection.get_websocket_protocolc C s | j jS )zOThe subprotocol selected by the server.
.. versionadded:: 5.1
)r� r� r� r' r' r* r� M s z.WebSocketClientConnection.selected_subprotocolrC z Optional[Type[BaseException]]rD rE c C s2 |d usJ �|d us J �t jd||||fd� d S )NzUncaught exception %sr
)r r� rF r' r' r* rG U s z'WebSocketClientConnection.log_exceptionr� rH r� r& r� )0r/ r0 r1 rP r� rY r � HTTPRequestr r r rI r2 r r rZ r3 r r rX r� r� r� r= � HTTPResponser| r
ZRequestStartLiner� r� r� r� r� r r� r@ r� r� rB rA r� r| r� r� rJ r rG r� r' r' rc r* rm l s� �������
� �
�
> ���
� ��� ���
���
�" �
� ����rm rx r� z!Future[WebSocketClientConnection]�connect_timeoutrn rV rS rT rU r� ro z$Awaitable[WebSocketClientConnection]c
C s� t | tj�r|du s J �| }
t�|
j�|
_ntj| |d�}
ttjt�|
tjj��}
t |
||||||| d�} |durJt
j dt dd� t
�� �| j|� | jS )aG Client-side websocket support.
Takes a url and returns a Future whose result is a
`WebSocketClientConnection`.
``compression_options`` is interpreted in the same way as the
return value of `.WebSocketHandler.get_compression_options`.
The connection supports two styles of operation. In the coroutine
style, the application typically calls
`~.WebSocketClientConnection.read_message` in a loop::
conn = yield websocket_connect(url)
while True:
msg = yield conn.read_message()
if msg is None: break
# Do something with msg
In the callback style, pass an ``on_message_callback`` to
``websocket_connect``. In both styles, a message of ``None``
indicates that the connection has been closed.
``subprotocols`` may be a list of strings specifying proposed
subprotocols. The selected protocol may be found on the
``selected_subprotocol`` attribute of the connection object
when the connection is complete.
.. versionchanged:: 3.2
Also accepts ``HTTPRequest`` objects in place of urls.
.. versionchanged:: 4.1
Added ``compression_options`` and ``on_message_callback``.
.. versionchanged:: 4.5
Added the ``ping_interval``, ``ping_timeout``, and ``max_message_size``
arguments, which have the same meaning as in `WebSocketHandler`.
.. versionchanged:: 5.0
The ``io_loop`` argument (deprecated since version 4.1) has been removed.
.. versionchanged:: 5.1
Added the ``subprotocols`` argument.
.. versionchanged:: 6.3
Added the ``resolver`` argument.
.. deprecated:: 6.5
The ``callback`` argument is deprecated and will be removed in Tornado 7.0.
Use the returned Future instead. Note that ``on_message_callback`` is not
deprecated and may still be used.
N)r� )rn rV rS rT rU r� ro zZThe callback argument to websocket_connect is deprecated. Use the returned Future instead.rA )�
stacklevel)r� r r� r
r� rt r Z
_RequestProxyZ _DEFAULTSrm r� r� �DeprecationWarningr rj r� ru ) rx r� r� rn rV rS rT rU r� ro r] �connr' r' r* �websocket_connect` s6 ? ��
�r� )WrP r� r r � functoolsr r` r< r� r: r� � urllib.parser r� r� Ztornado.concurrentr r Ztornado.escaper r r r r r
Ztornado.ioloopr Ztornado.iostreamr r
Z tornado.logr r Ztornado.netutilr r Ztornado.queuesr Ztornado.tcpclientr Z tornado.utilr �typingr r r r r r r r r r r �typesr Ztyping_extensionsr! r" r4 r9 rY � lru_cache�logr_ r� rL rO rQ rR r� ZRequestHandlerr[ r� �ABCr� r� r� r� Z_HTTPConnectionrm rI r� rZ r2 r3 r� r' r' r' r* �<module> s�
4
w[0& > w� ��������
�
� �