o ]@s8ddlZddlZddlZddlZddlZddlZddlZddlZddlZddlm Z m Z m Z m Z e dZe dZe dZdZejrHeneZGdddejjZGd d d eZGd d d eZGd ddeZGdddeZGdddeZGdddeZGdddeZ GdddeZ!GdddeZ"GdddeZ#GdddeZ$Gdd d eZ%Gd!d"d"eZ&Gd#d$d$eZ'Gd%d&d&eZ(Gd'd(d(eZ)Gd)d*d*eZ*Gd+d,d,eZ+Gd-d.d.eZ,Gd/d0d0eZ-Gd1d2d2eZ.Gd3d4d4eZ/Gd5d6d6eZ0Gd7d8d8eZ1Gd9d:d:eZ2Gd;d<dd>eZ4d?d@Z5idAedBedCedDedEe3dFedGe2dHedIe dJe!dKe1dLe&dMe"dNe&dOe#dPe$dQe%idRe&dSe(dTe)dUe*dVe&dWe'dXe+dYe,dZe-d[e-d\e-d]e.d^e/d_e4d`e0dae&dbe-Z6dS)cN) connectionlog str_tools tor_toolsz^(.*) ([A-Za-z0-9_]+)=(\S*)$z^(.*) ([A-Za-z0-9_]+)="(.*)"$z ^[a-z0-9_]+$Tc@s`eZdZdZdZiZdZdZdZe j dZ ddZ ddZd d Zd d Zd dZddZdS)EventaA Base for events we receive asynchronously, as described in section 4.1 of the `control-spec `_. :var str type: event type :var list positional_args: positional arguments of the event :var dict keyword_args: key/value arguments of the event Fz 0.1.1.1-alphacCsdt|s tdt|d|_g|_i|_|jtvr%t|j|_ |j s,| | dS)NzFReceived a blank tor event. Events must at the very least have a type.r) strstripstem ProtocolErrorsplittypepositional_args keyword_argsEVENT_TYPE_TO_CLASS __class__ _SKIP_PARSING_parse_standard_attr_parseselfrr6/usr/lib/python3/dist-packages/stem/response/events.py_parse_message1s     zEvent._parse_messagecCstjj|dtjjddS)NZ arrived_atT)parentcache)r utilZ _hash_attrresponseControlMessagerrrr__hash__CszEvent.__hash__c CsRt|} t|}|st|}|r |\}}}||j|<nnq|dd|_t|j}|j D]_}d}|r||j vsJ||j vr|d dr| dg}|d ds`td||f |sltd||f|| d|ddr|nqad |dd}n| d}t|||q3|jD]\} }t|||j| qdS) a% Most events are of the form... 650 *( positional_args ) *( key "=" value ) This parses this standard format, populating our **positional_args** and **keyword_args** attributes and creating attributes if it's in our event's **_POSITIONAL_ARGS** and **_KEYWORD_ARGS**. TNr"zCThe %s value should be quoted, but didn't have a starting quote: %szBThe %s value should be quoted, but didn't have an ending quote: %s )r QUOTED_KW_ARGmatchKW_ARGgroupsrr rlist_POSITIONAL_ARGS_QUOTED_OPTIONALLY_QUOTED startswithpopr r appendendswithjoinsetattr _KEYWORD_ARGSitemsget) rcontentr$keywordvalueZ positionalZ attr_nameZ attr_value attr_valuesZcontroller_attr_namerrrrFs@     "  zEvent._parse_standard_attrc CsD|durdSzt|WSty!}z td||fd}~ww)z Parses an iso timestamp (ISOTime2Frac in the control-spec). :param str timestamp: timestamp to parse :returns: **datetime** with the parsed timestamp :raises: :class:`stem.ProtocolError` if timestamp is malformed Nz"Unable to parse timestamp (%s): %s)rZ_parse_iso_timestamp ValueErrorr r )rZ timestampexcrrr_iso_timestamps  zEvent._iso_timestampcCsdSNrrrrrrsz Event._parsecCspt||}|r4tj|r|g}|D]#}||vr3d|j||f}d|j|||f}t|tj|qdSdS)a Checks if an attribute exists in a given enumeration, logging a message if it isn't. Attributes can either be for a string or collection of strings :param str attr: name of the attribute to check :param stem.util.enum.Enum enum: enumeration to check against zevent.%s.unknown_%s.%szd%s event had an unrecognized %s (%s). Maybe a new addition to the control protocol? Full Event: '%s'N) getattrr rZ_is_strr lowerrZlog_onceINFO)rattrZ attr_enumr7r6Zlog_idZunrecognized_msgrrr_log_if_unrecognizeds  zEvent._log_if_unrecognizedN)__name__ __module__ __qualname____doc__r(r1r)r*rr versionZVersion_VERSION_ADDEDrrrr:rr@rrrrrs  = rc@s,eZdZdZdZddddZdZdd Zd S) AddrMapEventa Event that indicates a new address mapping. The ADDRMAP event was one of the first Control Protocol V1 events and was introduced in tor version 0.1.1.1-alpha. .. versionchanged:: 1.1.0 Added the cached attribute. :var str hostname: address being resolved :var str destination: destination of the resolution, this is usually an ip, but could be a hostname if TrackHostExits is enabled or **NONE** if the resolution failed :var datetime expiry: expiration time of the resolution in local time :var str error: error code if the resolution failed :var datetime utc_expiry: expiration time of the resolution in UTC :var bool cached: **True** if the resolution will be kept until it expires, **False** otherwise or **None** if undefined )Zhostname destinationexpiryerror utc_expirycached)rJZEXPIRESZCACHEDrIcCs|jdkrd|_|jdur0|jdkrd|_nz tjj|j|_Wnty/td|w|jdur>tjj|j|_|j dur^|j dkrMd|_ dS|j dkrWd|_ dStd|dS) NzZNEVERz)Unable to parse date in ADDRMAP event: %sZYESTZNOFz?An ADDRMAP event's CACHED mapping can only be 'YES' or 'NO': %s) rHrIr rr_parse_timestampr8r rKrLrrrrrs&          zAddrMapEvent._parseN)rArBrCrDr(r1r*rrrrrrGs rGc@&eZdZdZdZejjjZ ddZ dS)AuthDirNewDescEventaj Event specific to directory authorities, indicating that we just received new descriptors. The descriptor type contained within this event is unspecified so the descriptor contents are left unparsed. The AUTHDIR_NEWDESCS event was introduced in tor version 0.1.1.10-alpha and removed in 0.3.2.1-alpha. (:spec:`6e887ba`) .. deprecated:: 1.6.0 Tor dropped this event as of version 0.3.2.1. (:spec:`6e887ba`) :var stem.AuthDescriptorAction action: what is being done with the descriptor :var str message: explanation of why we chose this action :var str descriptor: content of the descriptor TcCsft|d}t|dkrtd|ddkrtd|d|_|d|_d|d d|_dS) N zsAUTHDIR_NEWDESCS events must contain lines for at least the type, action, message, descriptor, and terminating 'OK'r!ZOKz)AUTHDIR_NEWDESCS doesn't end with an 'OK'r) rr lenr r actionmessager/ descriptor)rlinesrrrrs      zAuthDirNewDescEvent._parseN) rArBrCrDrr rE RequirementZEVENT_AUTHDIR_NEWDESCSrFrrrrrrO   rOc@eZdZdZdZddZdS)BandwidthEventa" Event emitted every second with the bytes sent and received by tor. The BW event was one of the first Control Protocol V1 events and was introduced in tor version 0.1.1.1-alpha. :var int read: bytes received by tor that second :var int written: bytes sent by tor that second )readwrittencCs^|jstd|jstd|jr|js!td|t|j|_t|j|_dS)Nz"BW event is missing its read valuez%BW event is missing its written valuezUA BW event's bytes sent and received should be a positive numeric value, received: %s)r]r r r^isdigitINT_TYPErrrrrs   zBandwidthEvent._parseN)rArBrCrDr(rrrrrr\ s r\c @s<eZdZdZdZddddddd d d Zejjj Z d d Z dS)BuildTimeoutSetEventa Event indicating that the timeout value for a circuit has changed. This was first added in tor version 0.2.2.7. The BUILDTIMEOUT_SET event was introduced in tor version 0.2.2.7-alpha. :var stem.TimeoutSetType set_type: way in which the timeout is changing :var int total_times: circuit build times tor used to determine the timeout :var int timeout: circuit timeout value in milliseconds :var int xm: Pareto parameter Xm in milliseconds :var float alpha: Pareto parameter alpha :var float quantile: CDF quantile cutoff point :var float timeout_rate: ratio of circuits that have time out :var int close_timeout: duration to keep measurement circuits in milliseconds :var float close_rate: ratio of measurement circuits that are closed )set_type total_timestimeoutxmalphaquantile timeout_rate close_timeout close_rate)Z TOTAL_TIMESZ TIMEOUT_MSZXMZALPHAZCUTOFF_QUANTILEZ TIMEOUT_RATEZCLOSE_MSZ CLOSE_RATEc CsdD]&}t||}|dur(z t||t|Wqty'td||fwqdD]&}t||}|durQz t||t|Wq+tyPtd||fwq+|dtjdS)N)rcrdreriz5The %s of a BUILDTIMEOUT_SET should be an integer: %s)rfrgrhrjz2The %s of a BUILDTIMEOUT_SET should be a float: %srb) r<r0intr8r r floatr@ZTimeoutSetType)rZparamZ param_valuerrrrBs&    zBuildTimeoutSetEvent._parseN) rArBrCrDr(r1r rErYZEVENT_BUILDTIMEOUT_SETrFrrrrrra#s rac @sLeZdZdZdZddddddd d d d Zd dZddZddZddZ dS) CircuitEventa Event that indicates that a circuit has changed. The fingerprint or nickname values in our 'path' may be **None** if the VERBOSE_NAMES feature isn't enabled. The option was first introduced in tor version 0.1.2.2, and on by default after 0.2.2.1. The CIRC event was one of the first Control Protocol V1 events and was introduced in tor version 0.1.1.1-alpha. .. versionchanged:: 1.4.0 Added the socks_username and socks_password attributes which is used for `stream isolation `_. :var str id: circuit identifier :var stem.CircStatus status: reported status for the circuit :var tuple path: relays involved in the circuit, these are **(fingerprint, nickname)** tuples :var tuple build_flags: :data:`~stem.CircBuildFlag` attributes governing how the circuit is built :var stem.CircPurpose purpose: purpose that the circuit is intended for :var stem.HiddenServiceState hs_state: status if this is a hidden service circuit :var str rend_query: circuit's rendezvous-point if this is hidden service related :var datetime created: time when the circuit was created or cannibalized :var stem.CircClosureReason reason: reason for the circuit to be closed :var stem.CircClosureReason remote_reason: remote side's reason for the circuit to be closed :var str socks_username: username for using this circuit :var str socks_password: password for using this circuit )idstatuspath build_flagspurposehs_state rend_querycreatedreason remote_reasonZsocks_usernameZsocks_password) BUILD_FLAGSPURPOSEHS_STATE REND_QUERY TIME_CREATEDREASON REMOTE_REASONZSOCKS_USERNAMEZSOCKS_PASSWORDcCsttj|j|_||j|_|jdurt|jd|_t |j s/t d|j |f| dtj| dtj| dtj| dtj| dtj| dtjdS) N,HCircuit IDs must be one to sixteen alphanumeric characters, got '%s': %srorqrrrsrvrw)tupler control_parse_circ_pathrpr:rurqr ris_valid_circuit_idrnr r@Z CircStatus CircBuildFlag CircPurposeHiddenServiceStateZCircClosureReasonrrrrr  zCircuitEvent._parsecCsFt|tsdSt|d}t|d}||kr|||S|t|t|S)NFrn) isinstancermr<hash)rothermethodZmy_idZtheir_idrrr_compares   $zCircuitEvent._comparecC||ddS)NcSs||kSr;rsorrrz%CircuitEvent.__gt__..rrrrrr__gt__zCircuitEvent.__gt__cCr)NcSs||kSr;rrrrrrrz%CircuitEvent.__ge__..rrrrr__ge__rzCircuitEvent.__ge__N) rArBrCrDr(r1rrrrrrrrrmZs"  rmc@s:eZdZdZdZddddddd d Zejjj Z d d Z d S)CircMinorEventa Event providing information about minor changes in our circuits. This was first added in tor version 0.2.3.11. The CIRC_MINOR event was introduced in tor version 0.2.3.11-alpha. :var str id: circuit identifier :var stem.CircEvent event: type of change in the circuit :var tuple path: relays involved in the circuit, these are **(fingerprint, nickname)** tuples :var tuple build_flags: :data:`~stem.CircBuildFlag` attributes governing how the circuit is built :var stem.CircPurpose purpose: purpose that the circuit is intended for :var stem.HiddenServiceState hs_state: status if this is a hidden service circuit :var str rend_query: circuit's rendezvous-point if this is hidden service related :var datetime created: time when the circuit was created or cannibalized :var stem.CircPurpose old_purpose: prior purpose for the circuit :var stem.HiddenServiceState old_hs_state: prior status as a hidden service circuit )rneventrprqrrrsrtru old_purpose old_hs_state)rxryrzr{r|Z OLD_PURPOSEZ OLD_HS_STATEcCsttj|j|_||j|_|jdurt|jd|_t |j s/t d|j |f| dtj| dtj| dtj| dtj| dtj| dtjdS) Nrrrrqrrrsrr)rr rrrpr:rurqr rrrnr r@Z CircEventrrrrrrrrrzCircMinorEvent._parseN) rArBrCrDr(r1r rErYZEVENT_CIRC_MINORrFrrrrrrs rc@s.eZdZdZddddZejjjZ ddZ dS) ClientsSeenEventa Periodic event on bridge relays that provides a summary of our users. The CLIENTS_SEEN event was introduced in tor version 0.2.1.10-alpha. :var datetime start_time: time in UTC that we started collecting these stats :var dict locales: mapping of country codes to a rounded count for the number of users :var dict ip_versions: mapping of ip protocols to a rounded count for the number of users start_timelocales ip_versions)Z TimeStartedZCountrySummaryZ IPVersionscCs@|jdurtjj|j|_|jdurci}|jdD]D}d|vr(td||dd\}}t|dkr?td||f| sLtd||f||vrYtd||ft |||<q||_|j duri}|j dD](}d|vr}td ||dd\}}| std ||ft |||<qp||_ dSdS) Nr=zhThe CLIENTS_SEEN's CountrySummary should be a comma separated listing of '=' mappings: %srrRz4Locales should be a two character code, got '%s': %sz%Locale count was non-numeric (%s): %sz1CountrySummary had multiple mappings for '%s': %szfThe CLIENTS_SEEN's IPVersions should be a comma separated listing of '=' mappings: %sz*IP protocol count was non-numeric (%s): %s) rr rrrMrr r rTr_rkr)rZlocale_to_countentrylocalecountZprotocol_to_countZprotocolrrrrs6     zClientsSeenEvent._parseN) rArBrCrDr1r rErYZEVENT_CLIENTS_SEENrFrrrrrrs   rc@rN)ConfChangedEventas Event that indicates that our configuration changed, either in response to a SETCONF or RELOAD signal. The CONF_CHANGED event was introduced in tor version 0.2.3.3-alpha. .. deprecated:: 1.7.0 Deprecated the *config* attribute. Some tor configuration options (like ExitPolicy) can have multiple values, so a simple 'str => str' mapping meant that we only provided the last. .. versionchanged:: 1.7.0 Added the changed and unset attributes. :var dict changed: mapping of configuration options to a list of their new values :var list unset: configuration options that have been unset TcCs~i|_g|_i|_t|ddD])}d|vr,|dd\}}|j|g|n |d}}|j|||j|<qdS)Nrr!r)ZchangedZunsetZconfigr splitlinesr setdefaultr-)rlinekeyr6rrrr/s    zConfChangedEvent._parseN) rArBrCrDrr rErYZEVENT_CONF_CHANGEDrFrrrrrrs   rc@seZdZdZejjjZdS)DescChangedEventz Event that indicates that our descriptor has changed. The DESCCHANGED event was introduced in tor version 0.1.2.2-alpha. N) rArBrCrDr rErYZEVENT_DESCCHANGEDrFrrrrrHsrc@&eZdZdZejjjZdZ ddZ dS) GuardEventaC Event that indicates that our guard relays have changed. The 'endpoint' could be either a... * fingerprint * 'fingerprint=nickname' pair The derived 'endpoint_*' attributes are generally more useful. The GUARD event was introduced in tor version 0.1.2.5-alpha. :var stem.GuardType guard_type: purpose the guard relay is for :var str endpoint: relay that the event concerns :var str endpoint_fingerprint: endpoint's finterprint :var str endpoint_nickname: endpoint's nickname if it was provided :var stem.GuardStatus status: status of the guard relay ) guard_typeendpointrocCsfd|_d|_z tj|j\|_|_Wntjy"td|w|dtj|dtj dS)Nz/GUARD's endpoint doesn't match a ServerSpec: %srro) endpoint_fingerprintendpoint_nicknamer r_parse_circ_entryrr r@Z GuardTypeZ GuardStatusrrrrrhs zGuardEvent._parseN) rArBrCrDr rErYZ EVENT_GUARDrFr(rrrrrrRs   rc@s2eZdZdZejjjZdZ ddddZ ddZ d S) HSDescEventa' Event triggered when we fetch a hidden service descriptor that currently isn't in our cache. The HS_DESC event was introduced in tor version 0.2.5.2-alpha. .. versionadded:: 1.2.0 .. versionchanged:: 1.3.0 Added the reason attribute. .. versionchanged:: 1.5.0 Added the replica attribute. .. versionchanged:: 1.7.0 Added the index attribute. :var stem.HSDescAction action: what is happening with the descriptor :var str address: hidden service address :var stem.HSAuth authentication: service's authentication method :var str directory: hidden service directory servicing the request :var str directory_fingerprint: hidden service directory's finterprint :var str directory_nickname: hidden service directory's nickname if it was provided :var str descriptor_id: descriptor identifier :var stem.HSDescReason reason: reason the descriptor failed to be fetched :var int replica: replica number the descriptor involves :var str index: computed index of the HSDir the descriptor was uploaded to or fetched from )rUaddressauthentication directory descriptor_idrvreplicaindex)r}ZREPLICAZ HSDIR_INDEXcCsd|_d|_|jdkr(z tj|j\|_|_Wntjy'td|w|jdurB|js