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 struct sctp_ipv4addr_param {
 277         struct sctp_paramhdr param_hdr;
 278         struct in_addr addr;
 279 };
 280
 281 /* Section 3.3.2.1. IPv6 Address Parameter (6) */
 282 struct sctp_ipv6addr_param {
 283         struct sctp_paramhdr param_hdr;
 284         struct in6_addr addr;
 285 };
 286
 287 /* Section 3.3.2.1 Cookie Preservative (9) */
 288 struct sctp_cookie_preserve_param {
 289         struct sctp_paramhdr param_hdr;
 290         __be32 lifespan_increment;
 291 };
 292
 293 /* Section 3.3.2.1 Host Name Address (11) */
 294 struct sctp_hostname_param {
 295         struct sctp_paramhdr param_hdr;
 296         uint8_t hostname[0];
 297 };
 298
 299 /* Section 3.3.2.1 Supported Address Types (12) */
 300 struct sctp_supported_addrs_param {
 301         struct sctp_paramhdr param_hdr;
 302         __be16 types[0];
 303 };
 304
 305 /* ADDIP Section 3.2.6 Adaptation Layer Indication */
 306 struct sctp_adaptation_ind_param {
 307         struct sctp_paramhdr param_hdr;
 308         __be32 adaptation_ind;
 309 };
 310
 311 /* ADDIP Section 4.2.7 Supported Extensions Parameter */
 312 struct sctp_supported_ext_param {
 313         struct sctp_paramhdr param_hdr;
 314         __u8 chunks[0];
 315 };
 316
 317 /* AUTH Section 3.1 Random */
 318 struct sctp_random_param {
 319         struct sctp_paramhdr param_hdr;
 320         __u8 random_val[0];
 321 };
 322
 323 /* AUTH Section 3.2 Chunk List */
 324 struct sctp_chunks_param {
 325         struct sctp_paramhdr param_hdr;
 326         __u8 chunks[0];
 327 };
 328
 329 /* AUTH Section 3.3 HMAC Algorithm */
 330 struct sctp_hmac_algo_param {
 331         struct sctp_paramhdr param_hdr;
 332         __be16 hmac_ids[0];
 333 };
 334
 335 /* RFC 2960.  Section 3.3.3 Initiation Acknowledgement (INIT ACK) (2):
 336  *   The INIT ACK chunk is used to acknowledge the initiation of an SCTP
 337  *   association.
 338  */
 339 struct sctp_initack_chunk {
 340         struct sctp_chunkhdr chunk_hdr;
 341         struct sctp_inithdr init_hdr;
 342 };
 343
 344 /* Section 3.3.3.1 State Cookie (7) */
 345 struct sctp_cookie_param {
 346         struct sctp_paramhdr p;
 347         __u8 body[0];
 348 };
 349
 350 /* Section 3.3.3.1 Unrecognized Parameters (8) */
 351 typedef struct sctp_unrecognized_param {
 352         struct sctp_paramhdr param_hdr;
 353         struct sctp_paramhdr unrecognized;
 354 } sctp_unrecognized_param_t;
 355
 356
 357
 358 /*
 359  * 3.3.4 Selective Acknowledgement (SACK) (3):
 360  *
 361  *  This chunk is sent to the peer endpoint to acknowledge received DATA
 362  *  chunks and to inform the peer endpoint of gaps in the received
 363  *  subsequences of DATA chunks as represented by their TSNs.
 364  */
 365
 366 typedef struct sctp_gap_ack_block {
 367         __be16 start;
 368         __be16 end;
 369 } sctp_gap_ack_block_t;
 370
 371 typedef __be32 sctp_dup_tsn_t;
 372
 373 typedef union {
 374         sctp_gap_ack_block_t    gab;
 375         sctp_dup_tsn_t          dup;
 376 } sctp_sack_variable_t;
 377
 378 typedef struct sctp_sackhdr {
 379         __be32 cum_tsn_ack;
 380         __be32 a_rwnd;
 381         __be16 num_gap_ack_blocks;
 382         __be16 num_dup_tsns;
 383         sctp_sack_variable_t variable[0];
 384 } sctp_sackhdr_t;
 385
 386 typedef struct sctp_sack_chunk {
 387         struct sctp_chunkhdr chunk_hdr;
 388         sctp_sackhdr_t sack_hdr;
 389 } sctp_sack_chunk_t;
 390
 391
 392 /* RFC 2960.  Section 3.3.5 Heartbeat Request (HEARTBEAT) (4):
 393  *
 394  *  An endpoint should send this chunk to its peer endpoint to probe the
 395  *  reachability of a particular destination transport address defined in
 396  *  the present association.
 397  */
 398
 399 typedef struct sctp_heartbeathdr {
 400         struct sctp_paramhdr info;
 401 } sctp_heartbeathdr_t;
 402
 403 typedef struct sctp_heartbeat_chunk {
 404         struct sctp_chunkhdr chunk_hdr;
 405         sctp_heartbeathdr_t hb_hdr;
 406 } sctp_heartbeat_chunk_t;
 407
 408
 409 /* For the abort and shutdown ACK we must carry the init tag in the
 410  * common header. Just the common header is all that is needed with a
 411  * chunk descriptor.
 412  */
 413 typedef struct sctp_abort_chunk {
 414         struct sctp_chunkhdr uh;
 415 } sctp_abort_chunk_t;
 416
 417
 418 /* For the graceful shutdown we must carry the tag (in common header)
 419  * and the highest consecutive acking value.
 420  */
 421 typedef struct sctp_shutdownhdr {
 422         __be32 cum_tsn_ack;
 423 } sctp_shutdownhdr_t;
 424
 425 struct sctp_shutdown_chunk_t {
 426         struct sctp_chunkhdr chunk_hdr;
 427         sctp_shutdownhdr_t shutdown_hdr;
 428 };
 429
 430 /* RFC 2960.  Section 3.3.10 Operation Error (ERROR) (9) */
 431
 432 typedef struct sctp_errhdr {
 433         __be16 cause;
 434         __be16 length;
 435         __u8  variable[0];
 436 } sctp_errhdr_t;
 437
 438 typedef struct sctp_operr_chunk {
 439         struct sctp_chunkhdr chunk_hdr;
 440         sctp_errhdr_t err_hdr;
 441 } sctp_operr_chunk_t;
 442
 443 /* RFC 2960 3.3.10 - Operation Error
 444  *
 445  * Cause Code: 16 bits (unsigned integer)
 446  *
 447  *     Defines the type of error conditions being reported.
 448  *    Cause Code
 449  *     Value           Cause Code
 450  *     ---------      ----------------
 451  *      1              Invalid Stream Identifier
 452  *      2              Missing Mandatory Parameter
 453  *      3              Stale Cookie Error
 454  *      4              Out of Resource
 455  *      5              Unresolvable Address
 456  *      6              Unrecognized Chunk Type
 457  *      7              Invalid Mandatory Parameter
 458  *      8              Unrecognized Parameters
 459  *      9              No User Data
 460  *     10              Cookie Received While Shutting Down
 461  */
 462 typedef enum {
 463
 464         SCTP_ERROR_NO_ERROR        = cpu_to_be16(0x00),
 465         SCTP_ERROR_INV_STRM        = cpu_to_be16(0x01),
 466         SCTP_ERROR_MISS_PARAM      = cpu_to_be16(0x02),
 467         SCTP_ERROR_STALE_COOKIE    = cpu_to_be16(0x03),
 468         SCTP_ERROR_NO_RESOURCE     = cpu_to_be16(0x04),
 469         SCTP_ERROR_DNS_FAILED      = cpu_to_be16(0x05),
 470         SCTP_ERROR_UNKNOWN_CHUNK   = cpu_to_be16(0x06),
 471         SCTP_ERROR_INV_PARAM       = cpu_to_be16(0x07),
 472         SCTP_ERROR_UNKNOWN_PARAM   = cpu_to_be16(0x08),
 473         SCTP_ERROR_NO_DATA         = cpu_to_be16(0x09),
 474         SCTP_ERROR_COOKIE_IN_SHUTDOWN = cpu_to_be16(0x0a),
 475
 476
 477         /* SCTP Implementation Guide:
 478          *  11  Restart of an association with new addresses
 479          *  12  User Initiated Abort
 480          *  13  Protocol Violation
 481          */
 482
 483         SCTP_ERROR_RESTART         = cpu_to_be16(0x0b),
 484         SCTP_ERROR_USER_ABORT      = cpu_to_be16(0x0c),
 485         SCTP_ERROR_PROTO_VIOLATION = cpu_to_be16(0x0d),
 486
 487         /* ADDIP Section 3.3  New Error Causes
 488          *
 489          * Four new Error Causes are added to the SCTP Operational Errors,
 490          * primarily for use in the ASCONF-ACK chunk.
 491          *
 492          * Value          Cause Code
 493          * ---------      ----------------
 494          * 0x00A0          Request to Delete Last Remaining IP Address.
 495          * 0x00A1          Operation Refused Due to Resource Shortage.
 496          * 0x00A2          Request to Delete Source IP Address.
 497          * 0x00A3          Association Aborted due to illegal ASCONF-ACK
 498          * 0x00A4          Request refused - no authorization.
 499          */
 500         SCTP_ERROR_DEL_LAST_IP  = cpu_to_be16(0x00A0),
 501         SCTP_ERROR_RSRC_LOW     = cpu_to_be16(0x00A1),
 502         SCTP_ERROR_DEL_SRC_IP   = cpu_to_be16(0x00A2),
 503         SCTP_ERROR_ASCONF_ACK   = cpu_to_be16(0x00A3),
 504         SCTP_ERROR_REQ_REFUSED  = cpu_to_be16(0x00A4),
 505
 506         /* AUTH Section 4.  New Error Cause
 507          *
 508          * This section defines a new error cause that will be sent if an AUTH
 509          * chunk is received with an unsupported HMAC identifier.
 510          * illustrates the new error cause.
 511          *
 512          * Cause Code      Error Cause Name
 513          * --------------------------------------------------------------
 514          * 0x0105          Unsupported HMAC Identifier
 515          */
 516          SCTP_ERROR_UNSUP_HMAC  = cpu_to_be16(0x0105)
 517 } sctp_error_t;
 518
 519
 520
 521 /* RFC 2960.  Appendix A.  Explicit Congestion Notification.
 522  *   Explicit Congestion Notification Echo (ECNE) (12)
 523  */
 524 typedef struct sctp_ecnehdr {
 525         __be32 lowest_tsn;
 526 } sctp_ecnehdr_t;
 527
 528 typedef struct sctp_ecne_chunk {
 529         struct sctp_chunkhdr chunk_hdr;
 530         sctp_ecnehdr_t ence_hdr;
 531 } sctp_ecne_chunk_t;
 532
 533 /* RFC 2960.  Appendix A.  Explicit Congestion Notification.
 534  *   Congestion Window Reduced (CWR) (13)
 535  */
 536 typedef struct sctp_cwrhdr {
 537         __be32 lowest_tsn;
 538 } sctp_cwrhdr_t;
 539
 540 typedef struct sctp_cwr_chunk {
 541         struct sctp_chunkhdr chunk_hdr;
 542         sctp_cwrhdr_t cwr_hdr;
 543 } sctp_cwr_chunk_t;
 544
 545 /* PR-SCTP
 546  * 3.2 Forward Cumulative TSN Chunk Definition (FORWARD TSN)
 547  *
 548  * Forward Cumulative TSN chunk has the following format:
 549  *
 550  *        0                   1                   2                   3
 551  *        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
 552  *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 553  *      |   Type = 192  |  Flags = 0x00 |        Length = Variable      |
 554  *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 555  *      |                      New Cumulative TSN                       |
 556  *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 557  *      |         Stream-1              |       Stream Sequence-1       |
 558  *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 559  *      \                                                               /
 560  *      /                                                               \
 561  *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 562  *      |         Stream-N              |       Stream Sequence-N       |
 563  *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 564  *
 565  *      Chunk Flags:
 566  *
 567  *        Set to all zeros on transmit and ignored on receipt.
 568  *
 569  *      New Cumulative TSN: 32 bit u_int
 570  *
 571  *       This indicates the new cumulative TSN to the data receiver. Upon
 572  *       the reception of this value, the data receiver MUST consider
 573  *       any missing TSNs earlier than or equal to this value as received
 574  *       and stop reporting them as gaps in any subsequent SACKs.
 575  *
 576  *      Stream-N: 16 bit u_int
 577  *
 578  *       This field holds a stream number that was skipped by this
 579  *       FWD-TSN.
 580  *
 581  *      Stream Sequence-N: 16 bit u_int
 582  *       This field holds the sequence number associated with the stream
 583  *       that was skipped. The stream sequence field holds the largest stream
 584  *       sequence number in this stream being skipped.  The receiver of
 585  *       the FWD-TSN's can use the Stream-N and Stream Sequence-N fields
 586  *       to enable delivery of any stranded TSN's that remain on the stream
 587  *       re-ordering queues. This field MUST NOT report TSN's corresponding
 588  *       to DATA chunk that are marked as unordered. For ordered DATA
 589  *       chunks this field MUST be filled in.
 590  */
 591 struct sctp_fwdtsn_skip {
 592         __be16 stream;
 593         __be16 ssn;
 594 };
 595
 596 struct sctp_fwdtsn_hdr {
 597         __be32 new_cum_tsn;
 598         struct sctp_fwdtsn_skip skip[0];
 599 };
 600
 601 struct sctp_fwdtsn_chunk {
 602         struct sctp_chunkhdr chunk_hdr;
 603         struct sctp_fwdtsn_hdr fwdtsn_hdr;
 604 };
 605
 606
 607 /* ADDIP
 608  * Section 3.1.1 Address Configuration Change Chunk (ASCONF)
 609  *
 610  *      Serial Number: 32 bits (unsigned integer)
 611  *      This value represents a Serial Number for the ASCONF Chunk. The
 612  *      valid range of Serial Number is from 0 to 2^32-1.
 613  *      Serial Numbers wrap back to 0 after reaching 2^32 -1.
 614  *
 615  *      Address Parameter: 8 or 20 bytes (depending on type)
 616  *      The address is an address of the sender of the ASCONF chunk,
 617  *      the address MUST be considered part of the association by the
 618  *      peer endpoint. This field may be used by the receiver of the
 619  *      ASCONF to help in finding the association. This parameter MUST
 620  *      be present in every ASCONF message i.e. it is a mandatory TLV
 621  *      parameter.
 622  *
 623  *      ASCONF Parameter: TLV format
 624  *      Each Address configuration change is represented by a TLV
 625  *      parameter as defined in Section 3.2. One or more requests may
 626  *      be present in an ASCONF Chunk.
 627  *
 628  * Section 3.1.2 Address Configuration Acknowledgement Chunk (ASCONF-ACK)
 629  *
 630  *      Serial Number: 32 bits (unsigned integer)
 631  *      This value represents the Serial Number for the received ASCONF
 632  *      Chunk that is acknowledged by this chunk. This value is copied
 633  *      from the received ASCONF Chunk.
 634  *
 635  *      ASCONF Parameter Response: TLV format
 636  *      The ASCONF Parameter Response is used in the ASCONF-ACK to
 637  *      report status of ASCONF processing.
 638  */
 639 typedef struct sctp_addip_param {
 640         struct sctp_paramhdr    param_hdr;
 641         __be32          crr_id;
 642 } sctp_addip_param_t;
 643
 644 typedef struct sctp_addiphdr {
 645         __be32  serial;
 646         __u8    params[0];
 647 } sctp_addiphdr_t;
 648
 649 typedef struct sctp_addip_chunk {
 650         struct sctp_chunkhdr chunk_hdr;
 651         sctp_addiphdr_t addip_hdr;
 652 } sctp_addip_chunk_t;
 653
 654 /* AUTH
 655  * Section 4.1  Authentication Chunk (AUTH)
 656  *
 657  *   This chunk is used to hold the result of the HMAC calculation.
 658  *
 659  *    0                   1                   2                   3
 660  *    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
 661  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 662  *   | Type = 0x0F   |   Flags=0     |             Length            |
 663  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 664  *   |     Shared Key Identifier     |   HMAC Identifier             |
 665  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 666  *   |                                                               |
 667  *   \                             HMAC                              /
 668  *   /                                                               \
 669  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 670  *
 671  *   Type: 1 byte (unsigned integer)
 672  *      This value MUST be set to 0x0F for  all AUTH-chunks.
 673  *
 674  *   Flags: 1 byte (unsigned integer)
 675  *      Set to zero on transmit and ignored on receipt.
 676  *
 677  *   Length: 2 bytes (unsigned integer)
 678  *      This value holds the length of the HMAC in bytes plus 8.
 679  *
 680  *  Shared Key Identifier: 2 bytes (unsigned integer)
 681  *      This value describes which endpoint pair shared key is used.
 682  *
 683  *   HMAC Identifier: 2 bytes (unsigned integer)
 684  *      This value describes which message digest is being used.  Table 2
 685  *      shows the currently defined values.
 686  *
 687  *    The following Table 2 shows the currently defined values for HMAC
 688  *       identifiers.
 689  *
 690  *       +-----------------+--------------------------+
 691  *       | HMAC Identifier | Message Digest Algorithm |
 692  *       +-----------------+--------------------------+
 693  *       | 0               | Reserved                 |
 694  *       | 1               | SHA-1 defined in [8]     |
 695  *       | 2               | Reserved                 |
 696  *       | 3               | SHA-256 defined in [8]   |
 697  *       +-----------------+--------------------------+
 698  *
 699  *
 700  *   HMAC: n bytes (unsigned integer) This hold the result of the HMAC
 701  *      calculation.
 702  */
 703 typedef struct sctp_authhdr {
 704         __be16 shkey_id;
 705         __be16 hmac_id;
 706         __u8   hmac[0];
 707 } sctp_authhdr_t;
 708
 709 typedef struct sctp_auth_chunk {
 710         struct sctp_chunkhdr chunk_hdr;
 711         sctp_authhdr_t auth_hdr;
 712 } sctp_auth_chunk_t;
 713
 714 struct sctp_infox {
 715         struct sctp_info *sctpinfo;
 716         struct sctp_association *asoc;
 717 };
 718
 719 struct sctp_reconf_chunk {
 720         struct sctp_chunkhdr chunk_hdr;
 721         __u8 params[0];
 722 };
 723
 724 struct sctp_strreset_outreq {
 725         struct sctp_paramhdr param_hdr;
 726         __u32 request_seq;
 727         __u32 response_seq;
 728         __u32 send_reset_at_tsn;
 729         __u16 list_of_streams[0];
 730 };
 731
 732 struct sctp_strreset_inreq {
 733         struct sctp_paramhdr param_hdr;
 734         __u32 request_seq;
 735         __u16 list_of_streams[0];
 736 };
 737
 738 struct sctp_strreset_tsnreq {
 739         struct sctp_paramhdr param_hdr;
 740         __u32 request_seq;
 741 };
 742
 743 struct sctp_strreset_addstrm {
 744         struct sctp_paramhdr param_hdr;
 745         __u32 request_seq;
 746         __u16 number_of_streams;
 747         __u16 reserved;
 748 };
 749
 750 enum {
 751         SCTP_STRRESET_NOTHING_TO_DO     = 0x00,
 752         SCTP_STRRESET_PERFORMED         = 0x01,
 753         SCTP_STRRESET_DENIED            = 0x02,
 754         SCTP_STRRESET_ERR_WRONG_SSN     = 0x03,
 755         SCTP_STRRESET_ERR_IN_PROGRESS   = 0x04,
 756         SCTP_STRRESET_ERR_BAD_SEQNO     = 0x05,
 757         SCTP_STRRESET_IN_PROGRESS       = 0x06,
 758 };
 759
 760 struct sctp_strreset_resp {
 761         struct sctp_paramhdr param_hdr;
 762         __u32 response_seq;
 763         __u32 result;
 764 };
 765
 766 struct sctp_strreset_resptsn {
 767         struct sctp_paramhdr param_hdr;
 768         __u32 response_seq;
 769         __u32 result;
 770         __u32 senders_next_tsn;
 771         __u32 receivers_next_tsn;
 772 };
 773
 774 #endif /* __LINUX_SCTP_H__ */