Registry Management

This module (pcapkit.foundation.registry) provides the registry management for pcapkit, as the module contains various registry points.

Foundation Registries

Engine Registries

pcapkit.foundation.registry.foundation.register_extractor_engine(name, module, class_='(null)')

Registered a new engine class.

Overloads:

• name (str), module (ModuleDescriptor[Engine] | Type[Engine]) → None

• name (str), module (str), class_ (str) → None

Notes

The full qualified class name of the new engine class should be as {module}.{class_}.

The function will register the given engine class to the pcapkit.foundation.extraction.Extractor.__engine__ registry.

Parameters:

• engine – engine name

• module (ModuleDescriptor[Engine] | Type[Engine] | str) – module name or module descriptor or an Engine subclass

• class_ (str) – class name

Dumper Registries

pcapkit.foundation.registry.foundation.register_dumper(format, module, class_='(null)', *, ext)

Registered a new dumper class.

Overloads:

• format (str), module (ModuleDescriptor[Dumper] | Type[Dumper]), ext (str) → None

• format (str), module (str), class_ (str), ext (str) → None

Notes

The full qualified class name of the new dumper class should be as {module}.{class_}.

The function will register the given dumper class to the pcapkit.foundation.traceflow.traceflow.TraceFlow.__output__ and pcapkit.foundation.extraction.Extractor.__output__ registry.

Parameters:

• format (str) – format name

• module (ModuleDescriptor[Dumper] | Type[Dumper] | str) – module name or module descriptor or a Dumper subclass

• class_ (str) – class name

• ext (str) – file extension

See also

• pcapkit.foundation.registry.foundation.register_extractor_dumper()

• pcapkit.foundation.registry.foundation.register_traceflow_dumper()

pcapkit.foundation.registry.foundation.register_extractor_dumper(format, module, class_='(null)', *, ext)

Registered a new dumper class.

Overloads:

• format (str), module (ModuleDescriptor[Dumper] | Type[Dumper]), ext (str) → None

• format (str), module (str), class_ (str), ext (str) → None

Notes

The full qualified class name of the new dumper class should be as {module}.{class_}.

The function will register the given dumper class to the pcapkit.foundation.extraction.Extractor.__output__ registry.

Parameters:

• format (str) – format name

• module (ModuleDescriptor[Dumper] | Type[Dumper] | str) – module name or module descriptor or a Dumper subclass

• class_ (str) – class name

• ext (str) – file extension

pcapkit.foundation.registry.foundation.register_traceflow_dumper(format, module, class_='(null)', *, ext)

Registered a new dumper class.

Overloads:

• format (str), module (ModuleDescriptor[Dumper] | Type[Dumper]), ext (str) → None

• format (str), module (str), class_ (str), ext (str) → None

Notes

The full qualified class name of the new dumper class should be as {module}.{class_}.

The function will register the given dumper class to the pcapkit.foundation.traceflow.traceflow.TraceFlow.__output__ registry.

Parameters:

• format (str) – format name

• module (ModuleDescriptor[Dumper] | Type[Dumper] | str) – module name or module descriptor or a Dumper subclass

• class_ (str) – class name

• ext (str) – file extension

Callback Registries

pcapkit.foundation.registry.foundation.register_reassembly_ipv4_callback(callback)

Registered a new callback function.

The function will register the given callback function to the IPv4.__callback_fn__ registry.

Parameters:

callback (Reasm_CallbackFn) – callback function

Return type:

None

pcapkit.foundation.registry.foundation.register_reassembly_ipv6_callback(callback)

Registered a new callback function.

The function will register the given callback function to the IPv6.__callback_fn__ registry.

Parameters:

callback (Reasm_CallbackFn) – callback function

Return type:

None

pcapkit.foundation.registry.foundation.register_reassembly_tcp_callback(callback)

Registered a new callback function.

The function will register the given callback function to the TCP.__callback_fn__ registry.

Parameters:

callback (Reasm_CallbackFn) – callback function

Return type:

None

pcapkit.foundation.registry.foundation.register_traceflow_tcp_callback(callback)

Registered a new callback function.

The function will register the given callback function to the TCP.__callback_fn__ registry.

Parameters:

callback (Trace_CallbackFn) – callback function

Return type:

None

Extractor Registries

pcapkit.foundation.registry.foundation.register_extractor_reassembly(protocol, module, class_='(null)')

Registered a new reassembly class.

Overloads:

• protocol (str), module (ModuleDescriptor[Reassembly] | Type[Reassembly]) → None

• protocol (str), module (str), class_ (str) → None

Notes

