scapy.main

Main module for interactive startup.

scapy.main.init_session(session_name: str | None, mydict: Dict[str, Any] | None = None, ret: bool = False) → Dict[str, Any] | None

scapy.main.interact(mydict: Any | None = None, argv: Any | None = None, mybanner: Any | None = None, loglevel: int = 20) → None

Starts Scapy’s console.

scapy.main.list_contrib(name: str | None = None, ret: bool = False, _debug: bool = False) → List[Dict[str, str]] | None

Show the list of all existing contribs.

Parameters:

• name – filter to search the contribs

• ret – whether the function should return a dict instead of printing it

Returns:

None or a dictionary containing the results if ret=True

scapy.main.load_contrib(name: str, globals_dict: Dict[str, Any] | None = None, symb_list: List[str] | None = None) → None

Loads a Scapy contrib module to make variables, objects and functions available globally.

If no contrib module can be found with the given name, try to find a layer module, since a contrib module may become a layer module.

scapy.main.load_layer(name: str, globals_dict: Dict[str, Any] | None = None, symb_list: List[str] | None = None) → None

Loads a Scapy layer module to make variables, objects and functions available globally.

scapy.main.load_module(name: str, globals_dict: Dict[str, Any] | None = None, symb_list: List[str] | None = None) → None

Loads a Scapy module to make variables, objects and functions available globally.

scapy.main.load_session(fname: str | None = None) → None

Load current Scapy session from the file specified in the fname arg. This will erase any existing session.

params:

• fname: file to load the scapy session from

scapy.main.save_session(fname: str = '', session: Dict[str, Any] | None = None, pickleProto: int = -1) → None

Save current Scapy session to the file specified in the fname arg.

params:

• fname: file to save the scapy session in

• session: scapy session to use. If None, the console one will be used

• pickleProto: pickle proto version (default: -1 = latest)

scapy.main.update_ipython_session(session: Dict[str, Any]) → None

Updates IPython session with a custom one

scapy.main.update_session(fname: str | None = None) → None

Update current Scapy session from the file specified in the fname arg.

params:

• fname: file to load the scapy session from