sys/netinet/sctp.h

   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 /* $KAME: sctp.h,v 1.18 2005/03/06 16:04:16 itojun Exp $         */
  31
  32 #include <sys/cdefs.h>
  33 __FBSDID("$FreeBSD$");
  34
  35 #ifndef _NETINET_SCTP_H_
  36 #define _NETINET_SCTP_H_
  37
  38 #include <sys/types.h>
  39
  40 /*
  41  * SCTP protocol - RFC2960.
  42  */
  43
  44 struct sctphdr {
  45         uint16_t src_port;      /* source port */
  46         uint16_t dest_port;     /* destination port */
  47         uint32_t v_tag;         /* verification tag of packet */
  48         uint32_t checksum;      /* Adler32 C-Sum */
  49         /* chunks follow... */
  50 };
  51
  52 /*
  53  * SCTP Chunks
  54  */
  55 struct sctp_chunkhdr {
  56         uint8_t chunk_type;     /* chunk type */
  57         uint8_t chunk_flags;    /* chunk flags */
  58         uint16_t chunk_length;  /* chunk length */
  59         /* optional params follow */
  60 };
  61
  62 /*
  63  * SCTP chunk parameters
  64  */
  65 struct sctp_paramhdr {
  66         uint16_t param_type;    /* parameter type */
  67         uint16_t param_length;  /* parameter length */
  68 };
  69
  70 /*
  71  * user socket options: socket API defined
  72  */
  73 /*
  74  * read-write options
  75  */
  76 #define SCTP_RTOINFO                    0x00000001
  77 #define SCTP_ASSOCINFO                  0x00000002
  78 #define SCTP_INITMSG                    0x00000003
  79 #define SCTP_NODELAY                    0x00000004
  80 #define SCTP_AUTOCLOSE                  0x00000005
  81 #define SCTP_SET_PEER_PRIMARY_ADDR      0x00000006
  82 #define SCTP_PRIMARY_ADDR               0x00000007
  83 #define SCTP_ADAPTATION_LAYER           0x00000008
  84 /* same as above */
  85 #define SCTP_ADAPTION_LAYER             0x00000008
  86 #define SCTP_DISABLE_FRAGMENTS          0x00000009
  87 #define SCTP_PEER_ADDR_PARAMS           0x0000000a
  88 #define SCTP_DEFAULT_SEND_PARAM         0x0000000b
  89 /* ancillary data/notification interest options */
  90 #define SCTP_EVENTS                     0x0000000c
  91 /* Without this applied we will give V4 and V6 addresses on a V6 socket */
  92 #define SCTP_I_WANT_MAPPED_V4_ADDR      0x0000000d
  93 #define SCTP_MAXSEG                     0x0000000e
  94 #define SCTP_DELAYED_ACK_TIME           0x0000000f
  95 #define SCTP_FRAGMENT_INTERLEAVE        0x00000010
  96 #define SCTP_PARTIAL_DELIVERY_POINT     0x00000011
  97 /* authentication support */
  98 #define SCTP_AUTH_CHUNK                 0x00000012
  99 #define SCTP_AUTH_KEY                   0x00000013
 100 #define SCTP_HMAC_IDENT                 0x00000014
 101 #define SCTP_AUTH_ACTIVE_KEY            0x00000015
 102 #define SCTP_AUTH_DELETE_KEY            0x00000016
 103 #define SCTP_USE_EXT_RCVINFO            0x00000017
 104 #define SCTP_AUTO_ASCONF                0x00000018      /* rw */
 105 #define SCTP_MAXBURST                   0x00000019      /* rw */
 106 /* assoc level context */
 107 #define SCTP_CONTEXT                    0x0000001a      /* rw */
 108 /* explict EOR signalling */
 109 #define SCTP_EXPLICIT_EOR               0x0000001b
 110
 111 /*
 112  * read-only options
 113  */
 114 #define SCTP_STATUS                     0x00000100
 115 #define SCTP_GET_PEER_ADDR_INFO         0x00000101
 116 /* authentication support */
 117 #define SCTP_PEER_AUTH_CHUNKS           0x00000102
 118 #define SCTP_LOCAL_AUTH_CHUNKS          0x00000103
 119
 120
 121 /*
 122  * user socket options: BSD implementation specific
 123  */
 124 /*
 125  * Blocking I/O is enabled on any TCP type socket by default. For the UDP
 126  * model if this is turned on then the socket buffer is shared for send
 127  * resources amongst all associations.  The default for the UDP model is that
 128  * is SS_NBIO is set.  Which means all associations have a seperate send
 129  * limit BUT they will NOT ever BLOCK instead you will get an error back
 130  * EAGAIN if you try to send to much. If you want the blocking symantics you
 131  * set this option at the cost of sharing one socket send buffer size amongst
 132  * all associations. Peeled off sockets turn this option off and block. But
 133  * since both TCP and peeled off sockets have only one assoc per socket this
 134  * is fine. It probably does NOT make sense to set this on SS_NBIO on a TCP
 135  * model OR peeled off UDP model, but we do allow you to do so. You just use
 136  * the normal syscall to toggle SS_NBIO the way you want.
 137  *
 138  * Blocking I/O is controled by the SS_NBIO flag on the socket state so_state
 139  * field.
 140  */
 141
 142 /* these should probably go into sockets API */
 143 #define SCTP_RESET_STREAMS              0x00001004      /* wo */
 144
 145
 146 /* here on down are more implementation specific */
 147 #define SCTP_SET_DEBUG_LEVEL            0x00001005
 148 #define SCTP_CLR_STAT_LOG               0x00001007
 149 /* CMT ON/OFF socket option */
 150 #define SCTP_CMT_ON_OFF                 0x00001200
 151 #define SCTP_CMT_USE_DAC                0x00001201
 152
 153 /* read only */
 154 #define SCTP_GET_SNDBUF_USE             0x00001101
 155 #define SCTP_GET_STAT_LOG               0x00001103
 156 #define SCTP_GET_ASOC_ID_LIST           0x00001104      /* ro */
 157 #define SCTP_PCB_STATUS                 0x00001105
 158 #define SCTP_GET_NONCE_VALUES           0x00001106
 159
 160 /* Special hook for dynamically setting primary for all assoc's,
 161  * this is a write only option that requires root privledge.
 162  */
 163 #define SCTP_SET_DYNAMIC_PRIMARY        0x00002001
 164
 165 /* VRF (virtual router feature) and multi-VRF support
 166  * options. VRF's provide splits within a router
 167  * that give the views of multiple routers. A
 168  * standard host, without VRF support, is just
 169  * a single VRF. If VRF's are supported then
 170  * the transport must be VRF aware. This means
 171  * that every socket call coming in must be directed
 172  * within the endpoint to one of the VRF's it belongs
 173  * to. The endpoint, before binding, may select
 174  * the "default" VRF it is in by using a set socket
 175  * option with SCTP_VRF_ID. This will also
 176  * get propegated to the default VRF. Once the
 177  * endpoint binds an address then it CANNOT add
 178  * additional VRF's to become a Multi-VRF endpoint.
 179  *
 180  * Before BINDING additional VRF's can be added with
 181  * the SCTP_ADD_VRF_ID call or deleted with
 182  * SCTP_DEL_VRF_ID.
 183  *
 184  * Associations are ALWAYS contained inside a single
 185  * VRF. They cannot reside in two (or more) VRF's. Incoming
 186  * packets, assuming the router is VRF aware, can always
 187  * tell us what VRF they arrived on. A host not supporting
 188  * any VRF's will find that the packets always arrived on the
 189  * single VRF that the host has.
 190  *
 191  */
 192
 193 #define SCTP_VRF_ID                     0x00003001
 194 #define SCTP_ADD_VRF_ID                 0x00003002
 195 #define SCTP_GET_VRF_IDS                0x00003003
 196 #define SCTP_GET_ASOC_VRF               0x00003004
 197 #define SCTP_DEL_VRF_ID                 0x00003005
 198 /*
 199  * hidden implementation specific options these are NOT user visible (should
 200  * move out of sctp.h)
 201  */
 202 /* sctp_bindx() flags as hidden socket options */
 203 #define SCTP_BINDX_ADD_ADDR             0x00008001
 204 #define SCTP_BINDX_REM_ADDR             0x00008002
 205 /* Hidden socket option that gets the addresses */
 206 #define SCTP_GET_PEER_ADDRESSES         0x00008003
 207 #define SCTP_GET_LOCAL_ADDRESSES        0x00008004
 208 /* return the total count in bytes needed to hold all local addresses bound */
 209 #define SCTP_GET_LOCAL_ADDR_SIZE        0x00008005
 210 /* Return the total count in bytes needed to hold the remote address */
 211 #define SCTP_GET_REMOTE_ADDR_SIZE       0x00008006
 212 /* hidden option for connectx */
 213 #define SCTP_CONNECT_X                  0x00008007
 214 /* hidden option for connectx_delayed, part of sendx */
 215 #define SCTP_CONNECT_X_DELAYED          0x00008008
 216 #define SCTP_CONNECT_X_COMPLETE         0x00008009
 217 /* hidden socket option based sctp_peeloff */
 218 #define SCTP_PEELOFF                    0x0000800a
 219 /* the real worker for sctp_getaddrlen() */
 220 #define SCTP_GET_ADDR_LEN               0x0000800b
 221 /* temporary workaround for Apple listen() issue, no args used */
 222 #define SCTP_LISTEN_FIX                 0x0000800c
 223 /* Debug things that need to be purged */
 224 #define SCTP_SET_INITIAL_DBG_SEQ        0x00009f00
 225
 226 /*
 227  * user state values
 228  */
 229 #define SCTP_CLOSED                     0x0000
 230 #define SCTP_BOUND                      0x1000
 231 #define SCTP_LISTEN                     0x2000
 232 #define SCTP_COOKIE_WAIT                0x0002
 233 #define SCTP_COOKIE_ECHOED              0x0004
 234 #define SCTP_ESTABLISHED                0x0008
 235 #define SCTP_SHUTDOWN_SENT              0x0010
 236 #define SCTP_SHUTDOWN_RECEIVED          0x0020
 237 #define SCTP_SHUTDOWN_ACK_SENT          0x0040
 238 #define SCTP_SHUTDOWN_PENDING           0x0080
 239
 240 /*
 241  * SCTP operational error codes (user visible)
 242  */
 243 #define SCTP_CAUSE_NO_ERROR             0x0000
 244 #define SCTP_CAUSE_INVALID_STREAM       0x0001
 245 #define SCTP_CAUSE_MISSING_PARAM        0x0002
 246 #define SCTP_CAUSE_STALE_COOKIE         0x0003
 247 #define SCTP_CAUSE_OUT_OF_RESC          0x0004
 248 #define SCTP_CAUSE_UNRESOLVABLE_ADDR    0x0005
 249 #define SCTP_CAUSE_UNRECOG_CHUNK        0x0006
 250 #define SCTP_CAUSE_INVALID_PARAM        0x0007
 251 #define SCTP_CAUSE_UNRECOG_PARAM        0x0008
 252 #define SCTP_CAUSE_NO_USER_DATA         0x0009
 253 #define SCTP_CAUSE_COOKIE_IN_SHUTDOWN   0x000a
 254 #define SCTP_CAUSE_RESTART_W_NEWADDR    0x000b
 255 #define SCTP_CAUSE_USER_INITIATED_ABT   0x000c
 256 #define SCTP_CAUSE_PROTOCOL_VIOLATION   0x000d
 257
 258 /* Error causes from draft-ietf-tsvwg-addip-sctp */
 259 #define SCTP_CAUSE_DELETING_LAST_ADDR   0x0100
 260 #define SCTP_CAUSE_RESOURCE_SHORTAGE    0x0101
 261 #define SCTP_CAUSE_DELETING_SRC_ADDR    0x0102
 262 #define SCTP_CAUSE_ILLEGAL_ASCONF_ACK   0x0103
 263 #define SCTP_CAUSE_REQUEST_REFUSED      0x0104
 264
 265 /* Error causes from draft-ietf-tsvwg-sctp-auth */
 266 #define SCTP_CAUSE_UNSUPPORTED_HMACID   0x0105
 267
 268 /*
 269  * error cause parameters (user visisble)
 270  */
 271 struct sctp_error_cause {
 272         uint16_t code;
 273         uint16_t length;
 274         /* optional cause-specific info may follow */
 275 };
 276
 277 struct sctp_error_invalid_stream {
 278         struct sctp_error_cause cause;  /* code=SCTP_ERROR_INVALID_STREAM */
 279         uint16_t stream_id;     /* stream id of the DATA in error */
 280         uint16_t reserved;
 281 };
 282
 283 struct sctp_error_missing_param {
 284         struct sctp_error_cause cause;  /* code=SCTP_ERROR_MISSING_PARAM */
 285         uint32_t num_missing_params;    /* number of missing parameters */
 286         /* uint16_t param_type's follow */
 287 };
 288
 289 struct sctp_error_stale_cookie {
 290         struct sctp_error_cause cause;  /* code=SCTP_ERROR_STALE_COOKIE */
 291         uint32_t stale_time;    /* time in usec of staleness */
 292 };
 293
 294 struct sctp_error_out_of_resource {
 295         struct sctp_error_cause cause;  /* code=SCTP_ERROR_OUT_OF_RESOURCES */
 296 };
 297
 298 struct sctp_error_unresolv_addr {
 299         struct sctp_error_cause cause;  /* code=SCTP_ERROR_UNRESOLVABLE_ADDR */
 300
 301 };
 302
 303 struct sctp_error_unrecognized_chunk {
 304         struct sctp_error_cause cause;  /* code=SCTP_ERROR_UNRECOG_CHUNK */
 305         struct sctp_chunkhdr ch;/* header from chunk in error */
 306 };
 307
 308 #define HAVE_SCTP                       1
 309 #define HAVE_KERNEL_SCTP                1
 310 #define HAVE_SCTP_PRSCTP                1
 311 #define HAVE_SCTP_ADDIP                 1
 312 #define HAVE_SCTP_CANSET_PRIMARY        1
 313 #define HAVE_SCTP_SAT_CAPABILITY        1
 314 #define HAVE_SCTP_MULTIBUF              1
 315 #define HAVE_SCTP_NOCONNECT             0
 316 #define HAVE_SCTP_ECN_NONCE             1       /* ECN Nonce option */
 317 #define HAVE_SCTP_AUTH                  1
 318 #define HAVE_SCTP_EXT_RCVINFO           1
 319 #define HAVE_SCTP_CONNECTX              1
 320 /*
 321  * Main SCTP chunk types we place these here so natd and f/w's in user land
 322  * can find them.
 323  */
 324 /************0x00 series ***********/
 325 #define SCTP_DATA               0x00
 326 #define SCTP_INITIATION         0x01
 327 #define SCTP_INITIATION_ACK     0x02
 328 #define SCTP_SELECTIVE_ACK      0x03
 329 #define SCTP_HEARTBEAT_REQUEST  0x04
 330 #define SCTP_HEARTBEAT_ACK      0x05
 331 #define SCTP_ABORT_ASSOCIATION  0x06
 332 #define SCTP_SHUTDOWN           0x07
 333 #define SCTP_SHUTDOWN_ACK       0x08
 334 #define SCTP_OPERATION_ERROR    0x09
 335 #define SCTP_COOKIE_ECHO        0x0a
 336 #define SCTP_COOKIE_ACK         0x0b
 337 #define SCTP_ECN_ECHO           0x0c
 338 #define SCTP_ECN_CWR            0x0d
 339 #define SCTP_SHUTDOWN_COMPLETE  0x0e
 340 /* draft-ietf-tsvwg-sctp-auth */
 341 #define SCTP_AUTHENTICATION     0x0f
 342 /************0x40 series ***********/
 343 /************0x80 series ***********/
 344 /* draft-ietf-tsvwg-addip-sctp */
 345 #define SCTP_ASCONF_ACK         0x80
 346 /* draft-ietf-stewart-pktdrpsctp */
 347 #define SCTP_PACKET_DROPPED     0x81
 348 /* draft-ietf-stewart-strreset-xxx */
 349 #define SCTP_STREAM_RESET       0x82
 350 /************0xc0 series ***********/
 351 /* RFC3758 */
 352 #define SCTP_FORWARD_CUM_TSN    0xc0
 353 /* draft-ietf-tsvwg-addip-sctp */
 354 #define SCTP_ASCONF             0xc1
 355
 356
 357 /* ABORT and SHUTDOWN COMPLETE FLAG */
 358 #define SCTP_HAD_NO_TCB         0x01
 359
 360 /* Packet dropped flags */
 361 #define SCTP_FROM_MIDDLE_BOX    SCTP_HAD_NO_TCB
 362 #define SCTP_BADCRC             0x02
 363 #define SCTP_PACKET_TRUNCATED   0x04
 364
 365 #define SCTP_SAT_NETWORK_MIN    400     /* min ms for RTT to set satellite
 366                                          * time */
 367 #define SCTP_SAT_NETWORK_BURST_INCR  2  /* how many times to multiply maxburst
 368                                          * in sat */
 369
 370 /* Data Chuck Specific Flags */
 371 #define SCTP_DATA_FRAG_MASK     0x03
 372 #define SCTP_DATA_MIDDLE_FRAG   0x00
 373 #define SCTP_DATA_LAST_FRAG     0x01
 374 #define SCTP_DATA_FIRST_FRAG    0x02
 375 #define SCTP_DATA_NOT_FRAG      0x03
 376 #define SCTP_DATA_UNORDERED     0x04
 377
 378 /* ECN Nonce: SACK Chunk Specific Flags */
 379 #define SCTP_SACK_NONCE_SUM     0x01
 380
 381 /* CMT DAC algorithm SACK flag */
 382 #define SCTP_SACK_CMT_DAC       0x80
 383
 384 #include <netinet/sctp_uio.h>
 385
 386 #endif                          /* !_NETINET_SCTP_H_ */