xref: /linux-6.15/include/linux/sctp.h (revision bbb03029)
1 /* SCTP kernel reference Implementation
2  * (C) Copyright IBM Corp. 2001, 2004
3  * Copyright (c) 1999-2000 Cisco, Inc.
4  * Copyright (c) 1999-2001 Motorola, Inc.
5  * Copyright (c) 2001 Intel Corp.
6  * Copyright (c) 2001 Nokia, Inc.
7  * Copyright (c) 2001 La Monte H.P. Yarroll
8  *
9  * This file is part of the SCTP kernel reference Implementation
10  *
11  * Various protocol defined structures.
12  *
13  * This SCTP implementation is free software;
14  * you can redistribute it and/or modify it under the terms of
15  * the GNU General Public License as published by
16  * the Free Software Foundation; either version 2, or (at your option)
17  * any later version.
18  *
19  * This SCTP implementation is distributed in the hope that it
20  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
21  *                 ************************
22  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
23  * See the GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License
26  * along with GNU CC; see the file COPYING.  If not, see
27  * <http://www.gnu.org/licenses/>.
28  *
29  * Please send any bug reports or fixes you make to the
30  * email address(es):
31  *    lksctp developers <[email protected]>
32  *
33  * Or submit a bug report through the following website:
34  *    http://www.sf.net/projects/lksctp
35  *
36  * Written or modified by:
37  *    La Monte H.P. Yarroll <[email protected]>
38  *    Karl Knutson <[email protected]>
39  *    Jon Grimm <[email protected]>
40  *    Xingang Guo <[email protected]>
41  *    [email protected]
42  *    [email protected]
43  *    [email protected]
44  *    Sridhar Samudrala <[email protected]>
45  *    Kevin Gao <[email protected]>
46  *
47  * Any bugs reported given to us we will try to fix... any fixes shared will
48  * be incorporated into the next SCTP release.
49  */
50 #ifndef __LINUX_SCTP_H__
51 #define __LINUX_SCTP_H__
52 
53 #include <linux/in.h>		/* We need in_addr.  */
54 #include <linux/in6.h>		/* We need in6_addr.  */
55 #include <linux/skbuff.h>
56 
57 #include <uapi/linux/sctp.h>
58 
59 /* Section 3.1.  SCTP Common Header Format */
60 struct sctphdr {
61 	__be16 source;
62 	__be16 dest;
63 	__be32 vtag;
64 	__le32 checksum;
65 };
66 
67 static inline struct sctphdr *sctp_hdr(const struct sk_buff *skb)
68 {
69 	return (struct sctphdr *)skb_transport_header(skb);
70 }
71 
72 /* Section 3.2.  Chunk Field Descriptions. */
73 struct sctp_chunkhdr {
74 	__u8 type;
75 	__u8 flags;
76 	__be16 length;
77 };
78 
79 
80 /* Section 3.2.  Chunk Type Values.
81  * [Chunk Type] identifies the type of information contained in the Chunk
82  * Value field. It takes a value from 0 to 254. The value of 255 is
83  * reserved for future use as an extension field.
84  */
85 enum sctp_cid {
86 	SCTP_CID_DATA			= 0,
87         SCTP_CID_INIT			= 1,
88         SCTP_CID_INIT_ACK		= 2,
89         SCTP_CID_SACK			= 3,
90         SCTP_CID_HEARTBEAT		= 4,
91         SCTP_CID_HEARTBEAT_ACK		= 5,
92         SCTP_CID_ABORT			= 6,
93         SCTP_CID_SHUTDOWN		= 7,
94         SCTP_CID_SHUTDOWN_ACK		= 8,
95         SCTP_CID_ERROR			= 9,
96         SCTP_CID_COOKIE_ECHO		= 10,
97         SCTP_CID_COOKIE_ACK	        = 11,
98         SCTP_CID_ECN_ECNE		= 12,
99         SCTP_CID_ECN_CWR		= 13,
100         SCTP_CID_SHUTDOWN_COMPLETE	= 14,
101 
102 	/* AUTH Extension Section 4.1 */
103 	SCTP_CID_AUTH			= 0x0F,
104 
105 	/* PR-SCTP Sec 3.2 */
106 	SCTP_CID_FWD_TSN		= 0xC0,
107 
108 	/* Use hex, as defined in ADDIP sec. 3.1 */
109 	SCTP_CID_ASCONF			= 0xC1,
110 	SCTP_CID_ASCONF_ACK		= 0x80,
111 	SCTP_CID_RECONF			= 0x82,
112 }; /* enum */
113 
114 
115 /* Section 3.2
116  *  Chunk Types are encoded such that the highest-order two bits specify
117  *  the action that must be taken if the processing endpoint does not
118  *  recognize the Chunk Type.
119  */
120 enum {
121 	SCTP_CID_ACTION_DISCARD     = 0x00,
122 	SCTP_CID_ACTION_DISCARD_ERR = 0x40,
123 	SCTP_CID_ACTION_SKIP        = 0x80,
124 	SCTP_CID_ACTION_SKIP_ERR    = 0xc0,
125 };
126 
127 enum { SCTP_CID_ACTION_MASK = 0xc0, };
128 
129 /* This flag is used in Chunk Flags for ABORT and SHUTDOWN COMPLETE.
130  *
131  * 3.3.7 Abort Association (ABORT) (6):
132  *    The T bit is set to 0 if the sender had a TCB that it destroyed.
133  *    If the sender did not have a TCB it should set this bit to 1.
134  */
135 enum { SCTP_CHUNK_FLAG_T = 0x01 };
136 
137 /*
138  *  Set the T bit
139  *
140  *      0                   1                   2                   3
141  *      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
142  *     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
143  *     |   Type = 14   |Reserved     |T|      Length = 4               |
144  *     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
145  *
146  * Chunk Flags: 8 bits
147  *
148  *   Reserved:  7 bits
149  *     Set to 0 on transmit and ignored on receipt.
150  *
151  *   T bit:  1 bit
152  *     The T bit is set to 0 if the sender had a TCB that it destroyed. If
153  *     the sender did NOT have a TCB it should set this bit to 1.
154  *
155  * Note: Special rules apply to this chunk for verification, please
156  * see Section 8.5.1 for details.
157  */
158 
159 #define sctp_test_T_bit(c)    ((c)->chunk_hdr->flags & SCTP_CHUNK_FLAG_T)
160 
161 /* RFC 2960
162  * Section 3.2.1 Optional/Variable-length Parmaeter Format.
163  */
164 
165 struct sctp_paramhdr {
166 	__be16 type;
167 	__be16 length;
168 };
169 
170 enum sctp_param {
171 
172 	/* RFC 2960 Section 3.3.5 */
173 	SCTP_PARAM_HEARTBEAT_INFO		= cpu_to_be16(1),
174 	/* RFC 2960 Section 3.3.2.1 */
175 	SCTP_PARAM_IPV4_ADDRESS			= cpu_to_be16(5),
176 	SCTP_PARAM_IPV6_ADDRESS			= cpu_to_be16(6),
177 	SCTP_PARAM_STATE_COOKIE			= cpu_to_be16(7),
178 	SCTP_PARAM_UNRECOGNIZED_PARAMETERS	= cpu_to_be16(8),
179 	SCTP_PARAM_COOKIE_PRESERVATIVE		= cpu_to_be16(9),
180 	SCTP_PARAM_HOST_NAME_ADDRESS		= cpu_to_be16(11),
181 	SCTP_PARAM_SUPPORTED_ADDRESS_TYPES	= cpu_to_be16(12),
182 	SCTP_PARAM_ECN_CAPABLE			= cpu_to_be16(0x8000),
183 
184 	/* AUTH Extension Section 3 */
185 	SCTP_PARAM_RANDOM			= cpu_to_be16(0x8002),
186 	SCTP_PARAM_CHUNKS			= cpu_to_be16(0x8003),
187 	SCTP_PARAM_HMAC_ALGO			= cpu_to_be16(0x8004),
188 
189 	/* Add-IP: Supported Extensions, Section 4.2 */
190 	SCTP_PARAM_SUPPORTED_EXT	= cpu_to_be16(0x8008),
191 
192 	/* PR-SCTP Sec 3.1 */
193 	SCTP_PARAM_FWD_TSN_SUPPORT	= cpu_to_be16(0xc000),
194 
195 	/* Add-IP Extension. Section 3.2 */
196 	SCTP_PARAM_ADD_IP		= cpu_to_be16(0xc001),
197 	SCTP_PARAM_DEL_IP		= cpu_to_be16(0xc002),
198 	SCTP_PARAM_ERR_CAUSE		= cpu_to_be16(0xc003),
199 	SCTP_PARAM_SET_PRIMARY		= cpu_to_be16(0xc004),
200 	SCTP_PARAM_SUCCESS_REPORT	= cpu_to_be16(0xc005),
201 	SCTP_PARAM_ADAPTATION_LAYER_IND = cpu_to_be16(0xc006),
202 
203 	/* RE-CONFIG. Section 4 */
204 	SCTP_PARAM_RESET_OUT_REQUEST		= cpu_to_be16(0x000d),
205 	SCTP_PARAM_RESET_IN_REQUEST		= cpu_to_be16(0x000e),
206 	SCTP_PARAM_RESET_TSN_REQUEST		= cpu_to_be16(0x000f),
207 	SCTP_PARAM_RESET_RESPONSE		= cpu_to_be16(0x0010),
208 	SCTP_PARAM_RESET_ADD_OUT_STREAMS	= cpu_to_be16(0x0011),
209 	SCTP_PARAM_RESET_ADD_IN_STREAMS		= cpu_to_be16(0x0012),
210 }; /* enum */
211 
212 
213 /* RFC 2960 Section 3.2.1
214  *  The Parameter Types are encoded such that the highest-order two bits
215  *  specify the action that must be taken if the processing endpoint does
216  *  not recognize the Parameter Type.
217  *
218  */
219 enum {
220 	SCTP_PARAM_ACTION_DISCARD     = cpu_to_be16(0x0000),
221 	SCTP_PARAM_ACTION_DISCARD_ERR = cpu_to_be16(0x4000),
222 	SCTP_PARAM_ACTION_SKIP        = cpu_to_be16(0x8000),
223 	SCTP_PARAM_ACTION_SKIP_ERR    = cpu_to_be16(0xc000),
224 };
225 
226 enum { SCTP_PARAM_ACTION_MASK = cpu_to_be16(0xc000), };
227 
228 /* RFC 2960 Section 3.3.1 Payload Data (DATA) (0) */
229 
230 struct sctp_datahdr {
231 	__be32 tsn;
232 	__be16 stream;
233 	__be16 ssn;
234 	__be32 ppid;
235 	__u8  payload[0];
236 };
237 
238 struct sctp_data_chunk {
239 	struct sctp_chunkhdr chunk_hdr;
240 	struct sctp_datahdr data_hdr;
241 };
242 
243 /* DATA Chuck Specific Flags */
244 enum {
245 	SCTP_DATA_MIDDLE_FRAG	= 0x00,
246 	SCTP_DATA_LAST_FRAG	= 0x01,
247 	SCTP_DATA_FIRST_FRAG	= 0x02,
248 	SCTP_DATA_NOT_FRAG	= 0x03,
249 	SCTP_DATA_UNORDERED	= 0x04,
250 	SCTP_DATA_SACK_IMM	= 0x08,
251 };
252 enum { SCTP_DATA_FRAG_MASK = 0x03, };
253 
254 
255 /* RFC 2960 Section 3.3.2 Initiation (INIT) (1)
256  *
257  *  This chunk is used to initiate a SCTP association between two
258  *  endpoints.
259  */
260 struct sctp_inithdr {
261 	__be32 init_tag;
262 	__be32 a_rwnd;
263 	__be16 num_outbound_streams;
264 	__be16 num_inbound_streams;
265 	__be32 initial_tsn;
266 	__u8  params[0];
267 };
268 
269 struct sctp_init_chunk {
270 	struct sctp_chunkhdr chunk_hdr;
271 	struct sctp_inithdr init_hdr;
272 };
273 
274 
275 /* Section 3.3.2.1. IPv4 Address Parameter (5) */
276 struct sctp_ipv4addr_param {
277 	struct sctp_paramhdr param_hdr;
278 	struct in_addr addr;
279 };
280 
281 /* Section 3.3.2.1. IPv6 Address Parameter (6) */
282 struct sctp_ipv6addr_param {
283 	struct sctp_paramhdr param_hdr;
284 	struct in6_addr addr;
285 };
286 
287 /* Section 3.3.2.1 Cookie Preservative (9) */
288 struct sctp_cookie_preserve_param {
289 	struct sctp_paramhdr param_hdr;
290 	__be32 lifespan_increment;
291 };
292 
293 /* Section 3.3.2.1 Host Name Address (11) */
294 struct sctp_hostname_param {
295 	struct sctp_paramhdr param_hdr;
296 	uint8_t hostname[0];
297 };
298 
299 /* Section 3.3.2.1 Supported Address Types (12) */
300 struct sctp_supported_addrs_param {
301 	struct sctp_paramhdr param_hdr;
302 	__be16 types[0];
303 };
304 
305 /* ADDIP Section 3.2.6 Adaptation Layer Indication */
306 struct sctp_adaptation_ind_param {
307 	struct sctp_paramhdr param_hdr;
308 	__be32 adaptation_ind;
309 };
310 
311 /* ADDIP Section 4.2.7 Supported Extensions Parameter */
312 struct sctp_supported_ext_param {
313 	struct sctp_paramhdr param_hdr;
314 	__u8 chunks[0];
315 };
316 
317 /* AUTH Section 3.1 Random */
318 struct sctp_random_param {
319 	struct sctp_paramhdr param_hdr;
320 	__u8 random_val[0];
321 };
322 
323 /* AUTH Section 3.2 Chunk List */
324 struct sctp_chunks_param {
325 	struct sctp_paramhdr param_hdr;
326 	__u8 chunks[0];
327 };
328 
329 /* AUTH Section 3.3 HMAC Algorithm */
330 struct sctp_hmac_algo_param {
331 	struct sctp_paramhdr param_hdr;
332 	__be16 hmac_ids[0];
333 };
334 
335 /* RFC 2960.  Section 3.3.3 Initiation Acknowledgement (INIT ACK) (2):
336  *   The INIT ACK chunk is used to acknowledge the initiation of an SCTP
337  *   association.
338  */
339 struct sctp_initack_chunk {
340 	struct sctp_chunkhdr chunk_hdr;
341 	struct sctp_inithdr init_hdr;
342 };
343 
344 /* Section 3.3.3.1 State Cookie (7) */
345 struct sctp_cookie_param {
346 	struct sctp_paramhdr p;
347 	__u8 body[0];
348 };
349 
350 /* Section 3.3.3.1 Unrecognized Parameters (8) */
351 struct sctp_unrecognized_param {
352 	struct sctp_paramhdr param_hdr;
353 	struct sctp_paramhdr unrecognized;
354 };
355 
356 
357 
358 /*
359  * 3.3.4 Selective Acknowledgement (SACK) (3):
360  *
361  *  This chunk is sent to the peer endpoint to acknowledge received DATA
362  *  chunks and to inform the peer endpoint of gaps in the received
363  *  subsequences of DATA chunks as represented by their TSNs.
364  */
365 
366 struct sctp_gap_ack_block {
367 	__be16 start;
368 	__be16 end;
369 };
370 
371 union sctp_sack_variable {
372 	struct sctp_gap_ack_block gab;
373 	__be32 dup;
374 };
375 
376 struct sctp_sackhdr {
377 	__be32 cum_tsn_ack;
378 	__be32 a_rwnd;
379 	__be16 num_gap_ack_blocks;
380 	__be16 num_dup_tsns;
381 	union sctp_sack_variable variable[0];
382 };
383 
384 struct sctp_sack_chunk {
385 	struct sctp_chunkhdr chunk_hdr;
386 	struct sctp_sackhdr sack_hdr;
387 };
388 
389 
390 /* RFC 2960.  Section 3.3.5 Heartbeat Request (HEARTBEAT) (4):
391  *
392  *  An endpoint should send this chunk to its peer endpoint to probe the
393  *  reachability of a particular destination transport address defined in
394  *  the present association.
395  */
396 
397 struct sctp_heartbeathdr {
398 	struct sctp_paramhdr info;
399 };
400 
401 struct sctp_heartbeat_chunk {
402 	struct sctp_chunkhdr chunk_hdr;
403 	struct sctp_heartbeathdr hb_hdr;
404 };
405 
406 
407 /* For the abort and shutdown ACK we must carry the init tag in the
408  * common header. Just the common header is all that is needed with a
409  * chunk descriptor.
410  */
411 struct sctp_abort_chunk {
412 	struct sctp_chunkhdr uh;
413 };
414 
415 
416 /* For the graceful shutdown we must carry the tag (in common header)
417  * and the highest consecutive acking value.
418  */
419 typedef struct sctp_shutdownhdr {
420 	__be32 cum_tsn_ack;
421 } sctp_shutdownhdr_t;
422 
423 struct sctp_shutdown_chunk_t {
424 	struct sctp_chunkhdr chunk_hdr;
425 	sctp_shutdownhdr_t shutdown_hdr;
426 };
427 
428 /* RFC 2960.  Section 3.3.10 Operation Error (ERROR) (9) */
429 
430 typedef struct sctp_errhdr {
431 	__be16 cause;
432 	__be16 length;
433 	__u8  variable[0];
434 } sctp_errhdr_t;
435 
436 typedef struct sctp_operr_chunk {
437 	struct sctp_chunkhdr chunk_hdr;
438 	sctp_errhdr_t err_hdr;
439 } sctp_operr_chunk_t;
440 
441 /* RFC 2960 3.3.10 - Operation Error
442  *
443  * Cause Code: 16 bits (unsigned integer)
444  *
445  *     Defines the type of error conditions being reported.
446  *    Cause Code
447  *     Value           Cause Code
448  *     ---------      ----------------
449  *      1              Invalid Stream Identifier
450  *      2              Missing Mandatory Parameter
451  *      3              Stale Cookie Error
452  *      4              Out of Resource
453  *      5              Unresolvable Address
454  *      6              Unrecognized Chunk Type
455  *      7              Invalid Mandatory Parameter
456  *      8              Unrecognized Parameters
457  *      9              No User Data
458  *     10              Cookie Received While Shutting Down
459  */
460 typedef enum {
461 
462 	SCTP_ERROR_NO_ERROR	   = cpu_to_be16(0x00),
463 	SCTP_ERROR_INV_STRM	   = cpu_to_be16(0x01),
464 	SCTP_ERROR_MISS_PARAM 	   = cpu_to_be16(0x02),
465 	SCTP_ERROR_STALE_COOKIE	   = cpu_to_be16(0x03),
466 	SCTP_ERROR_NO_RESOURCE 	   = cpu_to_be16(0x04),
467 	SCTP_ERROR_DNS_FAILED      = cpu_to_be16(0x05),
468 	SCTP_ERROR_UNKNOWN_CHUNK   = cpu_to_be16(0x06),
469 	SCTP_ERROR_INV_PARAM       = cpu_to_be16(0x07),
470 	SCTP_ERROR_UNKNOWN_PARAM   = cpu_to_be16(0x08),
471 	SCTP_ERROR_NO_DATA         = cpu_to_be16(0x09),
472 	SCTP_ERROR_COOKIE_IN_SHUTDOWN = cpu_to_be16(0x0a),
473 
474 
475 	/* SCTP Implementation Guide:
476 	 *  11  Restart of an association with new addresses
477 	 *  12  User Initiated Abort
478 	 *  13  Protocol Violation
479 	 */
480 
481 	SCTP_ERROR_RESTART         = cpu_to_be16(0x0b),
482 	SCTP_ERROR_USER_ABORT      = cpu_to_be16(0x0c),
483 	SCTP_ERROR_PROTO_VIOLATION = cpu_to_be16(0x0d),
484 
485 	/* ADDIP Section 3.3  New Error Causes
486 	 *
487 	 * Four new Error Causes are added to the SCTP Operational Errors,
488 	 * primarily for use in the ASCONF-ACK chunk.
489 	 *
490 	 * Value          Cause Code
491 	 * ---------      ----------------
492 	 * 0x00A0          Request to Delete Last Remaining IP Address.
493 	 * 0x00A1          Operation Refused Due to Resource Shortage.
494 	 * 0x00A2          Request to Delete Source IP Address.
495 	 * 0x00A3          Association Aborted due to illegal ASCONF-ACK
496 	 * 0x00A4          Request refused - no authorization.
497 	 */
498 	SCTP_ERROR_DEL_LAST_IP	= cpu_to_be16(0x00A0),
499 	SCTP_ERROR_RSRC_LOW	= cpu_to_be16(0x00A1),
500 	SCTP_ERROR_DEL_SRC_IP	= cpu_to_be16(0x00A2),
501 	SCTP_ERROR_ASCONF_ACK   = cpu_to_be16(0x00A3),
502 	SCTP_ERROR_REQ_REFUSED	= cpu_to_be16(0x00A4),
503 
504 	/* AUTH Section 4.  New Error Cause
505 	 *
506 	 * This section defines a new error cause that will be sent if an AUTH
507 	 * chunk is received with an unsupported HMAC identifier.
508 	 * illustrates the new error cause.
509 	 *
510 	 * Cause Code      Error Cause Name
511 	 * --------------------------------------------------------------
512 	 * 0x0105          Unsupported HMAC Identifier
513 	 */
514 	 SCTP_ERROR_UNSUP_HMAC	= cpu_to_be16(0x0105)
515 } sctp_error_t;
516 
517 
518 
519 /* RFC 2960.  Appendix A.  Explicit Congestion Notification.
520  *   Explicit Congestion Notification Echo (ECNE) (12)
521  */
522 typedef struct sctp_ecnehdr {
523 	__be32 lowest_tsn;
524 } sctp_ecnehdr_t;
525 
526 typedef struct sctp_ecne_chunk {
527 	struct sctp_chunkhdr chunk_hdr;
528 	sctp_ecnehdr_t ence_hdr;
529 } sctp_ecne_chunk_t;
530 
531 /* RFC 2960.  Appendix A.  Explicit Congestion Notification.
532  *   Congestion Window Reduced (CWR) (13)
533  */
534 typedef struct sctp_cwrhdr {
535 	__be32 lowest_tsn;
536 } sctp_cwrhdr_t;
537 
538 typedef struct sctp_cwr_chunk {
539 	struct sctp_chunkhdr chunk_hdr;
540 	sctp_cwrhdr_t cwr_hdr;
541 } sctp_cwr_chunk_t;
542 
543 /* PR-SCTP
544  * 3.2 Forward Cumulative TSN Chunk Definition (FORWARD TSN)
545  *
546  * Forward Cumulative TSN chunk has the following format:
547  *
548  *        0                   1                   2                   3
549  *        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
550  *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
551  *      |   Type = 192  |  Flags = 0x00 |        Length = Variable      |
552  *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
553  *      |                      New Cumulative TSN                       |
554  *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
555  *      |         Stream-1              |       Stream Sequence-1       |
556  *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
557  *      \                                                               /
558  *      /                                                               \
559  *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
560  *      |         Stream-N              |       Stream Sequence-N       |
561  *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
562  *
563  *      Chunk Flags:
564  *
565  *        Set to all zeros on transmit and ignored on receipt.
566  *
567  *      New Cumulative TSN: 32 bit u_int
568  *
569  *       This indicates the new cumulative TSN to the data receiver. Upon
570  *       the reception of this value, the data receiver MUST consider
571  *       any missing TSNs earlier than or equal to this value as received
572  *       and stop reporting them as gaps in any subsequent SACKs.
573  *
574  *      Stream-N: 16 bit u_int
575  *
576  *       This field holds a stream number that was skipped by this
577  *       FWD-TSN.
578  *
579  *      Stream Sequence-N: 16 bit u_int
580  *       This field holds the sequence number associated with the stream
581  *       that was skipped. The stream sequence field holds the largest stream
582  *       sequence number in this stream being skipped.  The receiver of
583  *       the FWD-TSN's can use the Stream-N and Stream Sequence-N fields
584  *       to enable delivery of any stranded TSN's that remain on the stream
585  *       re-ordering queues. This field MUST NOT report TSN's corresponding
586  *       to DATA chunk that are marked as unordered. For ordered DATA
587  *       chunks this field MUST be filled in.
588  */
589 struct sctp_fwdtsn_skip {
590 	__be16 stream;
591 	__be16 ssn;
592 };
593 
594 struct sctp_fwdtsn_hdr {
595 	__be32 new_cum_tsn;
596 	struct sctp_fwdtsn_skip skip[0];
597 };
598 
599 struct sctp_fwdtsn_chunk {
600 	struct sctp_chunkhdr chunk_hdr;
601 	struct sctp_fwdtsn_hdr fwdtsn_hdr;
602 };
603 
604 
605 /* ADDIP
606  * Section 3.1.1 Address Configuration Change Chunk (ASCONF)
607  *
608  * 	Serial Number: 32 bits (unsigned integer)
609  *	This value represents a Serial Number for the ASCONF Chunk. The
610  *	valid range of Serial Number is from 0 to 2^32-1.
611  *	Serial Numbers wrap back to 0 after reaching 2^32 -1.
612  *
613  *	Address Parameter: 8 or 20 bytes (depending on type)
614  *	The address is an address of the sender of the ASCONF chunk,
615  *	the address MUST be considered part of the association by the
616  *	peer endpoint. This field may be used by the receiver of the
617  *	ASCONF to help in finding the association. This parameter MUST
618  *	be present in every ASCONF message i.e. it is a mandatory TLV
619  *	parameter.
620  *
621  *	ASCONF Parameter: TLV format
622  *	Each Address configuration change is represented by a TLV
623  *	parameter as defined in Section 3.2. One or more requests may
624  *	be present in an ASCONF Chunk.
625  *
626  * Section 3.1.2 Address Configuration Acknowledgement Chunk (ASCONF-ACK)
627  *
628  *	Serial Number: 32 bits (unsigned integer)
629  *	This value represents the Serial Number for the received ASCONF
630  *	Chunk that is acknowledged by this chunk. This value is copied
631  *	from the received ASCONF Chunk.
632  *
633  *	ASCONF Parameter Response: TLV format
634  *	The ASCONF Parameter Response is used in the ASCONF-ACK to
635  *	report status of ASCONF processing.
636  */
637 typedef struct sctp_addip_param {
638 	struct sctp_paramhdr	param_hdr;
639 	__be32		crr_id;
640 } sctp_addip_param_t;
641 
642 typedef struct sctp_addiphdr {
643 	__be32	serial;
644 	__u8	params[0];
645 } sctp_addiphdr_t;
646 
647 typedef struct sctp_addip_chunk {
648 	struct sctp_chunkhdr chunk_hdr;
649 	sctp_addiphdr_t addip_hdr;
650 } sctp_addip_chunk_t;
651 
652 /* AUTH
653  * Section 4.1  Authentication Chunk (AUTH)
654  *
655  *   This chunk is used to hold the result of the HMAC calculation.
656  *
657  *    0                   1                   2                   3
658  *    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
659  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
660  *   | Type = 0x0F   |   Flags=0     |             Length            |
661  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
662  *   |     Shared Key Identifier     |   HMAC Identifier             |
663  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
664  *   |                                                               |
665  *   \                             HMAC                              /
666  *   /                                                               \
667  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
668  *
669  *   Type: 1 byte (unsigned integer)
670  *   	This value MUST be set to 0x0F for  all AUTH-chunks.
671  *
672  *   Flags: 1 byte (unsigned integer)
673  *	Set to zero on transmit and ignored on receipt.
674  *
675  *   Length: 2 bytes (unsigned integer)
676  *   	This value holds the length of the HMAC in bytes plus 8.
677  *
678  *  Shared Key Identifier: 2 bytes (unsigned integer)
679  *	This value describes which endpoint pair shared key is used.
680  *
681  *   HMAC Identifier: 2 bytes (unsigned integer)
682  *   	This value describes which message digest is being used.  Table 2
683  *	shows the currently defined values.
684  *
685  *    The following Table 2 shows the currently defined values for HMAC
686  *       identifiers.
687  *
688  *	 +-----------------+--------------------------+
689  *	 | HMAC Identifier | Message Digest Algorithm |
690  *	 +-----------------+--------------------------+
691  *	 | 0               | Reserved                 |
692  *	 | 1               | SHA-1 defined in [8]     |
693  *	 | 2               | Reserved                 |
694  *	 | 3               | SHA-256 defined in [8]   |
695  *	 +-----------------+--------------------------+
696  *
697  *
698  *   HMAC: n bytes (unsigned integer) This hold the result of the HMAC
699  *      calculation.
700  */
701 typedef struct sctp_authhdr {
702 	__be16 shkey_id;
703 	__be16 hmac_id;
704 	__u8   hmac[0];
705 } sctp_authhdr_t;
706 
707 typedef struct sctp_auth_chunk {
708 	struct sctp_chunkhdr chunk_hdr;
709 	sctp_authhdr_t auth_hdr;
710 } sctp_auth_chunk_t;
711 
712 struct sctp_infox {
713 	struct sctp_info *sctpinfo;
714 	struct sctp_association *asoc;
715 };
716 
717 struct sctp_reconf_chunk {
718 	struct sctp_chunkhdr chunk_hdr;
719 	__u8 params[0];
720 };
721 
722 struct sctp_strreset_outreq {
723 	struct sctp_paramhdr param_hdr;
724 	__u32 request_seq;
725 	__u32 response_seq;
726 	__u32 send_reset_at_tsn;
727 	__u16 list_of_streams[0];
728 };
729 
730 struct sctp_strreset_inreq {
731 	struct sctp_paramhdr param_hdr;
732 	__u32 request_seq;
733 	__u16 list_of_streams[0];
734 };
735 
736 struct sctp_strreset_tsnreq {
737 	struct sctp_paramhdr param_hdr;
738 	__u32 request_seq;
739 };
740 
741 struct sctp_strreset_addstrm {
742 	struct sctp_paramhdr param_hdr;
743 	__u32 request_seq;
744 	__u16 number_of_streams;
745 	__u16 reserved;
746 };
747 
748 enum {
749 	SCTP_STRRESET_NOTHING_TO_DO	= 0x00,
750 	SCTP_STRRESET_PERFORMED		= 0x01,
751 	SCTP_STRRESET_DENIED		= 0x02,
752 	SCTP_STRRESET_ERR_WRONG_SSN	= 0x03,
753 	SCTP_STRRESET_ERR_IN_PROGRESS	= 0x04,
754 	SCTP_STRRESET_ERR_BAD_SEQNO	= 0x05,
755 	SCTP_STRRESET_IN_PROGRESS	= 0x06,
756 };
757 
758 struct sctp_strreset_resp {
759 	struct sctp_paramhdr param_hdr;
760 	__u32 response_seq;
761 	__u32 result;
762 };
763 
764 struct sctp_strreset_resptsn {
765 	struct sctp_paramhdr param_hdr;
766 	__u32 response_seq;
767 	__u32 result;
768 	__u32 senders_next_tsn;
769 	__u32 receivers_next_tsn;
770 };
771 
772 #endif /* __LINUX_SCTP_H__ */
773