Files
HP_InHand_IG502/APPS_UNCOMPILED/lib/Pyro4/socketutil.py
2025-04-30 08:48:49 -05:00

642 lines
23 KiB
Python

# uncompyle6 version 3.9.2
# Python bytecode version base 3.7.0 (3394)
# Decompiled from: Python 3.8.19 (default, Mar 20 2024, 15:27:52)
# [Clang 14.0.6 ]
# Embedded file name: /var/user/app/device_supervisorbak/device_supervisor/lib/Pyro4/socketutil.py
# Compiled at: 2024-04-18 03:12:55
# Size of source mod 2**32: 23920 bytes
"""
Low level socket utilities.
Pyro - Python Remote Objects. Copyright by Irmen de Jong (irmen@razorvine.net).
"""
import os, socket, errno, time, sys, select, weakref
try:
import ssl
except ImportError:
ssl = None
from Pyro4.configuration import config
from Pyro4.errors import CommunicationError, TimeoutError, ConnectionClosedError
try:
InterruptedError()
except NameError:
class InterruptedError(Exception):
pass
ERRNO_RETRIES = [
errno.EINTR, errno.EAGAIN, errno.EWOULDBLOCK, errno.EINPROGRESS]
if hasattr(errno, "WSAEINTR"):
ERRNO_RETRIES.append(errno.WSAEINTR)
if hasattr(errno, "WSAEWOULDBLOCK"):
ERRNO_RETRIES.append(errno.WSAEWOULDBLOCK)
if hasattr(errno, "WSAEINPROGRESS"):
ERRNO_RETRIES.append(errno.WSAEINPROGRESS)
ERRNO_BADF = [errno.EBADF]
if hasattr(errno, "WSAEBADF"):
ERRNO_BADF.append(errno.WSAEBADF)
ERRNO_ENOTSOCK = [errno.ENOTSOCK]
if hasattr(errno, "WSAENOTSOCK"):
ERRNO_ENOTSOCK.append(errno.WSAENOTSOCK)
if not hasattr(socket, "SOL_TCP"):
socket.SOL_TCP = socket.IPPROTO_TCP
ERRNO_EADDRNOTAVAIL = [errno.EADDRNOTAVAIL]
if hasattr(errno, "WSAEADDRNOTAVAIL"):
ERRNO_EADDRNOTAVAIL.append(errno.WSAEADDRNOTAVAIL)
ERRNO_EADDRINUSE = [errno.EADDRINUSE]
if hasattr(errno, "WSAEADDRINUSE"):
ERRNO_EADDRINUSE.append(errno.WSAEADDRINUSE)
if sys.version_info >= (3, 0):
basestring = str
def getIpVersion(hostnameOrAddress):
"""
Determine what the IP version is of the given hostname or ip address (4 or 6).
First, it resolves the hostname or address to get an IP address.
Then, if the resolved IP contains a ':' it is considered to be an ipv6 address,
and if it contains a '.', it is ipv4.
"""
address = getIpAddress(hostnameOrAddress)
if "." in address:
return 4
if ":" in address:
return 6
raise CommunicationError("Unknown IP address format" + address)
def getIpAddress(hostname, workaround127=False, ipVersion=None):
"""
Returns the IP address for the given host. If you enable the workaround,
it will use a little hack if the ip address is found to be the loopback address.
The hack tries to discover an externally visible ip address instead (this only works for ipv4 addresses).
Set ipVersion=6 to return ipv6 addresses, 4 to return ipv4, 0 to let OS choose the best one or None to use config.PREFER_IP_VERSION.
"""
def getaddr(ipVersion):
if ipVersion == 6:
family = socket.AF_INET6
else:
if ipVersion == 4:
family = socket.AF_INET
else:
if ipVersion == 0:
family = socket.AF_UNSPEC
else:
raise ValueError("unknown value for argument ipVersion.")
ip = socket.getaddrinfo(hostname or socket.gethostname(), 80, family, socket.SOCK_STREAM, socket.SOL_TCP)[0][4][0]
if workaround127:
if ip.startswith("127.") or ip == "0.0.0.0":
ip = getInterfaceAddress("4.2.2.2")
return ip
try:
if hostname:
if ":" in hostname:
if ipVersion is None:
ipVersion = 0
if ipVersion is None:
return getaddr(config.PREFER_IP_VERSION)
return getaddr(ipVersion)
except socket.gaierror:
if (ipVersion == 6 or ipVersion) is None:
if config.PREFER_IP_VERSION == 6:
raise socket.error("unable to determine IPV6 address")
return getaddr(0)
def getInterfaceAddress(ip_address):
"""tries to find the ip address of the interface that connects to the given host's address"""
family = socket.AF_INET if getIpVersion(ip_address) == 4 else socket.AF_INET6
sock = socket.socket(family, socket.SOCK_DGRAM)
try:
sock.connect((ip_address, 53))
return sock.getsockname()[0]
finally:
sock.close()
def __nextRetrydelay(delay):
if delay == 0.0:
return 0.001
if delay == 0.001:
return 0.01
return delay + 0.1
def receiveData(sock, size):
"""Retrieve a given number of bytes from a socket.
It is expected the socket is able to supply that number of bytes.
If it isn't, an exception is raised (you will not get a zero length result
or a result that is smaller than what you asked for). The partial data that
has been received however is stored in the 'partialData' attribute of
the exception object."""
try:
retrydelay = 0.0
msglen = 0
chunks = []
if config.USE_MSG_WAITALL:
if not hasattr(sock, "getpeercert"):
while True:
try:
data = sock.recv(size, socket.MSG_WAITALL)
if len(data) == size:
return data
msglen = len(data)
chunks = [data]
break
except socket.timeout:
raise TimeoutError("receiving: timeout")
except socket.error as x:
try:
err = getattr(x, "errno", x.args[0])
if err not in ERRNO_RETRIES:
raise ConnectionClosedError("receiving: connection lost: " + str(x))
time.sleep(1e-05 + retrydelay)
retrydelay = __nextRetrydelay(retrydelay)
finally:
x = None
del x
while True:
try:
while msglen < size:
chunk = sock.recv(min(60000, size - msglen))
if not chunk:
break
chunks.append(chunk)
msglen += len(chunk)
data = (b'').join(chunks)
del chunks
if len(data) != size:
err = ConnectionClosedError("receiving: not enough data")
err.partialData = data
raise err
return data
except socket.timeout:
raise TimeoutError("receiving: timeout")
except socket.error:
x = sys.exc_info()[1]
err = getattr(x, "errno", x.args[0])
if err not in ERRNO_RETRIES:
raise ConnectionClosedError("receiving: connection lost: " + str(x))
time.sleep(1e-05 + retrydelay)
retrydelay = __nextRetrydelay(retrydelay)
except socket.timeout:
raise TimeoutError("receiving: timeout")
def sendData(sock, data):
"""
Send some data over a socket.
Some systems have problems with ``sendall()`` when the socket is in non-blocking mode.
For instance, Mac OS X seems to be happy to throw EAGAIN errors too often.
This function falls back to using a regular send loop if needed.
"""
if sock.gettimeout() is None:
try:
sock.sendall(data)
return
except socket.timeout:
raise TimeoutError("sending: timeout")
except socket.error as x:
try:
raise ConnectionClosedError("sending: connection lost: " + str(x))
finally:
x = None
del x
else:
retrydelay = 0.0
while data:
try:
sent = sock.send(data)
data = data[sent[:None]]
except socket.timeout:
raise TimeoutError("sending: timeout")
except socket.error as x:
try:
err = getattr(x, "errno", x.args[0])
if err not in ERRNO_RETRIES:
raise ConnectionClosedError("sending: connection lost: " + str(x))
time.sleep(1e-05 + retrydelay)
retrydelay = __nextRetrydelay(retrydelay)
finally:
x = None
del x
_GLOBAL_DEFAULT_TIMEOUT = object()
def createSocket(bind=None, connect=None, reuseaddr=False, keepalive=True, timeout=_GLOBAL_DEFAULT_TIMEOUT, noinherit=False, ipv6=False, nodelay=True, sslContext=None):
"""
Create a socket. Default socket options are keepalive and IPv4 family, and nodelay (nagle disabled).
If 'bind' or 'connect' is a string, it is assumed a Unix domain socket is requested.
Otherwise, a normal tcp/ip socket is used.
Set ipv6=True to create an IPv6 socket rather than IPv4.
Set ipv6=None to use the PREFER_IP_VERSION config setting.
"""
if bind:
if connect:
raise ValueError("bind and connect cannot both be specified at the same time")
forceIPv6 = ipv6 or ipv6 is None and config.PREFER_IP_VERSION == 6
if isinstance(bind, basestring) or isinstance(connect, basestring):
family = socket.AF_UNIX
else:
if not bind:
if not connect:
family = socket.AF_INET6 if forceIPv6 else socket.AF_INET
else:
if type(bind) is tuple:
if not bind[0]:
family = socket.AF_INET6 if forceIPv6 else socket.AF_INET
else:
if getIpVersion(bind[0]) == 4:
if forceIPv6:
raise ValueError("IPv4 address is used bind argument with forceIPv6 argument:" + bind[0] + ".")
family = socket.AF_INET
else:
if getIpVersion(bind[0]) == 6:
family = socket.AF_INET6
bind = (
bind[0], bind[1], 0, 0)
else:
raise ValueError("unknown bind format.")
else:
if type(connect) is tuple:
if not connect[0]:
family = socket.AF_INET6 if forceIPv6 else socket.AF_INET
else:
if getIpVersion(connect[0]) == 4:
if forceIPv6:
raise ValueError("IPv4 address is used in connect argument with forceIPv6 argument:" + bind[0] + ".")
family = socket.AF_INET
else:
if getIpVersion(connect[0]) == 6:
family = socket.AF_INET6
connect = (
connect[0], connect[1], 0, 0)
else:
raise ValueError("unknown connect format.")
else:
raise ValueError("unknown bind or connect format.")
else:
sock = socket.socket(family, socket.SOCK_STREAM)
if sslContext:
if bind:
sock = sslContext.wrap_socket(sock, server_side=True)
else:
if connect:
sock = sslContext.wrap_socket(sock, server_side=False, server_hostname=(connect[0]))
else:
sock = sslContext.wrap_socket(sock, server_side=False)
if nodelay:
setNoDelay(sock)
if reuseaddr:
setReuseAddr(sock)
if noinherit:
setNoInherit(sock)
if timeout == 0:
timeout = None
if timeout is not _GLOBAL_DEFAULT_TIMEOUT:
sock.settimeout(timeout)
if bind:
if type(bind) is tuple and bind[1] == 0:
bindOnUnusedPort(sock, bind[0])
else:
sock.bind(bind)
try:
sock.listen(100)
except (OSError, IOError):
pass
if connect:
try:
sock.connect(connect)
except socket.error:
xv = sys.exc_info()[1]
errno = getattr(xv, "errno", 0)
if errno in ERRNO_RETRIES and not timeout is _GLOBAL_DEFAULT_TIMEOUT:
if timeout < 0.1:
timeout = 0.1
while True:
try:
sr, sw, se = select.select([], [sock], [sock], timeout)
except InterruptedError:
continue
if sock in sw:
break
elif sock in se:
sock.close()
raise socket.error("connect failed")
else:
sock.close()
raise
if keepalive:
setKeepalive(sock)
return sock
def createBroadcastSocket(bind=None, reuseaddr=False, timeout=_GLOBAL_DEFAULT_TIMEOUT, ipv6=False):
"""
Create a udp broadcast socket.
Set ipv6=True to create an IPv6 socket rather than IPv4.
Set ipv6=None to use the PREFER_IP_VERSION config setting.
"""
forceIPv6 = ipv6 or ipv6 is None and config.PREFER_IP_VERSION == 6
if not bind:
family = socket.AF_INET6 if forceIPv6 else socket.AF_INET
else:
if type(bind) is tuple:
if not bind[0]:
family = socket.AF_INET6 if forceIPv6 else socket.AF_INET
else:
if getIpVersion(bind[0]) == 4:
if forceIPv6:
raise ValueError("IPv4 address is used with forceIPv6 option:" + bind[0] + ".")
family = socket.AF_INET
else:
if getIpVersion(bind[0]) == 6:
family = socket.AF_INET6
bind = (bind[0], bind[1], 0, 0)
else:
raise ValueError("unknown bind format: %r" % (bind,))
else:
raise ValueError("unknown bind format: %r" % (bind,))
sock = socket.socket(family, socket.SOCK_DGRAM)
if family == socket.AF_INET:
sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
if reuseaddr:
setReuseAddr(sock)
if timeout is None:
sock.settimeout(None)
else:
if timeout is not _GLOBAL_DEFAULT_TIMEOUT:
sock.settimeout(timeout)
elif bind:
host = bind[0] or ""
port = bind[1]
if port == 0:
bindOnUnusedPort(sock, host)
else:
if len(bind) == 2:
sock.bind((host, port))
else:
if len(bind) == 4:
sock.bind((host, port, 0, 0))
else:
raise ValueError("bind must be None, 2-tuple or 4-tuple")
return sock
def setReuseAddr(sock):
"""sets the SO_REUSEADDR option on the socket, if possible."""
try:
sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
except Exception:
pass
def setNoDelay(sock):
"""sets the TCP_NODELAY option on the socket (to disable Nagle's algorithm), if possible."""
try:
sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
except Exception:
pass
def setKeepalive(sock):
"""sets the SO_KEEPALIVE option on the socket, if possible."""
try:
sock.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
except Exception:
pass
try:
import fcntl
def setNoInherit(sock):
"""Mark the given socket fd as non-inheritable to child processes"""
fd = sock.fileno()
flags = fcntl.fcntl(fd, fcntl.F_GETFD)
fcntl.fcntl(fd, fcntl.F_SETFD, flags | fcntl.FD_CLOEXEC)
except ImportError:
try:
if sys.platform == "cli":
raise NotImplementedError("IronPython can't obtain a proper HANDLE from a socket")
from ctypes import windll, WinError, wintypes
_SetHandleInformation = windll.kernel32.SetHandleInformation
_SetHandleInformation.argtypes = [wintypes.HANDLE, wintypes.DWORD, wintypes.DWORD]
_SetHandleInformation.restype = wintypes.BOOL
def setNoInherit(sock):
"""Mark the given socket fd as non-inheritable to child processes"""
if not _SetHandleInformation(sock.fileno(), 1, 0):
raise WinError()
except (ImportError, NotImplementedError):
def setNoInherit(sock):
"""Mark the given socket fd as non-inheritable to child processes (dummy)"""
pass
class SocketConnection(object):
__doc__ = "A wrapper class for plain sockets, containing various methods such as :meth:`send` and :meth:`recv`"
def __init__(self, sock, objectId=None, keep_open=False):
self.sock = sock
self.objectId = objectId
self.pyroInstances = {}
self.tracked_resources = weakref.WeakSet()
self.keep_open = keep_open
def __del__(self):
self.close()
def __enter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
self.close()
def send(self, data):
sendData(self.sock, data)
def recv(self, size):
return receiveData(self.sock, size)
def close(self):
if self.keep_open:
return
try:
self.sock.shutdown(socket.SHUT_RDWR)
except:
pass
try:
self.sock.close()
except:
pass
self.pyroInstances.clear()
for rsc in self.tracked_resources:
try:
rsc.close()
except Exception:
pass
self.tracked_resources.clear()
def fileno(self):
return self.sock.fileno()
def family(self):
return family_str(self.sock)
def setTimeout(self, timeout):
self.sock.settimeout(timeout)
def getTimeout(self):
return self.sock.gettimeout()
def getpeercert(self):
try:
return self.sock.getpeercert()
except AttributeError:
return
timeout = property(getTimeout, setTimeout)
def family_str(sock):
f = sock.family
if f == socket.AF_INET:
return "IPv4"
if f == socket.AF_INET6:
return "IPv6"
if hasattr(socket, "AF_UNIX"):
if f == socket.AF_UNIX:
return "Unix"
return "???"
def findProbablyUnusedPort(family=socket.AF_INET, socktype=socket.SOCK_STREAM):
"""Returns an unused port that should be suitable for binding (likely, but not guaranteed).
This code is copied from the stdlib's test.test_support module."""
tempsock = socket.socket(family, socktype)
try:
port = bindOnUnusedPort(tempsock)
if sys.platform == "cli":
return port + 1
return port
finally:
tempsock.close()
def bindOnUnusedPort(sock, host='localhost'):
"""Bind the socket to a free port and return the port number.
This code is based on the code in the stdlib's test.test_support module."""
if sock.family in (socket.AF_INET, socket.AF_INET6):
if sock.type == socket.SOCK_STREAM:
if hasattr(socket, "SO_EXCLUSIVEADDRUSE"):
try:
sock.setsockopt(socket.SOL_SOCKET, socket.SO_EXCLUSIVEADDRUSE, 1)
except socket.error:
pass
if sock.family == socket.AF_INET:
if host == "localhost":
sock.bind(('127.0.0.1', 0))
else:
sock.bind((host, 0))
else:
if sock.family == socket.AF_INET6:
if host == "localhost":
sock.bind(('::1', 0, 0, 0))
else:
sock.bind((host, 0, 0, 0))
else:
raise CommunicationError("unsupported socket family: " + sock.family)
return sock.getsockname()[1]
def interruptSocket(address):
"""bit of a hack to trigger a blocking server to get out of the loop, useful at clean shutdowns"""
try:
sock = createSocket(connect=address, keepalive=False, timeout=None)
try:
sock.sendall(b'!!!!!!!!!!!!!!!!')
except (socket.error, AttributeError):
pass
try:
sock.shutdown(socket.SHUT_RDWR)
except (OSError, socket.error):
pass
sock.close()
except socket.error:
pass
__ssl_server_context = None
__ssl_client_context = None
def getSSLcontext(servercert='', serverkey='', clientcert='', clientkey='', cacerts='', keypassword=''):
"""creates an SSL context and caches it, so you have to set the parameters correctly before doing anything"""
global __ssl_client_context
global __ssl_server_context
if not ssl:
raise ValueError("SSL requested but ssl module is not available")
else:
if sys.version_info < (2, 7, 11):
raise RuntimeError("need Python 2.7.11 or newer to properly use SSL")
else:
if servercert:
if clientcert:
raise ValueError("can't have both server cert and client cert")
elif __ssl_server_context:
return __ssl_server_context
if not os.path.isfile(servercert):
raise IOError("server cert file not found")
if serverkey:
if not os.path.isfile(serverkey):
raise IOError("server key file not found")
__ssl_server_context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
__ssl_server_context.load_cert_chain(servercert, serverkey or None, keypassword or None)
if cacerts:
if os.path.isdir(cacerts):
__ssl_server_context.load_verify_locations(capath=cacerts)
else:
__ssl_server_context.load_verify_locations(cafile=cacerts)
if config.SSL_REQUIRECLIENTCERT:
__ssl_server_context.verify_mode = ssl.CERT_REQUIRED
else:
__ssl_server_context.verify_mode = ssl.CERT_NONE
return __ssl_server_context
if __ssl_client_context:
return __ssl_client_context
__ssl_client_context = ssl.create_default_context(ssl.Purpose.SERVER_AUTH)
if clientcert:
if not os.path.isfile(clientcert):
raise IOError("client cert file not found")
else:
__ssl_client_context.load_cert_chain(clientcert, clientkey or None, keypassword or None)
if cacerts:
if os.path.isdir(cacerts):
__ssl_client_context.load_verify_locations(capath=cacerts)
else:
__ssl_client_context.load_verify_locations(cafile=cacerts)
return __ssl_client_context