The full qualified class name of the new reassembly class should be as {module}.{class_}.

The function will register the given reassembly class to the pcapkit.foundation.extraction.Extractor.__reassembly__ registry.

Parameters:

• protocol (str) – protocol name

• module (str | ModuleDescriptor[Reassembly] | Type[Reassembly]) – module name or module descriptor or a Reassembly subclass

• class_ (str) – class name

pcapkit.foundation.registry.foundation.register_extractor_traceflow(protocol, module, class_='(null)')

Registered a new flow tracing class.

Overloads:

• protocol (str), module (ModuleDescriptor[TraceFlow] | Type[TraceFlow]) → None

• protocol (str), module (str), class_ (str) → None

Notes

The full qualified class name of the new flow tracing class should be as {module}.{class_}.

The function will register the given flow tracing class to the pcapkit.foundation.extraction.Extractor.__traceflow__ registry.

Parameters:

• protocol (str) – protocol name

• module (str | ModuleDescriptor[TraceFlow] | Type[TraceFlow]) – module name or module descriptor or a TraceFlow subclass

• class_ (str) – class name

Protocol Registries

pcapkit.foundation.registry.protocols.register_protocol(protocol)

Registered protocol class.

The protocol class must be a subclass of Protocol, and will be registered to the pcapkit.protocols.__proto__ registry.

Parameters:

protocol (Type[ProtocolBase]) – Protocol class.

Return type:

None

Top-Level Registries

pcapkit.foundation.registry.protocols.register_linktype(code, module, class_='(null)')

Register a new protocol class.

Overloads:

• code (LinkType), module (ModuleDescriptor[Protocol] | Type[Protocol]) → None

• code (LinkType), module (str), class_ (str) → None

Notes

The full qualified class name of the new protocol class should be as {module}.{class_}.

The function will register the given protocol class to the following registries:

• pcapkit.protocols.misc.pcap.frame.Frame.__proto__

• pcapkit.protocols.misc.pcapng.PCAPNG.__proto__

Parameters:

• code (LinkType) – protocol code as in LinkType

• module (str | ModuleDescriptor[ProtocolBase] | Type[ProtocolBase]) – module name or module descriptor or a Protocol subclass

• class_ (str) – class name

See also

• pcapkit.foundation.registry.protocols.register_pcap()

• pcapkit.foundation.registry.protocols.register_pcapng()

pcapkit.foundation.registry.protocols.register_pcap(code, module, class_='(null)')

Register a new protocol class.

Overloads:

• code (LinkType), module (ModuleDescriptor[Protocol] | Type[Protocol]) → None

• code (LinkType), module (str), class_ (str) → None

Notes

The full qualified class name of the new protocol class should be as {module}.{class_}.

The function will register the given protocol class to the pcapkit.protocols.misc.pcap.frame.Frame.__proto__ registry.

Parameters:

• code (LinkType) – protocol code as in LinkType

• module (str | ModuleDescriptor[ProtocolBase] | Type[ProtocolBase]) – module name or module descriptor or a Protocol subclass

• class_ (str) – class name

pcapkit.foundation.registry.protocols.register_pcapng(code, module, class_='(null)')

Register a new protocol class.

Overloads:

• code (LinkType), module (ModuleDescriptor[Protocol] | Type[Protocol]) → None

• code (LinkType), module (str), class_ (str) → None

Notes

The full qualified class name of the new protocol class should be as {module}.{class_}.

The function will register the given protocol class to the pcapkit.protocols.misc.pcapng.PCAPNG.__proto__ registry.

Parameters:

• code (LinkType) – protocol code as in LinkType

• module (str | ModuleDescriptor[ProtocolBase] | Type[ProtocolBase]) – module name or module descriptor or a Protocol subclass

• class_ (str) – class name

Link Layer Registries

pcapkit.foundation.registry.protocols.register_ethertype(code, module, class_='(null)')

Register a new protocol class.

Overloads:

• code (EtherType), module (ModuleDescriptor[Protocol] | Type[Protocol]) → None

• code (EtherType), module (str), class_ (str) → None

Notes

The full qualified class name of the new protocol class should be as {module}.{class_}.

The function will register the given protocol class to the pcapkit.protocols.link.link.Link.__proto__ registry.

Parameters:

• code (EtherType) – protocol code as in EtherType

• module (str | ModuleDescriptor[ProtocolBase] | Type[ProtocolBase]) – module name or module descriptor or a Protocol subclass

• class_ (str) – class name

Internet Layer Registries

pcapkit.foundation.registry.protocols.register_transtype(code, module, class_='(null)')

Register a new protocol class.

