Skip to content

Implement SCTP as a transport protocol (RFC 9260) #379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JarryShaw merged 2 commits into from
Sep 14, 2026
Merged

Implement SCTP as a transport protocol (RFC 9260) #379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c43fcd
sctp: implement SCTP as a transport protocol
JarryShaw Sep 14, 2026
2d67f86
sctp: add the vendor crawlers, and stop an unregistered PPID mutating…
JarryShaw Sep 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/source/ext.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ The following table shows all available protocol classes in :mod:`pcapkit`:
| Transport Layer | :class:`pcapkit.protocols.transport.tcp.TCP` |
+ (:class:`~pcapkit.protocols.transport.transport.Transport` +----------------+-----------------------+-------------------------------------------------------------+
| subclasses) | :class:`pcapkit.protocols.transport.udp.UDP` |
+ +----------------+-----------------------+-------------------------------------------------------------+
| | :class:`pcapkit.protocols.transport.sctp.SCTP` |
+------------------------------------------------------------------+----------------+-----------------------+-------------------------------------------------------------+
| | | :class:`pcapkit.protocols.application.ftp.FTP` |
+ + FTP Family +-----------------------+-------------------------------------------------------------+
Expand Down Expand Up @@ -145,6 +147,8 @@ functions:
| | | :func:`~pcapkit.foundation.registry.protocols.register_tcp` | the left columns |
+ Application Layer + :func:`~pcapkit.foundation.registry.protocols.register_apptype` +----------------------------------------------------------------+ when registering +
| | | :func:`~pcapkit.foundation.registry.protocols.register_udp` | new protocols. |
+ +-------------------------------------------------------------------+----------------------------------------------------------------+ +
| | | :func:`~pcapkit.foundation.registry.protocols.register_sctp` | |
+-------------------+-------------------------------------------------------------------+----------------------------------------------------------------+--------------------+

Samples
Expand Down Expand Up @@ -261,6 +265,12 @@ available extensible items and the helper registry functions:
| | | :attr:`TCP.__option__ <pcapkit.protocols.transport.tcp.TCP.__option__>` | :func:`~pcapkit.foundation.registry.protocols.register_tcp_option` |
+ Transport Layer + :class:`~pcapkit.protocols.transport.tcp.TCP` +-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
| | | :attr:`TCP.__mp_option__ <pcapkit.protocols.transport.tcp.TCP.__mp_option__>` | :func:`~pcapkit.foundation.registry.protocols.register_tcp_mp_option` |
+ +------------------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
| | | :attr:`SCTP.__chunk__ <pcapkit.protocols.transport.sctp.SCTP.__chunk__>` | :meth:`~pcapkit.protocols.transport.sctp.SCTP.register_chunk` |
+ + +-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
| | :class:`~pcapkit.protocols.transport.sctp.SCTP` | :attr:`SCTP.__parameter__ <pcapkit.protocols.transport.sctp.SCTP.__parameter__>` | :meth:`~pcapkit.protocols.transport.sctp.SCTP.register_parameter` |
+ + +-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
| | | :attr:`SCTP.__cause__ <pcapkit.protocols.transport.sctp.SCTP.__cause__>` | :meth:`~pcapkit.protocols.transport.sctp.SCTP.register_cause` |
+-------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
| Application Layer | :class:`~pcapkit.protocols.application.httpv2.HTTP` | :attr:`HTTP.__frame__ <pcapkit.protocols.application.httpv2.HTTP.__frame__>` | :func:`~pcapkit.foundation.registry.protocols.register_http_frame` |
+-------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
Expand Down
1 change: 1 addition & 0 deletions docs/source/pcapkit/const/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Transport Layer
.. toctree::
:maxdepth: 2

sctp
tcp

Application Layer
Expand Down
79 changes: 79 additions & 0 deletions docs/source/pcapkit/const/sctp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
=====================================================================
:class:`~pcapkit.protocols.transport.sctp.SCTP` Constant Enumerations
=====================================================================

.. module:: pcapkit.const.sctp

This module contains all constant enumerations of
:class:`~pcapkit.protocols.transport.sctp.SCTP` implementations. Available
enumerations include:

.. list-table::

