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