2 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
3 * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
4 * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
9 * a) Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
12 * b) Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the distribution.
16 * c) Neither the name of Cisco Systems, Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 * THE POSSIBILITY OF SUCH DAMAGE.
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #ifndef _NETINET_SCTP_HEADER_H_
37 #define _NETINET_SCTP_HEADER_H_
40 #include <netinet/sctp.h>
41 #include <netinet/sctp_constants.h>
43 #define SCTP_PACKED __attribute__((packed))
46 * Parameter structures
48 struct sctp_ipv4addr_param {
49 struct sctp_paramhdr ph;/* type=SCTP_IPV4_PARAM_TYPE, len=8 */
50 uint32_t addr; /* IPV4 address */
53 #define SCTP_V6_ADDR_BYTES 16
56 struct sctp_ipv6addr_param {
57 struct sctp_paramhdr ph;/* type=SCTP_IPV6_PARAM_TYPE, len=20 */
58 uint8_t addr[SCTP_V6_ADDR_BYTES]; /* IPV6 address */
61 /* Cookie Preservative */
62 struct sctp_cookie_perserve_param {
63 struct sctp_paramhdr ph;/* type=SCTP_COOKIE_PRESERVE, len=8 */
64 uint32_t time; /* time in ms to extend cookie */
67 #define SCTP_ARRAY_MIN_LEN 1
68 /* Host Name Address */
69 struct sctp_host_name_param {
70 struct sctp_paramhdr ph;/* type=SCTP_HOSTNAME_ADDRESS */
71 char name[SCTP_ARRAY_MIN_LEN]; /* host name */
75 * This is the maximum padded size of a s-a-p
76 * so paramheadr + 3 address types (6 bytes) + 2 byte pad = 12
78 #define SCTP_MAX_ADDR_PARAMS_SIZE 12
79 /* supported address type */
80 struct sctp_supported_addr_param {
81 struct sctp_paramhdr ph;/* type=SCTP_SUPPORTED_ADDRTYPE */
82 uint16_t addr_type[2]; /* array of supported address types */
85 /* heartbeat info parameter */
86 struct sctp_heartbeat_info_param {
87 struct sctp_paramhdr ph;
88 uint32_t time_value_1;
89 uint32_t time_value_2;
90 uint32_t random_value1;
91 uint32_t random_value2;
94 /* make sure that this structure is 4 byte aligned */
96 char address[SCTP_ADDRMAX];
100 /* draft-ietf-tsvwg-prsctp */
101 /* PR-SCTP supported parameter */
102 struct sctp_prsctp_supported_param {
103 struct sctp_paramhdr ph;
107 /* draft-ietf-tsvwg-addip-sctp */
108 struct sctp_asconf_paramhdr { /* an ASCONF "parameter" */
109 struct sctp_paramhdr ph;/* a SCTP parameter header */
110 uint32_t correlation_id;/* correlation id for this param */
113 struct sctp_asconf_addr_param { /* an ASCONF address parameter */
114 struct sctp_asconf_paramhdr aph; /* asconf "parameter" */
115 struct sctp_ipv6addr_param addrp; /* max storage size */
119 struct sctp_asconf_tag_param { /* an ASCONF NAT-Vtag parameter */
120 struct sctp_asconf_paramhdr aph; /* asconf "parameter" */
122 uint32_t remote_vtag;
126 struct sctp_asconf_addrv4_param { /* an ASCONF address (v4) parameter */
127 struct sctp_asconf_paramhdr aph; /* asconf "parameter" */
128 struct sctp_ipv4addr_param addrp; /* max storage size */
131 #define SCTP_MAX_SUPPORTED_EXT 256
133 struct sctp_supported_chunk_types_param {
134 struct sctp_paramhdr ph;/* type = 0x8008 len = x */
135 uint8_t chunk_types[];
140 * Structures for DATA chunks
145 uint16_t stream_sequence;
146 uint32_t protocol_id;
147 /* user data follows */
150 struct sctp_data_chunk {
151 struct sctp_chunkhdr ch;
156 * Structures for the control chunks
159 /* Initiate (INIT)/Initiate Ack (INIT ACK) */
161 uint32_t initiate_tag; /* initiate tag */
162 uint32_t a_rwnd; /* a_rwnd */
163 uint16_t num_outbound_streams; /* OS */
164 uint16_t num_inbound_streams; /* MIS */
165 uint32_t initial_tsn; /* I-TSN */
166 /* optional param's follow */
169 #define SCTP_IDENTIFICATION_SIZE 16
170 #define SCTP_ADDRESS_SIZE 4
171 #define SCTP_RESERVE_SPACE 6
172 /* state cookie header */
173 struct sctp_state_cookie { /* this is our definition... */
174 uint8_t identification[SCTP_IDENTIFICATION_SIZE]; /* id of who we are */
175 struct timeval time_entered; /* the time I built cookie */
176 uint32_t cookie_life; /* life I will award this cookie */
177 uint32_t tie_tag_my_vtag; /* my tag in old association */
179 uint32_t tie_tag_peer_vtag; /* peers tag in old association */
180 uint32_t peers_vtag; /* peers tag in INIT (for quick ref) */
182 uint32_t my_vtag; /* my tag in INIT-ACK (for quick ref) */
183 uint32_t address[SCTP_ADDRESS_SIZE]; /* 4 ints/128 bits */
184 uint32_t addr_type; /* address type */
185 uint32_t laddress[SCTP_ADDRESS_SIZE]; /* my local from address */
186 uint32_t laddr_type; /* my local from address type */
187 uint32_t scope_id; /* v6 scope id for link-locals */
189 uint16_t peerport; /* port address of the peer in the INIT */
190 uint16_t myport; /* my port address used in the INIT */
191 uint8_t ipv4_addr_legal;/* Are V4 addr legal? */
192 uint8_t ipv6_addr_legal;/* Are V6 addr legal? */
193 uint8_t local_scope; /* IPv6 local scope flag */
194 uint8_t site_scope; /* IPv6 site scope flag */
196 uint8_t ipv4_scope; /* IPv4 private addr scope */
197 uint8_t loopback_scope; /* loopback scope information */
198 uint8_t reserved[SCTP_RESERVE_SPACE]; /* Align to 64 bits */
200 * at the end is tacked on the INIT chunk and the INIT-ACK chunk
201 * (minus the cookie).
206 /* Used for NAT state error cause */
207 struct sctp_missing_nat_state {
214 struct sctp_inv_mandatory_param {
220 * We include this to 0 it since only a missing cookie will cause
226 struct sctp_unresolv_addr {
230 uint16_t reserved; /* Only one invalid addr type */
233 /* state cookie parameter */
234 struct sctp_state_cookie_param {
235 struct sctp_paramhdr ph;
236 struct sctp_state_cookie cookie;
239 struct sctp_init_chunk {
240 struct sctp_chunkhdr ch;
241 struct sctp_init init;
244 struct sctp_init_msg {
246 struct sctp_init_chunk msg;
249 /* ... used for both INIT and INIT ACK */
250 #define sctp_init_ack sctp_init
251 #define sctp_init_ack_chunk sctp_init_chunk
252 #define sctp_init_ack_msg sctp_init_msg
255 /* Selective Ack (SACK) */
256 struct sctp_gap_ack_block {
257 uint16_t start; /* Gap Ack block start */
258 uint16_t end; /* Gap Ack block end */
262 uint32_t cum_tsn_ack; /* cumulative TSN Ack */
263 uint32_t a_rwnd; /* updated a_rwnd of sender */
264 uint16_t num_gap_ack_blks; /* number of Gap Ack blocks */
265 uint16_t num_dup_tsns; /* number of duplicate TSNs */
266 /* struct sctp_gap_ack_block's follow */
267 /* uint32_t duplicate_tsn's follow */
270 struct sctp_sack_chunk {
271 struct sctp_chunkhdr ch;
272 struct sctp_sack sack;
275 struct sctp_nr_sack {
276 uint32_t cum_tsn_ack; /* cumulative TSN Ack */
277 uint32_t a_rwnd; /* updated a_rwnd of sender */
278 uint16_t num_gap_ack_blks; /* number of Gap Ack blocks */
279 uint16_t num_nr_gap_ack_blks; /* number of NR Gap Ack blocks */
280 uint16_t num_dup_tsns; /* number of duplicate TSNs */
281 uint16_t reserved; /* not currently used */
282 /* struct sctp_gap_ack_block's follow */
283 /* uint32_t duplicate_tsn's follow */
286 struct sctp_nr_sack_chunk {
287 struct sctp_chunkhdr ch;
288 struct sctp_nr_sack nr_sack;
292 /* Heartbeat Request (HEARTBEAT) */
293 struct sctp_heartbeat {
294 struct sctp_heartbeat_info_param hb_info;
297 struct sctp_heartbeat_chunk {
298 struct sctp_chunkhdr ch;
299 struct sctp_heartbeat heartbeat;
302 /* ... used for Heartbeat Ack (HEARTBEAT ACK) */
303 #define sctp_heartbeat_ack sctp_heartbeat
304 #define sctp_heartbeat_ack_chunk sctp_heartbeat_chunk
307 /* Abort Asssociation (ABORT) */
308 struct sctp_abort_chunk {
309 struct sctp_chunkhdr ch;
310 /* optional error cause may follow */
313 struct sctp_abort_msg {
315 struct sctp_abort_chunk msg;
319 /* Shutdown Association (SHUTDOWN) */
320 struct sctp_shutdown_chunk {
321 struct sctp_chunkhdr ch;
322 uint32_t cumulative_tsn_ack;
326 /* Shutdown Acknowledgment (SHUTDOWN ACK) */
327 struct sctp_shutdown_ack_chunk {
328 struct sctp_chunkhdr ch;
332 /* Operation Error (ERROR) */
333 struct sctp_error_chunk {
334 struct sctp_chunkhdr ch;
335 /* optional error causes follow */
339 /* Cookie Echo (COOKIE ECHO) */
340 struct sctp_cookie_echo_chunk {
341 struct sctp_chunkhdr ch;
342 struct sctp_state_cookie cookie;
345 /* Cookie Acknowledgment (COOKIE ACK) */
346 struct sctp_cookie_ack_chunk {
347 struct sctp_chunkhdr ch;
350 /* Explicit Congestion Notification Echo (ECNE) */
351 struct old_sctp_ecne_chunk {
352 struct sctp_chunkhdr ch;
356 struct sctp_ecne_chunk {
357 struct sctp_chunkhdr ch;
359 uint32_t num_pkts_since_cwr;
362 /* Congestion Window Reduced (CWR) */
363 struct sctp_cwr_chunk {
364 struct sctp_chunkhdr ch;
368 /* Shutdown Complete (SHUTDOWN COMPLETE) */
369 struct sctp_shutdown_complete_chunk {
370 struct sctp_chunkhdr ch;
373 /* Oper error holding a stale cookie */
374 struct sctp_stale_cookie_msg {
375 struct sctp_paramhdr ph;/* really an error cause */
379 struct sctp_adaptation_layer_indication {
380 struct sctp_paramhdr ph;
384 struct sctp_cookie_while_shutting_down {
386 struct sctp_chunkhdr ch;
387 struct sctp_paramhdr ph;/* really an error cause */
390 struct sctp_shutdown_complete_msg {
392 struct sctp_shutdown_complete_chunk shut_cmp;
396 * draft-ietf-tsvwg-addip-sctp
398 /* Address/Stream Configuration Change (ASCONF) */
399 struct sctp_asconf_chunk {
400 struct sctp_chunkhdr ch;
401 uint32_t serial_number;
402 /* lookup address parameter (mandatory) */
403 /* asconf parameters follow */
406 /* Address/Stream Configuration Acknowledge (ASCONF ACK) */
407 struct sctp_asconf_ack_chunk {
408 struct sctp_chunkhdr ch;
409 uint32_t serial_number;
410 /* asconf parameters follow */
413 /* draft-ietf-tsvwg-prsctp */
414 /* Forward Cumulative TSN (FORWARD TSN) */
415 struct sctp_forward_tsn_chunk {
416 struct sctp_chunkhdr ch;
417 uint32_t new_cumulative_tsn;
418 /* stream/sequence pairs (sctp_strseq) follow */
426 struct sctp_forward_tsn_msg {
428 struct sctp_forward_tsn_chunk msg;
431 /* should be a multiple of 4 - 1 aka 3/7/11 etc. */
433 #define SCTP_NUM_DB_TO_VERIFY 31
435 struct sctp_chunk_desc {
437 uint8_t data_bytes[SCTP_NUM_DB_TO_VERIFY];
442 struct sctp_pktdrop_chunk {
443 struct sctp_chunkhdr ch;
445 uint32_t current_onq;
451 /**********STREAM RESET STUFF ******************/
453 struct sctp_stream_reset_request {
454 struct sctp_paramhdr ph;
455 uint32_t request_seq;
458 struct sctp_stream_reset_out_request {
459 struct sctp_paramhdr ph;
460 uint32_t request_seq; /* monotonically increasing seq no */
461 uint32_t response_seq; /* if a response, the resp seq no */
462 uint32_t send_reset_at_tsn; /* last TSN I assigned outbound */
463 uint16_t list_of_streams[]; /* if not all list of streams */
466 struct sctp_stream_reset_in_request {
467 struct sctp_paramhdr ph;
468 uint32_t request_seq;
469 uint16_t list_of_streams[]; /* if not all list of streams */
472 struct sctp_stream_reset_tsn_request {
473 struct sctp_paramhdr ph;
474 uint32_t request_seq;
477 struct sctp_stream_reset_response {
478 struct sctp_paramhdr ph;
479 uint32_t response_seq; /* if a response, the resp seq no */
483 struct sctp_stream_reset_response_tsn {
484 struct sctp_paramhdr ph;
485 uint32_t response_seq; /* if a response, the resp seq no */
487 uint32_t senders_next_tsn;
488 uint32_t receivers_next_tsn;
491 struct sctp_stream_reset_add_strm {
492 struct sctp_paramhdr ph;
493 uint32_t request_seq;
494 uint16_t number_of_streams;
498 #define SCTP_STREAM_RESET_RESULT_NOTHING_TO_DO 0x00000000 /* XXX: unused */
499 #define SCTP_STREAM_RESET_RESULT_PERFORMED 0x00000001
500 #define SCTP_STREAM_RESET_RESULT_DENIED 0x00000002
501 #define SCTP_STREAM_RESET_RESULT_ERR__WRONG_SSN 0x00000003 /* XXX: unused */
502 #define SCTP_STREAM_RESET_RESULT_ERR_IN_PROGRESS 0x00000004
503 #define SCTP_STREAM_RESET_RESULT_ERR_BAD_SEQNO 0x00000005
504 #define SCTP_STREAM_RESET_RESULT_IN_PROGRESS 0x00000006 /* XXX: unused */
507 * convience structures, note that if you are making a request for specific
508 * streams then the request will need to be an overlay structure.
511 struct sctp_stream_reset_tsn_req {
512 struct sctp_chunkhdr ch;
513 struct sctp_stream_reset_tsn_request sr_req;
516 struct sctp_stream_reset_resp {
517 struct sctp_chunkhdr ch;
518 struct sctp_stream_reset_response sr_resp;
521 /* respone only valid with a TSN request */
522 struct sctp_stream_reset_resp_tsn {
523 struct sctp_chunkhdr ch;
524 struct sctp_stream_reset_response_tsn sr_resp;
527 /****************************************************/
530 * Authenticated chunks support draft-ietf-tsvwg-sctp-auth
533 /* Should we make the max be 32? */
534 #define SCTP_RANDOM_MAX_SIZE 256
535 struct sctp_auth_random {
536 struct sctp_paramhdr ph;/* type = 0x8002 */
537 uint8_t random_data[];
540 struct sctp_auth_chunk_list {
541 struct sctp_paramhdr ph;/* type = 0x8003 */
542 uint8_t chunk_types[];
545 struct sctp_auth_hmac_algo {
546 struct sctp_paramhdr ph;/* type = 0x8004 */
550 struct sctp_auth_chunk {
551 struct sctp_chunkhdr ch;
552 uint16_t shared_key_id;
557 struct sctp_auth_invalid_hmac {
558 struct sctp_paramhdr ph;
564 * we pre-reserve enough room for a ECNE or CWR AND a SACK with no missing
565 * pieces. If ENCE is missing we could have a couple of blocks. This way we
566 * optimize so we MOST likely can bundle a SACK/ECN with the smallest size
567 * data chunk I will split into. We could increase throughput slightly by
568 * taking out these two but the 24-sack/8-CWR i.e. 32 bytes I pre-reserve I
569 * feel is worth it for now.
571 #ifndef SCTP_MAX_OVERHEAD
573 #define SCTP_MAX_OVERHEAD (sizeof(struct sctp_data_chunk) + \
574 sizeof(struct sctphdr) + \
575 sizeof(struct sctp_ecne_chunk) + \
576 sizeof(struct sctp_sack_chunk) + \
577 sizeof(struct ip6_hdr))
579 #define SCTP_MED_OVERHEAD (sizeof(struct sctp_data_chunk) + \
580 sizeof(struct sctphdr) + \
581 sizeof(struct ip6_hdr))
584 #define SCTP_MIN_OVERHEAD (sizeof(struct ip6_hdr) + \
585 sizeof(struct sctphdr))
588 #define SCTP_MAX_OVERHEAD (sizeof(struct sctp_data_chunk) + \
589 sizeof(struct sctphdr) + \
590 sizeof(struct sctp_ecne_chunk) + \
591 sizeof(struct sctp_sack_chunk) + \
594 #define SCTP_MED_OVERHEAD (sizeof(struct sctp_data_chunk) + \
595 sizeof(struct sctphdr) + \
599 #define SCTP_MIN_OVERHEAD (sizeof(struct ip) + \
600 sizeof(struct sctphdr))
603 #endif /* !SCTP_MAX_OVERHEAD */
605 #define SCTP_MED_V4_OVERHEAD (sizeof(struct sctp_data_chunk) + \
606 sizeof(struct sctphdr) + \
609 #define SCTP_MIN_V4_OVERHEAD (sizeof(struct ip) + \
610 sizeof(struct sctphdr))
613 #endif /* !__sctp_header_h__ */