Overloads:

• code (TransType), module (ModuleDescriptor[Protocol] | Type[Protocol]) → None

• code (TransType), module (str), class_ (str) → None

Notes

The full qualified class name of the new protocol class should be as {module}.{class_}.

The function will register the given protocol class to the pcapkit.protocols.internet.internet.Internet.__proto__ registry.

Parameters:

• code (TransType) – protocol code as in TransType

• module (str | ModuleDescriptor[ProtocolBase] | Type[ProtocolBase]) – module name or module descriptor or a Protocol subclass

• class_ (str) – class name

pcapkit.foundation.registry.protocols.register_ipv4_option(code, meth, *, schema=None)

Register an option parser.

The function will register the given option parser to the pcapkit.protocols.internet.internet.IPv4 internal registry.

Parameters:

• code (OptionNumber) – IPv4 option code as in OptionNumber.

• meth (str | tuple[Callable[[Option, OrderedMultiDict[OptionNumber, Option]], Option], Callable[[OptionNumber, Option | None, Any], Option]]) – Method name or callable to parse and/or construct the option.

• schema (Type[Option] | None) – Schema class for the option. It should be a subclass of pcapkit.protocols.schema.internet.ipv4.Option.

Return type:

None

pcapkit.foundation.registry.protocols.register_hip_parameter(code, meth, *, schema=None)

Register a parameter parser.

The function will register the given parameter parser to the pcapkit.protocols.internet.hip.HIP internal registry.

Parameters:

• code (Parameter) – HIP parameter code as in Parameter.

• meth (str | tuple[Callable[[Parameter, int, OrderedMultiDict[Parameter, Parameter]], Parameter], Callable[[Parameter, Parameter | None, int, Any], Parameter]]) – Method name or callable to parse and/or construct the parameter.

• schema (Type[Parameter] | None) – Schema class for the parameter. It should be a subclass of pcapkit.protocols.schema.internet.hip.Parameter.

Return type:

None

pcapkit.foundation.registry.protocols.register_hopopt_option(code, meth, *, schema=None)

Register an option parser.

The function will register the given option parser to the pcapkit.protocols.internet.hopopt.HOPOPT.__option__ registry.

Parameters:

• code (Option) – HOPOPT option code as in Option.

• meth (str | tuple[Callable[[Option, OrderedMultiDict[Option, Option]], Option], Callable[[Option, Option | None, Any], Option]]) – Method name or callable to parse and/or construct the option.

• schema (Type[Option] | None) – Schema class for the option. It should be a subclass of pcapkit.protocols.schema.internet.hopopt.Option.

Return type:

None

pcapkit.foundation.registry.protocols.register_ipv6_opts_option(code, meth, *, schema=None)

Register an option parser.

The function will register the given option parser to the pcapkit.protocols.internet.ipv6_opts.IPv6_Opts.__option__ registry.

Parameters:

• code (Option) – IPv6-Opts option code as in Option.

• meth (str | tuple[Callable[[Option, OrderedMultiDict[Option, Option]], Option], Callable[[Option, Option | None, Any], Option]]) – Method name or callable to parse and/or construct the option.

• schema (Type[Option] | None) – Schema class for the option. It should be a subclass of pcapkit.protocols.schema.internet.ipv6_opts.Option.

Return type:

None

pcapkit.foundation.registry.protocols.register_ipv6_route_routing(code, meth, *, schema=None)

Register a routing data parser.

The function will register the given routing data parser to the pcapkit.protocols.internet.ipv6_route.IPv6_Route.__routing__ registry.

Parameters:

• code (Routing) – IPv6-Route data type code as in Routing.

• meth (str | tuple[Callable[[RoutingType, IPv6_Route], IPv6_Route], Callable[[Routing, IPv6_Route | None, IPv6Address | None, Any], RoutingType]]) – Method name or callable to parse and/or construct the data.

• schema (Type[RoutingType] | None) – Schema class for the routing data. It should be a subclass of pcapkit.protocols.schema.internet.ipv6_route.RoutingType.

Return type:

None

pcapkit.foundation.registry.protocols.register_mh_message(code, meth, *, schema=None)

Register a MH message type parser.

The function will register the given message type parser to the pcapkit.protocols.internet.mh.MH.__message__ registry.

Parameters:

• code (Packet) – MH> data type code as in Packet.

• meth (str | tuple[Callable[[Packet, MH], MH], Callable[[MH | None, Any], Packet]]) – Method name or callable to parse and/or construct the data.

• schema (Type[Packet] | None) – Schema class for the message type. It should be a subclass of pcapkit.protocols.schema.internet.mh.Packet.

