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