IPX - Internetwork Packet Exchange¶

pcapkit.protocols.internet.ipx contains IPX only, which implements extractor for Internetwork Packet Exchange (IPX) [*], whose structure is described as below:

Octets	Bits	Name	Description
0	0	`ipx.chksum`	Checksum
2	16	`ipx.len`	Packet Length (header includes)
4	32	`ipx.count`	Transport Control (hop count)
5	40	`ipx.type`	Packet Type
6	48	`ipx.dst`	Destination Address
18	144	`ipx.src`	Source Address

class pcapkit.protocols.internet.ipx.IPX(file=None, length=None, **kwargs)[source]¶

Bases: Internet[IPX, IPX]

This class implements Internetwork Packet Exchange.

Changed in version 1.5.0: from_data() rebuilds a parsed packet rather than raising struct.error (#1315), and the octets past the IPX Length field are kept as trailer (#1433).

property name: Literal['Internetwork Packet Exchange']¶: Name of corresponding protocol.

property length: Literal[30]¶: Header length of corresponding protocol.

property protocol: TransType¶: Name of next layer protocol.

property src: str¶: Source IPX address.

property dst: str¶: Destination IPX address.

read(length=None, **kwargs)[source]¶

Read Internetwork Packet Exchange.

Parameters:

length (int | None) – Length of packet data.
**kwargs (Any) – Arbitrary keyword arguments.

Return type:

IPX

Returns:

Parsed packet data.

make(chksum=b'\\x00\\x00', count=0, type=<Packet.Unknown: 0>, type_default=None, type_namespace=None, type_reversed=False, total_length=None, dst=b'\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00', src=b'\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00', payload=b'', trailer=b'', **kwargs)[source]¶

Make (construct) packet data.

Parameters:

chksum (bytes) – Checksum.
count (int) – Transport Control (hop count).
type (Packet | IntEnum | IntEnum | str | int) – Packet Type.
type_default (int | None) – Default value for undefined packet type.
type_namespace (dict[str, int] | dict[int, str] | Type[IntEnum] | Type[IntEnum] | None) – Namespace for packet type.
type_reversed (bool) – Reverse namespace for packet type.
total_length (int | None) – Packet length (header includes); computed as 30 plus the payload length when not given.
dst (bytes) – Destination Address.
src (bytes) – Source Address.
payload (bytes | ProtocolBase | Schema) – Payload data.
trailer (bytes) – Octets after the packet, outside the Packet Length, such as link-layer padding; written as is.
**kwargs (Any) – Arbitrary keyword arguments.

Return type:

IPX

Returns:

Constructed packet data.

classmethod _make_data(data)[source]¶

Create key-value pairs from data for protocol construction.

Parameters:: data (IPX) – protocol data
Return type:: dict[str, Any]
Returns:: Key-value pairs for protocol construction.

classmethod __index__()[source]¶

Numeral registry index of the protocol.

Return type:: TransType
Returns:: Numeral registry index of the protocol in IANA.

Header Schemas¶

class pcapkit.protocols.schema.internet.ipx.IPX(*args: _VT, **kwargs: _VT)[source]¶

Bases: Schema

Header schema for IPX packet.

chksum: bytes = <BytesField chksum>¶: Checksum.

len: int = <UInt16Field len>¶: Packet length (header includes).

count: int = <UInt8Field count>¶: Transport control (hop count).

type: Packet = <EnumField type>¶: Packet type.

dst: bytes = <BytesField dst>¶: Destination address.

src: bytes = <BytesField src>¶: Source address.

payload: bytes = <PayloadField payload>¶: Payload.

trailer: bytes = <PayloadField trailer>¶: Octets captured past the Packet Length, such as Ethernet minimum-frame padding. A PayloadField with no length takes whatever the payload leaves on unpack and writes its value verbatim on pack, so the octets survive whatever they hold.

Data Models¶

class pcapkit.protocols.data.internet.ipx.IPX(*args: VT, **kwargs: VT)[source]¶

Bases: Protocol

Data model for Internetwork Packet Exchange.

chksum: bytes¶: Checksum.

len: int¶: Packet length (header includes).

count: int¶: Transport control (hop count).

type: Packet¶: Packet type.

dst: Address¶: Destination Address.

src: Address¶: Source Address.

trailer: bytes¶: Octets captured past the Packet Length, present only when there are any.

class pcapkit.protocols.data.internet.ipx.Address(*args: VT, **kwargs: VT)[source]¶

Bases: Data

Data model for IPX address.

network: str¶: Network number (: separated).

node: str¶: Node number (- separated).

socket: Socket¶: Socket number (: separated).

addr: str¶: Full address (: separated).

Footnotes