Internet DRAFT - draft-ietf-tsvwg-sctp-strrst
draft-ietf-tsvwg-sctp-strrst
Network Working Group R. Stewart
Internet-Draft Adara Networks
Intended status: Standards Track M. Tuexen
Expires: June 10, 2012 Muenster Univ. of Appl. Sciences
P. Lei
Cisco Systems, Inc.
December 8, 2011
Stream Control Transmission Protocol (SCTP) Stream Reconfiguration
draft-ietf-tsvwg-sctp-strrst-13.txt
Abstract
Many applications that use SCTP want the ability to "reset" a stream.
The intention of resetting a stream is to set the numbering sequence
of the stream back to 'zero' with a corresponding notification to the
application layer that the reset has been performed. Applications
requiring this feature want it so that they can "re-use" streams for
different purposes but still utilize the stream sequence number so
that the application can track the message flows. Thus, without this
feature, a new use of an old stream would result in message numbers
greater than expected unless there is a protocol mechanism to "reset
the streams back to zero". This document also includes methods for
resetting the transport sequence numbers, adding additional streams
and resetting all stream sequence numbers.
Status of this Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on June 10, 2012.
Copyright Notice
Copyright (c) 2011 IETF Trust and the persons identified as the
document authors. All rights reserved.
Stewart, et al. Expires June 10, 2012 [Page 1]
Internet-Draft SCTP Stream Reconfiguration December 2011
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4
2. Conventions . . . . . . . . . . . . . . . . . . . . . . . . . 4
3. New Chunk Type . . . . . . . . . . . . . . . . . . . . . . . . 4
3.1. RE-CONFIG Chunk . . . . . . . . . . . . . . . . . . . . . 5
4. New Parameter Types . . . . . . . . . . . . . . . . . . . . . 6
4.1. Outgoing SSN Reset Request Parameter . . . . . . . . . . . 7
4.2. Incoming SSN Reset Request Parameter . . . . . . . . . . . 8
4.3. SSN/TSN Reset Request Parameter . . . . . . . . . . . . . 9
4.4. Re-configuration Response Parameter . . . . . . . . . . . 9
4.5. Add Outgoing Streams Request Parameter . . . . . . . . . . 11
4.6. Add Incoming Streams Request Parameter . . . . . . . . . . 12
5. Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . 13
5.1. Sender Side Procedures . . . . . . . . . . . . . . . . . . 13
5.1.1. Sender Side Procedures for the RE-CONFIG Chunk . . . . 13
5.1.2. Sender Side Procedures for the Outgoing SSN Reset
Request Parameter . . . . . . . . . . . . . . . . . . 14
5.1.3. Sender Side Procedures for the Incoming SSN Reset
Request Parameter . . . . . . . . . . . . . . . . . . 15
5.1.4. Sender Side Procedures for the SSN/TSN Reset
Request Parameter . . . . . . . . . . . . . . . . . . 16
5.1.5. Sender Side Procedures for the Re-configuration
Response Parameter . . . . . . . . . . . . . . . . . . 16
5.1.6. Sender Side Procedures for the Add Outgoing
Streams Request Parameter . . . . . . . . . . . . . . 17
5.1.7. Sender Side Procedures for the Add Incoming
Streams Request Parameter . . . . . . . . . . . . . . 17
5.2. Receiver Side Procedures . . . . . . . . . . . . . . . . . 18
5.2.1. Receiver Side Procedures for the RE-CONFIG Chunk . . . 18
5.2.2. Receiver Side Procedures for the Outgoing SSN
Reset Request Parameter . . . . . . . . . . . . . . . 18
5.2.3. Receiver Side Procedures for the Incoming SSN
Reset Request Parameter . . . . . . . . . . . . . . . 19
5.2.4. Receiver Side Procedures for the SSN/TSN Reset
Request Parameter . . . . . . . . . . . . . . . . . . 20
5.2.5. Receiver Side Procedures for the Add Outgoing
Stewart, et al. Expires June 10, 2012 [Page 2]
Internet-Draft SCTP Stream Reconfiguration December 2011
Streams Request Parameter . . . . . . . . . . . . . . 21
5.2.6. Receiver Side Procedures for the Add Incoming
Streams Request Parameter . . . . . . . . . . . . . . 21
5.2.7. Receiver Side Procedures for the Re-configuration
Response Parameter . . . . . . . . . . . . . . . . . . 21
6. Socket API Considerations . . . . . . . . . . . . . . . . . . 22
6.1. Events . . . . . . . . . . . . . . . . . . . . . . . . . . 22
6.1.1. Stream Reset Event . . . . . . . . . . . . . . . . . . 23
6.1.2. Association Reset Event . . . . . . . . . . . . . . . 24
6.1.3. Stream Change Event . . . . . . . . . . . . . . . . . 25
6.2. Event Subscription . . . . . . . . . . . . . . . . . . . . 26
6.3. Socket Options . . . . . . . . . . . . . . . . . . . . . . 26
6.3.1. Enable/Disable Stream Reset
(SCTP_ENABLE_STREAM_RESET) . . . . . . . . . . . . . . 27
6.3.2. Reset Incoming and/or Outgoing Streams
(SCTP_RESET_STREAMS) . . . . . . . . . . . . . . . . . 28
6.3.3. Reset SSN/TSN (SCTP_RESET_ASSOC) . . . . . . . . . . . 28
6.3.4. Add Incoming and/or Outgoing Streams
(SCTP_ADD_STREAMS) . . . . . . . . . . . . . . . . . . 29
7. Security Considerations . . . . . . . . . . . . . . . . . . . 29
8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 30
8.1. A New Chunk Type . . . . . . . . . . . . . . . . . . . . . 30
8.2. Six New Chunk Parameter Types . . . . . . . . . . . . . . 30
9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 31
10. References . . . . . . . . . . . . . . . . . . . . . . . . . . 31
10.1. Normative References . . . . . . . . . . . . . . . . . . . 31
10.2. Informative References . . . . . . . . . . . . . . . . . . 31
Appendix A. Examples of the Re-configuration procedures . . . . . 32
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 33
Stewart, et al. Expires June 10, 2012 [Page 3]
Internet-Draft SCTP Stream Reconfiguration December 2011
1. Introduction
Many applications that use SCTP as defined in [RFC4960] want the
ability to "reset" a stream. The intention of resetting a stream is
to set the stream sequence numbers (SSNs) of the stream back to
'zero' with a corresponding notification to the application layer
that the reset has been performed. Applications requiring this
feature want to "re-use" streams for different purposes but still
utilize the stream sequence number so that the application can track
the message flows. Thus, without this feature, a new use of an old
stream would result in message numbers greater than expected unless
there is a protocol mechanism to "reset the streams back to zero".
This document also includes methods for resetting the transport
sequence numbers (TSNs), adding additional streams and resetting all
stream sequence numbers.
The socket API for SCTP defined in [I-D.ietf-tsvwg-sctpsocket]
exposes the sequence numbers used by SCTP for user message transfer.
Therefore, resetting them can be used by application writers. Please
note that the corresponding sequence number for TCP is not exposed
via the socket API for TCP.
2. Conventions
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119].
3. New Chunk Type
This section defines the new chunk type that will be used to re-
configure streams. Table 1 illustrates the new chunk type.
+------------+------------------------------------+
| Chunk Type | Chunk Name |
+------------+------------------------------------+
| 0x82 | Re-configuration Chunk (RE-CONFIG) |
+------------+------------------------------------+
Table 1
It should be noted that the format of the RE-CONFIG chunk requires
the receiver to ignore the chunk if it is not understood and continue
processing all chunks that follow. This is accomplished by the use
of the upper bits of the chunk type as described in section 3.2 of
[RFC4960].
Stewart, et al. Expires June 10, 2012 [Page 4]
Internet-Draft SCTP Stream Reconfiguration December 2011
All transported integer numbers are in "network byte order" a.k.a.,
Big Endian.
3.1. RE-CONFIG Chunk
This document adds one new chunk type to SCTP. The chunk has the
following format:
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Type = 0x82 | Chunk Flags | Chunk Length |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
\ \
/ Re-configuration Parameter /
\ \
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
\ \
/ Re-configuration Parameter (optional) /
\ \
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Chunk Type: 1 byte (unsigned integer)
This field holds the IANA defined chunk type for the RE-CONFIG
chunk. The suggested value of this field for IANA is 0x82.
Chunk Flags: 1 byte (unsigned integer)
This field is set to 0 by the sender and ignored by the receiver.
Chunk Length: 2 bytes (unsigned integer)
This field holds the length of the chunk in bytes, including the
Chunk Type, Chunk Flags and Chunk Length.
Re-configuration Parameter
This field holds a Re-configuration Request Parameter or a Re-
configuration Response Parameter.
Note that each RE-CONFIG chunk holds at least one parameter and at
most two parameters. Only the following combinations are allowed:
1. Outgoing SSN Reset Request Parameter.
2. Incoming SSN Reset Request Parameter.
3. Outgoing SSN Reset Request Parameter, Incoming SSN Reset Request
Parameter.
Stewart, et al. Expires June 10, 2012 [Page 5]
Internet-Draft SCTP Stream Reconfiguration December 2011
4. SSN/TSN Reset Request Parameter.
5. Add Outgoing Streams Request Parameter.
6. Add Incoming Streams Request Parameter.
7. Add Outgoing Streams Request Parameter, Add Incoming Streams
Request Parameter.
8. Re-configuration Response Parameter.
9. Re-configuration Response Parameter, Outgoing SSN Reset Request
Parameter.
10. Re-configuration Response Parameter, Re-configuration Response
Parameter.
If a sender transmits an unsupported combination, the receiver SHOULD
send an ERROR chunk with a Protocol Violation cause as defined in
section 3.3.10.13 of [RFC4960]).
4. New Parameter Types
This section defines the new parameter types that will be used in the
RE-CONFIG chunk. Table 2 illustrates the new parameter types.
+----------------+----------------------------------------+
| Parameter Type | Parameter Name |
+----------------+----------------------------------------+
| 0x000d | Outgoing SSN Reset Request Parameter |
| 0x000e | Incoming SSN Reset Request Parameter |
| 0x000f | SSN/TSN Reset Request Parameter |
| 0x0010 | Re-configuration Response Parameter |
| 0x0011 | Add Outgoing Streams Request Parameter |
| 0x0012 | Add Incoming Streams Request Parameter |
+----------------+----------------------------------------+
Table 2
It should be noted that the parameter format requires the receiver to
stop processing the parameter and not to process any further
parameters within the chunk if the parameter type is not recognized.
This is accomplished by the use of the upper bits of the parameter
type as described in section 3.2.1 of [RFC4960].
All transported integer numbers are in "network byte order" a.k.a.,
Big Endian.
Stewart, et al. Expires June 10, 2012 [Page 6]
Internet-Draft SCTP Stream Reconfiguration December 2011
4.1. Outgoing SSN Reset Request Parameter
This parameter is used by the sender to request the reset of some or
all outgoing streams.
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Parameter Type = 0x000d | Parameter Length = 16 + 2 * N |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Re-configuration Request Sequence Number |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Re-configuration Response Sequence Number |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Sender's Last Assigned TSN |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Stream Number 1 (optional) | Stream Number 2 (optional) |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/ ...... /
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Stream Number N-1 (optional) | Stream Number N (optional) |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Parameter Type: 2 bytes (unsigned integer)
This field holds the IANA defined parameter type for the Outgoing
SSN Reset Request Parameter. The suggested value of this field
for IANA is 0x000d.
Parameter Length: 2 bytes (unsigned integer)
This field holds the length in bytes of the parameter; the value
MUST be 16 + 2 * N, where N is the number of stream numbers
listed.
Re-configuration Request Sequence Number: 4 bytes (unsigned integer)
This field is used to identify the request. It is a monotonically
increasing number that is initialized to the same value as the
Initial TSN number. It is increased by 1 whenever sending a new
Re-configuration Request parameter.
Re-configuration Response Sequence Number: 4 bytes (unsigned
integer)
When this Outgoing SSN Reset Request Parameter is sent in response
to an Incoming SSN Reset Request Parameter this parameter is also
an implicit response to the incoming request. Then this field
holds the Re-configuration Request Sequence Number of the incoming
request. In other cases it holds the next expected Re-
configuration Request Sequence Number minus 1.
Stewart, et al. Expires June 10, 2012 [Page 7]
Internet-Draft SCTP Stream Reconfiguration December 2011
Sender's last assigned TSN: 4 bytes (unsigned integer)
This value holds the next TSN minus 1, in other words the last TSN
that this sender assigned.
Stream Number 1..N: 2 bytes (unsigned integer)
This optional field, if included, is used to indicate specific
streams that are to be reset. If no streams are listed, then all
streams are to be reset.
This parameter can appear in a RE-CONFIG chunk. This parameter MUST
NOT appear in any other chunk type.
4.2. Incoming SSN Reset Request Parameter
This parameter is used by the sender to request that the peer resets
some or all of its outgoing streams.
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Parameter Type = 0x000e | Parameter Length = 8 + 2 * N |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Re-configuration Request Sequence Number |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Stream Number 1 (optional) | Stream Number 2 (optional) |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/ ...... /
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Stream Number N-1 (optional) | Stream Number N (optional) |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Parameter Type: 2 bytes (unsigned integer)
This field holds the IANA defined parameter type for the Incoming
SSN Reset Request Parameter. The suggested value of this field
for IANA is 0x000e.
Parameter Length: 2 bytes (unsigned integer)
This field holds the length in bytes of the parameter; the value
MUST be 8 + 2 * N.
Re-configuration Request Sequence Number: 4 bytes (unsigned integer)
This field is used to identify the request. It is a monotonically
increasing number that is initialized to the same value as the
Initial TSN number. It is increased by 1 whenever sending a new
Re-configuration Request parameter.
Stewart, et al. Expires June 10, 2012 [Page 8]
Internet-Draft SCTP Stream Reconfiguration December 2011
Stream Number 1..N: 2 bytes (unsigned integer)
This optional field, if included, is used to indicate specific
streams that are to be reset. If no streams are listed, then all
streams are to be reset.
This parameter can appear in a RE-CONFIG chunk. This parameter MUST
NOT appear in any other chunk type.
4.3. SSN/TSN Reset Request Parameter
This parameter is used by the sender to request a reset of the TSN
and SSN numbering of all incoming and outgoing streams.
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Parameter Type = 0x000f | Parameter Length = 8 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Re-configuration Request Sequence Number |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Parameter Type: 2 bytes (unsigned integer)
This field holds the IANA defined parameter type for the SSN/TSN
Reset Request Parameter. The suggested value of this field for
IANA is 0x000f.
Parameter Length: 2 bytes (unsigned integer)
This field holds the length in bytes of the parameter; the value
MUST be 8.
Re-configuration Request Sequence Number: 4 bytes (unsigned integer)
This field is used to identify the request. It is a monotonically
increasing number that is initialized to the same value as the
Initial TSN number. It is increased by 1 whenever sending a new
Re-configuration Request parameter.
This parameter can appear in a RE-CONFIG chunk. This parameter MUST
NOT appear in any other chunk type.
4.4. Re-configuration Response Parameter
This parameter is used by the receiver of a Re-configuration Request
parameter to respond to the request.
Stewart, et al. Expires June 10, 2012 [Page 9]
Internet-Draft SCTP Stream Reconfiguration December 2011
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Parameter Type = 0x0010 | Parameter Length |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Re-configuration Response Sequence Number |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Result |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Sender's next TSN (optional) |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Receiver's next TSN (optional) |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Parameter Type: 2 bytes (unsigned integer)
This field holds the IANA defined parameter type for Re-
configuration Response Parameter. The suggested value of this
field for IANA is 0x0010.
Parameter Type Length: 2 bytes (unsigned integer)
This field holds the length in bytes of the parameter; the value
MUST be 12 if the optional fields are not present and 20
otherwise.
Re-configuration Response Sequence Number: 4 bytes (unsigned
integer)
This value is copied from the request parameter and is used by the
receiver of the Re-configuration Response Parameter to tie the
response to the request.
Result: 4 bytes (unsigned integer)
This value describes the result of the processing of the request.
It is encoded as given by the following table
+--------+-------------------------------------+
| Result | Description |
+--------+-------------------------------------+
| 0 | Success - Nothing to do |
| 1 | Success - Performed |
| 2 | Denied |
| 3 | Error - Wrong SSN |
| 4 | Error - Request already in progress |
| 5 | Error - Bad Sequence Number |
| 6 | In progress |
+--------+-------------------------------------+
Table 3
Stewart, et al. Expires June 10, 2012 [Page 10]
Internet-Draft SCTP Stream Reconfiguration December 2011
Sender's next TSN: 4 bytes (unsigned integer)
This field holds the TSN the sender of the response will use to
send the next DATA chunk. The field is only applicable in
responses to SSN/TSN reset requests.
Receiver's next TSN: 4 bytes (unsigned integer)
This field holds the TSN the receiver of the response must use to
send the next DATA chunk. The field is only applicable in
responses to SSN/TSN reset requests.
Either both optional fields (Sender's next TSN and Receiver's next
TSN) MUST be present or none.
This parameter can appear in a RE-CONFIG chunk. This parameter MUST
NOT appear in any other chunk type.
4.5. Add Outgoing Streams Request Parameter
This parameter is used by the sender to request that an additional
number of outgoing streams (i.e. the receiver's incoming streams) be
added to the association.
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Parameter Type = 0x0011 | Parameter Length = 12 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Re-configuration Request Sequence Number |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Number of new streams | Reserved |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Parameter Type: 2 bytes (unsigned integer)
This field holds the IANA defined parameter type for the the Add
Outgoing Streams Request Parameter. The suggested value of this
field for IANA is 0x0011.
Parameter Length: 2 bytes (unsigned integer)
This field holds the length in bytes of the parameter; the value
MUST be 12.
Re-configuration Request Sequence Number: 4 bytes (unsigned integer)
This field is used to identify the request. It is a monotonically
increasing number that is initialized to the same value as the
Initial TSN number. It is increased by 1 whenever sending a new
Re-configuration Request parameter.
Stewart, et al. Expires June 10, 2012 [Page 11]
Internet-Draft SCTP Stream Reconfiguration December 2011
Number of new streams: 2 bytes (unsigned integer)
This value holds the number of additional outgoing streams the
sender requests to be added to the association. Streams are added
in order and are consecutive, e.g. if an association has four
outgoing streams (0-3) and a requested is made to add 3 streams
then the new streams will be 4, 5 and 6.
Reserved: 2 bytes (unsigned integer)
This field is reserved. It SHOULD be set to 0 by the sender and
ignored by the receiver.
This parameter MAY appear in a RE-CONFIG chunk. This parameter MUST
NOT appear in any other chunk type.
4.6. Add Incoming Streams Request Parameter
This parameter is used by the sender to request that the peer adds an
additional number of outgoing streams (i.e. the sender's incoming
streams) to the association.
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Parameter Type = 0x0012 | Parameter Length = 12 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Re-configuration Request Sequence Number |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Number of new streams | Reserved |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Parameter Type: 2 bytes (unsigned integer)
This field holds the IANA defined parameter type for the the Add
Incoming Streams Request Parameter. The suggested value of this
field for IANA is 0x0012.
Parameter Length: 2 bytes (unsigned integer)
This field holds the length in bytes of the parameter; the value
MUST be 12.
Re-configuration Request Sequence Number: 4 bytes (unsigned integer)
This field is used to identify the request. It is a monotonically
increasing number that is initialized to the same value as the
Initial TSN number. It is increased by 1 whenever sending a new
Re-configuration Request parameter.
Stewart, et al. Expires June 10, 2012 [Page 12]
Internet-Draft SCTP Stream Reconfiguration December 2011
Number of new streams: 2 bytes (unsigned integer)
This value holds the number of additional incoming streams the
sender requests to be added to the association. Streams are added
in order and are consecutive, e.g. if an association has four
outgoing streams (0-3) and a requested is made to add 3 streams
then the new streams will be 4, 5 and 6.
Reserved: 2 bytes (unsigned integer)
This field is reserved. It SHOULD be set to 0 by the sender and
ignored by the receiver.
This parameter MAY appear in a RE-CONFIG chunk. This parameter MUST
NOT appear in any other chunk type.
5. Procedures
This section defines the procedures used by both the sender and
receiver of a RE-CONFIG chunk. Various examples of re-configuration
scenarios are given in Appendix A.
One important thing to remember about SCTP streams is that they are
uni-directional. The endpoint for which a stream is an outgoing
stream is called the outgoing side, the endpoint for which the stream
is an incoming stream is called the incoming side. The procedures
outlined in this section are designed so that the incoming side will
always reset their stream sequence number first before the outgoing
side which means the re-configuration request must always originate
from the outgoing side. These two issues have important
ramifications upon how an SCTP endpoint might request that its
incoming streams be reset. In effect it must ask the peer to start
an outgoing reset procedure and once that request is acknowledged let
the peer actually control the reset operation.
5.1. Sender Side Procedures
This section describes the procedures related to the sending of RE-
CONFIG chunks. A RE-CONFIG chunk is composed of one or two Type
Length Value (TLV) parameters.
5.1.1. Sender Side Procedures for the RE-CONFIG Chunk
This SCTP extension uses the Supported Extensions Parameter defined
in [RFC5061] for negotiating the support for it.
An SCTP endpoint supporting this extension MUST include the chunk
type of the RE-CONFIG chunk in the Supported Extensions Parameter in
either the INIT or INIT-ACK. Before sending a RE-CONFIG chunk the
Stewart, et al. Expires June 10, 2012 [Page 13]
Internet-Draft SCTP Stream Reconfiguration December 2011
sender MUST ensure that the peer advertised support for the re-
configuration extension. If the chunk type of the RE-CONFIG chunk
does not appear in the supported extensions list of chunks, then the
sender MUST NOT send any re-configuration request to the peer, and
any request by the application for such service SHOULD be responded
to with an appropriate error indicating the peer SCTP stack does not
support the re-configuration extension.
At any given time there MUST NOT be more than one request be in
flight. So if the Re-configuration Timer is running and the the RE-
CONFIG chunk contains at least one request parameter the chunk MUST
be buffered.
After packaging the RE-CONFIG chunk and sending it to the peer the
sender MUST start the Re-configuration Timer if the RE-CONFIG chunk
contains at least one request parameter. If it contains no request
parameters, the Re-configuration Timer MUST NOT be started. This
timer MUST use the same value as SCTP's Data transmission timer (i.e.
the RTO timer) and MUST use exponential backoff doubling the value at
every expiration. If the timer expires, besides doubling the value,
the sender MUST retransmit the RE-CONFIG chunk, increment the
appropriate error counts (both for the association and the
destination), and perform threshold management possibly destroying
the association if SCTP retransmission thresholds are exceeded.
5.1.2. Sender Side Procedures for the Outgoing SSN Reset Request
Parameter
When an SCTP sender wants to reset the SSNs of some or all outgoing
streams it can send an Outgoing SSN Reset Request Parameter provided
that the Re-configuration Timer is not running. The following steps
must be followed:
A1: The sender MUST stop assigning new SSNs to new user data
provided by the upper layer for the affected streams and queue
it. This is because it is not known whether the receiver of the
request will accept or deny it and moreover, a lost request
might cause an out-of-sequence error in a stream that the
receiver is not yet prepared to handle.
A2: The sender MUST assign the next re-configuration request
sequence number and MUST put it into the Re-configuration
Request Sequence Number field of the Outgoing SSN Reset Request
Parameter. The next re-configuration request sequence number
MUST then be incremented by 1.
Stewart, et al. Expires June 10, 2012 [Page 14]
Internet-Draft SCTP Stream Reconfiguration December 2011
A3: The Sender's Last Assigned TSN MUST be set to the next TSN the
sender assigns minus 1.
A4: If this Outgoing SSN Reset Request Parameter is sent in response
to an Incoming SSN Reset Request Parameter the Stream Numbers
MUST be copied from the Incoming SSN Reset Request Parameter to
the Outgoing SSN Reset Request Parameter. The Re-configuration
Response Sequence Number of the Outgoing SSN Reset Request
Parameter MUST be the Re-configuration Request Sequence Number
of the Incoming SSN Reset Request Parameter. If this Outgoing
SSN Reset Request Parameter is sent at the request of the upper
layer and the sender requests all outgoing streams to be reset
Stream Numbers SHOULD NOT be put into the Outgoing SSN Reset
Request Parameter. If the sender requests only some outgoing
streams to be reset these Stream Numbers MUST be placed in the
Outgoing SSN Reset Request Parameter. Re-configuration Response
Sequence Number is the next expected Re-configuration Request
Sequence Number of the peer minus 1.
A5: The Outgoing SSN Reset Request Parameter MUST be put into a RE-
CONFIG Chunk. The Outgoing SSN Reset Request Parameter MAY be
put together with either an Incoming SSN Reset Request Parameter
or an Re-configuration Response Parameter but not both. It MUST
NOT be put together with any other parameter as described in
Section 3.1.
A6: The RE-CONFIG chunk MUST be sent following the rules given in
Section 5.1.1.
5.1.3. Sender Side Procedures for the Incoming SSN Reset Request
Parameter
When an SCTP sender wants to reset the SSNs of some or all incoming
streams it can send an Incoming SSN Reset Request Parameter provided
that the Re-configuration Timer is not running. The following steps
must be followed:
B1: The sender MUST assign the next re-configuration request
sequence number and MUST put it into the Re-configuration
Request Sequence Number field of the Incoming SSN Reset Request
Parameter. After assigning it the next re-configuration request
sequence number MUST be incremented by 1.
B2: If the sender wants all incoming streams to be reset Stream
Numbers SHOULD NOT be put into the Incoming SSN Reset Request
Parameter. If the sender wants only some incoming streams to be
reset these Stream Numbers MUST be filled in the Incoming SSN
Reset Request Parameter.
Stewart, et al. Expires June 10, 2012 [Page 15]
Internet-Draft SCTP Stream Reconfiguration December 2011
B3: The Incoming SSN Reset Request Parameter MUST be put into a RE-
CONFIG Chunk. It MAY be put together with an Outgoing SSN Reset
Request Parameter but MUST NOT be put together with any other
parameter.
B4: The RE-CONFIG chunk MUST be sent following the rules given in
Section 5.1.1.
When sending an Incoming SSN Reset Request there is a potential that
the peer has just reset or is in the process of resetting the same
streams via an Outgoing SSN Reset Request. This collision scenario
is discussed in Section 5.2.3.
5.1.4. Sender Side Procedures for the SSN/TSN Reset Request Parameter
When an SCTP sender wants to reset the SSNs and TSNs it can send an
SSN/TSN Reset Request Parameter provided that the Re-configuration
Timer is not running. The following steps must be followed:
C1: The sender MUST assign the next re-configuration request
sequence number and put it into the Re-configuration Request
Sequence Number field of the SSN/TSN Reset Request Parameter.
After assigning it the next re-configuration request sequence
number MUST be incremented by 1.
C2: The sender has either no outstanding TSNs or considers all
outstanding TSNs abandoned. The sender MUST queue any user data
suspending any new transmissions and TSN assignment until the
reset procedure is finished by the peer either acknowledging or
denying the request.
C3: The SSN/TSN Reset Request Parameter MUST be put into a RE-CONFIG
chunk. There MUST NOT be any other parameter in this chunk.
C4: The RE-CONFIG chunk MUST be sent following the rules given in
Section 5.1.1.
Only one SSN/TSN Reset Request SHOULD be sent within 30 seconds,
which is considered a maximum segment lifetime, the IP MSL.
5.1.5. Sender Side Procedures for the Re-configuration Response
Parameter
When an implementation receives a reset request parameter it must
respond with a Re-configuration Response Parameter in the following
manner:
Stewart, et al. Expires June 10, 2012 [Page 16]
Internet-Draft SCTP Stream Reconfiguration December 2011
D1: The Re-configuration Request Sequence number of the incoming
request MUST be copied to the Re-configuration Response Sequence
Number field of the Re-configuration Response Parameter.
D2: The result of the processing of the incoming request according
to Table 3 MUST be placed in the Result field of the Re-
configuration Response Parameter.
D3: If the incoming request is an SSN/TSN reset request, the
Sender's next TSN field MUST be filled with the next TSN the
sender of this Re-configuration Response Parameter will assign.
For other requests the Sender's next TSN field, which is
optional, MUST NOT be used.
D4: If the incoming request is an SSN/TSN reset request, the
Receiver's next TSN field MUST be filled with a TSN such that
the sender of the Re-configuration Response Parameter can be
sure it can discard received DATA chunks with smaller TSNs. The
value SHOULD be the smallest TSN not acknowledged by the
receiver of the request plus 2^31. For other requests the
Receiver's next TSN field, which is optional, MUST NOT be used.
5.1.6. Sender Side Procedures for the Add Outgoing Streams Request
Parameter
When an SCTP sender wants to increase the number of outbound streams
to which it is able to send, it may add an Add Outgoing Streams
Request parameter to the RE-CONFIG chunk. Upon sending the request
the sender MUST await a positive acknowledgment (Success) before
using any additional stream added by this request. Note that new
streams are added adjacent to the previous streams with no gaps.
This means that if a request is made to add 2 streams to an
association that has already 5 (0-4) then the new streams, upon
successful completion, are streams 5 and 6. A new stream MUST use
the stream sequence number 0 for its first ordered message.
5.1.7. Sender Side Procedures for the Add Incoming Streams Request
Parameter
When an SCTP sender wants to increase the number of inbound streams
to which the peer is able to send, it may add an Add Incoming Streams
Request parameter to the RE-CONFIG chunk. Note that new streams are
added adjacent to the previous streams with no gaps. This means that
if a request is made to add 2 streams to an association that has
already 5 (0-4) then the new streams, upon successful completion, are
streams 5 and 6. A new stream MUST use the stream sequence number 0
for its first ordered message.
Stewart, et al. Expires June 10, 2012 [Page 17]
Internet-Draft SCTP Stream Reconfiguration December 2011
5.2. Receiver Side Procedures
5.2.1. Receiver Side Procedures for the RE-CONFIG Chunk
Upon reception of a RE-CONFIG chunk each parameter within it SHOULD
be processed. If multiple parameters have to be returned, they MUST
be put into one RE_CONFIG chunk. If the received RE-CONFIG chunk
contains at least one request parameter, a SACK chunk SHOULD be sent
back and MAY be bundled with the RE-CONFIG chunk. If the received
RE-CONFIG chunk contains at least one request and based on the
analysis of the Re-configuration Request Sequence Numbers this is the
last received RE-CONFIG chunk (i.e. a retransmission), the same RE-
CONFIG chunk MUST to be sent back in response as was earlier.
The decision to deny a re-configuration request is an administrative
decision and may be user configurable even after the association has
formed. If for whatever reason the endpoint does not wish to process
a received request parameter it MUST send a corresponding response
parameter as described in Section 5.1.5 with an appropriate Result
field.
Implementation Note: A SACK is recommended to be bundled with any re-
configuration response so that any retransmission processing that
needs to occur can be expedited. A SACK chunk is not required for
this feature to work, but it will in effect help minimize the delay
in completing a re-configuration operation in the face of any data
loss.
5.2.2. Receiver Side Procedures for the Outgoing SSN Reset Request
Parameter
In the case that the endpoint is willing to perform a stream reset
the following steps must be followed:
E1: If the Re-configuration Timer is running for the Re-
configuration Request Sequence Number indicated in the Re-
configuration Response Sequence Number field, the Re-
configuration Request Sequence Number MUST be marked as
acknowledged. If all Re-configuration Request Sequence Numbers
the Re-configuration Timer is running for are acknowledged, the
Re-configuration Timer MUST be stopped.
E2: If the Sender's Last Assigned TSN number is greater than the
cumulative acknowledgment point, then the endpoint MUST enter
"deferred reset processing". In this mode, any data arriving
with a TSN number larger than the 'senders last assigned TSN'
for the affected stream(s) MUST be queued locally and held until
the Cumulative Acknowledgment point reaches the 'senders last
Stewart, et al. Expires June 10, 2012 [Page 18]
Internet-Draft SCTP Stream Reconfiguration December 2011
assigned TSN number'. When the Cumulative Acknowledgment point
reaches the last assigned TSN number then proceed to the next
step. If the endpoint enters "deferred reset processing", it
MUST put a Re-configuration Response Parameter into a RE-CONFIG
chunk indicating 'In progress' and MUST send the RE-CONFIG
chunk.
E3: If no Stream Numbers are listed in the parameter, then all
incoming streams MUST be reset to 0 as the next expected stream
sequence number. If specific Stream Numbers are listed, then
only these specific streams MUST be reset to 0 and all other
non-listed stream sequence numbers remain unchanged.
E4: Any queued TSN's (queued at step E2) MUST now be released and
processed normally.
E5: A Re-configuration Response Parameter MUST be put into a RE-
CONFIG chunk indicating successful processing.
E6: The RE-CONFIG chunk MUST be sent after the incoming RE-CONFIG
chunk is processed completely.
5.2.3. Receiver Side Procedures for the Incoming SSN Reset Request
Parameter
In the case that the endpoint is willing to perform a stream reset
the following steps must be followed:
F1: An Outgoing SSN Reset Request Parameter MUST be put into an RE-
CONFIG chunk according to Section 5.1.2.
F2: The RE-CONFIG chunk MUST be sent after the incoming RE-CONFIG
chunk is processed completely.
When a peer endpoint requests an Incoming SSN Reset Request it is
possible that the local endpoint has just sent an Outgoing SSN Reset
Request on the same association and has not yet received a response.
In such a case the local endpoint MUST do the following:
o If the just sent Outgoing SSN Reset Request Parameter completely
overlaps the received Incoming SSN Reset Request Parameter respond
to the peer with an acknowledgment indicating that there was
'Nothing to do'.
o Otherwise process the Incoming SSN Reset Request Parameter
normally responding to the peer with an acknowledgment. Note that
this case includes the situation where some of the streams
requested overlap with the just sent Outgoing SSN Reset Request.
Stewart, et al. Expires June 10, 2012 [Page 19]
Internet-Draft SCTP Stream Reconfiguration December 2011
Even in such a situation the Incoming SSN Reset MUST be processed
normally even though this means that (if the endpoint elects to do
the stream reset) streams that are already at SSN 0, will be reset
a subsequent time.
It is also possible that the Incoming request will arrive after the
Outgoing SSN Reset Request just completed. In such a case all of the
streams being requested will be already set to 0. If so, the local
endpoint SHOULD send back a Re-configuration Response with the
success code "Nothing to do".
Note that in either race condition the local endpoint could
optionally also perform the reset. This would result in streams that
are already at sequence 0 being reset again to 0 which would cause no
harm to the application but will add an extra message to the network.
5.2.4. Receiver Side Procedures for the SSN/TSN Reset Request Parameter
In the case that the endpoint is willing to perform an SSN/TSN reset
the following steps must be followed:
G1: Compute an appropriate value for the Receiver's next TSN, the
TSN the peer should use to send the next DATA chunk. The value
SHOULD be the smallest TSN not acknowledged by the receiver of
the request plus 2^31.
G2: Compute an appropriate value for the local endpoint's next TSN,
i.e. the receiver of the SSN/TSN reset chunk next TSN to be
assigned. The value SHOULD be the highest TSN sent by the
receiver of the request plus 1.
G3: The same processing as if a SACK chunk with no gap report and a
cumulative TSN ACK of Sender's next TSN minus 1 was received
MUST be performed.
G4: The same processing as if a FWD-TSN chunk as defined in
[RFC3758] with all streams affected and a new cumulative TSN ACK
of Receiver's next TSN minus 1 was received MUST be performed.
G5: The next expected and outgoing stream sequence numbers MUST be
reset to 0 for all incoming and outgoing streams.
G6: A Re-configuration Response Parameter MUST be put into a RE-
CONFIG chunk indicating successful processing.
Stewart, et al. Expires June 10, 2012 [Page 20]
Internet-Draft SCTP Stream Reconfiguration December 2011
G7: The RE-CONFIG chunk MUST be sent after the incoming RE-CONFIG
chunk is processed completely.
5.2.5. Receiver Side Procedures for the Add Outgoing Streams Request
Parameter
When an SCTP endpoint receives a re-configuration request adding
additional streams, it MUST send a response parameter either
acknowledging or denying the request. If the response is successful
the receiver MUST add the requested number of inbound streams to the
association, initializing the next expected stream sequence number to
be 0. The SCTP endpoint SHOULD deny the request if the number of
streams exceeds a limit which should be configurable by the
application.
5.2.6. Receiver Side Procedures for the Add Incoming Streams Request
Parameter
When an SCTP endpoint receives a re-configuration request adding
additional incoming streams, it MUST either send a response parameter
denying the request or sending a corresponding Add Outgoing Streams
Request Parameter following the rules given in Section 5.1.6. The
SCTP endpoint SHOULD deny the request if the number of streams
exceeds a limit which should be configurable by the application.
5.2.7. Receiver Side Procedures for the Re-configuration Response
Parameter
On receipt of a Re-configuration Response Parameter the following
must be performed:
H1: If the Re-confguration Timer is running for the Re-configuration
Request Sequence Number indicated in the Re-configuration
Response Sequence Number field, the Re-configuration Request
Sequence Number MUST be marked as acknowledged. If all Re-
configuration Request Sequence Numbers the Re-configuration
Timer is running for are acknowledged, the Re-configuration
Timer MUST be stopped. If the timer was not running for the Re-
configuration Request Sequence Number, the processing of the Re-
configuration Response Parameter is complete.
H2: If the Result field indicates 'In progress', the timer for the
Re-configuration Request Sequence Number is started again. If
the timer runs off, the RE-CONFIG chunk MUST be retransmitted
but the corresponding error counters MUST NOT be incremented.
Stewart, et al. Expires June 10, 2012 [Page 21]
Internet-Draft SCTP Stream Reconfiguration December 2011
H3: If the Result field does not indicate successful processing the
processing of this response is complete.
H4: If the request was an Outgoing SSN Reset Request the affected
streams MUST now be reset and all queued data should be
processed now and assigning of stream sequence numbers is
allowed again.
H5: If the request was an SSN/TSN Reset Request new data MUST be
sent from Receiver's next TSN and beginning with stream sequence
number 0 for all outgoing streams. All incoming streams MUST be
reset to 0 as the next expected stream sequence number. The
peer will send DATA chunks starting with Sender's next TSN.
H6: If the request was to add outgoing streams, the endpoint MUST
add the additional streams to the association. Note that an
implementation may allocate the memory at the time of the
request, but it MUST NOT use the streams until the peer has
responded with a positive acknowledgment.
6. Socket API Considerations
This section describes how the socket API defined in
[I-D.ietf-tsvwg-sctpsocket] needs to be extended to make the features
of SCTP re-configuration available to the application.
Please note that this section is informational only.
6.1. Events
When the SCTP_ASSOC_CHANGE notification is delivered and both peers
support the extension described in this document,
SCTP_ASSOC_SUPPORTS_RE_CONFIG should be listed in the sac_info field.
The union sctp_notification {} is extended to contain three new
fields: sn_strreset_event, sn_assocreset_event, and
sn_strchange_event:
Stewart, et al. Expires June 10, 2012 [Page 22]
Internet-Draft SCTP Stream Reconfiguration December 2011
union sctp_notification {
struct {
uint16_t sn_type;
uint16_t sn_flags;
uint32_t sn_length;
} sn_header;
...
struct sctp_stream_reset_event sn_strreset_event;
struct sctp_assoc_reset_event sn_assocreset_event;
struct sctp_stream_change_event sn_strchange_event;
...
}
The corresponding sn_type values are given in Table 4.
+--------------------------+----------------------------------------+
| sn_type | valid field in union sctp_notification |
+--------------------------+----------------------------------------+
| SCTP_STREAM_RESET_EVENT | sn_strreset_event |
| SCTP_ASSOC_RESET_EVENT | sn_assocreset_event |
| SCTP_STREAM_CHANGE_EVENT | sn_strchange_event |
+--------------------------+----------------------------------------+
Table 4
These events are delivered when an incoming request was processed
successfully or the processing of an outgoing request has been
finished.
6.1.1. Stream Reset Event
The event delivered has the following structure:
struct sctp_stream_reset_event {
uint16_t strreset_type;
uint16_t strreset_flags;
uint32_t strreset_length;
sctp_assoc_t strreset_assoc_id;
uint16_t strreset_stream_list[];
};
strreset_type: It should be SCTP_STREAM_RESET_EVENT.
strreset_flags: This field is formed from the bitwise OR of one or
more of the following currently defined flags:
Stewart, et al. Expires June 10, 2012 [Page 23]
Internet-Draft SCTP Stream Reconfiguration December 2011
SCTP_STREAM_RESET_INCOMING_SSN: The stream identifiers given in
strreset_stream_list[] refer to incoming streams of the
endpoint.
SCTP_STREAM_RESET_OUTGOING_SSN: The stream identifiers given in
strreset_stream_list[] refer to outgoing streams of the
endpoint.
SCTP_STREAM_RESET_DENIED: The corresponding request was denied by
the peer.
SCTP_STREAM_RESET_FAILED: The corresponding request failed.
At least one of SCTP_STREAM_RESET_INCOMING_SSN and
SCTP_STREAM_RESET_OUTGOING_SSN is set. SCTP_STREAM_RESET_DENIED
and SCTP_STREAM_RESET_FAILED are mutually exclusive. If the
request was successful, none of these are set.
strreset_length: This field is the total length in bytes of the
delivered event, including the header.
strreset_assoc_id: The association id field, holds the identifier
for the association. All notifications for a given association
have the same association identifier. For one-to-one style
sockets, this field is ignored.
strreset_stream_list: The list of stream identifiers this event
refers to. An empty list identifies all streams as being reset.
Depending on strreset_flags the identifiers refer to incoming or
outgoing streams or both.
6.1.2. Association Reset Event
The event delivered has the following structure:
struct sctp_assoc_reset_event {
uint16_t assocreset_type;
uint16_t assocreset_flags;
uint32_t assocreset_length;
sctp_assoc_t assocreset_assoc_id;
uint32_t assocreset_local_tsn;
uint32_t assocreset_remote_tsn;
};
Stewart, et al. Expires June 10, 2012 [Page 24]
Internet-Draft SCTP Stream Reconfiguration December 2011
assocreset_type: It should be SCTP_ASSOC_RESET_EVENT.
assocreset_flags: This field is formed from the bitwise OR of one or
more of the following currently defined flags:
SCTP_ASSOC_RESET_DENIED: The corresponding outgoing request was
denied by the peer.
SCTP_ASSOC_RESET_FAILED: The corresponding outgoing request
failed.
SCTP_ASSOC_RESET_DENIED and SCTP_ASSOC_RESET_FAILED are mutual
exclusive. If the request was successful, none of these are set.
assocreset_length: This field is the total length in bytes of the
delivered event, including the header.
assocreset_assoc_id: The association id field, holds the identifier
for the association. All notifications for a given association
have the same association identifier. For one-to-one style
sockets, this field is ignored.
assocreset_local_tsn: The next TSN used by the endpoint.
assocreset_remote_tsn: The next TSN used by the peer.
6.1.3. Stream Change Event
The event delivered has the following structure:
struct sctp_stream_change_event {
uint16_t strchange_type;
uint16_t strchange_flags;
uint32_t strchange_length;
sctp_assoc_t strchange_assoc_id;
uint16_t strchange_instrms;
uint16_t strchange_outstrms;
};
strchange_type: It should be SCTP_STREAM_CHANGE_EVENT.
strchange_flags: This field is formed from the bitwise OR of one or
more of the following currently defined flags:
SCTP_STREAM_CHANGE_DENIED: The corresponding request was denied
by the peer.
Stewart, et al. Expires June 10, 2012 [Page 25]
Internet-Draft SCTP Stream Reconfiguration December 2011
SCTP_STREAM_CHANGE_FAILED: The corresponding request failed.
SCTP_STREAM_CHANGE_DENIED and SCTP_STREAM_CHANGE_FAILED are mutual
exclusive. If the request was successful, none of these are set.
strchange_length: This field is the total length in bytes of the
delivered event, including the header.
strchange_assoc_id: The association id field, holds the identifier
for the association. All notifications for a given association
have the same association identifier. For one-to-one style
sockets, this field is ignored.
strchange_instrms: The number of streams that the peer is allowed to
use outbound.
strchange_outstrms: The number of streams that the endpoint is
allowed to use outbound.
6.2. Event Subscription
Subscribing to events as described in [I-D.ietf-tsvwg-sctpsocket]
uses a setsockopt() call with the SCTP_EVENT socket option. This
option takes the following structure that specifies the association,
the event type (using the same value found in the event type field)
and an on/off boolean.
struct sctp_event {
sctp_assoc_t se_assoc_id;
uint16_t se_type;
uint8_t se_on;
};
The user fills in the se_type with the same value found in the
strreset_type field i.e. SCTP_STREAM_RESET_EVENT. The user will
also fill in the se_assoc_id field with either the association to set
this event on (this field is ignored for one-to-one style sockets) or
one of the reserved constant values defined in
[I-D.ietf-tsvwg-sctpsocket]. Finally the se_on field is set with a 1
to enable the event or a 0 to disable the event.
6.3. Socket Options
The following table describes the new socket options which make the
re-configuration features accessible to the user. They all use
IPPROTO_SCTP as their level.
If a call to setsockopt() is used to issue a Re-configuration request
Stewart, et al. Expires June 10, 2012 [Page 26]
Internet-Draft SCTP Stream Reconfiguration December 2011
while the Re-configuration timer is running, setsockopt() will return
-1 and error is set to EALREADY.
+--------------------------+---------------------------+-----+-----+
| option name | data type | get | set |
+--------------------------+---------------------------+-----+-----+
| SCTP_ENABLE_STREAM_RESET | struct sctp_assoc_value | X | X |
| SCTP_RESET_STREAMS | struct sctp_reset_streams | | X |
| SCTP_RESET_ASSOC | sctp_assoc_t | | X |
| SCTP_ADD_STREAMS | struct sctp_add_streams | | X |
+--------------------------+---------------------------+-----+-----+
Table 5
6.3.1. Enable/Disable Stream Reset (SCTP_ENABLE_STREAM_RESET)
This option allows a user to control whether the SCTP implementation
processes or denies incoming requests in STREAM_RESET chunks.
The default is to deny all incoming requests.
To set or get this option the user fills in the following structure:
struct sctp_assoc_value {
sctp_assoc_t assoc_id;
uint32_t assoc_value;
};
assoc_id: This parameter is ignored for one-to-one style sockets.
For one-to-many style sockets this parameter indicates which
association the user is performing an action upon.
assoc_value: It is formed from the bitwise OR of one or more of the
following currently defined flags:
SCTP_ENABLE_RESET_STREAM_REQ: Process received Incoming/Outgoing
SSN Reset Requests if this flag is set, deny them if not.
SCTP_ENABLE_RESET_ASSOC_REQ: Process received SSN/TSN Reset
Requests if this flag is set, deny them if not.
SCTP_ENABLE_CHANGE_ASSOC_REQ: Process received Add Outgoing
Streams Requests if this flag is set, deny them if not.
The default value is !(SCTP_ENABLE_RESET_STREAM_REQ|
SCTP_ENABLE_RESET_ASSOC_REQ|SCTP_ENABLE_CHANGE_ASSOC_REQ).
Please note that using the option does not have any impact on
Stewart, et al. Expires June 10, 2012 [Page 27]
Internet-Draft SCTP Stream Reconfiguration December 2011
subscribing to any related events.
6.3.2. Reset Incoming and/or Outgoing Streams (SCTP_RESET_STREAMS)
This option allows the user to request the reset of incoming and/or
outgoing streams.
To set or get this option the user fills in the following structure:
struct sctp_reset_streams {
sctp_assoc_t srs_assoc_id;
uint16_t srs_flags;
uint16_t srs_number_streams;
uint16_t srs_stream_list[];
};
srs_assoc_id: This parameter is ignored for one-to-one style
sockets. For one-to-many style sockets this parameter indicates
which association the user is performing an action upon.
srs_flags: This parameter describes which class of streams is reset.
It is formed from the bitwise OR of one or more of the following
currently defined flags:
* SCTP_STREAM_RESET_INCOMING
* SCTP_STREAM_RESET_OUTGOING
srs_number_streams: This parameter is the number of elements in the
srs_stream_list. If it is zero, the operation is performed on all
streams.
srs_stream_list: This parameter contains a list of stream
identifiers the operation is performed upon. It contains
srs_number_streams elements. If it is empty, the operation is
performed on all streams. Depending on srs_flags the identifiers
refer to incoming or outgoing streams or both.
6.3.3. Reset SSN/TSN (SCTP_RESET_ASSOC)
This option allows a user to request the reset of the SSN/TSN.
To set this option the user provides an option_value of type
sctp_assoc_t.
On one-to-one style sockets the option_value is ignored. For one-to-
many style sockets the option_value is the association identifier of
the association the action is to be performed upon.
Stewart, et al. Expires June 10, 2012 [Page 28]
Internet-Draft SCTP Stream Reconfiguration December 2011
6.3.4. Add Incoming and/or Outgoing Streams (SCTP_ADD_STREAMS)
This option allows a user to request the addition of a number of
incoming and/or outgoing streams.
To set this option the user fills in the following structure:
struct sctp_add_streams {
sctp_assoc_t sas_assoc_id;
uint16_t sas_instrms;
uint16_t sas_outstrms;
};
sas_assoc_id: This parameter is ignored for one-to-one style
sockets. For one-to-many style sockets this parameter indicates
which association the user is performing an action upon.
sas_instrms: This parameter is the number of incoming streams to
add.
sas_outstrms: This parameter is the number of outgoing streams to
add.
An endpoint can limit the number of incoming and outgoing streams by
using the sinit_max_instreams field in the struct sctp_initmsg{} when
issuing an SCTP_INIT socket option, as defined in
[I-D.ietf-tsvwg-sctpsocket]. An incoming request asking for more
streams than allowed will be denied.
7. Security Considerations
The SCTP socket API as described in [I-D.ietf-tsvwg-sctpsocket]
exposes the sequence numbers of received DATA chunks to the
application. An application might expect them to be monotonically
increasing. When using the re-configuration extension this might no
longer be true. Therefore the applications must enable this
extension explicitly before it is used. In addition, applications
must subscribe explicitly to notifications related to the re-
configuration extension before receiving them.
SCTP associations are protected against blind attackers by using the
verification tags. This is still valid when using the re-
configuration extension. Therefore this extension does not add any
additional security risk to SCTP in relation to blind attackers.
When the both sequence numbers are reset, the maximum segment
lifetime is used to avoid the wrap-around for the TSN.
Stewart, et al. Expires June 10, 2012 [Page 29]
Internet-Draft SCTP Stream Reconfiguration December 2011
8. IANA Considerations
[NOTE to RFC-Editor:
"RFCXXXX" is to be replaced by the RFC number you assign this
document.
]
[NOTE to RFC-Editor:
The suggested values for the chunk type and the chunk parameter
types are tentative and to be confirmed by IANA.
]
This document (RFCXXXX) is the reference for all registrations
described in this section. The suggested changes are described
below.
8.1. A New Chunk Type
A chunk type has to be assigned by IANA. It is suggested to use the
values given in Table 1. IANA should assign this value from the pool
of chunks with the upper two bits set to '10'.
This requires an additional line in the "Chunk Types" registry for
SCTP:
Chunk Types
ID Value Chunk Type Reference
----- ---------- ---------
130 Re-configuration Chunk (RE-CONFIG) [RFCXXXX]
The registration table as defined in [RFC6096] for the chunk flags of
this chunk type is empty.
8.2. Six New Chunk Parameter Types
Six chunk parameter types have to be assigned by IANA. It is
suggested to use the values given in Table 2. IANA should assign
these values from the pool of parameters with the upper two bits set
to '00'.
This requires six additional lines in the "Chunk Parameter Types"
registry for SCTP:
Stewart, et al. Expires June 10, 2012 [Page 30]
Internet-Draft SCTP Stream Reconfiguration December 2011
Chunk Parameter Types
ID Value Chunk Parameter Type Reference
-------- ------------------------------------------------ ---------
13 Outgoing SSN Reset Request Parameter [RFCXXXX]
14 Incoming SSN Reset Request Parameter [RFCXXXX]
15 SSN/TSN Reset Request Parameter [RFCXXXX]
16 Re-configuration Response Parameter [RFCXXXX]
17 Add Outgoing Streams Request Parameter [RFCXXXX]
18 Add Incoming Streams Request Parameter [RFCXXXX]
9. Acknowledgments
The authors wish to thank Paul Aitken, Gorry Fairhurst, Tom Petch,
Kacheong Poon, Irene Ruengeler, Robin Seggelmann, Gavin Shearer, and
Vlad Yasevich for there invaluable comments.
10. References
10.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC3758] Stewart, R., Ramalho, M., Xie, Q., Tuexen, M., and P.
Conrad, "Stream Control Transmission Protocol (SCTP)
Partial Reliability Extension", RFC 3758, May 2004.
[RFC4960] Stewart, R., "Stream Control Transmission Protocol",
RFC 4960, September 2007.
[RFC5061] Stewart, R., Xie, Q., Tuexen, M., Maruyama, S., and M.
Kozuka, "Stream Control Transmission Protocol (SCTP)
Dynamic Address Reconfiguration", RFC 5061,
September 2007.
[RFC6096] Tuexen, M. and R. Stewart, "Stream Control Transmission
Protocol (SCTP) Chunk Flags Registration", RFC 6096,
January 2011.
10.2. Informative References
[I-D.ietf-tsvwg-sctpsocket]
Stewart, R., Tuexen, M., Poon, K., Lei, P., and V.
Yasevich, "Sockets API Extensions for Stream Control
Transmission Protocol (SCTP)",
Stewart, et al. Expires June 10, 2012 [Page 31]
Internet-Draft SCTP Stream Reconfiguration December 2011
draft-ietf-tsvwg-sctpsocket-32 (work in progress),
October 2011.
Appendix A. Examples of the Re-configuration procedures
Please note that this appendix is informational only.
The following message flows between an Endpoint A and an Endpoint Z
illustrate the described procedures. The time progresses in downward
direction.
The following example illustrates an Endpoint A resetting stream 1
and 2 for just its outgoing streams.
E-A E-Z
----------[RE-CONFIG(OUT-REQ:X/1,2)]---------->
<-------------[RE-CONFIG(RESP:X)]--------------
The following example illustrates an Endpoint A resetting stream 1
and 2 for just its incoming streams.
E-A E-Z
-----------[RE-CONFIG(IN-REQ:X/1,2)]---------->
<--------[RE-CONFIG(OUT-REQ:Y,X/1,2)]----------
-------------[RE-CONFIG(RESP:Y)]-------------->
The following example illustrates an Endpoint A resetting all streams
in both directions.
E-A E-Z
-----[RE-CONFIG(OUT-REQ:X,Y-1|IN-REQ:X+1)]---->
<------[RE-CONFIG(RESP:X|OUT-REQ:Y,X+1)]-------
-------------[RE-CONFIG(RESP:Y)]-------------->
The following example illustrates an Endpoint A requesting the
streams and TSNs be reset. At the completion E-A has the new sending
TSN (selected by the peer) of B and E-Z has the new sending TSN of A
(also selected by the peer).
E-A E-Z
------------[RE-CONFIG(TSN-REQ:X)]------------>
<-----[RE-CONFIG(RESP:X/S-TSN=A, R-TSN=B)]-----
The following example illustrates an Endpoint A requesting to add 3
additional outgoing streams.
Stewart, et al. Expires June 10, 2012 [Page 32]
Internet-Draft SCTP Stream Reconfiguration December 2011
E-A E-Z
--------[RE-CONFIG(ADD_OUT_STRMS:X/3)]-------->
<-------------[RE-CONFIG(RESP:X)]--------------
The following example illustrates an Endpoint A requesting to add 3
additional incoming streams.
E-A E-Z
---------[RE-CONFIG(ADD_IN_STRMS:X/3)]-------->
<----[RE-CONFIG(ADD_OUT_STRMS-REQ:Y,X/3)]------
-------------[RE-CONFIG(RESP:Y)]-------------->
Authors' Addresses
Randall R. Stewart
Adara Networks
Chapin, SC 29036
USA
Email: randall@lakerest.net
Michael Tuexen
Muenster University of Applied Sciences
Stegerwaldstr. 39
48565 Steinfurt
DE
Email: tuexen@fh-muenster.de
Peter Lei
Cisco Systems, Inc.
8735 West Higgins Road
Suite 300
Chicago, IL 60631
USA
Email: peterlei@cisco.com
Stewart, et al. Expires June 10, 2012 [Page 33]
