hFcFdZddlZddlZddlZddlZddlZddlZddlZddlZddl Zddl Zddl Zddl m Z m Z mZmZ ddlmZdZe j,ddddd d d d d ZdZdZdaej6dej8dej:dej<dej>dej@dejBdejDdejFdi Z$ej6dej8dej:dej<dej>dej@dejBdejDdejFd i Z%Gd!d"ejLd"gd#Z'd3d$Z(d4d%Z)d5d&Z*d'Z+d(Z,d6d)Z-d6d*Z.d+Z/d,Z0d-Z1d.Z2d/Z3d0Z4d1Z5d2Z6e*Z7y#e$rddlZY]wxYw)7at Connection and networking based utility functions. **Module Overview:** :: download - download from a given url get_connections - quieries the connections belonging to a given process system_resolvers - provides connection resolution methods that are likely to be available port_usage - brief description of the common usage for a port is_valid_ipv4_address - checks if a string is a valid IPv4 address is_valid_ipv6_address - checks if a string is a valid IPv6 address is_valid_port - checks if something is a valid representation for a port is_private_address - checks if an IPv4 address belongs to a private range or not address_to_int - provides an integer representation of an IP address expand_ipv6_address - provides an IPv6 address with its collapsed portions expanded get_mask_ipv4 - provides the mask representation for a given number of bits get_mask_ipv6 - provides the IPv6 mask representation for a given number of bits .. data:: Resolver (enum) Method for resolving a process' connections. .. versionadded:: 1.1.0 .. versionchanged:: 1.4.0 Added **NETSTAT_WINDOWS**. .. versionchanged:: 1.6.0 Added **BSD_FSTAT**. .. deprecated:: 1.6.0 The SOCKSTAT connection resolver is proving to be unreliable (:trac:`23057`), and will be dropped in the 2.0.0 release unless fixed. ==================== =========== Resolver Description ==================== =========== **PROC** /proc contents **NETSTAT** netstat **NETSTAT_WINDOWS** netstat command under Windows **SS** ss command **LSOF** lsof command **SOCKSTAT** sockstat command under \*nix **BSD_SOCKSTAT** sockstat command under FreeBSD **BSD_PROCSTAT** procstat command under FreeBSD **BSD_FSTAT** fstat command under OpenBSD ==================== =========== N)confenumlog str_toolsF)PROCproc)NETSTATnetstat)NETSTAT_WINDOWSznetstat (windows))SSss)LSOFlsof)SOCKSTATsockstat) BSD_SOCKSTATzsockstat (bsd)) BSD_PROCSTATzprocstat (bsd)) BSD_FSTATz fstat (bsd)z255.255.255.255z'FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFFz netstat -npWz netstat -anozss -nptuz lsof -wnPirz sockstat -4czprocstat -f {pid}zfstat -p {pid}zF^{protocol}\s+.*\s+{local}\s+{remote}\s+ESTABLISHED\s+{pid}/{name}\s*$z=^\s*{protocol}\s+{local}\s+{remote}\s+ESTABLISHED\s+{pid}\s*$ze^{protocol}\s+ESTAB\s+.*\s+{local}\s+{remote}\s+users:\(\("{name}",(?:pid=)?{pid},(?:fd=)?[0-9]+\)\)$zF^{name}\s+{pid}\s+.*\s+{protocol}\s+{local}->{remote} \(ESTABLISHED\)$zG^\S+\s+{name}\s+{pid}\s+{protocol}4\s+{local}\s+{remote}\s+ESTABLISHED$z?^\S+\s+{name}\s+{pid}\s+\S+\s+{protocol}4\s+{local}\s+{remote}$z:^\s*{pid}\s+{name}\s+.*\s+{protocol}\s+{local}\s+{remote}$zO^\S+\s+{name}\s+{pid}\s+.*\s+{protocol}\s+\S+\s+{local}\s+[-<]-[->]\s+{remote}$ceZdZdZy) Connectiona Network connection information. .. versionchanged:: 1.5.0 Added the **is_ipv6** attribute. :var str local_address: ip address the connection originates from :var int local_port: port the connection originates from :var str remote_address: destionation ip address :var int remote_port: destination port :var str protocol: protocol of the connection ('tcp', 'udp', etc) :var bool is_ipv6: addresses are ipv6 if true, and ipv4 otherwise N)__name__ __module__ __qualname____doc__^/var/www/betterdocs.net/sherlock_api/venv/lib/python3.12/site-packages/stem/util/connection.pyrrs rr) local_address local_portremote_address remote_portprotocolis_ipv6cP|d}tj} tj||jS#tj $r2}t j||tjd|d}~wtjdd\}}||tj|z z}|dkDr4||dkDr-tjd|||fzt|||dz cYStjd|d |t j|||xYw) a Download from the given url. .. versionadded:: 1.8.0 :param str url: uncompressed url to download from :param int timeout: timeout when connection becomes idle, no timeout applied if **None** :param int retires: maximum attempts to impose :returns: **bytes** content of the given url :raises: * :class:`~stem.DownloadTimeout` if our request timed out * :class:`~stem.DownloadFailed` if our request fails Nr)timeoutz5Failed to download from %s (%i retries remaining): %szFailed to download from : )timeurlliburlopenreadsocketr&stemDownloadTimeoutsysexc_infordebugdownloadDownloadFailed)urlr&retries start_timeexc stacktraces rr5r5s$ _Gyy{*6 >># 1 6 6 88 E   sC):G DD 6llnQq)OC z))g{7Q; iiG3PWY\J]]^ c7GaK 00 iiC=>   S* 55s$?D%-A??A2D%32D%c |st}|r|d}n td|s |s tdddd|d|d|t|tr t |}|t jjj|d }t|dk(rC|tjtjtjfvritd |d |dt|dk(r|d}nC|tjtjtjfvrtd|d |d|tjk(r*t jjj!|St"|j%|} t jjj'|}t*|j%ddd|r|nd|r|nd}d|zddj-|zg} t/j0|} fd} |D]} | j3| } | s| j5}| d|d| \}}| d |d | \}}|r|r|r|sP|d!j7}|d"k(rd#}|d$vrd%|d&| }t9|||||t;|}| j=|t |d't| z| std(|z| S#t$rtd |zwxYw#t($r}td|d|d }~wwxYw))a& Retrieves a list of the current connections for a given process. This provides a list of :class:`~stem.util.connection.Connection`. Note that addresses may be IPv4 *or* IPv6 depending on what the platform supports. .. versionadded:: 1.1.0 .. versionchanged:: 1.5.0 Made our resolver argument optional. .. versionchanged:: 1.5.0 IPv6 support when resolving via proc, netstat, lsof, or ss. :param Resolver resolver: method of connection resolution to use, if not provided then one is picked from among those that should likely be available for the system :param int process_pid: pid of the process to retrieve :param str process_name: name of the process to retrieve :returns: **list** of :class:`~stem.util.connection.Connection` instances :raises: * **ValueError** if neither a process_pid nor process_name is provided * **IOError** if no connections are available or resolution fails (generally they're indistinguishable). The common causes are the command being unavailable or permissions. rz)Unable to determine a connection resolverzAYou must provide a pid or process name to provide connections forc<trtj|yyN)LOG_CONNECTION_RESOLUTIONrr4)msgs r_logzget_connections.._logs  iin!rzP================================================================================z#Querying connections for resolver: z, pid: z, name: zProcess pid was non-numeric: %sNTz Unable to determine the pid of 'z'. z- requires the pid to provide the connections.r(z"There's multiple processes named 'z2 requires a single pid to provide the connections.)pidzUnable to query '': z(?P\S+)z(?P[\[\]0-9a-f.:]+)z(?P[\[\]0-9a-f.:]+)z[0-9]*z\S*)r#localremoterBnamezResolver regex: %szResolver results: %s c4|jdd\}}t|st|dsd|d|d|yt|sd|d |d|yd |d|d ||j d j d t |fS)N:r(T)allow_bracketszInvalid z address (): NNz port (zValid r*[])rsplitis_valid_ipv4_addressis_valid_ipv6_address is_valid_portlstriprstripint) addr_typeaddr_strlineaddrportrAs r_parse_address_strz+get_connections.._parse_address_str3sa(JD$  &/DT\`/a ItT BC  4  D$ ?@  dD 12 [[  $ $S )3t9 44rrDrEr#tcp6tcp)r]udpzUnrecognized protocol (rKz%i connections foundzNo results found using: %s)system_resolversIOError ValueError isinstancestrrUr0utilsystem pid_by_namelenResolverr rrr connectionsRESOLVER_COMMANDformatcallOSErrorRESOLVER_FILTERjoinrecompilematch groupdictlowerrrQappend)resolver process_pid process_nameavailable_resolversall_pidsresolver_commandresultsr:resolver_regex_strriresolver_regexr[rXrrattr local_addrr remote_addrr"r#connrAs @rget_connectionsrs^< *,$Q'h ? @@ \ X YYx.X{\hij S!H $kyy++L$?H 8} h.. x?T?TU Up|GHI I X! QKk h.. x?T?TU UxDFNOP P  99>> % %K % 88%h/66[6IHii##$45G'x077# * ,$+('(L99L>c|?tjjjrd}nt j}|dk(rt j g}n|dk(rt jg}n|dk(rt jg}ns|dk(r0t jt jt jg}n>t jt jt jt jg}|Dcgc]5}tjjjt|s4|7}}tjj jr\t#j$dt"j&r8t#j$dt"j&rt j(g|z}|Scc}w)a Provides the types of connection resolvers likely to be available on this platform. .. versionadded:: 1.1.0 .. versionchanged:: 1.3.0 Renamed from get_system_resolvers() to system_resolvers(). The old name still works as an alias, but will be dropped in Stem version 2.0.0. :param str system: system to get resolvers for, this is determined by platform.system() if not provided :returns: **list** of :data:`~stem.util.connection.Resolver` instances available on this platform GentooWindowsDarwinOpenBSDFreeBSDz /proc/net/tcpz /proc/net/udp)r0rdre is_gentooplatformrhr rrrrr rr is_availablerjrosaccessR_OKr)re resolversrs rr_r_asD  ^ yy!!#f f y))*I I ##$I  &&(=(=x}}MI!!8#4#4hmmX[[QI$ZQtyy'7'7'D'DEUVWEX'YqZ)Z YY^^  "ryy"'''JryyYhjljqjqOr)+I [s >5G4Gcttj}tjj tjj td} |j|i}|jdijD]v\}}|jr||t|<%d|vrA|jdd\}}tt|t|dzD]}|||< jtd|z|atsyt'|t(r|jr t|}tj|S#t $r%} t#j$d|d| Yd} ~ pd} ~ wwxYw) z Provides the common use of a given port. For example, 'HTTP' for port 80 or 'SSH' for 22. .. versionadded:: 1.2.0 :param int port: port number to look up :returns: **str** with a description for the port, **None** if none is known Nz ports.cfgrZ-r(z'%s' is an invalid keyz>BUG: stem failed to load its internal port descriptions from 'rC) PORT_USESrConfigrpathrodirname__file__loadgetitemsisdigitrUsplitrangera Exceptionrwarnrbrc) rZconfig config_path port_useskeyvaluemin_portmax_port port_entryr:s r port_usagersJ [[]F'',,rwwx8+FKm kk+i 62.446 ;*#u ;;=$3s8  CZ"yya0 (H!#h-X1BC *j$)Ij ! *3c9: : ;i  ct||~ t9D t  m hhZegjkllmsB.E FE<<Fctt|trtj|}n tj j |sy|jddk7ry|jdD]I}|jrt|dkst|dkDry|ddk(s:t|dkDsIyy) z Checks if a string is a valid IPv4 address. :param str address: string to be checked :returns: **True** if input is a valid IPv4 address, **False** otherwise F.r)r0r(T) rbbytesr _to_unicoder0rd_is_strcountrrrUrg)addressentrys rrPrPs##G,G 99  W %  ]]31 }}S!e ==?c%j1nE S0@  qSSZ!^   rct|trtj|}n tj j |sy|r'|jdr|jdr|dd}|jddk(r|jdd |jddz}|jd|dz}|dk(rd }t|||sy|d k7r|d |dz nd d |r||dzd nd g}djtd |}|jd}|d kDry|d k7rd |vry|jd dkDsd|vry|jdD]}t!j"d|ryy)z Checks if a string is a valid IPv6 address. :param str address: string to be checked :param bool allow_brackets: ignore brackets which form '[address]' :returns: **True** if input is a valid IPv6 address, **False** otherwise FrMrNr(rr)rIrNzff:ff::z:::z^[0-9a-fA-f]{0,4}$T)rbrrrr0rdr startswithendswithrrfindfindrProfilterrrprr)rrJ ipv4_startipv4_end addr_comp colon_countrs rrQrQs##G,G 99  W % #7#3#3C#8" g ]]31sAw||C'89A=J||Ca0H2~h H!= > -71_*q.)$ksQXYadeYeYfQgy}~IhhvdI./G  c"+1_ aD/ }}TQ%7"2 }}S!e 88(% 0  rc t|}t|t|k7ry|r|dk(ry|dkDxr|dkS#t$r1t|tt fr|D]}t ||rYyYyYyt$rYywxYw)a+ Checks if a string or int is a valid port number. :param list,str,int entry: string, integer or list to be checked :param bool allow_zero: accept port number of zero (reserved by definition) :returns: **True** if input is an integer and within the valid port range, **False** otherwise FrTi)rUrc TypeErrorrbtuplelistrRra)r allow_zerorrZs rrRrRs JE 5zSZ    QY (55=( %%'$T:.   s)"99 90A=*A=-A=2A=<A=ct|std|z|jds"|jds|jdry|jdr(t|j dd}|d k\r|d kryy ) a Checks if the IPv4 address is in a range belonging to the local network or loopback. These include: * Private ranges: 10.*, 172.16.* - 172.31.*, 192.168.* * Loopback: 127.* .. versionadded:: 1.1.0 :param str address: string to be checked :returns: **True** if input is in a private range, **False** otherwise :raises: **ValueError** if the address isn't a valid IPv4 address z'%s' isn't a valid IPv4 addressz10.z192.168.z127.Tz172.rr(F)rPrarrUr)r second_octets ris_private_addressr6s" w ' 6@ AA '"4"4Z"@GDVDVW]D^  w}}S)!,-Lrlb0  rc,tt|dS)z Provides an integer representation of a IPv4 or IPv6 address that can be used for sorting. .. versionadded:: 1.5.0 :param str address: IPv4 or IPv6 address :returns: **int** representation of the address r')rU_address_to_binary)rs raddress_to_intrZs  (! ,,rc ,t|std|z|jddk(r|jdd|j ddz}|j d|dz}|dk(rd}t |||}t d Dcgc]}|d |zd |dzz}}dj|Dcgc]}d t|d zc}}|dk7r|d|dz nd||r||dzdndg}djtd|}d |vr,d |jdz } |jd d d| zz}t dD]H} | dz} | d k7r|jd| n t|} d| | z z } | dkDs8|d| d| zz|| dz}J|Scc}wcc}w)a Expands abbreviated IPv6 addresses to their full colon separated hex format. For instance... :: >>> expand_ipv6_address('2001:db8::ff00:42:8329') '2001:0db8:0000:0000:0000:ff00:0042:8329' >>> expand_ipv6_address('::') '0000:0000:0000:0000:0000:0000:0000:0000' >>> expand_ipv6_address('::ffff:5.9.158.75') '0000:0000:0000:0000:0000:ffff:0509:9e4b' :param str address: IPv6 address to be expanded :raises: **ValueError** if the address can't be expanded due to being malformed z'%s' isn't a valid IPv6 addressrr)rIrr(rNr'r%04xrrr) rQrarrrrrrorUrreplaceindexrg)rrripv4_bini groupingsgroup ipv6_snippetrmissing_groupsrstartend missing_zeross rexpand_ipv6_addressrls* w ' 6@ AA ]]31sAw||C'89A=J||Ca0H2~h "'*X">?H8=aA1"q&q1u.AIA88KVc%m3KLL-71_*q.)$ pxV]^fij^j^kVlCDIhhvdI./G W_s++NoodD3+?$?@GQxHe AIE',z'--U #s7|Cu%Mq# "55Gg H .+BKs F 0Fc 8|dkDs|dkrtd|z|dk(rtStd|zdz dddd}tdDcgc]}|d |zd |dzz}}d j |Dcgc]}t t |dc}Scc}wcc}w) a! Provides the IPv4 mask for a given number of bits, in the dotted-quad format. :param int bits: number of bits to be converted :returns: **str** with the subnet mask representation for this many bits :raises: **ValueError** if given a number of bits outside the range of 0-32 rz$A mask can only be 0-32 bits, got %ir'r(Nrrrr)raFULL_IPv4_MASK _get_binaryrrorcrU)bitsmask_binroctetsoctets r get_mask_ipv4rs BY$( ;dB CC rz dQ +DbD 1(27q :AHQU1A; ' :& : 6:%3s5!}%: ;; ;;s B/Bc H|dkDs|dkrtd|z|dk(rtStd|zdz dddd}tdDcgc]}|d |zd |dzz}}d j |Dcgc]}d t |dzc}j Scc}wcc}w) a, Provides the IPv6 mask for a given number of bits, in the hex colon-delimited format. :param int bits: number of bits to be converted :returns: **str** with the subnet mask representation for this many bits :raises: **ValueError** if given a number of bits outside the range of 0-128 rz%A mask can only be 0-128 bits, got %ir'r(NrrrrIr)raFULL_IPv6_MASKrrrorUupper)rrrrrs r get_mask_ipv6rs CZ4!8 H II P[s B3B8rL)NNNr>)F)8r collectionsrrrpr/r2r+r0 stem.utilstem.util.procstem.util.systemrrrrurllib.requestrequestr, ImportErrorurllib2r?Enumrhrrrrr r r rrrrrrjrn namedtuplerr5rr_rrPrQrRrrrrrrrrget_system_resolversrrrrs 4l  00!" 499*$$ #:   -- N N ++z -- Z  , &3: -- b a ++ --_ e b [ q3: ''' 7NO  &6REP0f+\:4n@!H-$:z<4K6I2 K J,(csF F F