blob: 9f4d9c8a925b5ff2b66edb79835213a4a3255834 [file] [log] [blame]
Mauro Carvalho Chehab671d1142020-04-30 18:04:22 +02001.. SPDX-License-Identifier: GPL-2.0
2
3=================
4Linux Kernel SCTP
5=================
Linus Torvalds1da177e2005-04-16 15:20:36 -07006
7This is the current BETA release of the Linux Kernel SCTP reference
Mauro Carvalho Chehab671d1142020-04-30 18:04:22 +02008implementation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
10SCTP (Stream Control Transmission Protocol) is a IP based, message oriented,
11reliable transport protocol, with congestion control, support for
12transparent multi-homing, and multiple ordered streams of messages.
13RFC2960 defines the core protocol. The IETF SIGTRAN working group originally
Mauro Carvalho Chehab671d1142020-04-30 18:04:22 +020014developed the SCTP protocol and later handed the protocol over to the
15Transport Area (TSVWG) working group for the continued evolvement of SCTP as a
16general purpose transport.
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
Mauro Carvalho Chehab671d1142020-04-30 18:04:22 +020018See the IETF website (http://www.ietf.org) for further documents on SCTP.
19See http://www.ietf.org/rfc/rfc2960.txt
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21The initial project goal is to create an Linux kernel reference implementation
Mauro Carvalho Chehab671d1142020-04-30 18:04:22 +020022of SCTP that is RFC 2960 compliant and provides an programming interface
23referred to as the UDP-style API of the Sockets Extensions for SCTP, as
24proposed in IETF Internet-Drafts.
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
Mauro Carvalho Chehab671d1142020-04-30 18:04:22 +020026Caveats
27=======
Linus Torvalds1da177e2005-04-16 15:20:36 -070028
Mauro Carvalho Chehab671d1142020-04-30 18:04:22 +020029- lksctp can be built as statically or as a module. However, be aware that
30 module removal of lksctp is not yet a safe activity.
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Mauro Carvalho Chehab671d1142020-04-30 18:04:22 +020032- There is tentative support for IPv6, but most work has gone towards
33 implementation and testing lksctp on IPv4.
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35
36For more information, please visit the lksctp project website:
Mauro Carvalho Chehab671d1142020-04-30 18:04:22 +020037
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 http://www.sf.net/projects/lksctp
39
40Or contact the lksctp developers through the mailing list:
Mauro Carvalho Chehab671d1142020-04-30 18:04:22 +020041
Daniel Borkmann91705c62013-07-23 14:51:47 +020042 <linux-sctp@vger.kernel.org>