* - :class:`SCTP_Chunk <pcapkit.const.sctp.chunk.Chunk>`
- SCTP Chunk Types [*]_
* - :class:`SCTP_Parameter <pcapkit.const.sctp.parameter.Parameter>`
- SCTP Chunk Parameter Types [*]_
* - :class:`SCTP_CauseCode <pcapkit.const.sctp.cause_code.CauseCode>`
- SCTP Error Cause Codes [*]_
* - :class:`SCTP_PayloadProtocolIdentifier <pcapkit.const.sctp.payload_protocol_identifier.PayloadProtocolIdentifier>`
- SCTP Payload Protocol Identifiers [*]_

SCTP Chunk Types
================

.. module:: pcapkit.const.sctp.chunk

This module contains the constant enumeration for **SCTP Chunk Types**,
which is automatically generated from :class:`pcapkit.vendor.sctp.chunk.Chunk`.

.. autoclass:: pcapkit.const.sctp.chunk.Chunk
:members:
:undoc-members:
:show-inheritance:

SCTP Chunk Parameter Types
==========================

.. module:: pcapkit.const.sctp.parameter

This module contains the constant enumeration for **SCTP Chunk Parameter Types**,
which is automatically generated from :class:`pcapkit.vendor.sctp.parameter.Parameter`.

.. autoclass:: pcapkit.const.sctp.parameter.Parameter
:members:
:undoc-members:
:show-inheritance:

SCTP Error Cause Codes
======================

.. module:: pcapkit.const.sctp.cause_code

This module contains the constant enumeration for **SCTP Error Cause Codes**,
which is automatically generated from :class:`pcapkit.vendor.sctp.cause_code.CauseCode`.

.. autoclass:: pcapkit.const.sctp.cause_code.CauseCode
:members:
:undoc-members:
:show-inheritance:

SCTP Payload Protocol Identifiers
=================================

.. module:: pcapkit.const.sctp.payload_protocol_identifier

This module contains the constant enumeration for **SCTP Payload Protocol Identifiers**,
which is automatically generated from :class:`pcapkit.vendor.sctp.payload_protocol_identifier.PayloadProtocolIdentifier`.

.. autoclass:: pcapkit.const.sctp.payload_protocol_identifier.PayloadProtocolIdentifier
:members:
:undoc-members:
:show-inheritance:

.. rubric:: Footnotes

.. [*] https://www.iana.org/assignments/sctp-parameters/sctp-parameters.xhtml#sctp-parameters-1
.. [*] https://www.iana.org/assignments/sctp-parameters/sctp-parameters.xhtml#sctp-parameters-2
.. [*] https://www.iana.org/assignments/sctp-parameters/sctp-parameters.xhtml#sctp-parameters-24
.. [*] https://www.iana.org/assignments/sctp-parameters/sctp-parameters.xhtml#sctp-parameters-25
2 changes: 2 additions & 0 deletions docs/source/pcapkit/foundation/registry.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ Transport Layer Registries

.. autofunction:: pcapkit.foundation.registry.protocols.register_udp

.. autofunction:: pcapkit.foundation.registry.protocols.register_sctp

Application Layer Registries
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
3 changes: 2 additions & 1 deletion docs/source/pcapkit/protocols/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ diagram of the class hierarchy of :mod:`pcapkit.protocols`:
end

subgraph transport [Transport Layer]
Transport --> TCP & UDP
Transport --> TCP & UDP & SCTP
end

subgraph application [Application Layer]
Expand Down Expand Up @@ -124,6 +124,7 @@ diagram of the class hierarchy of :mod:`pcapkit.protocols`:
click Transport "/pcapkit/protocols/transport/transport.html#pcapkit.protocols.transport.Transport"
click TCP "/pcapkit/protocols/transport/tcp.html#pcapkit.protocols.internet.tcp.TCP"
click UDP "/pcapkit/protocols/transport/udp.html#pcapkit.protocols.internet.udp.UDP"
click SCTP "/pcapkit/protocols/transport/sctp.html#pcapkit.protocols.transport.sctp.SCTP"

click Application "/pcapkit/protocols/application/application.html#pcapkit.protocols.application.Application"
click HTTP "/pcapkit/protocols/application/http.html#pcapkit.protocols.application.http.HTTP"
Expand Down
3 changes: 2 additions & 1 deletion docs/source/pcapkit/protocols/transport/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,13 @@ transport layer, with detailed implementation and methods.
:maxdepth: 1

transport
sctp
tcp
udp

.. todo::

Implements DCCP, RSVP, SCTP.
Implements DCCP, RSVP.

Protocol Registry
-----------------
Expand Down
Loading