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