scapy.interfaces

Interfaces management

class scapy.interfaces.InterfaceProvider

Bases: object

header_sort = 1

headers = ('Index', 'Name', 'MAC', 'IPv4', 'IPv6')

l2listen() → Type[SuperSocket]

Return L2listen socket used by interfaces of this provider

l2socket() → Type[SuperSocket]

Return L2 socket used by interfaces of this provider

l3socket() → Type[SuperSocket]

Return L3 socket used by interfaces of this provider

libpcap = False

load() → Dict[str, NetworkInterface]

Returns a dictionary of the loaded interfaces, by their name.

name = 'Unknown'

reload() → Dict[str, NetworkInterface]

Same than load() but for reloads. By default calls load

class scapy.interfaces.NetworkInterface(provider: InterfaceProvider, data: Dict[str, Any] | None = None)

Bases: object

is_valid() → bool

l2listen() → Type[SuperSocket]

l2socket() → Type[SuperSocket]

l3socket() → Type[SuperSocket]

update(data: Dict[str, Any]) → None

Update info about a network interface according to a given dictionary. Such data is provided by providers

class scapy.interfaces.NetworkInterfaceDict

Bases: UserDict[str, NetworkInterface]

Store information about network interfaces and convert between names

dev_from_index(if_index: int) → NetworkInterface

Return interface name from interface index

dev_from_name(name: str) → NetworkInterface

Return the first network device name for a given device name.

dev_from_networkname(network_name: str) → NoReturn

Return interface for a given network device name.

load_confiface() → None

Reload conf.iface

register_provider(provider: type) → None

reload() → None

show(print_result: bool = True, hidden: bool = False, **kwargs: Any) → str | None

Print list of available network interfaces in human readable form

Parameters:

• print_result – print the results if True, else return it

• hidden – if True, also displays invalid interfaces

scapy.interfaces.dev_from_index(if_index: int) → NetworkInterface

Return interface for a given interface index

scapy.interfaces.dev_from_networkname(network_name: str) → NetworkInterface

Return Scapy device name for given network device name

scapy.interfaces.get_if_list() → List[str]

Return a list of interface names

scapy.interfaces.get_working_if() → NetworkInterface

Return an interface that works

scapy.interfaces.get_working_ifaces() → List[NetworkInterface]

Return all interfaces that work

scapy.interfaces.network_name(dev: NetworkInterface | str) → str

Resolves the device network name of a device or Scapy NetworkInterface

scapy.interfaces.resolve_iface(dev: NetworkInterface | str) → NetworkInterface

Resolve an interface name into the interface

scapy.interfaces.show_interfaces(resolve_mac: bool = True) → None

Print list of available network interfaces