1 /*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
5 * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
6 * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
10 *
11 * a) Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
13 *
14 * b) Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the distribution.
17 *
18 * c) Neither the name of Cisco Systems, Inc. nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
24 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32 * THE POSSIBILITY OF SUCH DAMAGE.
33 */
34
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
37
38 #ifndef _NETINET_SCTP_HEADER_H_
39 #define _NETINET_SCTP_HEADER_H_
40
41 #include <sys/time.h>
42 #include <netinet/sctp.h>
43 #include <netinet/sctp_constants.h>
44
45 #define SCTP_PACKED __attribute__((packed))
46
47 /*
48 * Parameter structures
49 */
50 struct sctp_ipv4addr_param {
51 struct sctp_paramhdr ph; /* type=SCTP_IPV4_PARAM_TYPE, len=8 */
52 uint32_t addr; /* IPV4 address */
53 } SCTP_PACKED;
54
55 #define SCTP_V6_ADDR_BYTES 16
56
57 struct sctp_ipv6addr_param {
58 struct sctp_paramhdr ph; /* type=SCTP_IPV6_PARAM_TYPE, len=20 */
59 uint8_t addr[SCTP_V6_ADDR_BYTES]; /* IPV6 address */
60 } SCTP_PACKED;
61
62 /* Cookie Preservative */
63 struct sctp_cookie_perserve_param {
64 struct sctp_paramhdr ph; /* type=SCTP_COOKIE_PRESERVE, len=8 */
65 uint32_t time; /* time in ms to extend cookie */
66 } SCTP_PACKED;
67
68 #define SCTP_ARRAY_MIN_LEN 1
69 /* Host Name Address */
70 struct sctp_host_name_param {
71 struct sctp_paramhdr ph; /* type=SCTP_HOSTNAME_ADDRESS */
72 char name[SCTP_ARRAY_MIN_LEN]; /* host name */
73 } SCTP_PACKED;
74
75 /*
76 * This is the maximum padded size of a s-a-p
77 * so paramheadr + 3 address types (6 bytes) + 2 byte pad = 12
78 */
79 #define SCTP_MAX_ADDR_PARAMS_SIZE 12
80 /* supported address type */
81 struct sctp_supported_addr_param {
82 struct sctp_paramhdr ph; /* type=SCTP_SUPPORTED_ADDRTYPE */
83 uint16_t addr_type[2]; /* array of supported address types */
84 } SCTP_PACKED;
85
86 /* heartbeat info parameter */
87 struct sctp_heartbeat_info_param {
88 struct sctp_paramhdr ph;
89 uint32_t time_value_1;
90 uint32_t time_value_2;
91 uint32_t random_value1;
92 uint32_t random_value2;
93 uint8_t addr_family;
94 uint8_t addr_len;
95 /* make sure that this structure is 4 byte aligned */
96 uint8_t padding[2];
97 char address[SCTP_ADDRMAX];
98 } SCTP_PACKED;
99
100 /* draft-ietf-tsvwg-prsctp */
101 /* PR-SCTP supported parameter */
102 struct sctp_prsctp_supported_param {
103 struct sctp_paramhdr ph;
104 } SCTP_PACKED;
105
106 /* draft-ietf-tsvwg-addip-sctp */
107 struct sctp_asconf_paramhdr { /* an ASCONF "parameter" */
108 struct sctp_paramhdr ph; /* a SCTP parameter header */
109 uint32_t correlation_id; /* correlation id for this param */
110 } SCTP_PACKED;
111
112 struct sctp_asconf_addr_param { /* an ASCONF address parameter */
113 struct sctp_asconf_paramhdr aph; /* asconf "parameter" */
114 struct sctp_ipv6addr_param addrp; /* max storage size */
115 } SCTP_PACKED;
116
117 struct sctp_asconf_tag_param { /* an ASCONF NAT-Vtag parameter */
118 struct sctp_asconf_paramhdr aph; /* asconf "parameter" */
119 uint32_t local_vtag;
120 uint32_t remote_vtag;
121 } SCTP_PACKED;
122
123 struct sctp_asconf_addrv4_param { /* an ASCONF address (v4) parameter */
124 struct sctp_asconf_paramhdr aph; /* asconf "parameter" */
125 struct sctp_ipv4addr_param addrp; /* max storage size */
126 } SCTP_PACKED;
127
128 #define SCTP_MAX_SUPPORTED_EXT 256
129
130 struct sctp_supported_chunk_types_param {
131 struct sctp_paramhdr ph; /* type = 0x8008 len = x */
132 uint8_t chunk_types[];
133 } SCTP_PACKED;
134
135 /*
136 * Structures for DATA chunks
137 */
138 struct sctp_data {
139 uint32_t tsn;
140 uint16_t sid;
141 uint16_t ssn;
142 uint32_t ppid;
143 /* user data follows */
144 } SCTP_PACKED;
145
146 struct sctp_data_chunk {
147 struct sctp_chunkhdr ch;
148 struct sctp_data dp;
149 } SCTP_PACKED;
150
151 struct sctp_idata {
152 uint32_t tsn;
153 uint16_t sid;
154 uint16_t reserved; /* Where does the SSN go? */
155 uint32_t mid;
156 union {
157 uint32_t ppid;
158 uint32_t fsn; /* Fragment Sequence Number */
159 } ppid_fsn;
160 /* user data follows */
161 } SCTP_PACKED;
162
163 struct sctp_idata_chunk {
164 struct sctp_chunkhdr ch;
165 struct sctp_idata dp;
166 } SCTP_PACKED;
167
168 /*
169 * Structures for the control chunks
170 */
171
172 /* Initiate (INIT)/Initiate Ack (INIT ACK) */
173 struct sctp_init {
174 uint32_t initiate_tag; /* initiate tag */
175 uint32_t a_rwnd; /* a_rwnd */
176 uint16_t num_outbound_streams; /* OS */
177 uint16_t num_inbound_streams; /* MIS */
178 uint32_t initial_tsn; /* I-TSN */
179 /* optional param's follow */
180 } SCTP_PACKED;
181 #define SCTP_IDENTIFICATION_SIZE 16
182 #define SCTP_ADDRESS_SIZE 4
183 #define SCTP_RESERVE_SPACE 6
184 /* state cookie header */
185 struct sctp_state_cookie { /* this is our definition... */
186 uint8_t identification[SCTP_IDENTIFICATION_SIZE]; /* id of who we are */
187 struct timeval time_entered; /* the time I built cookie */
188 uint32_t cookie_life; /* life I will award this cookie */
189 uint32_t tie_tag_my_vtag; /* my tag in old association */
190
191 uint32_t tie_tag_peer_vtag; /* peers tag in old association */
192 uint32_t peers_vtag; /* peers tag in INIT (for quick ref) */
193
194 uint32_t my_vtag; /* my tag in INIT-ACK (for quick ref) */
195 uint32_t address[SCTP_ADDRESS_SIZE]; /* 4 ints/128 bits */
196 uint32_t addr_type; /* address type */
197 uint32_t laddress[SCTP_ADDRESS_SIZE]; /* my local from address */
198 uint32_t laddr_type; /* my local from address type */
199 uint32_t scope_id; /* v6 scope id for link-locals */
200
201 uint16_t peerport; /* port address of the peer in the INIT */
202 uint16_t myport; /* my port address used in the INIT */
203 uint8_t ipv4_addr_legal; /* Are V4 addr legal? */
204 uint8_t ipv6_addr_legal; /* Are V6 addr legal? */
205 uint8_t local_scope; /* IPv6 local scope flag */
206 uint8_t site_scope; /* IPv6 site scope flag */
207
208 uint8_t ipv4_scope; /* IPv4 private addr scope */
209 uint8_t loopback_scope; /* loopback scope information */
210 uint8_t reserved[SCTP_RESERVE_SPACE]; /* Align to 64 bits */
211 /*
212 * at the end is tacked on the INIT chunk and the INIT-ACK chunk
213 * (minus the cookie).
214 */
215 } SCTP_PACKED;
216
217 /* state cookie parameter */
218 struct sctp_state_cookie_param {
219 struct sctp_paramhdr ph;
220 struct sctp_state_cookie cookie;
221 } SCTP_PACKED;
222
223 struct sctp_init_chunk {
224 struct sctp_chunkhdr ch;
225 struct sctp_init init;
226 } SCTP_PACKED;
227
228 struct sctp_init_msg {
229 struct sctphdr sh;
230 struct sctp_init_chunk msg;
231 } SCTP_PACKED;
232
233 /* ... used for both INIT and INIT ACK */
234 #define sctp_init_ack sctp_init
235 #define sctp_init_ack_chunk sctp_init_chunk
236 #define sctp_init_ack_msg sctp_init_msg
237
238 /* Selective Ack (SACK) */
239 struct sctp_gap_ack_block {
240 uint16_t start; /* Gap Ack block start */
241 uint16_t end; /* Gap Ack block end */
242 } SCTP_PACKED;
243
244 struct sctp_sack {
245 uint32_t cum_tsn_ack; /* cumulative TSN Ack */
246 uint32_t a_rwnd; /* updated a_rwnd of sender */
247 uint16_t num_gap_ack_blks; /* number of Gap Ack blocks */
248 uint16_t num_dup_tsns; /* number of duplicate TSNs */
249 /* struct sctp_gap_ack_block's follow */
250 /* uint32_t duplicate_tsn's follow */
251 } SCTP_PACKED;
252
253 struct sctp_sack_chunk {
254 struct sctp_chunkhdr ch;
255 struct sctp_sack sack;
256 } SCTP_PACKED;
257
258 struct sctp_nr_sack {
259 uint32_t cum_tsn_ack; /* cumulative TSN Ack */
260 uint32_t a_rwnd; /* updated a_rwnd of sender */
261 uint16_t num_gap_ack_blks; /* number of Gap Ack blocks */
262 uint16_t num_nr_gap_ack_blks; /* number of NR Gap Ack blocks */
263 uint16_t num_dup_tsns; /* number of duplicate TSNs */
264 uint16_t reserved; /* not currently used */
265 /* struct sctp_gap_ack_block's follow */
266 /* uint32_t duplicate_tsn's follow */
267 } SCTP_PACKED;
268
269 struct sctp_nr_sack_chunk {
270 struct sctp_chunkhdr ch;
271 struct sctp_nr_sack nr_sack;
272 } SCTP_PACKED;
273
274 /* Heartbeat Request (HEARTBEAT) */
275 struct sctp_heartbeat {
276 struct sctp_heartbeat_info_param hb_info;
277 } SCTP_PACKED;
278
279 struct sctp_heartbeat_chunk {
280 struct sctp_chunkhdr ch;
281 struct sctp_heartbeat heartbeat;
282 } SCTP_PACKED;
283
284 /* ... used for Heartbeat Ack (HEARTBEAT ACK) */
285 #define sctp_heartbeat_ack sctp_heartbeat
286 #define sctp_heartbeat_ack_chunk sctp_heartbeat_chunk
287
288 /* Abort Asssociation (ABORT) */
289 struct sctp_abort_chunk {
290 struct sctp_chunkhdr ch;
291 /* optional error cause may follow */
292 } SCTP_PACKED;
293
294 struct sctp_abort_msg {
295 struct sctphdr sh;
296 struct sctp_abort_chunk msg;
297 } SCTP_PACKED;
298
299 /* Shutdown Association (SHUTDOWN) */
300 struct sctp_shutdown_chunk {
301 struct sctp_chunkhdr ch;
302 uint32_t cumulative_tsn_ack;
303 } SCTP_PACKED;
304
305 /* Shutdown Acknowledgment (SHUTDOWN ACK) */
306 struct sctp_shutdown_ack_chunk {
307 struct sctp_chunkhdr ch;
308 } SCTP_PACKED;
309
310 /* Operation Error (ERROR) */
311 struct sctp_error_chunk {
312 struct sctp_chunkhdr ch;
313 /* optional error causes follow */
314 } SCTP_PACKED;
315
316 /* Cookie Echo (COOKIE ECHO) */
317 struct sctp_cookie_echo_chunk {
318 struct sctp_chunkhdr ch;
319 struct sctp_state_cookie cookie;
320 } SCTP_PACKED;
321
322 /* Cookie Acknowledgment (COOKIE ACK) */
323 struct sctp_cookie_ack_chunk {
324 struct sctp_chunkhdr ch;
325 } SCTP_PACKED;
326
327 /* Explicit Congestion Notification Echo (ECNE) */
328 struct old_sctp_ecne_chunk {
329 struct sctp_chunkhdr ch;
330 uint32_t tsn;
331 } SCTP_PACKED;
332
333 struct sctp_ecne_chunk {
334 struct sctp_chunkhdr ch;
335 uint32_t tsn;
336 uint32_t num_pkts_since_cwr;
337 } SCTP_PACKED;
338
339 /* Congestion Window Reduced (CWR) */
340 struct sctp_cwr_chunk {
341 struct sctp_chunkhdr ch;
342 uint32_t tsn;
343 } SCTP_PACKED;
344
345 /* Shutdown Complete (SHUTDOWN COMPLETE) */
346 struct sctp_shutdown_complete_chunk {
347 struct sctp_chunkhdr ch;
348 } SCTP_PACKED;
349
350 struct sctp_adaptation_layer_indication {
351 struct sctp_paramhdr ph;
352 uint32_t indication;
353 } SCTP_PACKED;
354
355 /*
356 * draft-ietf-tsvwg-addip-sctp
357 */
358 /* Address/Stream Configuration Change (ASCONF) */
359 struct sctp_asconf_chunk {
360 struct sctp_chunkhdr ch;
361 uint32_t serial_number;
362 /* lookup address parameter (mandatory) */
363 /* asconf parameters follow */
364 } SCTP_PACKED;
365
366 /* Address/Stream Configuration Acknowledge (ASCONF ACK) */
367 struct sctp_asconf_ack_chunk {
368 struct sctp_chunkhdr ch;
369 uint32_t serial_number;
370 /* asconf parameters follow */
371 } SCTP_PACKED;
372
373 /* draft-ietf-tsvwg-prsctp */
374 /* Forward Cumulative TSN (FORWARD TSN) */
375 struct sctp_forward_tsn_chunk {
376 struct sctp_chunkhdr ch;
377 uint32_t new_cumulative_tsn;
378 /* stream/sequence pairs (sctp_strseq) follow */
379 } SCTP_PACKED;
380
381 struct sctp_strseq {
382 uint16_t sid;
383 uint16_t ssn;
384 } SCTP_PACKED;
385
386 struct sctp_strseq_mid {
387 uint16_t sid;
388 uint16_t flags;
389 uint32_t mid;
390 };
391
392 struct sctp_forward_tsn_msg {
393 struct sctphdr sh;
394 struct sctp_forward_tsn_chunk msg;
395 } SCTP_PACKED;
396
397 /* should be a multiple of 4 - 1 aka 3/7/11 etc. */
398
399 #define SCTP_NUM_DB_TO_VERIFY 31
400
401 struct sctp_chunk_desc {
402 uint8_t chunk_type;
403 uint8_t data_bytes[SCTP_NUM_DB_TO_VERIFY];
404 uint32_t tsn_ifany;
405 } SCTP_PACKED;
406
407 struct sctp_pktdrop_chunk {
408 struct sctp_chunkhdr ch;
409 uint32_t bottle_bw;
410 uint32_t current_onq;
411 uint16_t trunc_len;
412 uint16_t reserved;
413 uint8_t data[];
414 } SCTP_PACKED;
415
416 /**********STREAM RESET STUFF ******************/
417
418 struct sctp_stream_reset_request {
419 struct sctp_paramhdr ph;
420 uint32_t request_seq;
421 } SCTP_PACKED;
422
423 struct sctp_stream_reset_out_request {
424 struct sctp_paramhdr ph;
425 uint32_t request_seq; /* monotonically increasing seq no */
426 uint32_t response_seq; /* if a response, the resp seq no */
427 uint32_t send_reset_at_tsn; /* last TSN I assigned outbound */
428 uint16_t list_of_streams[]; /* if not all list of streams */
429 } SCTP_PACKED;
430
431 struct sctp_stream_reset_in_request {
432 struct sctp_paramhdr ph;
433 uint32_t request_seq;
434 uint16_t list_of_streams[]; /* if not all list of streams */
435 } SCTP_PACKED;
436
437 struct sctp_stream_reset_tsn_request {
438 struct sctp_paramhdr ph;
439 uint32_t request_seq;
440 } SCTP_PACKED;
441
442 struct sctp_stream_reset_response {
443 struct sctp_paramhdr ph;
444 uint32_t response_seq; /* if a response, the resp seq no */
445 uint32_t result;
446 } SCTP_PACKED;
447
448 struct sctp_stream_reset_response_tsn {
449 struct sctp_paramhdr ph;
450 uint32_t response_seq; /* if a response, the resp seq no */
451 uint32_t result;
452 uint32_t senders_next_tsn;
453 uint32_t receivers_next_tsn;
454 } SCTP_PACKED;
455
456 struct sctp_stream_reset_add_strm {
457 struct sctp_paramhdr ph;
458 uint32_t request_seq;
459 uint16_t number_of_streams;
460 uint16_t reserved;
461 } SCTP_PACKED;
462
463 #define SCTP_STREAM_RESET_RESULT_NOTHING_TO_DO 0x00000000 /* XXX: unused */
464 #define SCTP_STREAM_RESET_RESULT_PERFORMED 0x00000001
465 #define SCTP_STREAM_RESET_RESULT_DENIED 0x00000002
466 #define SCTP_STREAM_RESET_RESULT_ERR__WRONG_SSN 0x00000003 /* XXX: unused */
467 #define SCTP_STREAM_RESET_RESULT_ERR_IN_PROGRESS 0x00000004
468 #define SCTP_STREAM_RESET_RESULT_ERR_BAD_SEQNO 0x00000005
469 #define SCTP_STREAM_RESET_RESULT_IN_PROGRESS 0x00000006 /* XXX: unused */
470
471 /*
472 * convience structures, note that if you are making a request for specific
473 * streams then the request will need to be an overlay structure.
474 */
475
476 struct sctp_stream_reset_tsn_req {
477 struct sctp_chunkhdr ch;
478 struct sctp_stream_reset_tsn_request sr_req;
479 } SCTP_PACKED;
480
481 struct sctp_stream_reset_resp {
482 struct sctp_chunkhdr ch;
483 struct sctp_stream_reset_response sr_resp;
484 } SCTP_PACKED;
485
486 /* respone only valid with a TSN request */
487 struct sctp_stream_reset_resp_tsn {
488 struct sctp_chunkhdr ch;
489 struct sctp_stream_reset_response_tsn sr_resp;
490 } SCTP_PACKED;
491
492 /****************************************************/
493
494 /*
495 * Authenticated chunks support draft-ietf-tsvwg-sctp-auth
496 */
497
498 /* Should we make the max be 32? */
499 #define SCTP_RANDOM_MAX_SIZE 256
500 struct sctp_auth_random {
501 struct sctp_paramhdr ph; /* type = 0x8002 */
502 uint8_t random_data[];
503 } SCTP_PACKED;
504
505 struct sctp_auth_chunk_list {
506 struct sctp_paramhdr ph; /* type = 0x8003 */
507 uint8_t chunk_types[];
508 } SCTP_PACKED;
509
510 struct sctp_auth_hmac_algo {
511 struct sctp_paramhdr ph; /* type = 0x8004 */
512 uint16_t hmac_ids[];
513 } SCTP_PACKED;
514
515 struct sctp_auth_chunk {
516 struct sctp_chunkhdr ch;
517 uint16_t shared_key_id;
518 uint16_t hmac_id;
519 uint8_t hmac[];
520 } SCTP_PACKED;
521
522 /*
523 * we pre-reserve enough room for a ECNE or CWR AND a SACK with no missing
524 * pieces. If ENCE is missing we could have a couple of blocks. This way we
525 * optimize so we MOST likely can bundle a SACK/ECN with the smallest size
526 * data chunk I will split into. We could increase throughput slightly by
527 * taking out these two but the 24-sack/8-CWR i.e. 32 bytes I pre-reserve I
528 * feel is worth it for now.
529 */
530 #ifndef SCTP_MAX_OVERHEAD
531 #ifdef INET6
532 #define SCTP_MAX_OVERHEAD (sizeof(struct sctp_data_chunk) + \
533 sizeof(struct sctphdr) + \
534 sizeof(struct sctp_ecne_chunk) + \
535 sizeof(struct sctp_sack_chunk) + \
536 sizeof(struct ip6_hdr))
537
538 #define SCTP_MED_OVERHEAD (sizeof(struct sctp_data_chunk) + \
539 sizeof(struct sctphdr) + \
540 sizeof(struct ip6_hdr))
541
542 #define SCTP_MIN_OVERHEAD (sizeof(struct ip6_hdr) + \
543 sizeof(struct sctphdr))
544
545 #else
546 #define SCTP_MAX_OVERHEAD (sizeof(struct sctp_data_chunk) + \
547 sizeof(struct sctphdr) + \
548 sizeof(struct sctp_ecne_chunk) + \
549 sizeof(struct sctp_sack_chunk) + \
550 sizeof(struct ip))
551
552 #define SCTP_MED_OVERHEAD (sizeof(struct sctp_data_chunk) + \
553 sizeof(struct sctphdr) + \
554 sizeof(struct ip))
555
556 #define SCTP_MIN_OVERHEAD (sizeof(struct ip) + \
557 sizeof(struct sctphdr))
558
559 #endif /* INET6 */
560 #endif /* !SCTP_MAX_OVERHEAD */
561
562 #define SCTP_MED_V4_OVERHEAD (sizeof(struct sctp_data_chunk) + \
563 sizeof(struct sctphdr) + \
564 sizeof(struct ip))
565
566 #define SCTP_MIN_V4_OVERHEAD (sizeof(struct ip) + \
567 sizeof(struct sctphdr))
568
569 #undef SCTP_PACKED
570 #endif /* !__sctp_header_h__ */
Cache object: 85f1f399d842b255b9eeaf6742f03671
|