Function ScopedIP

scapy/base_classes.py:128–157

An str that also holds extra attributes. Examples:: >>> ScopedIP("224.0.0.1%eth0") # interface 'eth0' >>> ScopedIP("224.0.0.1%1") # interface index 1 >>> ScopedIP("224.0.0.1", scope=conf.iface)

(net: str, scope: Optional[Any] = None)

def ScopedIP(net: str, scope: Optional[Any] = None) -> _ScopedIP:
    """
    An str that also holds extra attributes.

    Examples::

        >>> ScopedIP("224.0.0.1%eth0")  # interface 'eth0'
        >>> ScopedIP("224.0.0.1%1")  # interface index 1
        >>> ScopedIP("224.0.0.1", scope=conf.iface)
    """
    if "%" in net:
        try:
            net, scope = net.split("%", 1)
        except ValueError:
            raise Scapy_Exception("Scope identifier can only be present once !")
    if scope is not None:
        from scapy.interfaces import resolve_iface, network_name, dev_from_index
        try:
            iface = dev_from_index(int(scope))
        except (ValueError, TypeError):
            iface = resolve_iface(scope)
        if not iface.is_valid():
            raise Scapy_Exception(
                "RFC6874 scope identifier '%s' could not be resolved to a "
                "valid interface !" % scope
            )
        scope = network_name(iface)
    x = _ScopedIP(net)
    x.scope = scope
    return x


class Net(Gen[str]):