net_utils.py

Net utilities.

__all__ = ['resolve_hostname', 'validate_scheme_host_port'] module-attribute

is_valid_hostname(hostname)

Validate a host name.

Parameters:

Name	Type	Description	Default
hostname	str	host name to validate.	required

Returns:

Type	Description
bool	True if is valid else False.

Source code in solnlib/net_utils.py

def is_valid_hostname(hostname: str) -> bool:
    """Validate a host name.

    Arguments:
        hostname: host name to validate.

    Returns:
        True if is valid else False.
    """
    # Splunk IPv6 support.
    # https://docs.splunk.com/Documentation/Splunk/9.0.0/Admin/ConfigureSplunkforIPv6#Change_the_prioritization_of_IPv4_and_IPv6_communications
    if hostname == "[::1]":
        return True

    if len(hostname) > 255:
        return False
    if hostname[-1:] == ".":
        hostname = hostname[:-1]
    allowed = re.compile(r"(?!-)(::)?[A-Z\d-]{1,63}(?<!-)$", re.IGNORECASE)
    return all(allowed.match(x) for x in hostname.split("."))

is_valid_ip(addr)

Validate an IPV4 address.

Parameters:

Name	Type	Description	Default
addr	str	IP address to validate.	required

Returns:

Type	Description
bool	True if is valid else False.

Source code in solnlib/net_utils.py

def is_valid_ip(addr: str) -> bool:
    """Validate an IPV4 address.

    Arguments:
        addr: IP address to validate.

    Returns:
        True if is valid else False.
    """

    ip_rx = re.compile(
        r"""
        ^(((
              [0-1]\d{2}                  # matches 000-199
            | 2[0-4]\d                    # matches 200-249
            | 25[0-5]                     # matches 250-255
            | \d{1,2}                     # matches 0-9, 00-99
        )\.){3})                          # 3 of the preceding stanzas
        ([0-1]\d{2}|2[0-4]\d|25[0-5]|\d{1,2})$     # final octet
    """,
        re.VERBOSE,
    )

    try:
        return ip_rx.match(addr.strip())
    except AttributeError:
        # Value was not a string
        return False

is_valid_port(port)

Validate a port.

Parameters:

Name	Type	Description	Default
port	Union[str, int]	port to validate.	required

Returns:

Type	Description
bool	True if is valid else False.

Source code in solnlib/net_utils.py

def is_valid_port(port: Union[str, int]) -> bool:
    """Validate a port.

    Arguments:
        port: port to validate.

    Returns:
        True if is valid else False.
    """

    try:
        return 0 < int(port) <= 65535
    except ValueError:
        return False

is_valid_scheme(scheme)

Validate a scheme.

Parameters:

Name	Type	Description	Default
scheme	str	scheme to validate.	required

Returns:

Type	Description
bool	True if is valid else False.

Source code in solnlib/net_utils.py

def is_valid_scheme(scheme: str) -> bool:
    """Validate a scheme.

    Arguments:
        scheme: scheme to validate.

    Returns:
        True if is valid else False.
    """

    return scheme.lower() in ("http", "https")

resolve_hostname(addr)

Try to resolve an IP to a host name and returns None on common failures.

Parameters:

Name	Type	Description	Default
addr	str	IP address to resolve.	required

Returns:

Type	Description
Optional[str]	Host name if success else None.

Raises:

Type	Description
ValueError	If addr is not a valid address.

Source code in solnlib/net_utils.py

def resolve_hostname(addr: str) -> Optional[str]:
    """Try to resolve an IP to a host name and returns None on common failures.

    Arguments:
        addr: IP address to resolve.

    Returns:
        Host name if success else None.

    Raises:
        ValueError: If `addr` is not a valid address.
    """

    if is_valid_ip(addr):
        try:
            name, _, _ = socket.gethostbyaddr(addr)
            return name
        except socket.gaierror:
            # [Errno 8] nodename nor servname provided, or not known
            pass
        except socket.herror:
            # [Errno 1] Unknown host
            pass
        except socket.timeout:
            # Timeout.
            pass

        return None
    else:
        raise ValueError("Invalid ip address.")

validate_scheme_host_port(scheme, host, port)

Validates scheme, host and port.

Parameters:

Name	Type	Description	Default
scheme	str	scheme to validate.	required
host	str	hostname to validate.	required
port	Union[str, int]	port to validate.	required

Raises:

Type	Description
ValueError	if scheme, host or port are invalid.

Source code in solnlib/net_utils.py

def validate_scheme_host_port(scheme: str, host: str, port: Union[str, int]):
    """Validates scheme, host and port.

    Arguments:
        scheme: scheme to validate.
        host: hostname to validate.
        port: port to validate.

    Raises:
        ValueError: if scheme, host or port are invalid.
    """
    if scheme is not None and not is_valid_scheme(scheme):
        raise ValueError("Invalid scheme")
    if host is not None and not is_valid_hostname(host):
        raise ValueError("Invalid host")
    if port is not None and not is_valid_port(port):
        raise ValueError("Invalid port")