Return type:

None

pcapkit.foundation.registry.protocols.register_mh_option(code, meth, *, schema=None)

Register a MH option parser.

The function will register the given option parser to the pcapkit.protocols.internet.mh.MH.__option__ registry.

Parameters:

• code (Option) – MH> data type code as in Option.

• meth (str | tuple[Callable[[Option, OrderedMultiDict[Option, Option]], Option], Callable[[Option, Option | None, Any], Option]]) – Method name or callable to parse and/or construct the data.

• schema (Type[Option] | None) – Schema class for the message type. It should be a subclass of pcapkit.protocols.schema.internet.mh.Option.

Return type:

None

pcapkit.foundation.registry.protocols.register_mh_extension(code, meth, schema=None)

Register a CGA extension parser.

The function will register the given CGA extension to the pcapkit.protocols.internet.mh.MH.__extension__ registry.

Parameters:

• code (CGAExtension) – MH> data type code as in CGAExtension.

• meth (str | tuple[Callable[[CGAExtension, OrderedMultiDict[CGAExtension, CGAExtension]], CGAExtension], Callable[[CGAExtension, CGAExtension | None, Any], CGAExtension]]) – Method name or callable to parse and/or construct the data.

• schema (Type[CGAExtension] | None) – Schema class for the message type. It should be a subclass of pcapkit.protocols.schema.internet.mh.CGAExtension.

Return type:

None

Transport Layer Registries

pcapkit.foundation.registry.protocols.register_apptype(code, module, class_='(null)', *, proto='(null)')

Register a new protocol class.

Overloads:

• code (int), module (ModuleDescriptor[Protocol] | Type[Protocol]), proto (TransportProtocol | str) → None

• code (Enum_AppType), module (ModuleDescriptor[Protocol] | Type[Protocol]), proto (TransportProtocol | str) → None

• code (int), module (str), class_ (str), proto (TransportProtocol | str) → None

• code (Enum_AppType), module (str), class_ (str), proto (TransportProtocol | str) → None

Notes

The full qualified class name of the new protocol class should be as {module}.{class_}.

The function will register the given protocol class to the pcapkit.protocols.transport.tcp.TCP.__proto__ and/or pcapkit.protocols.transport.udp.UDP.__proto__ registry.

Parameters:

• code (int | AppType) – port number

• module (str | ModuleDescriptor[ProtocolBase] | Type[ProtocolBase]) – module name or module descriptor or a Protocol subclass

• class_ (str) – class name

• proto (TransportProtocol | str) – protocol name (must be a valid transport protocol)

See also

• pcapkit.foundation.registry.register_tcp()

• pcapkit.foundation.registry.register_udp()

pcapkit.foundation.registry.protocols.register_tcp(code, module, class_='(null)')

Register a new protocol class.

Overloads:

• code (int | Enum_AppType), module (ModuleDescriptor[Protocol] | Type[Protocol]) → None

• code (int | Enum_AppType), module (str), class_ (str) → None

Notes

The full qualified class name of the new protocol class should be as {module}.{class_}.

The function will register the given protocol class to the pcapkit.protocols.transport.tcp.TCP.__proto__ registry.

Parameters:

• code (int | AppType) – port number

• module (str | ModuleDescriptor[ProtocolBase] | Type[ProtocolBase]) – module name or module descriptor or a Protocol subclass

• class_ (str) – class name

pcapkit.foundation.registry.protocols.register_tcp_option(code, meth, *, schema=None)

Register an option parser.

The function will register the given option parser to the pcapkit.protocols.transport.tcp.TCP.__option__ registry.

Parameters:

• code (Option) – TCP option code as in Option.

• meth (str | tuple[Callable[[Option, OrderedMultiDict[Option, Option]], Option], Callable[[Option, Option | None, Any], Option]]) – Method name or callable to parse and/or construct the option.

• schema (Type[Option] | None) – Schema class for the option. It should be a subclass of pcapkit.protocols.schema.transport.tcp.Option.

Return type:

None

pcapkit.foundation.registry.protocols.register_tcp_mp_option(code, meth, *, schema=None)

Register an MPTCP option parser.

The function will register the given option parser to the pcapkit.protocols.transport.tcp.TCP.__mp_option__ registry.

Parameters:

• code (MPTCPOption) – Multipath TCP option code as in MPTCPOption.

• meth (str | tuple[Callable[[MPTCP, OrderedMultiDict[Option, Option]], MPTCP], Callable[[MPTCPOption, MPTCP | None, Any], MPTCP]]) – Method name or callable to parse and/or construct the option.

