1/*- 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. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions are met: 8 * 9 * a) Redistributions of source code must retain the above copyright notice, 10 * this list of conditions and the following disclaimer. 11 * 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. 15 * 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. 19 * 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. 31 */ 32 33#include <sys/cdefs.h> 34__FBSDID("$FreeBSD$"); 35 36#ifndef _NETINET_SCTP_HEADER_H_ 37#define _NETINET_SCTP_HEADER_H_ 38 39#include <sys/time.h> 40#include <netinet/sctp.h> 41#include <netinet/sctp_constants.h> 42 43#define SCTP_PACKED __attribute__((packed)) 44 45/* 46 * Parameter structures 47 */ 48struct sctp_ipv4addr_param { 49 struct sctp_paramhdr ph;/* type=SCTP_IPV4_PARAM_TYPE, len=8 */ 50 uint32_t addr; /* IPV4 address */ 51} SCTP_PACKED; 52 53#define SCTP_V6_ADDR_BYTES 16 54 55 56struct 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 */ 59} SCTP_PACKED; 60 61/* Cookie Preservative */ 62struct 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 */ 65} SCTP_PACKED; 66 67#define SCTP_ARRAY_MIN_LEN 1 68/* Host Name Address */ 69struct sctp_host_name_param { 70 struct sctp_paramhdr ph;/* type=SCTP_HOSTNAME_ADDRESS */ 71 char name[SCTP_ARRAY_MIN_LEN]; /* host name */ 72} SCTP_PACKED; 73 74/* 75 * This is the maximum padded size of a s-a-p 76 * so paramheadr + 3 address types (6 bytes) + 2 byte pad = 12 77 */ 78#define SCTP_MAX_ADDR_PARAMS_SIZE 12 79/* supported address type */ 80struct sctp_supported_addr_param { 81 struct sctp_paramhdr ph;/* type=SCTP_SUPPORTED_ADDRTYPE */ 82 uint16_t addr_type[2]; /* array of supported address types */ 83} SCTP_PACKED; 84 85/* heartbeat info parameter */ 86struct 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; 92 uint8_t addr_family; 93 uint8_t addr_len; 94 /* make sure that this structure is 4 byte aligned */ 95 uint8_t padding[2]; 96 char address[SCTP_ADDRMAX]; 97} SCTP_PACKED; 98 99 100/* draft-ietf-tsvwg-prsctp */ 101/* PR-SCTP supported parameter */ 102struct sctp_prsctp_supported_param { 103 struct sctp_paramhdr ph; 104} SCTP_PACKED; 105 106 107/* draft-ietf-tsvwg-addip-sctp */ 108struct 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 */ 111} SCTP_PACKED; 112 113struct 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 */ 116} SCTP_PACKED; 117 118 119struct sctp_asconf_tag_param { /* an ASCONF NAT-Vtag parameter */ 120 struct sctp_asconf_paramhdr aph; /* asconf "parameter" */ 121 uint32_t local_vtag; 122 uint32_t remote_vtag; 123} SCTP_PACKED; 124 125 126struct 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 */ 129} SCTP_PACKED; 130 131#define SCTP_MAX_SUPPORTED_EXT 256 132 133struct sctp_supported_chunk_types_param { 134 struct sctp_paramhdr ph;/* type = 0x8008 len = x */ 135 uint8_t chunk_types[]; 136} SCTP_PACKED; 137 138 139/* 140 * Structures for DATA chunks 141 */ 142struct sctp_data { 143 uint32_t tsn; 144 uint16_t stream_id; 145 uint16_t stream_sequence; 146 uint32_t protocol_id; 147 /* user data follows */ 148} SCTP_PACKED; 149 150struct sctp_data_chunk { 151 struct sctp_chunkhdr ch; 152 struct sctp_data dp; 153} SCTP_PACKED; 154 155/* 156 * Structures for the control chunks 157 */ 158 159/* Initiate (INIT)/Initiate Ack (INIT ACK) */ 160struct sctp_init { 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 */ 167} SCTP_PACKED; 168 169#define SCTP_IDENTIFICATION_SIZE 16 170#define SCTP_ADDRESS_SIZE 4 171#define SCTP_RESERVE_SPACE 6 172/* state cookie header */ 173struct 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 */ 178 179 uint32_t tie_tag_peer_vtag; /* peers tag in old association */ 180 uint32_t peers_vtag; /* peers tag in INIT (for quick ref) */ 181 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 */ 188 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 */ 195 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 */ 199 /* 200 * at the end is tacked on the INIT chunk and the INIT-ACK chunk 201 * (minus the cookie). 202 */ 203} SCTP_PACKED; 204 205/* state cookie parameter */ 206struct sctp_state_cookie_param { 207 struct sctp_paramhdr ph; 208 struct sctp_state_cookie cookie; 209} SCTP_PACKED; 210 211struct sctp_init_chunk { 212 struct sctp_chunkhdr ch; 213 struct sctp_init init; 214} SCTP_PACKED; 215 216struct sctp_init_msg { 217 struct sctphdr sh; 218 struct sctp_init_chunk msg; 219} SCTP_PACKED; 220 221/* ... used for both INIT and INIT ACK */ 222#define sctp_init_ack sctp_init 223#define sctp_init_ack_chunk sctp_init_chunk 224#define sctp_init_ack_msg sctp_init_msg 225 226 227/* Selective Ack (SACK) */ 228struct sctp_gap_ack_block { 229 uint16_t start; /* Gap Ack block start */ 230 uint16_t end; /* Gap Ack block end */ 231} SCTP_PACKED; 232 233struct sctp_sack { 234 uint32_t cum_tsn_ack; /* cumulative TSN Ack */ 235 uint32_t a_rwnd; /* updated a_rwnd of sender */ 236 uint16_t num_gap_ack_blks; /* number of Gap Ack blocks */ 237 uint16_t num_dup_tsns; /* number of duplicate TSNs */ 238 /* struct sctp_gap_ack_block's follow */ 239 /* uint32_t duplicate_tsn's follow */ 240} SCTP_PACKED; 241 242struct sctp_sack_chunk { 243 struct sctp_chunkhdr ch; 244 struct sctp_sack sack; 245} SCTP_PACKED; 246 247struct sctp_nr_sack { 248 uint32_t cum_tsn_ack; /* cumulative TSN Ack */ 249 uint32_t a_rwnd; /* updated a_rwnd of sender */ 250 uint16_t num_gap_ack_blks; /* number of Gap Ack blocks */ 251 uint16_t num_nr_gap_ack_blks; /* number of NR Gap Ack blocks */ 252 uint16_t num_dup_tsns; /* number of duplicate TSNs */ 253 uint16_t reserved; /* not currently used */ 254 /* struct sctp_gap_ack_block's follow */ 255 /* uint32_t duplicate_tsn's follow */ 256} SCTP_PACKED; 257 258struct sctp_nr_sack_chunk { 259 struct sctp_chunkhdr ch; 260 struct sctp_nr_sack nr_sack; 261} SCTP_PACKED; 262 263 264/* Heartbeat Request (HEARTBEAT) */ 265struct sctp_heartbeat { 266 struct sctp_heartbeat_info_param hb_info; 267} SCTP_PACKED; 268 269struct sctp_heartbeat_chunk { 270 struct sctp_chunkhdr ch; 271 struct sctp_heartbeat heartbeat; 272} SCTP_PACKED; 273 274/* ... used for Heartbeat Ack (HEARTBEAT ACK) */ 275#define sctp_heartbeat_ack sctp_heartbeat 276#define sctp_heartbeat_ack_chunk sctp_heartbeat_chunk 277 278 279/* Abort Asssociation (ABORT) */ 280struct sctp_abort_chunk { 281 struct sctp_chunkhdr ch; 282 /* optional error cause may follow */ 283} SCTP_PACKED; 284 285struct sctp_abort_msg { 286 struct sctphdr sh; 287 struct sctp_abort_chunk msg; 288} SCTP_PACKED; 289 290 291/* Shutdown Association (SHUTDOWN) */ 292struct sctp_shutdown_chunk { 293 struct sctp_chunkhdr ch; 294 uint32_t cumulative_tsn_ack; 295} SCTP_PACKED; 296 297 298/* Shutdown Acknowledgment (SHUTDOWN ACK) */ 299struct sctp_shutdown_ack_chunk { 300 struct sctp_chunkhdr ch; 301} SCTP_PACKED; 302 303 304/* Operation Error (ERROR) */ 305struct sctp_error_chunk { 306 struct sctp_chunkhdr ch; 307 /* optional error causes follow */ 308} SCTP_PACKED; 309 310 311/* Cookie Echo (COOKIE ECHO) */ 312struct sctp_cookie_echo_chunk { 313 struct sctp_chunkhdr ch; 314 struct sctp_state_cookie cookie; 315} SCTP_PACKED; 316 317/* Cookie Acknowledgment (COOKIE ACK) */ 318struct sctp_cookie_ack_chunk { 319 struct sctp_chunkhdr ch; 320} SCTP_PACKED; 321 322/* Explicit Congestion Notification Echo (ECNE) */ 323struct old_sctp_ecne_chunk { 324 struct sctp_chunkhdr ch; 325 uint32_t tsn; 326} SCTP_PACKED; 327 328struct sctp_ecne_chunk { 329 struct sctp_chunkhdr ch; 330 uint32_t tsn; 331 uint32_t num_pkts_since_cwr; 332} SCTP_PACKED; 333 334/* Congestion Window Reduced (CWR) */ 335struct sctp_cwr_chunk { 336 struct sctp_chunkhdr ch; 337 uint32_t tsn; 338} SCTP_PACKED; 339 340/* Shutdown Complete (SHUTDOWN COMPLETE) */ 341struct sctp_shutdown_complete_chunk { 342 struct sctp_chunkhdr ch; 343} SCTP_PACKED; 344 345struct sctp_adaptation_layer_indication { 346 struct sctp_paramhdr ph; 347 uint32_t indication; 348} SCTP_PACKED; 349 350/* 351 * draft-ietf-tsvwg-addip-sctp 352 */ 353/* Address/Stream Configuration Change (ASCONF) */ 354struct sctp_asconf_chunk { 355 struct sctp_chunkhdr ch; 356 uint32_t serial_number; 357 /* lookup address parameter (mandatory) */ 358 /* asconf parameters follow */ 359} SCTP_PACKED; 360 361/* Address/Stream Configuration Acknowledge (ASCONF ACK) */ 362struct sctp_asconf_ack_chunk { 363 struct sctp_chunkhdr ch; 364 uint32_t serial_number; 365 /* asconf parameters follow */ 366} SCTP_PACKED; 367 368/* draft-ietf-tsvwg-prsctp */ 369/* Forward Cumulative TSN (FORWARD TSN) */ 370struct sctp_forward_tsn_chunk { 371 struct sctp_chunkhdr ch; 372 uint32_t new_cumulative_tsn; 373 /* stream/sequence pairs (sctp_strseq) follow */ 374} SCTP_PACKED; 375 376struct sctp_strseq { 377 uint16_t stream; 378 uint16_t sequence; 379} SCTP_PACKED; 380 381struct sctp_forward_tsn_msg { 382 struct sctphdr sh; 383 struct sctp_forward_tsn_chunk msg; 384} SCTP_PACKED; 385 386/* should be a multiple of 4 - 1 aka 3/7/11 etc. */ 387 388#define SCTP_NUM_DB_TO_VERIFY 31 389 390struct sctp_chunk_desc { 391 uint8_t chunk_type; 392 uint8_t data_bytes[SCTP_NUM_DB_TO_VERIFY]; 393 uint32_t tsn_ifany; 394} SCTP_PACKED; 395 396 397struct sctp_pktdrop_chunk { 398 struct sctp_chunkhdr ch; 399 uint32_t bottle_bw; 400 uint32_t current_onq; 401 uint16_t trunc_len; 402 uint16_t reserved; 403 uint8_t data[]; 404} SCTP_PACKED; 405 406/**********STREAM RESET STUFF ******************/ 407 408struct sctp_stream_reset_request { 409 struct sctp_paramhdr ph; 410 uint32_t request_seq; 411} SCTP_PACKED; 412 413struct sctp_stream_reset_out_request { 414 struct sctp_paramhdr ph; 415 uint32_t request_seq; /* monotonically increasing seq no */ 416 uint32_t response_seq; /* if a response, the resp seq no */ 417 uint32_t send_reset_at_tsn; /* last TSN I assigned outbound */ 418 uint16_t list_of_streams[]; /* if not all list of streams */ 419} SCTP_PACKED; 420 421struct sctp_stream_reset_in_request { 422 struct sctp_paramhdr ph; 423 uint32_t request_seq; 424 uint16_t list_of_streams[]; /* if not all list of streams */ 425} SCTP_PACKED; 426 427struct sctp_stream_reset_tsn_request { 428 struct sctp_paramhdr ph; 429 uint32_t request_seq; 430} SCTP_PACKED; 431 432struct sctp_stream_reset_response { 433 struct sctp_paramhdr ph; 434 uint32_t response_seq; /* if a response, the resp seq no */ 435 uint32_t result; 436} SCTP_PACKED; 437 438struct sctp_stream_reset_response_tsn { 439 struct sctp_paramhdr ph; 440 uint32_t response_seq; /* if a response, the resp seq no */ 441 uint32_t result; 442 uint32_t senders_next_tsn; 443 uint32_t receivers_next_tsn; 444} SCTP_PACKED; 445 446struct sctp_stream_reset_add_strm { 447 struct sctp_paramhdr ph; 448 uint32_t request_seq; 449 uint16_t number_of_streams; 450 uint16_t reserved; 451} SCTP_PACKED; 452 453#define SCTP_STREAM_RESET_RESULT_NOTHING_TO_DO 0x00000000 /* XXX: unused */ 454#define SCTP_STREAM_RESET_RESULT_PERFORMED 0x00000001 455#define SCTP_STREAM_RESET_RESULT_DENIED 0x00000002 456#define SCTP_STREAM_RESET_RESULT_ERR__WRONG_SSN 0x00000003 /* XXX: unused */ 457#define SCTP_STREAM_RESET_RESULT_ERR_IN_PROGRESS 0x00000004 458#define SCTP_STREAM_RESET_RESULT_ERR_BAD_SEQNO 0x00000005 459#define SCTP_STREAM_RESET_RESULT_IN_PROGRESS 0x00000006 /* XXX: unused */ 460 461/* 462 * convience structures, note that if you are making a request for specific 463 * streams then the request will need to be an overlay structure. 464 */ 465 466struct sctp_stream_reset_tsn_req { 467 struct sctp_chunkhdr ch; 468 struct sctp_stream_reset_tsn_request sr_req; 469} SCTP_PACKED; 470 471struct sctp_stream_reset_resp { 472 struct sctp_chunkhdr ch; 473 struct sctp_stream_reset_response sr_resp; 474} SCTP_PACKED; 475 476/* respone only valid with a TSN request */ 477struct sctp_stream_reset_resp_tsn { 478 struct sctp_chunkhdr ch; 479 struct sctp_stream_reset_response_tsn sr_resp; 480} SCTP_PACKED; 481 482/****************************************************/ 483 484/* 485 * Authenticated chunks support draft-ietf-tsvwg-sctp-auth 486 */ 487 488/* Should we make the max be 32? */ 489#define SCTP_RANDOM_MAX_SIZE 256 490struct sctp_auth_random { 491 struct sctp_paramhdr ph;/* type = 0x8002 */ 492 uint8_t random_data[]; 493} SCTP_PACKED; 494 495struct sctp_auth_chunk_list { 496 struct sctp_paramhdr ph;/* type = 0x8003 */ 497 uint8_t chunk_types[]; 498} SCTP_PACKED; 499 500struct sctp_auth_hmac_algo { 501 struct sctp_paramhdr ph;/* type = 0x8004 */ 502 uint16_t hmac_ids[]; 503} SCTP_PACKED; 504 505struct sctp_auth_chunk { 506 struct sctp_chunkhdr ch; 507 uint16_t shared_key_id; 508 uint16_t hmac_id; 509 uint8_t hmac[]; 510} SCTP_PACKED; 511 512/* 513 * we pre-reserve enough room for a ECNE or CWR AND a SACK with no missing 514 * pieces. If ENCE is missing we could have a couple of blocks. This way we 515 * optimize so we MOST likely can bundle a SACK/ECN with the smallest size 516 * data chunk I will split into. We could increase throughput slightly by 517 * taking out these two but the 24-sack/8-CWR i.e. 32 bytes I pre-reserve I 518 * feel is worth it for now. 519 */ 520#ifndef SCTP_MAX_OVERHEAD 521#ifdef INET6 522#define SCTP_MAX_OVERHEAD (sizeof(struct sctp_data_chunk) + \ 523 sizeof(struct sctphdr) + \ 524 sizeof(struct sctp_ecne_chunk) + \ 525 sizeof(struct sctp_sack_chunk) + \ 526 sizeof(struct ip6_hdr)) 527 528#define SCTP_MED_OVERHEAD (sizeof(struct sctp_data_chunk) + \ 529 sizeof(struct sctphdr) + \ 530 sizeof(struct ip6_hdr)) 531 532 533#define SCTP_MIN_OVERHEAD (sizeof(struct ip6_hdr) + \ 534 sizeof(struct sctphdr)) 535 536#else 537#define SCTP_MAX_OVERHEAD (sizeof(struct sctp_data_chunk) + \ 538 sizeof(struct sctphdr) + \ 539 sizeof(struct sctp_ecne_chunk) + \ 540 sizeof(struct sctp_sack_chunk) + \ 541 sizeof(struct ip)) 542 543#define SCTP_MED_OVERHEAD (sizeof(struct sctp_data_chunk) + \ 544 sizeof(struct sctphdr) + \ 545 sizeof(struct ip)) 546 547 548#define SCTP_MIN_OVERHEAD (sizeof(struct ip) + \ 549 sizeof(struct sctphdr)) 550 551#endif /* INET6 */ 552#endif /* !SCTP_MAX_OVERHEAD */ 553 554#define SCTP_MED_V4_OVERHEAD (sizeof(struct sctp_data_chunk) + \ 555 sizeof(struct sctphdr) + \ 556 sizeof(struct ip)) 557 558#define SCTP_MIN_V4_OVERHEAD (sizeof(struct ip) + \ 559 sizeof(struct sctphdr)) 560 561#undef SCTP_PACKED 562#endif /* !__sctp_header_h__ */ 563