o u]4@sdZddlZddlZddlZddlZddlZddlZddlmZmZm Z ddl m Z m Z m Z mZmZmZddgZdZGdd d eZGd d d eZdS) a Interaction with a Tor relay's ORPort. :class:`~stem.client.Relay` is a wrapper for :class:`~stem.socket.RelaySocket`, much the same way as :class:`~stem.control.Controller` provides higher level functions for :class:`~stem.socket.ControlSocket`. .. versionadded:: 1.7.0 :: Relay - Connection with a tor relay's ORPort. | +- connect - Establishes a connection with a relay. | |- is_alive - reports if our connection is open or closed |- connection_time - time when we last connected or disconnected |- close - shuts down our connection | +- create_circuit - establishes a new circuit Circuit - Circuit we've established through a relay. |- send - sends a message through this circuit +- close - closes this circuit N)CELL_TYPE_SIZEFIXED_PAYLOAD_LENCell)ZEROAddressKDF LinkProtocol RelayCommandsplitcellZdatatype)c@sreZdZdZddZeefddZdddZd d Z d d Z d dZ ddZ ddZ ddZddZddZdS)Relayzk Connection with a Tor relay's ORPort. :var int link_protocol: link protocol version we established cCs*t||_||_d|_t|_i|_dS)N)r link_protocol_orport_orport_buffer threadingRLock _orport_lock _circuits)selfZorportrr6/usr/lib/python3/dist-packages/stem/client/__init__.py__init__Bs   zRelay.__init__c Csjt|}tjj|std||stdz tj||}Wn2tjyR}z%dt |vr8td||fdt |vsDdt |vrMtd||fd}~ww| tj j |d |}|ss|td ||ftj j j|d d }t||j}|s|td d |||d |jft|} | tj j |g| t|| S)af Establishes a connection with the given ORPort. :param str address: ip address of the relay :param int port: ORPort of the relay :param tuple link_protocols: acceptable link protocol versions :raises: * **ValueError** if address or port are invalid * :class:`stem.SocketError` if we're unable to establish a connection z'%s' isn't a valid portz8Connection can't be established without a link protocol.zConnection refusedz5Failed to connect to %s:%i. Maybe it isn't an ORPort?zunknown protocolzwrong version numberz>Failed to SSL authenticate to %s:%i. Maybe it isn't an ORPort?Nz5Unable to establish a common link protocol with %s:%irzKUnable to find a common link protocol. We support %s but %s:%i supports %s.z, )rstemutilZ connectionZ is_valid_port ValueErrorZsocketZ RelaySocketZ SocketErrorstrsendclientr Z VersionsCellpackrecvcloserpopset intersectionZversionsjoinmaxZ NetinfoCellr) ZaddressZportZlink_protocolsZ relay_addrZconnexcresponseZversions_replyZcommon_protocolsrrrrconnectQs8   $ z Relay.connectFcCs|j|jjj}t|j|tjkr'|j|j7_t|j|tjkst t |j|dd}|j rA|tjt }n=t|j|tjt jkre|j|j7_t|j|tjt jksNt |j|tjdd}|tjt j|}t|j|kr|j|j7_t|j|ks|rt|j|\}|_|WdSt |j|j\}|_|WdS1swYdS)z Reads the next cell from our ORPort. If none is present this blocks until one is available. :param bool raw: provides bytes rather than parsing as a cell if **True** :returns: next :class:`~stem.client.cell.Cell` Nr)rr circ_id_sizesizelenrrrr$rZby_valuer&Z IS_FIXED_SIZErr )rrawr.Z cell_typeZ cell_sizeZ payload_lenZcontentr rrr_recvs. $z Relay._recvccsV|jjdd|j||j|jjdd}tjjj ||jD]}|Vq#dS)ae Sends a cell on the ORPort and provides the response we receive in reply. Unfortunately unlike control sockets, ORPorts don't have generalized rules for predictable message IO. With control sockets... * Each message we send receives a single reply. * We may also receive asynchronous events marked with a 650 status. ORPorts by contrast receive variable length cells with differing rules on their arrival. As such making a best effort attempt at a send-and-receive method in which we do the following... * Discard any existing unread data from the socket. * Send our request. * Await up to a second for a reply. It's quite possible this is a stupid approach. If so, patches welcome. :param stem.client.cell.Cell cell: cell to be sent :returns: **generator** with the cells received in reply r)ZtimeoutN) rr$r!r#rrr"r rr&)rr r,Z received_cellrrr_msgsz Relay._msgcC |jS)z Checks if our socket is currently connected. This is a pass-through for our socket's :func:`~stem.socket.BaseSocket.is_alive` method. :returns: **bool** that's **True** if our socket is connected and **False** otherwise )ris_aliverrrrr6s zRelay.is_alivecCr5)aH Provides the unix timestamp for when our socket was either connected or disconnected. That is to say, the time we connected if we're currently connected and the time we disconnected if we're not connected. :returns: **float** for when we last connected or disconnected, zero if we've never connected )rconnection_timer7rrrr8s zRelay.connection_timecCs4|j |jWdS1swYdS)z Closes our socket connection. This is a pass-through for our socket's :func:`~stem.socket.BaseSocket.close` method. N)rrr%r7rrrr%s$z Relay.closecCs|jZ|jrt|jdn|jj}tjj|}d}| |D]}t |tjjj r.|}nq |s5t dt |j|j}|j|jkrHt dt|||}||j|j<|WdS1s`wYdS)z$ Establishes a new circuit. r3Nz@We should get a CREATED_FAST response from a CREATE_FAST requestz3Remote failed to prove that it knows our shared key)rrr*rZ first_circ_idrr"r ZCreateFastCellr4 isinstanceZCreatedFastCellrrZ from_valueZ key_materialZderivative_keyZkey_hashCircuitid)rcirc_idZcreate_fast_cellZcreated_fast_cellr kdfcircrrrcreate_circuits$   $zRelay.create_circuitccsD|j|jD]}|Vq WddS1swYdSN)rrvalues)rr>rrr__iter__ s "zRelay.__iter__cC|Sr@rr7rrr __enter__%zRelay.__enter__cC |dSr@r%rZ exit_typevalue tracebackrrr__exit__( zRelay.__exit__N)F)__name__ __module__ __qualname____doc__r staticmethodDEFAULT_LINK_PROTOCOLSr-r2r4r6r8r%r?rBrDrKrrrrr;s I)     rc@sDeZdZdZddZdddZddd Zd d Zd d ZddZ dS)r:a Circuit through which requests can be made of a `Tor relay's ORPort `_. :var stem.client.Relay relay: relay through which this circuit has been established :var int id: circuit id :var hashlib.sha1 forward_digest: digest for forward integrity check :var hashlib.sha1 backward_digest: digest for backward integrity check :var bytes forward_key: forward encryption key :var bytes backward_key: backward encryption key c Cstjs tdddlm}m}m}ddlm }| t |j j d}||_||_t|j|_t|j|_|| |j|||_|| |j|||_dS)Nz5Circuit construction requires the cryptography moduler)Cipher algorithmsmodes)default_backend)rZprereqZis_crypto_available ImportErrorZ&cryptography.hazmat.primitives.ciphersrSrTrUZcryptography.hazmat.backendsrVZCTRrZAESZ block_sizerelayr;hashlibZsha1forward_digestbackward_digest forward_keyZ encryptor backward_keyZ decryptor) rrYr<r=rSrTrUrVZctrrrrr9s   zCircuit.__init__rcCs|jjb|jtj|d|jtj||dg} |jjdd}tjj j |jj ||j |j\}}}|j|jkrCtd|j|jf||_||_ |jtjkr`ddd|DWdS||q1siwYdS) z Request descriptors from the relay. :param str request: directory request to make :param int stream_id: specific stream this concerns :returns: **str** with the requested descriptor data  stream_idT)r1z,Response should be for circuit id %i, not %ircSsg|]}|jqSr)data).0r rrr hsz%Circuit.directory..N)rYr_sendr Z BEGIN_DIRZDATAr2rr"r RelayCellZdecryptrr^r\r;r<Z ProtocolErrorcommandZENDr)append)rZrequestr`r,Zencrypted_cellZdecrypted_cellr^r\rrr directoryIs" $   zCircuit.directorycCs||jj0tjjj|j|||d}||jj|j |j \}}}|jj |||_ ||_ WddS1s7wYdS)z Sends a message over the circuit. :param stem.client.datatype.RelayCommand command: command to be issued :param bytes data: message payload :param int stream_id: specific stream this concerns r_N) rYrrr"r rer;Zencryptrr]r[rr!)rrfrar`r Zpayloadr]r[rrrrdls "z Circuit._sendcCs^|jj!|jjtjj|j |jj |jj |j=WddS1s(wYdSr@) rYrrr!rr"r Z DestroyCellr;r#rrr7rrrr%s $"z Circuit.closecCrCr@rr7rrrrDrEzCircuit.__enter__cCrFr@rGrHrrrrKrLzCircuit.__exit__N)r)rir) rMrNrOrPrrhrdr%rDrKrrrrr:,s  # r:)rPrZrrZstem.client.cellZ stem.socketZstem.util.connectionrrrZstem.client.datatyperrrrr r __all__rRobjectrr:rrrrs   r