• schema (Type[MPTCP] | None) – Schema class for the option. It should be a subclass of pcapkit.protocols.schema.transport.tcp.MPTCP.

Return type:

None

pcapkit.foundation.registry.protocols.register_udp(code, module, class_='(null)')

Register a new protocol class.

Overloads:

• code (int | Enum_AppType), module (ModuleDescriptor[Protocol] | Type[Protocol]) → None

• code (int | Enum_AppType), module (str), class_ (str) → None

Notes

The full qualified class name of the new protocol class should be as {module}.{class_}.

The function will register the given protocol class to the pcapkit.protocols.transport.udp.UDP.__proto__ registry.

Parameters:

• code (int | AppType) – port number

• module (str | ModuleDescriptor[ProtocolBase] | Type[ProtocolBase]) – module name or module descriptor or a Protocol subclass

• class_ (str) – class name

Application Layer Registries

pcapkit.foundation.registry.protocols.register_http_frame(code, meth, *, schema=None)

Registered a frame parser.

The function will register the given frame parser to the pcapkit.protocols.application.httpv2.HTTP.__frame__ registry.

Parameters:

• code (HTTP_Frame) – HTTP/2 frame type code as in Frame.

• meth (str | tuple[HTTP_FrameParser, HTTP_FrameConstructor]) – Method name or callable to parse and/or construct the frame.

• schema (Optional[Type[Schema_HTTP_FrameType]]) – Schema class for the frame. It should be a subclass of pcapkit.protocols.schema.application.httpv2.FrameType.

Return type:

None

Miscellaneous Protocol Registries

pcapkit.foundation.registry.protocols.register_pcapng_block(code, meth, *, schema=None)

Registered a block parser.

The function will register the given block parser to the pcapkit.protocols.misc.pcapng.PCAPNG.__block__ registry.

Parameters:

• code (BlockType) – HTTP/2 block type code as in BlockType.

• meth (str | tuple[Callable[[BlockType, PCAPNG], PCAPNG], Callable[[PCAPNG | None, Any], BlockType]]) – Method name or callable to parse and/or construct the block.

• schema (Type[BlockType] | None) – Schema class for the block. It should be a subclass of pcapkit.protocols.schema.misc.pcapng.BlockType.

Return type:

None

pcapkit.foundation.registry.protocols.register_pcapng_option(code, meth, *, schema=None)

Registered a option parser.

The function will register the given option parser to the pcapkit.protocols.misc.pcapng.PCAPNG.__option__ registry.

Parameters:

• code (OptionType) – PCAPNG option type code as in OptionType.

• meth (str | tuple[Callable[[Option, OrderedMultiDict[OptionType, Option]], Option], Callable[[OptionType, Option | None, Any], Option]]) – Method name or callable to parse and/or construct the option.

• schema (Type[Option] | None) – Schema class for the option. It should be a subclass of pcapkit.protocols.schema.misc.pcapng.Option.

Return type:

None

pcapkit.foundation.registry.protocols.register_pcapng_record(code, meth, *, schema=None)

Registered a name resolution record parser.

The function will register the given name resolution record parser to the pcapkit.protocols.misc.pcapng.PCAPNG.__record__ registry.

Parameters:

• code (RecordType) – PCAPNG name resolution record type code as in RecordType.

• meth (str | tuple[Callable[[NameResolutionRecord, OrderedMultiDict[RecordType, NameResolutionRecord]], NameResolutionRecord], Callable[[RecordType, NameResolutionRecord | None, Any], NameResolutionRecord]]) – Method name or callable to parse and/or construct the name resolution record.

• schema (Type[NameResolutionRecord] | None) – Schema class for the name resolution record. It should be a subclass of pcapkit.protocols.schema.misc.pcapng.NameResolutionRecord.

Return type:

None

pcapkit.foundation.registry.protocols.register_pcapng_secrets(code, meth, *, schema=None)

Registered a decryption secrets parser.

The function will register the given decryption secrets parser to the pcapkit.protocols.misc.pcapng.PCAPNG.__secrets__ registry.

Parameters:

• code (SecretsType) – PCAPNG decryption secrets type code as in SecretsType.

• meth (str | tuple[Callable[[DSBSecrets, DecryptionSecretsBlock], DSBSecrets], Callable[[SecretsType, DSBSecrets | None, Any], DSBSecrets]]) – Method name or callable to parse and/or construct the decryption secrets.

• schema (Type[DSBSecrets] | None) – Schema class for the decryption secrets. It should be a subclass of pcapkit.protocols.schema.misc.pcapng.DSBSecrets.

Return type:

None