IP Address Fields

IP Addresses

class pcapkit.corekit.fields.ipaddress.IPv4AddressField(default=<pcapkit.corekit.fields.field.NoValueType object>, callback=<function IPv4AddressField.<lambda>>)

Bases: _IPAddressField[IPv4Address]

IPv4 address value for protocol fields.

Parameters:

• default (IPv4Address | NoValueType) – Field default value, if any.

• callback (Callable[[Self, dict[str, Any]], None]) – Callback function to be called upon self.__call__.

property version: Literal[4]

IP version number.

class pcapkit.corekit.fields.ipaddress.IPv6AddressField(default=<pcapkit.corekit.fields.field.NoValueType object>, callback=<function IPv6AddressField.<lambda>>)

Bases: _IPAddressField[IPv6Address]

IPv6 address value for protocol fields.

Parameters:

• default (IPv6Address | NoValueType) – Field default value, if any.

• callback (Callable[[Self, dict[str, Any]], None]) – Callback function to be called upon self.__call__.

property version: Literal[6]

IP version number.

IP Interface

class pcapkit.corekit.fields.ipaddress.IPv4InterfaceField(default=<pcapkit.corekit.fields.field.NoValueType object>, callback=<function IPv4InterfaceField.<lambda>>)

Bases: _IPInterfaceField[IPv4Interface]

IPv4 interface value for protocol fields.

Parameters:

• default (IPv4Interface | NoValueType) – Field default value, if any.

• callback (Callable[[Self, dict[str, Any]], None]) – Callback function to be called upon self.__call__.

property version: Literal[4]

IP version number.

pre_process(value, packet)

Process field value before packing.

Parameters:

• value (IPv4Interface | bytes | int | str) – Field value.

• packet (dict[str, Any]) – Packet data.

Return type:

bytes

Returns:

Processed field value.

post_process(value, packet)

Process field value after parsing (unpacking).

Parameters:

• value (bytes) – Field value.

• packet (dict[str, Any]) – Packet data.

Return type:

IPv4Interface

Returns:

Processed field value.

class pcapkit.corekit.fields.ipaddress.IPv6InterfaceField(default=<pcapkit.corekit.fields.field.NoValueType object>, callback=<function IPv6InterfaceField.<lambda>>)

Bases: _IPInterfaceField[IPv6Interface]

IPv6 interface value for protocol fields.

Parameters:

• default (IPv6Interface | NoValueType) – Field default value, if any.

• callback (Callable[[Self, dict[str, Any]], None]) – Callback function to be called upon self.__call__.

property version: Literal[6]

IP version number.

pre_process(value, packet)

Process field value before packing.

Parameters:

• value (IPv6Interface | bytes | int | str) – Field value.

• packet (dict[str, Any]) – Packet data.

Return type:

bytes

Returns:

Processed field value.

post_process(value, packet)

Process field value after parsing (unpacking).

Parameters:

• value (bytes) – Field value.

• packet (dict[str, Any]) – Packet data.

Return type:

IPv6Interface

Returns:

Processed field value.

Internal Definitions

class pcapkit.corekit.fields.ipaddress._IPField(length, default=<pcapkit.corekit.fields.field.NoValueType object>, callback=<function Field.<lambda>>)

Bases: Field[_T], Generic[_T]

Internal IP related value for protocol fields.

Parameters:

• length (Union[int, Callable[[dict[str, Any]], int]]) – Field size (in bytes).

• callback (Callable[[Self, dict[str, Any]], None]) – Callback function to be called upon self.__call__.

abstract property version: int

IP version number.

class pcapkit.corekit.fields.ipaddress._IPAddressField(length, default=<pcapkit.corekit.fields.field.NoValueType object>, callback=<function Field.<lambda>>)

Bases: _IPField[_AT]

Internal IP address value for protocol fields.

Parameters:

• length (Union[int, Callable[[dict[str, Any]], int]]) – Field size (in bytes).

• callback (Callable[[Self, dict[str, Any]], None]) – Callback function to be called upon self.__call__.

pre_process(value, packet)

Process field value before packing.

Parameters:

• value (Union[TypeVar(_AT, IPv4Address, IPv6Address), bytes, int, str]) – Field value.

• packet (dict[str, Any]) – Packet data.

Return type:

bytes

Returns:

Processed field value.

post_process(value, packet)

Process field value after parsing (unpacking).

Parameters:

• value (bytes) – Field value.

• packet (dict[str, Any]) – Packet data.

Return type:

TypeVar(_AT, IPv4Address, IPv6Address)

Returns:

Processed field value.

class pcapkit.corekit.fields.ipaddress._IPInterfaceField(length, default=<pcapkit.corekit.fields.field.NoValueType object>, callback=<function Field.<lambda>>)

Bases: _IPField[_IT]

Internal IP interface value for protocol fields.

Parameters:

• length (Union[int, Callable[[dict[str, Any]], int]]) – Field size (in bytes); if a callable is given, it should return an integer value and accept the current packet as its only argument.

• default (Union[TypeVar(_T), NoValueType]) – Field default value, if any.

• callback (Callable[[Self, dict[str, Any]], None]) – Callback function to be called upon self.__call__.

Type Variables

pcapkit.corekit.fields.ipaddress._T: ipaddress.IPv4Address | ipaddress.IPv6Address | ipaddress.IPv4Interface | ipaddress.IPv6Interface

pcapkit.corekit.fields.ipaddress._AT: ipaddress.IPv4Address | ipaddress.IPv6Address

pcapkit.corekit.fields.ipaddress._IT: ipaddress.IPv4Interface | ipaddress.IPv6Interface