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 */
86 struct sctp_ecn_supported_param {
87 struct sctp_paramhdr ph;/* type=SCTP_ECN_CAPABLE */
91 /* heartbeat info parameter */
92 struct sctp_heartbeat_info_param {
93 struct sctp_paramhdr ph;
94 uint32_t time_value_1;
95 uint32_t time_value_2;
96 uint32_t random_value1;
97 uint32_t random_value2;
100 /* make sure that this structure is 4 byte aligned */
102 char address[SCTP_ADDRMAX];
106 /* draft-ietf-tsvwg-prsctp */
107 /* PR-SCTP supported parameter */
108 struct sctp_prsctp_supported_param {
109 struct sctp_paramhdr ph;
113 /* draft-ietf-tsvwg-addip-sctp */
114 struct sctp_asconf_paramhdr { /* an ASCONF "parameter" */
115 struct sctp_paramhdr ph;/* a SCTP parameter header */
116 uint32_t correlation_id;/* correlation id for this param */
119 struct sctp_asconf_addr_param { /* an ASCONF address parameter */
120 struct sctp_asconf_paramhdr aph; /* asconf "parameter" */
121 struct sctp_ipv6addr_param addrp; /* max storage size */
125 struct sctp_asconf_tag_param { /* an ASCONF NAT-Vtag parameter */
126 struct sctp_asconf_paramhdr aph; /* asconf "parameter" */
128 uint32_t remote_vtag;
132 struct sctp_asconf_addrv4_param { /* an ASCONF address (v4) parameter */
133 struct sctp_asconf_paramhdr aph; /* asconf "parameter" */
134 struct sctp_ipv4addr_param addrp; /* max storage size */
137 #define SCTP_MAX_SUPPORTED_EXT 256
139 struct sctp_supported_chunk_types_param {
140 struct sctp_paramhdr ph;/* type = 0x8008 len = x */
141 uint8_t chunk_types[];
146 * Structures for DATA chunks
151 uint16_t stream_sequence;
152 uint32_t protocol_id;
153 /* user data follows */
156 struct sctp_data_chunk {
157 struct sctp_chunkhdr ch;
162 * Structures for the control chunks
165 /* Initiate (INIT)/Initiate Ack (INIT ACK) */
167 uint32_t initiate_tag; /* initiate tag */
168 uint32_t a_rwnd; /* a_rwnd */
169 uint16_t num_outbound_streams; /* OS */
170 uint16_t num_inbound_streams; /* MIS */
171 uint32_t initial_tsn; /* I-TSN */
172 /* optional param's follow */
175 #define SCTP_IDENTIFICATION_SIZE 16
176 #define SCTP_ADDRESS_SIZE 4
177 #define SCTP_RESERVE_SPACE 6
178 /* state cookie header */
179 struct sctp_state_cookie { /* this is our definition... */
180 uint8_t identification[SCTP_IDENTIFICATION_SIZE]; /* id of who we are */
181 struct timeval time_entered; /* the time I built cookie */
182 uint32_t cookie_life; /* life I will award this cookie */
183 uint32_t tie_tag_my_vtag; /* my tag in old association */
185 uint32_t tie_tag_peer_vtag; /* peers tag in old association */
186 uint32_t peers_vtag; /* peers tag in INIT (for quick ref) */
188 uint32_t my_vtag; /* my tag in INIT-ACK (for quick ref) */
189 uint32_t address[SCTP_ADDRESS_SIZE]; /* 4 ints/128 bits */
190 uint32_t addr_type; /* address type */
191 uint32_t laddress[SCTP_ADDRESS_SIZE]; /* my local from address */
192 uint32_t laddr_type; /* my local from address type */
193 uint32_t scope_id; /* v6 scope id for link-locals */
195 uint16_t peerport; /* port address of the peer in the INIT */
196 uint16_t myport; /* my port address used in the INIT */
197 uint8_t ipv4_addr_legal;/* Are V4 addr legal? */
198 uint8_t ipv6_addr_legal;/* Are V6 addr legal? */
199 uint8_t local_scope; /* IPv6 local scope flag */
200 uint8_t site_scope; /* IPv6 site scope flag */
202 uint8_t ipv4_scope; /* IPv4 private addr scope */
203 uint8_t loopback_scope; /* loopback scope information */
204 uint8_t reserved[SCTP_RESERVE_SPACE]; /* Align to 64 bits */
206 * at the end is tacked on the INIT chunk and the INIT-ACK chunk
207 * (minus the cookie).
212 /* Used for NAT state error cause */
213 struct sctp_missing_nat_state {
220 struct sctp_inv_mandatory_param {
226 * We include this to 0 it since only a missing cookie will cause
232 struct sctp_unresolv_addr {
236 uint16_t reserved; /* Only one invalid addr type */
239 /* state cookie parameter */
240 struct sctp_state_cookie_param {
241 struct sctp_paramhdr ph;
242 struct sctp_state_cookie cookie;
245 struct sctp_init_chunk {
246 struct sctp_chunkhdr ch;
247 struct sctp_init init;
250 struct sctp_init_msg {
252 struct sctp_init_chunk msg;
255 /* ... used for both INIT and INIT ACK */
256 #define sctp_init_ack sctp_init
257 #define sctp_init_ack_chunk sctp_init_chunk
258 #define sctp_init_ack_msg sctp_init_msg
261 /* Selective Ack (SACK) */
262 struct sctp_gap_ack_block {
263 uint16_t start; /* Gap Ack block start */
264 uint16_t end; /* Gap Ack block end */
268 uint32_t cum_tsn_ack; /* cumulative TSN Ack */
269 uint32_t a_rwnd; /* updated a_rwnd of sender */
270 uint16_t num_gap_ack_blks; /* number of Gap Ack blocks */
271 uint16_t num_dup_tsns; /* number of duplicate TSNs */
272 /* struct sctp_gap_ack_block's follow */
273 /* uint32_t duplicate_tsn's follow */
276 struct sctp_sack_chunk {
277 struct sctp_chunkhdr ch;
278 struct sctp_sack sack;
281 struct sctp_nr_sack {
282 uint32_t cum_tsn_ack; /* cumulative TSN Ack */
283 uint32_t a_rwnd; /* updated a_rwnd of sender */
284 uint16_t num_gap_ack_blks; /* number of Gap Ack blocks */
285 uint16_t num_nr_gap_ack_blks; /* number of NR Gap Ack blocks */
286 uint16_t num_dup_tsns; /* number of duplicate TSNs */
287 uint16_t reserved; /* not currently used */
288 /* struct sctp_gap_ack_block's follow */
289 /* uint32_t duplicate_tsn's follow */
292 struct sctp_nr_sack_chunk {
293 struct sctp_chunkhdr ch;
294 struct sctp_nr_sack nr_sack;
298 /* Heartbeat Request (HEARTBEAT) */
299 struct sctp_heartbeat {
300 struct sctp_heartbeat_info_param hb_info;
303 struct sctp_heartbeat_chunk {
304 struct sctp_chunkhdr ch;
305 struct sctp_heartbeat heartbeat;
308 /* ... used for Heartbeat Ack (HEARTBEAT ACK) */
309 #define sctp_heartbeat_ack sctp_heartbeat
310 #define sctp_heartbeat_ack_chunk sctp_heartbeat_chunk
313 /* Abort Asssociation (ABORT) */
314 struct sctp_abort_chunk {
315 struct sctp_chunkhdr ch;
316 /* optional error cause may follow */
319 struct sctp_abort_msg {
321 struct sctp_abort_chunk msg;
325 /* Shutdown Association (SHUTDOWN) */
326 struct sctp_shutdown_chunk {
327 struct sctp_chunkhdr ch;
328 uint32_t cumulative_tsn_ack;
332 /* Shutdown Acknowledgment (SHUTDOWN ACK) */
333 struct sctp_shutdown_ack_chunk {
334 struct sctp_chunkhdr ch;
338 /* Operation Error (ERROR) */
339 struct sctp_error_chunk {
340 struct sctp_chunkhdr ch;
341 /* optional error causes follow */
345 /* Cookie Echo (COOKIE ECHO) */
346 struct sctp_cookie_echo_chunk {
347 struct sctp_chunkhdr ch;
348 struct sctp_state_cookie cookie;
351 /* Cookie Acknowledgment (COOKIE ACK) */
352 struct sctp_cookie_ack_chunk {
353 struct sctp_chunkhdr ch;
356 /* Explicit Congestion Notification Echo (ECNE) */
357 struct old_sctp_ecne_chunk {
358 struct sctp_chunkhdr ch;
362 struct sctp_ecne_chunk {
363 struct sctp_chunkhdr ch;
365 uint32_t num_pkts_since_cwr;
368 /* Congestion Window Reduced (CWR) */
369 struct sctp_cwr_chunk {
370 struct sctp_chunkhdr ch;
374 /* Shutdown Complete (SHUTDOWN COMPLETE) */
375 struct sctp_shutdown_complete_chunk {
376 struct sctp_chunkhdr ch;
379 /* Oper error holding a stale cookie */
380 struct sctp_stale_cookie_msg {
381 struct sctp_paramhdr ph;/* really an error cause */
385 struct sctp_adaptation_layer_indication {
386 struct sctp_paramhdr ph;
390 struct sctp_cookie_while_shutting_down {
392 struct sctp_chunkhdr ch;
393 struct sctp_paramhdr ph;/* really an error cause */
396 struct sctp_shutdown_complete_msg {
398 struct sctp_shutdown_complete_chunk shut_cmp;
402 * draft-ietf-tsvwg-addip-sctp
404 /* Address/Stream Configuration Change (ASCONF) */
405 struct sctp_asconf_chunk {
406 struct sctp_chunkhdr ch;
407 uint32_t serial_number;
408 /* lookup address parameter (mandatory) */
409 /* asconf parameters follow */
412 /* Address/Stream Configuration Acknowledge (ASCONF ACK) */
413 struct sctp_asconf_ack_chunk {
414 struct sctp_chunkhdr ch;
415 uint32_t serial_number;
416 /* asconf parameters follow */
419 /* draft-ietf-tsvwg-prsctp */
420 /* Forward Cumulative TSN (FORWARD TSN) */
421 struct sctp_forward_tsn_chunk {
422 struct sctp_chunkhdr ch;
423 uint32_t new_cumulative_tsn;
424 /* stream/sequence pairs (sctp_strseq) follow */
432 struct sctp_forward_tsn_msg {
434 struct sctp_forward_tsn_chunk msg;
437 /* should be a multiple of 4 - 1 aka 3/7/11 etc. */
439 #define SCTP_NUM_DB_TO_VERIFY 31
441 struct sctp_chunk_desc {
443 uint8_t data_bytes[SCTP_NUM_DB_TO_VERIFY];
448 struct sctp_pktdrop_chunk {
449 struct sctp_chunkhdr ch;
451 uint32_t current_onq;
457 /**********STREAM RESET STUFF ******************/
459 struct sctp_stream_reset_out_request {
460 struct sctp_paramhdr ph;
461 uint32_t request_seq; /* monotonically increasing seq no */
462 uint32_t response_seq; /* if a response, the resp seq no */
463 uint32_t send_reset_at_tsn; /* last TSN I assigned outbound */
464 uint16_t list_of_streams[]; /* if not all list of streams */
467 struct sctp_stream_reset_in_request {
468 struct sctp_paramhdr ph;
469 uint32_t request_seq;
470 uint16_t list_of_streams[]; /* if not all list of streams */
474 struct sctp_stream_reset_tsn_request {
475 struct sctp_paramhdr ph;
476 uint32_t request_seq;
479 struct sctp_stream_reset_response {
480 struct sctp_paramhdr ph;
481 uint32_t response_seq; /* if a response, the resp seq no */
485 struct sctp_stream_reset_response_tsn {
486 struct sctp_paramhdr ph;
487 uint32_t response_seq; /* if a response, the resp seq no */
489 uint32_t senders_next_tsn;
490 uint32_t receivers_next_tsn;
493 struct sctp_stream_reset_add_strm {
494 struct sctp_paramhdr ph;
495 uint32_t request_seq;
496 uint16_t number_of_streams;
500 #define SCTP_STREAM_RESET_RESULT_NOTHING_TO_DO 0x00000000 /* XXX: unused */
501 #define SCTP_STREAM_RESET_RESULT_PERFORMED 0x00000001
502 #define SCTP_STREAM_RESET_RESULT_DENIED 0x00000002
503 #define SCTP_STREAM_RESET_RESULT_ERR__WRONG_SSN 0x00000003 /* XXX: unused */
504 #define SCTP_STREAM_RESET_RESULT_ERR_IN_PROGRESS 0x00000004
505 #define SCTP_STREAM_RESET_RESULT_ERR_BAD_SEQNO 0x00000005
506 #define SCTP_STREAM_RESET_RESULT_IN_PROGRESS 0x00000006 /* XXX: unused */
509 * convience structures, note that if you are making a request for specific
510 * streams then the request will need to be an overlay structure.
513 struct sctp_stream_reset_tsn_req {
514 struct sctp_chunkhdr ch;
515 struct sctp_stream_reset_tsn_request sr_req;
518 struct sctp_stream_reset_resp {
519 struct sctp_chunkhdr ch;
520 struct sctp_stream_reset_response sr_resp;
523 /* respone only valid with a TSN request */
524 struct sctp_stream_reset_resp_tsn {
525 struct sctp_chunkhdr ch;
526 struct sctp_stream_reset_response_tsn sr_resp;
529 /****************************************************/
532 * Authenticated chunks support draft-ietf-tsvwg-sctp-auth
535 /* Should we make the max be 32? */
536 #define SCTP_RANDOM_MAX_SIZE 256
537 struct sctp_auth_random {
538 struct sctp_paramhdr ph;/* type = 0x8002 */
539 uint8_t random_data[];
542 struct sctp_auth_chunk_list {
543 struct sctp_paramhdr ph;/* type = 0x8003 */
544 uint8_t chunk_types[];
547 struct sctp_auth_hmac_algo {
548 struct sctp_paramhdr ph;/* type = 0x8004 */
552 struct sctp_auth_chunk {
553 struct sctp_chunkhdr ch;
554 uint16_t shared_key_id;
559 struct sctp_auth_invalid_hmac {
560 struct sctp_paramhdr ph;
566 * we pre-reserve enough room for a ECNE or CWR AND a SACK with no missing
567 * pieces. If ENCE is missing we could have a couple of blocks. This way we
568 * optimize so we MOST likely can bundle a SACK/ECN with the smallest size
569 * data chunk I will split into. We could increase throughput slightly by
570 * taking out these two but the 24-sack/8-CWR i.e. 32 bytes I pre-reserve I
571 * feel is worth it for now.
573 #ifndef SCTP_MAX_OVERHEAD
575 #define SCTP_MAX_OVERHEAD (sizeof(struct sctp_data_chunk) + \
576 sizeof(struct sctphdr) + \
577 sizeof(struct sctp_ecne_chunk) + \
578 sizeof(struct sctp_sack_chunk) + \
579 sizeof(struct ip6_hdr))
581 #define SCTP_MED_OVERHEAD (sizeof(struct sctp_data_chunk) + \
582 sizeof(struct sctphdr) + \
583 sizeof(struct ip6_hdr))
586 #define SCTP_MIN_OVERHEAD (sizeof(struct ip6_hdr) + \
587 sizeof(struct sctphdr))
590 #define SCTP_MAX_OVERHEAD (sizeof(struct sctp_data_chunk) + \
591 sizeof(struct sctphdr) + \
592 sizeof(struct sctp_ecne_chunk) + \
593 sizeof(struct sctp_sack_chunk) + \
596 #define SCTP_MED_OVERHEAD (sizeof(struct sctp_data_chunk) + \
597 sizeof(struct sctphdr) + \
601 #define SCTP_MIN_OVERHEAD (sizeof(struct ip) + \
602 sizeof(struct sctphdr))
605 #endif /* !SCTP_MAX_OVERHEAD */
607 #define SCTP_MED_V4_OVERHEAD (sizeof(struct sctp_data_chunk) + \
608 sizeof(struct sctphdr) + \
611 #define SCTP_MIN_V4_OVERHEAD (sizeof(struct ip) + \
612 sizeof(struct sctphdr))
615 #endif /* !__sctp_header_h__ */