include/linux/sctp.h

   1 /* SCTP kernel reference Implementation
   2  * (C) Copyright IBM Corp. 2001, 2004
   3  * Copyright (c) 1999-2000 Cisco, Inc.
   4  * Copyright (c) 1999-2001 Motorola, Inc.
   5  * Copyright (c) 2001 Intel Corp.
   6  * Copyright (c) 2001 Nokia, Inc.
   7  * Copyright (c) 2001 La Monte H.P. Yarroll
   8  *
   9  * This file is part of the SCTP kernel reference Implementation
  10  *
  11  * Various protocol defined structures.
  12  *
  13  * This SCTP implementation is free software;
  14  * you can redistribute it and/or modify it under the terms of
  15  * the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2, or (at your option)
  17  * any later version.
  18  *
  19  * This SCTP implementation is distributed in the hope that it
  20  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  21  *                 ************************
  22  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  23  * See the GNU General Public License for more details.
  24  *
  25  * You should have received a copy of the GNU General Public License
  26  * along with GNU CC; see the file COPYING.  If not, see
  27  * <http://www.gnu.org/licenses/>.
  28  *
  29  * Please send any bug reports or fixes you make to the
  30  * email address(es):
  31  *    lksctp developers <linux-sctp@vger.kernel.org>
  32  *
  33  * Or submit a bug report through the following website:
  34  *    http://www.sf.net/projects/lksctp
  35  *
  36  * Written or modified by:
  37  *    La Monte H.P. Yarroll <piggy@acm.org>
  38  *    Karl Knutson <karl@athena.chicago.il.us>
  39  *    Jon Grimm <jgrimm@us.ibm.com>
  40  *    Xingang Guo <xingang.guo@intel.com>
  41  *    randall@sctp.chicago.il.us
  42  *    kmorneau@cisco.com
  43  *    qxie1@email.mot.com
  44  *    Sridhar Samudrala <sri@us.ibm.com>
  45  *    Kevin Gao <kevin.gao@intel.com>
  46  *
  47  * Any bugs reported given to us we will try to fix... any fixes shared will
  48  * be incorporated into the next SCTP release.
  49  */
  50 #ifndef __LINUX_SCTP_H__
  51 #define __LINUX_SCTP_H__
  52
  53 #include <linux/in.h>           /* We need in_addr.  */
  54 #include <linux/in6.h>          /* We need in6_addr.  */
  55 #include <linux/skbuff.h>
  56
  57 #include <uapi/linux/sctp.h>
  58
  59 /* Section 3.1.  SCTP Common Header Format */
  60 struct sctphdr {
  61         __be16 source;
  62         __be16 dest;
  63         __be32 vtag;
  64         __le32 checksum;
  65 };
  66
  67 static inline struct sctphdr *sctp_hdr(const struct sk_buff *skb)
  68 {
  69         return (struct sctphdr *)skb_transport_header(skb);
  70 }
  71
  72 /* Section 3.2.  Chunk Field Descriptions. */
  73 struct sctp_chunkhdr {
  74         __u8 type;
  75         __u8 flags;
  76         __be16 length;
  77 };
  78
  79
  80 /* Section 3.2.  Chunk Type Values.
  81  * [Chunk Type] identifies the type of information contained in the Chunk
  82  * Value field. It takes a value from 0 to 254. The value of 255 is
  83  * reserved for future use as an extension field.
  84  */
  85 enum sctp_cid {
  86         SCTP_CID_DATA                   = 0,
  87         SCTP_CID_INIT                   = 1,
  88         SCTP_CID_INIT_ACK               = 2,
  89         SCTP_CID_SACK                   = 3,
  90         SCTP_CID_HEARTBEAT              = 4,
  91         SCTP_CID_HEARTBEAT_ACK          = 5,
  92         SCTP_CID_ABORT                  = 6,
  93         SCTP_CID_SHUTDOWN               = 7,
  94         SCTP_CID_SHUTDOWN_ACK           = 8,
  95         SCTP_CID_ERROR                  = 9,
  96         SCTP_CID_COOKIE_ECHO            = 10,
  97         SCTP_CID_COOKIE_ACK             = 11,
  98         SCTP_CID_ECN_ECNE               = 12,
  99         SCTP_CID_ECN_CWR                = 13,
 100         SCTP_CID_SHUTDOWN_COMPLETE      = 14,
 101
 102         /* AUTH Extension Section 4.1 */
 103         SCTP_CID_AUTH                   = 0x0F,
 104
 105         /* PR-SCTP Sec 3.2 */
 106         SCTP_CID_FWD_TSN                = 0xC0,
 107
 108         /* Use hex, as defined in ADDIP sec. 3.1 */
 109         SCTP_CID_ASCONF                 = 0xC1,
 110         SCTP_CID_ASCONF_ACK             = 0x80,
 111         SCTP_CID_RECONF                 = 0x82,
 112 }; /* enum */
 113
 114
 115 /* Section 3.2
 116  *  Chunk Types are encoded such that the highest-order two bits specify
 117  *  the action that must be taken if the processing endpoint does not
 118  *  recognize the Chunk Type.
 119  */
 120 enum {
 121         SCTP_CID_ACTION_DISCARD     = 0x00,
 122         SCTP_CID_ACTION_DISCARD_ERR = 0x40,
 123         SCTP_CID_ACTION_SKIP        = 0x80,
 124         SCTP_CID_ACTION_SKIP_ERR    = 0xc0,
 125 };
 126
 127 enum { SCTP_CID_ACTION_MASK = 0xc0, };
 128
 129 /* This flag is used in Chunk Flags for ABORT and SHUTDOWN COMPLETE.
 130  *
 131  * 3.3.7 Abort Association (ABORT) (6):
 132  *    The T bit is set to 0 if the sender had a TCB that it destroyed.
 133  *    If the sender did not have a TCB it should set this bit to 1.
 134  */
 135 enum { SCTP_CHUNK_FLAG_T = 0x01 };
 136
 137 /*
 138  *  Set the T bit
 139  *
 140  *      0                   1                   2                   3
 141  *      0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 142  *     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 143  *     |   Type = 14   |Reserved     |T|      Length = 4               |
 144  *     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 145  *
 146  * Chunk Flags: 8 bits
 147  *
 148  *   Reserved:  7 bits
 149  *     Set to 0 on transmit and ignored on receipt.
 150  *
 151  *   T bit:  1 bit
 152  *     The T bit is set to 0 if the sender had a TCB that it destroyed. If
 153  *     the sender did NOT have a TCB it should set this bit to 1.
 154  *
 155  * Note: Special rules apply to this chunk for verification, please
 156  * see Section 8.5.1 for details.
 157  */
 158
 159 #define sctp_test_T_bit(c)    ((c)->chunk_hdr->flags & SCTP_CHUNK_FLAG_T)
 160
 161 /* RFC 2960
 162  * Section 3.2.1 Optional/Variable-length Parmaeter Format.
 163  */
 164
 165 struct sctp_paramhdr {
 166         __be16 type;
 167         __be16 length;
 168 };
 169
 170 enum sctp_param {
 171
 172         /* RFC 2960 Section 3.3.5 */
 173         SCTP_PARAM_HEARTBEAT_INFO               = cpu_to_be16(1),
 174         /* RFC 2960 Section 3.3.2.1 */
 175         SCTP_PARAM_IPV4_ADDRESS                 = cpu_to_be16(5),
 176         SCTP_PARAM_IPV6_ADDRESS                 = cpu_to_be16(6),
 177         SCTP_PARAM_STATE_COOKIE                 = cpu_to_be16(7),
 178         SCTP_PARAM_UNRECOGNIZED_PARAMETERS      = cpu_to_be16(8),
 179         SCTP_PARAM_COOKIE_PRESERVATIVE          = cpu_to_be16(9),
 180         SCTP_PARAM_HOST_NAME_ADDRESS            = cpu_to_be16(11),
 181         SCTP_PARAM_SUPPORTED_ADDRESS_TYPES      = cpu_to_be16(12),
 182         SCTP_PARAM_ECN_CAPABLE                  = cpu_to_be16(0x8000),
 183
 184         /* AUTH Extension Section 3 */
 185         SCTP_PARAM_RANDOM                       = cpu_to_be16(0x8002),
 186         SCTP_PARAM_CHUNKS                       = cpu_to_be16(0x8003),
 187         SCTP_PARAM_HMAC_ALGO                    = cpu_to_be16(0x8004),
 188
 189         /* Add-IP: Supported Extensions, Section 4.2 */
 190         SCTP_PARAM_SUPPORTED_EXT        = cpu_to_be16(0x8008),
 191
 192         /* PR-SCTP Sec 3.1 */
 193         SCTP_PARAM_FWD_TSN_SUPPORT      = cpu_to_be16(0xc000),
 194
 195         /* Add-IP Extension. Section 3.2 */
 196         SCTP_PARAM_ADD_IP               = cpu_to_be16(0xc001),
 197         SCTP_PARAM_DEL_IP               = cpu_to_be16(0xc002),
 198         SCTP_PARAM_ERR_CAUSE            = cpu_to_be16(0xc003),
 199         SCTP_PARAM_SET_PRIMARY          = cpu_to_be16(0xc004),
 200         SCTP_PARAM_SUCCESS_REPORT       = cpu_to_be16(0xc005),
 201         SCTP_PARAM_ADAPTATION_LAYER_IND = cpu_to_be16(0xc006),
 202
 203         /* RE-CONFIG. Section 4 */
 204         SCTP_PARAM_RESET_OUT_REQUEST            = cpu_to_be16(0x000d),
 205         SCTP_PARAM_RESET_IN_REQUEST             = cpu_to_be16(0x000e),
 206         SCTP_PARAM_RESET_TSN_REQUEST            = cpu_to_be16(0x000f),
 207         SCTP_PARAM_RESET_RESPONSE               = cpu_to_be16(0x0010),
 208         SCTP_PARAM_RESET_ADD_OUT_STREAMS        = cpu_to_be16(0x0011),
 209         SCTP_PARAM_RESET_ADD_IN_STREAMS         = cpu_to_be16(0x0012),
 210 }; /* enum */
 211
 212
 213 /* RFC 2960 Section 3.2.1
 214  *  The Parameter Types are encoded such that the highest-order two bits
 215  *  specify the action that must be taken if the processing endpoint does
 216  *  not recognize the Parameter Type.
 217  *
 218  */
 219 enum {
 220         SCTP_PARAM_ACTION_DISCARD     = cpu_to_be16(0x0000),
 221         SCTP_PARAM_ACTION_DISCARD_ERR = cpu_to_be16(0x4000),
 222         SCTP_PARAM_ACTION_SKIP        = cpu_to_be16(0x8000),
 223         SCTP_PARAM_ACTION_SKIP_ERR    = cpu_to_be16(0xc000),
 224 };
 225
 226 enum { SCTP_PARAM_ACTION_MASK = cpu_to_be16(0xc000), };
 227
 228 /* RFC 2960 Section 3.3.1 Payload Data (DATA) (0) */
 229
 230 struct sctp_datahdr {
 231         __be32 tsn;
 232         __be16 stream;
 233         __be16 ssn;
 234         __be32 ppid;
 235         __u8  payload[0];
 236 };
 237
 238 struct sctp_data_chunk {
 239         struct sctp_chunkhdr chunk_hdr;
 240         struct sctp_datahdr data_hdr;
 241 };
 242
 243 /* DATA Chuck Specific Flags */
 244 enum {
 245         SCTP_DATA_MIDDLE_FRAG   = 0x00,
 246         SCTP_DATA_LAST_FRAG     = 0x01,
 247         SCTP_DATA_FIRST_FRAG    = 0x02,
 248         SCTP_DATA_NOT_FRAG      = 0x03,
 249         SCTP_DATA_UNORDERED     = 0x04,
 250         SCTP_DATA_SACK_IMM      = 0x08,
 251 };
 252 enum { SCTP_DATA_FRAG_MASK = 0x03, };
 253
 254
 255 /* RFC 2960 Section 3.3.2 Initiation (INIT) (1)
 256  *
 257  *  This chunk is used to initiate a SCTP association between two
 258  *  endpoints.
 259  */
 260 struct sctp_inithdr {
 261         __be32 init_tag;
 262         __be32 a_rwnd;
 263         __be16 num_outbound_streams;
 264         __be16 num_inbound_streams;
 265         __be32 initial_tsn;
 266         __u8  params[0];
 267 };
 268
 269 struct sctp_init_chunk {
 270         struct sctp_chunkhdr chunk_hdr;
 271         struct sctp_inithdr init_hdr;
 272 };
 273
 274
 275 /* Section 3.3.2.1. IPv4 Address Parameter (5) */
 276 typedef struct sctp_ipv4addr_param {
 277         struct sctp_paramhdr param_hdr;
 278         struct in_addr  addr;
 279 } sctp_ipv4addr_param_t;
 280
 281 /* Section 3.3.2.1. IPv6 Address Parameter (6) */
 282 typedef struct sctp_ipv6addr_param {
 283         struct sctp_paramhdr param_hdr;
 284         struct in6_addr addr;
 285 } sctp_ipv6addr_param_t;
 286
 287 /* Section 3.3.2.1 Cookie Preservative (9) */
 288 typedef struct sctp_cookie_preserve_param {
 289         struct sctp_paramhdr param_hdr;
 290         __be32          lifespan_increment;
 291 } sctp_cookie_preserve_param_t;
 292
 293 /* Section 3.3.2.1 Host Name Address (11) */
 294 typedef struct sctp_hostname_param {
 295         struct sctp_paramhdr param_hdr;
 296         uint8_t hostname[0];
 297 } sctp_hostname_param_t;
 298
 299 /* Section 3.3.2.1 Supported Address Types (12) */
 300 typedef struct sctp_supported_addrs_param {
 301         struct sctp_paramhdr param_hdr;
 302         __be16 types[0];
 303 } sctp_supported_addrs_param_t;
 304
 305 /* Appendix A. ECN Capable (32768) */
 306 typedef struct sctp_ecn_capable_param {
 307         struct sctp_paramhdr param_hdr;
 308 } sctp_ecn_capable_param_t;
 309
 310 /* ADDIP Section 3.2.6 Adaptation Layer Indication */
 311 typedef struct sctp_adaptation_ind_param {
 312         struct sctp_paramhdr param_hdr;
 313         __be32 adaptation_ind;
 314 } sctp_adaptation_ind_param_t;
 315
 316 /* ADDIP Section 4.2.7 Supported Extensions Parameter */
 317 typedef struct sctp_supported_ext_param {
 318         struct sctp_paramhdr param_hdr;
 319         __u8 chunks[0];
 320 } sctp_supported_ext_param_t;
 321
 322 /* AUTH Section 3.1 Random */
 323 typedef struct sctp_random_param {
 324         struct sctp_paramhdr param_hdr;
 325         __u8 random_val[0];
 326 } sctp_random_param_t;
 327
 328 /* AUTH Section 3.2 Chunk List */
 329 typedef struct sctp_chunks_param {
 330         struct sctp_paramhdr param_hdr;
 331         __u8 chunks[0];
 332 } sctp_chunks_param_t;
 333
 334 /* AUTH Section 3.3 HMAC Algorithm */
 335 typedef struct sctp_hmac_algo_param {
 336         struct sctp_paramhdr param_hdr;
 337         __be16 hmac_ids[0];
 338 } sctp_hmac_algo_param_t;
 339
 340 /* RFC 2960.  Section 3.3.3 Initiation Acknowledgement (INIT ACK) (2):
 341  *   The INIT ACK chunk is used to acknowledge the initiation of an SCTP
 342  *   association.
 343  */
 344 typedef struct sctp_init_chunk sctp_initack_chunk_t;
 345
 346 /* Section 3.3.3.1 State Cookie (7) */
 347 typedef struct sctp_cookie_param {
 348         struct sctp_paramhdr p;
 349         __u8 body[0];
 350 } sctp_cookie_param_t;
 351
 352 /* Section 3.3.3.1 Unrecognized Parameters (8) */
 353 typedef struct sctp_unrecognized_param {
 354         struct sctp_paramhdr param_hdr;
 355         struct sctp_paramhdr unrecognized;
 356 } sctp_unrecognized_param_t;
 357
 358
 359
 360 /*
 361  * 3.3.4 Selective Acknowledgement (SACK) (3):
 362  *
 363  *  This chunk is sent to the peer endpoint to acknowledge received DATA
 364  *  chunks and to inform the peer endpoint of gaps in the received
 365  *  subsequences of DATA chunks as represented by their TSNs.
 366  */
 367
 368 typedef struct sctp_gap_ack_block {
 369         __be16 start;
 370         __be16 end;
 371 } sctp_gap_ack_block_t;
 372
 373 typedef __be32 sctp_dup_tsn_t;
 374
 375 typedef union {
 376         sctp_gap_ack_block_t    gab;
 377         sctp_dup_tsn_t          dup;
 378 } sctp_sack_variable_t;
 379
 380 typedef struct sctp_sackhdr {
 381         __be32 cum_tsn_ack;
 382         __be32 a_rwnd;
 383         __be16 num_gap_ack_blocks;
 384         __be16 num_dup_tsns;
 385         sctp_sack_variable_t variable[0];
 386 } sctp_sackhdr_t;
 387
 388 typedef struct sctp_sack_chunk {
 389         struct sctp_chunkhdr chunk_hdr;
 390         sctp_sackhdr_t sack_hdr;
 391 } sctp_sack_chunk_t;
 392
 393
 394 /* RFC 2960.  Section 3.3.5 Heartbeat Request (HEARTBEAT) (4):
 395  *
 396  *  An endpoint should send this chunk to its peer endpoint to probe the
 397  *  reachability of a particular destination transport address defined in
 398  *  the present association.
 399  */
 400
 401 typedef struct sctp_heartbeathdr {
 402         struct sctp_paramhdr info;
 403 } sctp_heartbeathdr_t;
 404
 405 typedef struct sctp_heartbeat_chunk {
 406         struct sctp_chunkhdr chunk_hdr;
 407         sctp_heartbeathdr_t hb_hdr;
 408 } sctp_heartbeat_chunk_t;
 409
 410
 411 /* For the abort and shutdown ACK we must carry the init tag in the
 412  * common header. Just the common header is all that is needed with a
 413  * chunk descriptor.
 414  */
 415 typedef struct sctp_abort_chunk {
 416         struct sctp_chunkhdr uh;
 417 } sctp_abort_chunk_t;
 418
 419
 420 /* For the graceful shutdown we must carry the tag (in common header)
 421  * and the highest consecutive acking value.
 422  */
 423 typedef struct sctp_shutdownhdr {
 424         __be32 cum_tsn_ack;
 425 } sctp_shutdownhdr_t;
 426
 427 struct sctp_shutdown_chunk_t {
 428         struct sctp_chunkhdr chunk_hdr;
 429         sctp_shutdownhdr_t shutdown_hdr;
 430 };
 431
 432 /* RFC 2960.  Section 3.3.10 Operation Error (ERROR) (9) */
 433
 434 typedef struct sctp_errhdr {
 435         __be16 cause;
 436         __be16 length;
 437         __u8  variable[0];
 438 } sctp_errhdr_t;
 439
 440 typedef struct sctp_operr_chunk {
 441         struct sctp_chunkhdr chunk_hdr;
 442         sctp_errhdr_t err_hdr;
 443 } sctp_operr_chunk_t;
 444
 445 /* RFC 2960 3.3.10 - Operation Error
 446  *
 447  * Cause Code: 16 bits (unsigned integer)
 448  *
 449  *     Defines the type of error conditions being reported.
 450  *    Cause Code
 451  *     Value           Cause Code
 452  *     ---------      ----------------
 453  *      1              Invalid Stream Identifier
 454  *      2              Missing Mandatory Parameter
 455  *      3              Stale Cookie Error
 456  *      4              Out of Resource
 457  *      5              Unresolvable Address
 458  *      6              Unrecognized Chunk Type
 459  *      7              Invalid Mandatory Parameter
 460  *      8              Unrecognized Parameters
 461  *      9              No User Data
 462  *     10              Cookie Received While Shutting Down
 463  */
 464 typedef enum {
 465
 466         SCTP_ERROR_NO_ERROR        = cpu_to_be16(0x00),
 467         SCTP_ERROR_INV_STRM        = cpu_to_be16(0x01),
 468         SCTP_ERROR_MISS_PARAM      = cpu_to_be16(0x02),
 469         SCTP_ERROR_STALE_COOKIE    = cpu_to_be16(0x03),
 470         SCTP_ERROR_NO_RESOURCE     = cpu_to_be16(0x04),
 471         SCTP_ERROR_DNS_FAILED      = cpu_to_be16(0x05),
 472         SCTP_ERROR_UNKNOWN_CHUNK   = cpu_to_be16(0x06),
 473         SCTP_ERROR_INV_PARAM       = cpu_to_be16(0x07),
 474         SCTP_ERROR_UNKNOWN_PARAM   = cpu_to_be16(0x08),
 475         SCTP_ERROR_NO_DATA         = cpu_to_be16(0x09),
 476         SCTP_ERROR_COOKIE_IN_SHUTDOWN = cpu_to_be16(0x0a),
 477
 478
 479         /* SCTP Implementation Guide:
 480          *  11  Restart of an association with new addresses
 481          *  12  User Initiated Abort
 482          *  13  Protocol Violation
 483          */
 484
 485         SCTP_ERROR_RESTART         = cpu_to_be16(0x0b),
 486         SCTP_ERROR_USER_ABORT      = cpu_to_be16(0x0c),
 487         SCTP_ERROR_PROTO_VIOLATION = cpu_to_be16(0x0d),
 488
 489         /* ADDIP Section 3.3  New Error Causes
 490          *
 491          * Four new Error Causes are added to the SCTP Operational Errors,
 492          * primarily for use in the ASCONF-ACK chunk.
 493          *
 494          * Value          Cause Code
 495          * ---------      ----------------
 496          * 0x00A0          Request to Delete Last Remaining IP Address.
 497          * 0x00A1          Operation Refused Due to Resource Shortage.
 498          * 0x00A2          Request to Delete Source IP Address.
 499          * 0x00A3          Association Aborted due to illegal ASCONF-ACK
 500          * 0x00A4          Request refused - no authorization.
 501          */
 502         SCTP_ERROR_DEL_LAST_IP  = cpu_to_be16(0x00A0),
 503         SCTP_ERROR_RSRC_LOW     = cpu_to_be16(0x00A1),
 504         SCTP_ERROR_DEL_SRC_IP   = cpu_to_be16(0x00A2),
 505         SCTP_ERROR_ASCONF_ACK   = cpu_to_be16(0x00A3),
 506         SCTP_ERROR_REQ_REFUSED  = cpu_to_be16(0x00A4),
 507
 508         /* AUTH Section 4.  New Error Cause
 509          *
 510          * This section defines a new error cause that will be sent if an AUTH
 511          * chunk is received with an unsupported HMAC identifier.
 512          * illustrates the new error cause.
 513          *
 514          * Cause Code      Error Cause Name
 515          * --------------------------------------------------------------
 516          * 0x0105          Unsupported HMAC Identifier
 517          */
 518          SCTP_ERROR_UNSUP_HMAC  = cpu_to_be16(0x0105)
 519 } sctp_error_t;
 520
 521
 522
 523 /* RFC 2960.  Appendix A.  Explicit Congestion Notification.
 524  *   Explicit Congestion Notification Echo (ECNE) (12)
 525  */
 526 typedef struct sctp_ecnehdr {
 527         __be32 lowest_tsn;
 528 } sctp_ecnehdr_t;
 529
 530 typedef struct sctp_ecne_chunk {
 531         struct sctp_chunkhdr chunk_hdr;
 532         sctp_ecnehdr_t ence_hdr;
 533 } sctp_ecne_chunk_t;
 534
 535 /* RFC 2960.  Appendix A.  Explicit Congestion Notification.
 536  *   Congestion Window Reduced (CWR) (13)
 537  */
 538 typedef struct sctp_cwrhdr {
 539         __be32 lowest_tsn;
 540 } sctp_cwrhdr_t;
 541
 542 typedef struct sctp_cwr_chunk {
 543         struct sctp_chunkhdr chunk_hdr;
 544         sctp_cwrhdr_t cwr_hdr;
 545 } sctp_cwr_chunk_t;
 546
 547 /* PR-SCTP
 548  * 3.2 Forward Cumulative TSN Chunk Definition (FORWARD TSN)
 549  *
 550  * Forward Cumulative TSN chunk has the following format:
 551  *
 552  *        0                   1                   2                   3
 553  *        0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 554  *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 555  *      |   Type = 192  |  Flags = 0x00 |        Length = Variable      |
 556  *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 557  *      |                      New Cumulative TSN                       |
 558  *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 559  *      |         Stream-1              |       Stream Sequence-1       |
 560  *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 561  *      \                                                               /
 562  *      /                                                               \
 563  *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 564  *      |         Stream-N              |       Stream Sequence-N       |
 565  *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 566  *
 567  *      Chunk Flags:
 568  *
 569  *        Set to all zeros on transmit and ignored on receipt.
 570  *
 571  *      New Cumulative TSN: 32 bit u_int
 572  *
 573  *       This indicates the new cumulative TSN to the data receiver. Upon
 574  *       the reception of this value, the data receiver MUST consider
 575  *       any missing TSNs earlier than or equal to this value as received
 576  *       and stop reporting them as gaps in any subsequent SACKs.
 577  *
 578  *      Stream-N: 16 bit u_int
 579  *
 580  *       This field holds a stream number that was skipped by this
 581  *       FWD-TSN.
 582  *
 583  *      Stream Sequence-N: 16 bit u_int
 584  *       This field holds the sequence number associated with the stream
 585  *       that was skipped. The stream sequence field holds the largest stream
 586  *       sequence number in this stream being skipped.  The receiver of
 587  *       the FWD-TSN's can use the Stream-N and Stream Sequence-N fields
 588  *       to enable delivery of any stranded TSN's that remain on the stream
 589  *       re-ordering queues. This field MUST NOT report TSN's corresponding
 590  *       to DATA chunk that are marked as unordered. For ordered DATA
 591  *       chunks this field MUST be filled in.
 592  */
 593 struct sctp_fwdtsn_skip {
 594         __be16 stream;
 595         __be16 ssn;
 596 };
 597
 598 struct sctp_fwdtsn_hdr {
 599         __be32 new_cum_tsn;
 600         struct sctp_fwdtsn_skip skip[0];
 601 };
 602
 603 struct sctp_fwdtsn_chunk {
 604         struct sctp_chunkhdr chunk_hdr;
 605         struct sctp_fwdtsn_hdr fwdtsn_hdr;
 606 };
 607
 608
 609 /* ADDIP
 610  * Section 3.1.1 Address Configuration Change Chunk (ASCONF)
 611  *
 612  *      Serial Number: 32 bits (unsigned integer)
 613  *      This value represents a Serial Number for the ASCONF Chunk. The
 614  *      valid range of Serial Number is from 0 to 2^32-1.
 615  *      Serial Numbers wrap back to 0 after reaching 2^32 -1.
 616  *
 617  *      Address Parameter: 8 or 20 bytes (depending on type)
 618  *      The address is an address of the sender of the ASCONF chunk,
 619  *      the address MUST be considered part of the association by the
 620  *      peer endpoint. This field may be used by the receiver of the
 621  *      ASCONF to help in finding the association. This parameter MUST
 622  *      be present in every ASCONF message i.e. it is a mandatory TLV
 623  *      parameter.
 624  *
 625  *      ASCONF Parameter: TLV format
 626  *      Each Address configuration change is represented by a TLV
 627  *      parameter as defined in Section 3.2. One or more requests may
 628  *      be present in an ASCONF Chunk.
 629  *
 630  * Section 3.1.2 Address Configuration Acknowledgement Chunk (ASCONF-ACK)
 631  *
 632  *      Serial Number: 32 bits (unsigned integer)
 633  *      This value represents the Serial Number for the received ASCONF
 634  *      Chunk that is acknowledged by this chunk. This value is copied
 635  *      from the received ASCONF Chunk.
 636  *
 637  *      ASCONF Parameter Response: TLV format
 638  *      The ASCONF Parameter Response is used in the ASCONF-ACK to
 639  *      report status of ASCONF processing.
 640  */
 641 typedef struct sctp_addip_param {
 642         struct sctp_paramhdr    param_hdr;
 643         __be32          crr_id;
 644 } sctp_addip_param_t;
 645
 646 typedef struct sctp_addiphdr {
 647         __be32  serial;
 648         __u8    params[0];
 649 } sctp_addiphdr_t;
 650
 651 typedef struct sctp_addip_chunk {
 652         struct sctp_chunkhdr chunk_hdr;
 653         sctp_addiphdr_t addip_hdr;
 654 } sctp_addip_chunk_t;
 655
 656 /* AUTH
 657  * Section 4.1  Authentication Chunk (AUTH)
 658  *
 659  *   This chunk is used to hold the result of the HMAC calculation.
 660  *
 661  *    0                   1                   2                   3
 662  *    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 663  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 664  *   | Type = 0x0F   |   Flags=0     |             Length            |
 665  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 666  *   |     Shared Key Identifier     |   HMAC Identifier             |
 667  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 668  *   |                                                               |
 669  *   \                             HMAC                              /
 670  *   /                                                               \
 671  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 672  *
 673  *   Type: 1 byte (unsigned integer)
 674  *      This value MUST be set to 0x0F for  all AUTH-chunks.
 675  *
 676  *   Flags: 1 byte (unsigned integer)
 677  *      Set to zero on transmit and ignored on receipt.
 678  *
 679  *   Length: 2 bytes (unsigned integer)
 680  *      This value holds the length of the HMAC in bytes plus 8.
 681  *
 682  *  Shared Key Identifier: 2 bytes (unsigned integer)
 683  *      This value describes which endpoint pair shared key is used.
 684  *
 685  *   HMAC Identifier: 2 bytes (unsigned integer)
 686  *      This value describes which message digest is being used.  Table 2
 687  *      shows the currently defined values.
 688  *
 689  *    The following Table 2 shows the currently defined values for HMAC
 690  *       identifiers.
 691  *
 692  *       +-----------------+--------------------------+
 693  *       | HMAC Identifier | Message Digest Algorithm |
 694  *       +-----------------+--------------------------+
 695  *       | 0               | Reserved                 |
 696  *       | 1               | SHA-1 defined in [8]     |
 697  *       | 2               | Reserved                 |
 698  *       | 3               | SHA-256 defined in [8]   |
 699  *       +-----------------+--------------------------+
 700  *
 701  *
 702  *   HMAC: n bytes (unsigned integer) This hold the result of the HMAC
 703  *      calculation.
 704  */
 705 typedef struct sctp_authhdr {
 706         __be16 shkey_id;
 707         __be16 hmac_id;
 708         __u8   hmac[0];
 709 } sctp_authhdr_t;
 710
 711 typedef struct sctp_auth_chunk {
 712         struct sctp_chunkhdr chunk_hdr;
 713         sctp_authhdr_t auth_hdr;
 714 } sctp_auth_chunk_t;
 715
 716 struct sctp_infox {
 717         struct sctp_info *sctpinfo;
 718         struct sctp_association *asoc;
 719 };
 720
 721 struct sctp_reconf_chunk {
 722         struct sctp_chunkhdr chunk_hdr;
 723         __u8 params[0];
 724 };
 725
 726 struct sctp_strreset_outreq {
 727         struct sctp_paramhdr param_hdr;
 728         __u32 request_seq;
 729         __u32 response_seq;
 730         __u32 send_reset_at_tsn;
 731         __u16 list_of_streams[0];
 732 };
 733
 734 struct sctp_strreset_inreq {
 735         struct sctp_paramhdr param_hdr;
 736         __u32 request_seq;
 737         __u16 list_of_streams[0];
 738 };
 739
 740 struct sctp_strreset_tsnreq {
 741         struct sctp_paramhdr param_hdr;
 742         __u32 request_seq;
 743 };
 744
 745 struct sctp_strreset_addstrm {
 746         struct sctp_paramhdr param_hdr;
 747         __u32 request_seq;
 748         __u16 number_of_streams;
 749         __u16 reserved;
 750 };
 751
 752 enum {
 753         SCTP_STRRESET_NOTHING_TO_DO     = 0x00,
 754         SCTP_STRRESET_PERFORMED         = 0x01,
 755         SCTP_STRRESET_DENIED            = 0x02,
 756         SCTP_STRRESET_ERR_WRONG_SSN     = 0x03,
 757         SCTP_STRRESET_ERR_IN_PROGRESS   = 0x04,
 758         SCTP_STRRESET_ERR_BAD_SEQNO     = 0x05,
 759         SCTP_STRRESET_IN_PROGRESS       = 0x06,
 760 };
 761
 762 struct sctp_strreset_resp {
 763         struct sctp_paramhdr param_hdr;
 764         __u32 response_seq;
 765         __u32 result;
 766 };
 767
 768 struct sctp_strreset_resptsn {
 769         struct sctp_paramhdr param_hdr;
 770         __u32 response_seq;
 771         __u32 result;
 772         __u32 senders_next_tsn;
 773         __u32 receivers_next_tsn;
 774 };
 775
 776 #endif /* __LINUX_SCTP_H__ */