Kobject: remove kobject_init() as no one uses it anymore
[linux-2.6/mini2440.git] / net / sctp / sm_statefuns.c
blobd247ed4ee42369c69aa8c8a3f26c83a370e906fc
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-2002 Intel Corp.
6 * Copyright (c) 2002 Nokia Corp.
8 * This file is part of the SCTP kernel reference Implementation
10 * This is part of the SCTP Linux Kernel Reference Implementation.
12 * These are the state functions for the state machine.
14 * The SCTP reference implementation is free software;
15 * you can redistribute it and/or modify it under the terms of
16 * the GNU General Public License as published by
17 * the Free Software Foundation; either version 2, or (at your option)
18 * any later version.
20 * The SCTP reference implementation is distributed in the hope that it
21 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
22 * ************************
23 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
24 * See the GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with GNU CC; see the file COPYING. If not, write to
28 * the Free Software Foundation, 59 Temple Place - Suite 330,
29 * Boston, MA 02111-1307, USA.
31 * Please send any bug reports or fixes you make to the
32 * email address(es):
33 * lksctp developers <lksctp-developers@lists.sourceforge.net>
35 * Or submit a bug report through the following website:
36 * http://www.sf.net/projects/lksctp
38 * Written or modified by:
39 * La Monte H.P. Yarroll <piggy@acm.org>
40 * Karl Knutson <karl@athena.chicago.il.us>
41 * Mathew Kotowsky <kotowsky@sctp.org>
42 * Sridhar Samudrala <samudrala@us.ibm.com>
43 * Jon Grimm <jgrimm@us.ibm.com>
44 * Hui Huang <hui.huang@nokia.com>
45 * Dajiang Zhang <dajiang.zhang@nokia.com>
46 * Daisy Chang <daisyc@us.ibm.com>
47 * Ardelle Fan <ardelle.fan@intel.com>
48 * Ryan Layer <rmlayer@us.ibm.com>
49 * Kevin Gao <kevin.gao@intel.com>
51 * Any bugs reported given to us we will try to fix... any fixes shared will
52 * be incorporated into the next SCTP release.
55 #include <linux/types.h>
56 #include <linux/kernel.h>
57 #include <linux/ip.h>
58 #include <linux/ipv6.h>
59 #include <linux/net.h>
60 #include <linux/inet.h>
61 #include <net/sock.h>
62 #include <net/inet_ecn.h>
63 #include <linux/skbuff.h>
64 #include <net/sctp/sctp.h>
65 #include <net/sctp/sm.h>
66 #include <net/sctp/structs.h>
68 static struct sctp_packet *sctp_abort_pkt_new(const struct sctp_endpoint *ep,
69 const struct sctp_association *asoc,
70 struct sctp_chunk *chunk,
71 const void *payload,
72 size_t paylen);
73 static int sctp_eat_data(const struct sctp_association *asoc,
74 struct sctp_chunk *chunk,
75 sctp_cmd_seq_t *commands);
76 static struct sctp_packet *sctp_ootb_pkt_new(const struct sctp_association *asoc,
77 const struct sctp_chunk *chunk);
78 static void sctp_send_stale_cookie_err(const struct sctp_endpoint *ep,
79 const struct sctp_association *asoc,
80 const struct sctp_chunk *chunk,
81 sctp_cmd_seq_t *commands,
82 struct sctp_chunk *err_chunk);
83 static sctp_disposition_t sctp_sf_do_5_2_6_stale(const struct sctp_endpoint *ep,
84 const struct sctp_association *asoc,
85 const sctp_subtype_t type,
86 void *arg,
87 sctp_cmd_seq_t *commands);
88 static sctp_disposition_t sctp_sf_shut_8_4_5(const struct sctp_endpoint *ep,
89 const struct sctp_association *asoc,
90 const sctp_subtype_t type,
91 void *arg,
92 sctp_cmd_seq_t *commands);
93 static sctp_disposition_t sctp_sf_tabort_8_4_8(const struct sctp_endpoint *ep,
94 const struct sctp_association *asoc,
95 const sctp_subtype_t type,
96 void *arg,
97 sctp_cmd_seq_t *commands);
98 static struct sctp_sackhdr *sctp_sm_pull_sack(struct sctp_chunk *chunk);
100 static sctp_disposition_t sctp_stop_t1_and_abort(sctp_cmd_seq_t *commands,
101 __be16 error, int sk_err,
102 const struct sctp_association *asoc,
103 struct sctp_transport *transport);
105 static sctp_disposition_t sctp_sf_abort_violation(
106 const struct sctp_endpoint *ep,
107 const struct sctp_association *asoc,
108 void *arg,
109 sctp_cmd_seq_t *commands,
110 const __u8 *payload,
111 const size_t paylen);
113 static sctp_disposition_t sctp_sf_violation_chunklen(
114 const struct sctp_endpoint *ep,
115 const struct sctp_association *asoc,
116 const sctp_subtype_t type,
117 void *arg,
118 sctp_cmd_seq_t *commands);
120 static sctp_disposition_t sctp_sf_violation_paramlen(
121 const struct sctp_endpoint *ep,
122 const struct sctp_association *asoc,
123 const sctp_subtype_t type,
124 void *arg,
125 sctp_cmd_seq_t *commands);
127 static sctp_disposition_t sctp_sf_violation_ctsn(
128 const struct sctp_endpoint *ep,
129 const struct sctp_association *asoc,
130 const sctp_subtype_t type,
131 void *arg,
132 sctp_cmd_seq_t *commands);
134 static sctp_disposition_t sctp_sf_violation_chunk(
135 const struct sctp_endpoint *ep,
136 const struct sctp_association *asoc,
137 const sctp_subtype_t type,
138 void *arg,
139 sctp_cmd_seq_t *commands);
141 static sctp_ierror_t sctp_sf_authenticate(const struct sctp_endpoint *ep,
142 const struct sctp_association *asoc,
143 const sctp_subtype_t type,
144 struct sctp_chunk *chunk);
146 /* Small helper function that checks if the chunk length
147 * is of the appropriate length. The 'required_length' argument
148 * is set to be the size of a specific chunk we are testing.
149 * Return Values: 1 = Valid length
150 * 0 = Invalid length
153 static inline int
154 sctp_chunk_length_valid(struct sctp_chunk *chunk,
155 __u16 required_length)
157 __u16 chunk_length = ntohs(chunk->chunk_hdr->length);
159 if (unlikely(chunk_length < required_length))
160 return 0;
162 return 1;
165 /**********************************************************
166 * These are the state functions for handling chunk events.
167 **********************************************************/
170 * Process the final SHUTDOWN COMPLETE.
172 * Section: 4 (C) (diagram), 9.2
173 * Upon reception of the SHUTDOWN COMPLETE chunk the endpoint will verify
174 * that it is in SHUTDOWN-ACK-SENT state, if it is not the chunk should be
175 * discarded. If the endpoint is in the SHUTDOWN-ACK-SENT state the endpoint
176 * should stop the T2-shutdown timer and remove all knowledge of the
177 * association (and thus the association enters the CLOSED state).
179 * Verification Tag: 8.5.1(C), sctpimpguide 2.41.
180 * C) Rules for packet carrying SHUTDOWN COMPLETE:
181 * ...
182 * - The receiver of a SHUTDOWN COMPLETE shall accept the packet
183 * if the Verification Tag field of the packet matches its own tag and
184 * the T bit is not set
185 * OR
186 * it is set to its peer's tag and the T bit is set in the Chunk
187 * Flags.
188 * Otherwise, the receiver MUST silently discard the packet
189 * and take no further action. An endpoint MUST ignore the
190 * SHUTDOWN COMPLETE if it is not in the SHUTDOWN-ACK-SENT state.
192 * Inputs
193 * (endpoint, asoc, chunk)
195 * Outputs
196 * (asoc, reply_msg, msg_up, timers, counters)
198 * The return value is the disposition of the chunk.
200 sctp_disposition_t sctp_sf_do_4_C(const struct sctp_endpoint *ep,
201 const struct sctp_association *asoc,
202 const sctp_subtype_t type,
203 void *arg,
204 sctp_cmd_seq_t *commands)
206 struct sctp_chunk *chunk = arg;
207 struct sctp_ulpevent *ev;
209 if (!sctp_vtag_verify_either(chunk, asoc))
210 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
212 /* RFC 2960 6.10 Bundling
214 * An endpoint MUST NOT bundle INIT, INIT ACK or
215 * SHUTDOWN COMPLETE with any other chunks.
217 if (!chunk->singleton)
218 return sctp_sf_violation_chunk(ep, asoc, type, arg, commands);
220 /* Make sure that the SHUTDOWN_COMPLETE chunk has a valid length. */
221 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_chunkhdr_t)))
222 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
223 commands);
225 /* RFC 2960 10.2 SCTP-to-ULP
227 * H) SHUTDOWN COMPLETE notification
229 * When SCTP completes the shutdown procedures (section 9.2) this
230 * notification is passed to the upper layer.
232 ev = sctp_ulpevent_make_assoc_change(asoc, 0, SCTP_SHUTDOWN_COMP,
233 0, 0, 0, NULL, GFP_ATOMIC);
234 if (ev)
235 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP,
236 SCTP_ULPEVENT(ev));
238 /* Upon reception of the SHUTDOWN COMPLETE chunk the endpoint
239 * will verify that it is in SHUTDOWN-ACK-SENT state, if it is
240 * not the chunk should be discarded. If the endpoint is in
241 * the SHUTDOWN-ACK-SENT state the endpoint should stop the
242 * T2-shutdown timer and remove all knowledge of the
243 * association (and thus the association enters the CLOSED
244 * state).
246 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
247 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
249 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
250 SCTP_TO(SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD));
252 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
253 SCTP_STATE(SCTP_STATE_CLOSED));
255 SCTP_INC_STATS(SCTP_MIB_SHUTDOWNS);
256 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
258 sctp_add_cmd_sf(commands, SCTP_CMD_DELETE_TCB, SCTP_NULL());
260 return SCTP_DISPOSITION_DELETE_TCB;
264 * Respond to a normal INIT chunk.
265 * We are the side that is being asked for an association.
267 * Section: 5.1 Normal Establishment of an Association, B
268 * B) "Z" shall respond immediately with an INIT ACK chunk. The
269 * destination IP address of the INIT ACK MUST be set to the source
270 * IP address of the INIT to which this INIT ACK is responding. In
271 * the response, besides filling in other parameters, "Z" must set the
272 * Verification Tag field to Tag_A, and also provide its own
273 * Verification Tag (Tag_Z) in the Initiate Tag field.
275 * Verification Tag: Must be 0.
277 * Inputs
278 * (endpoint, asoc, chunk)
280 * Outputs
281 * (asoc, reply_msg, msg_up, timers, counters)
283 * The return value is the disposition of the chunk.
285 sctp_disposition_t sctp_sf_do_5_1B_init(const struct sctp_endpoint *ep,
286 const struct sctp_association *asoc,
287 const sctp_subtype_t type,
288 void *arg,
289 sctp_cmd_seq_t *commands)
291 struct sctp_chunk *chunk = arg;
292 struct sctp_chunk *repl;
293 struct sctp_association *new_asoc;
294 struct sctp_chunk *err_chunk;
295 struct sctp_packet *packet;
296 sctp_unrecognized_param_t *unk_param;
297 int len;
299 /* 6.10 Bundling
300 * An endpoint MUST NOT bundle INIT, INIT ACK or
301 * SHUTDOWN COMPLETE with any other chunks.
303 * IG Section 2.11.2
304 * Furthermore, we require that the receiver of an INIT chunk MUST
305 * enforce these rules by silently discarding an arriving packet
306 * with an INIT chunk that is bundled with other chunks.
308 if (!chunk->singleton)
309 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
311 /* If the packet is an OOTB packet which is temporarily on the
312 * control endpoint, respond with an ABORT.
314 if (ep == sctp_sk((sctp_get_ctl_sock()))->ep)
315 return sctp_sf_tabort_8_4_8(ep, asoc, type, arg, commands);
317 /* 3.1 A packet containing an INIT chunk MUST have a zero Verification
318 * Tag.
320 if (chunk->sctp_hdr->vtag != 0)
321 return sctp_sf_tabort_8_4_8(ep, asoc, type, arg, commands);
323 /* Make sure that the INIT chunk has a valid length.
324 * Normally, this would cause an ABORT with a Protocol Violation
325 * error, but since we don't have an association, we'll
326 * just discard the packet.
328 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_init_chunk_t)))
329 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
331 /* Verify the INIT chunk before processing it. */
332 err_chunk = NULL;
333 if (!sctp_verify_init(asoc, chunk->chunk_hdr->type,
334 (sctp_init_chunk_t *)chunk->chunk_hdr, chunk,
335 &err_chunk)) {
336 /* This chunk contains fatal error. It is to be discarded.
337 * Send an ABORT, with causes if there is any.
339 if (err_chunk) {
340 packet = sctp_abort_pkt_new(ep, asoc, arg,
341 (__u8 *)(err_chunk->chunk_hdr) +
342 sizeof(sctp_chunkhdr_t),
343 ntohs(err_chunk->chunk_hdr->length) -
344 sizeof(sctp_chunkhdr_t));
346 sctp_chunk_free(err_chunk);
348 if (packet) {
349 sctp_add_cmd_sf(commands, SCTP_CMD_SEND_PKT,
350 SCTP_PACKET(packet));
351 SCTP_INC_STATS(SCTP_MIB_OUTCTRLCHUNKS);
352 return SCTP_DISPOSITION_CONSUME;
353 } else {
354 return SCTP_DISPOSITION_NOMEM;
356 } else {
357 return sctp_sf_tabort_8_4_8(ep, asoc, type, arg,
358 commands);
362 /* Grab the INIT header. */
363 chunk->subh.init_hdr = (sctp_inithdr_t *)chunk->skb->data;
365 /* Tag the variable length parameters. */
366 chunk->param_hdr.v = skb_pull(chunk->skb, sizeof(sctp_inithdr_t));
368 new_asoc = sctp_make_temp_asoc(ep, chunk, GFP_ATOMIC);
369 if (!new_asoc)
370 goto nomem;
372 /* The call, sctp_process_init(), can fail on memory allocation. */
373 if (!sctp_process_init(new_asoc, chunk->chunk_hdr->type,
374 sctp_source(chunk),
375 (sctp_init_chunk_t *)chunk->chunk_hdr,
376 GFP_ATOMIC))
377 goto nomem_init;
379 /* B) "Z" shall respond immediately with an INIT ACK chunk. */
381 /* If there are errors need to be reported for unknown parameters,
382 * make sure to reserve enough room in the INIT ACK for them.
384 len = 0;
385 if (err_chunk)
386 len = ntohs(err_chunk->chunk_hdr->length) -
387 sizeof(sctp_chunkhdr_t);
389 if (sctp_assoc_set_bind_addr_from_ep(new_asoc, GFP_ATOMIC) < 0)
390 goto nomem_init;
392 repl = sctp_make_init_ack(new_asoc, chunk, GFP_ATOMIC, len);
393 if (!repl)
394 goto nomem_init;
396 /* If there are errors need to be reported for unknown parameters,
397 * include them in the outgoing INIT ACK as "Unrecognized parameter"
398 * parameter.
400 if (err_chunk) {
401 /* Get the "Unrecognized parameter" parameter(s) out of the
402 * ERROR chunk generated by sctp_verify_init(). Since the
403 * error cause code for "unknown parameter" and the
404 * "Unrecognized parameter" type is the same, we can
405 * construct the parameters in INIT ACK by copying the
406 * ERROR causes over.
408 unk_param = (sctp_unrecognized_param_t *)
409 ((__u8 *)(err_chunk->chunk_hdr) +
410 sizeof(sctp_chunkhdr_t));
411 /* Replace the cause code with the "Unrecognized parameter"
412 * parameter type.
414 sctp_addto_chunk(repl, len, unk_param);
415 sctp_chunk_free(err_chunk);
418 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_ASOC, SCTP_ASOC(new_asoc));
420 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(repl));
423 * Note: After sending out INIT ACK with the State Cookie parameter,
424 * "Z" MUST NOT allocate any resources, nor keep any states for the
425 * new association. Otherwise, "Z" will be vulnerable to resource
426 * attacks.
428 sctp_add_cmd_sf(commands, SCTP_CMD_DELETE_TCB, SCTP_NULL());
430 return SCTP_DISPOSITION_DELETE_TCB;
432 nomem_init:
433 sctp_association_free(new_asoc);
434 nomem:
435 if (err_chunk)
436 sctp_chunk_free(err_chunk);
437 return SCTP_DISPOSITION_NOMEM;
441 * Respond to a normal INIT ACK chunk.
442 * We are the side that is initiating the association.
444 * Section: 5.1 Normal Establishment of an Association, C
445 * C) Upon reception of the INIT ACK from "Z", "A" shall stop the T1-init
446 * timer and leave COOKIE-WAIT state. "A" shall then send the State
447 * Cookie received in the INIT ACK chunk in a COOKIE ECHO chunk, start
448 * the T1-cookie timer, and enter the COOKIE-ECHOED state.
450 * Note: The COOKIE ECHO chunk can be bundled with any pending outbound
451 * DATA chunks, but it MUST be the first chunk in the packet and
452 * until the COOKIE ACK is returned the sender MUST NOT send any
453 * other packets to the peer.
455 * Verification Tag: 3.3.3
456 * If the value of the Initiate Tag in a received INIT ACK chunk is
457 * found to be 0, the receiver MUST treat it as an error and close the
458 * association by transmitting an ABORT.
460 * Inputs
461 * (endpoint, asoc, chunk)
463 * Outputs
464 * (asoc, reply_msg, msg_up, timers, counters)
466 * The return value is the disposition of the chunk.
468 sctp_disposition_t sctp_sf_do_5_1C_ack(const struct sctp_endpoint *ep,
469 const struct sctp_association *asoc,
470 const sctp_subtype_t type,
471 void *arg,
472 sctp_cmd_seq_t *commands)
474 struct sctp_chunk *chunk = arg;
475 sctp_init_chunk_t *initchunk;
476 struct sctp_chunk *err_chunk;
477 struct sctp_packet *packet;
478 sctp_error_t error;
480 if (!sctp_vtag_verify(chunk, asoc))
481 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
483 /* 6.10 Bundling
484 * An endpoint MUST NOT bundle INIT, INIT ACK or
485 * SHUTDOWN COMPLETE with any other chunks.
487 if (!chunk->singleton)
488 return sctp_sf_violation_chunk(ep, asoc, type, arg, commands);
490 /* Make sure that the INIT-ACK chunk has a valid length */
491 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_initack_chunk_t)))
492 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
493 commands);
494 /* Grab the INIT header. */
495 chunk->subh.init_hdr = (sctp_inithdr_t *) chunk->skb->data;
497 /* Verify the INIT chunk before processing it. */
498 err_chunk = NULL;
499 if (!sctp_verify_init(asoc, chunk->chunk_hdr->type,
500 (sctp_init_chunk_t *)chunk->chunk_hdr, chunk,
501 &err_chunk)) {
503 /* This chunk contains fatal error. It is to be discarded.
504 * Send an ABORT, with causes if there is any.
506 if (err_chunk) {
507 packet = sctp_abort_pkt_new(ep, asoc, arg,
508 (__u8 *)(err_chunk->chunk_hdr) +
509 sizeof(sctp_chunkhdr_t),
510 ntohs(err_chunk->chunk_hdr->length) -
511 sizeof(sctp_chunkhdr_t));
513 sctp_chunk_free(err_chunk);
515 if (packet) {
516 sctp_add_cmd_sf(commands, SCTP_CMD_SEND_PKT,
517 SCTP_PACKET(packet));
518 SCTP_INC_STATS(SCTP_MIB_OUTCTRLCHUNKS);
519 error = SCTP_ERROR_INV_PARAM;
520 } else {
521 error = SCTP_ERROR_NO_RESOURCE;
523 } else {
524 sctp_sf_tabort_8_4_8(ep, asoc, type, arg, commands);
525 error = SCTP_ERROR_INV_PARAM;
528 /* SCTP-AUTH, Section 6.3:
529 * It should be noted that if the receiver wants to tear
530 * down an association in an authenticated way only, the
531 * handling of malformed packets should not result in
532 * tearing down the association.
534 * This means that if we only want to abort associations
535 * in an authenticated way (i.e AUTH+ABORT), then we
536 * can't destory this association just becuase the packet
537 * was malformed.
539 if (sctp_auth_recv_cid(SCTP_CID_ABORT, asoc))
540 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
542 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
543 return sctp_stop_t1_and_abort(commands, error, ECONNREFUSED,
544 asoc, chunk->transport);
547 /* Tag the variable length parameters. Note that we never
548 * convert the parameters in an INIT chunk.
550 chunk->param_hdr.v = skb_pull(chunk->skb, sizeof(sctp_inithdr_t));
552 initchunk = (sctp_init_chunk_t *) chunk->chunk_hdr;
554 sctp_add_cmd_sf(commands, SCTP_CMD_PEER_INIT,
555 SCTP_PEER_INIT(initchunk));
557 /* Reset init error count upon receipt of INIT-ACK. */
558 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_COUNTER_RESET, SCTP_NULL());
560 /* 5.1 C) "A" shall stop the T1-init timer and leave
561 * COOKIE-WAIT state. "A" shall then ... start the T1-cookie
562 * timer, and enter the COOKIE-ECHOED state.
564 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
565 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_INIT));
566 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_START,
567 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_COOKIE));
568 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
569 SCTP_STATE(SCTP_STATE_COOKIE_ECHOED));
571 /* SCTP-AUTH: genereate the assocition shared keys so that
572 * we can potentially signe the COOKIE-ECHO.
574 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_SHKEY, SCTP_NULL());
576 /* 5.1 C) "A" shall then send the State Cookie received in the
577 * INIT ACK chunk in a COOKIE ECHO chunk, ...
579 /* If there is any errors to report, send the ERROR chunk generated
580 * for unknown parameters as well.
582 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_COOKIE_ECHO,
583 SCTP_CHUNK(err_chunk));
585 return SCTP_DISPOSITION_CONSUME;
589 * Respond to a normal COOKIE ECHO chunk.
590 * We are the side that is being asked for an association.
592 * Section: 5.1 Normal Establishment of an Association, D
593 * D) Upon reception of the COOKIE ECHO chunk, Endpoint "Z" will reply
594 * with a COOKIE ACK chunk after building a TCB and moving to
595 * the ESTABLISHED state. A COOKIE ACK chunk may be bundled with
596 * any pending DATA chunks (and/or SACK chunks), but the COOKIE ACK
597 * chunk MUST be the first chunk in the packet.
599 * IMPLEMENTATION NOTE: An implementation may choose to send the
600 * Communication Up notification to the SCTP user upon reception
601 * of a valid COOKIE ECHO chunk.
603 * Verification Tag: 8.5.1 Exceptions in Verification Tag Rules
604 * D) Rules for packet carrying a COOKIE ECHO
606 * - When sending a COOKIE ECHO, the endpoint MUST use the value of the
607 * Initial Tag received in the INIT ACK.
609 * - The receiver of a COOKIE ECHO follows the procedures in Section 5.
611 * Inputs
612 * (endpoint, asoc, chunk)
614 * Outputs
615 * (asoc, reply_msg, msg_up, timers, counters)
617 * The return value is the disposition of the chunk.
619 sctp_disposition_t sctp_sf_do_5_1D_ce(const struct sctp_endpoint *ep,
620 const struct sctp_association *asoc,
621 const sctp_subtype_t type, void *arg,
622 sctp_cmd_seq_t *commands)
624 struct sctp_chunk *chunk = arg;
625 struct sctp_association *new_asoc;
626 sctp_init_chunk_t *peer_init;
627 struct sctp_chunk *repl;
628 struct sctp_ulpevent *ev, *ai_ev = NULL;
629 int error = 0;
630 struct sctp_chunk *err_chk_p;
631 struct sock *sk;
633 /* If the packet is an OOTB packet which is temporarily on the
634 * control endpoint, respond with an ABORT.
636 if (ep == sctp_sk((sctp_get_ctl_sock()))->ep)
637 return sctp_sf_tabort_8_4_8(ep, asoc, type, arg, commands);
639 /* Make sure that the COOKIE_ECHO chunk has a valid length.
640 * In this case, we check that we have enough for at least a
641 * chunk header. More detailed verification is done
642 * in sctp_unpack_cookie().
644 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_chunkhdr_t)))
645 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
647 /* If the endpoint is not listening or if the number of associations
648 * on the TCP-style socket exceed the max backlog, respond with an
649 * ABORT.
651 sk = ep->base.sk;
652 if (!sctp_sstate(sk, LISTENING) ||
653 (sctp_style(sk, TCP) && sk_acceptq_is_full(sk)))
654 return sctp_sf_tabort_8_4_8(ep, asoc, type, arg, commands);
656 /* "Decode" the chunk. We have no optional parameters so we
657 * are in good shape.
659 chunk->subh.cookie_hdr =
660 (struct sctp_signed_cookie *)chunk->skb->data;
661 if (!pskb_pull(chunk->skb, ntohs(chunk->chunk_hdr->length) -
662 sizeof(sctp_chunkhdr_t)))
663 goto nomem;
665 /* 5.1 D) Upon reception of the COOKIE ECHO chunk, Endpoint
666 * "Z" will reply with a COOKIE ACK chunk after building a TCB
667 * and moving to the ESTABLISHED state.
669 new_asoc = sctp_unpack_cookie(ep, asoc, chunk, GFP_ATOMIC, &error,
670 &err_chk_p);
672 /* FIXME:
673 * If the re-build failed, what is the proper error path
674 * from here?
676 * [We should abort the association. --piggy]
678 if (!new_asoc) {
679 /* FIXME: Several errors are possible. A bad cookie should
680 * be silently discarded, but think about logging it too.
682 switch (error) {
683 case -SCTP_IERROR_NOMEM:
684 goto nomem;
686 case -SCTP_IERROR_STALE_COOKIE:
687 sctp_send_stale_cookie_err(ep, asoc, chunk, commands,
688 err_chk_p);
689 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
691 case -SCTP_IERROR_BAD_SIG:
692 default:
693 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
698 /* Delay state machine commands until later.
700 * Re-build the bind address for the association is done in
701 * the sctp_unpack_cookie() already.
703 /* This is a brand-new association, so these are not yet side
704 * effects--it is safe to run them here.
706 peer_init = &chunk->subh.cookie_hdr->c.peer_init[0];
708 if (!sctp_process_init(new_asoc, chunk->chunk_hdr->type,
709 &chunk->subh.cookie_hdr->c.peer_addr,
710 peer_init, GFP_ATOMIC))
711 goto nomem_init;
713 /* SCTP-AUTH: Now that we've populate required fields in
714 * sctp_process_init, set up the assocaition shared keys as
715 * necessary so that we can potentially authenticate the ACK
717 error = sctp_auth_asoc_init_active_key(new_asoc, GFP_ATOMIC);
718 if (error)
719 goto nomem_init;
721 /* SCTP-AUTH: auth_chunk pointer is only set when the cookie-echo
722 * is supposed to be authenticated and we have to do delayed
723 * authentication. We've just recreated the association using
724 * the information in the cookie and now it's much easier to
725 * do the authentication.
727 if (chunk->auth_chunk) {
728 struct sctp_chunk auth;
729 sctp_ierror_t ret;
731 /* set-up our fake chunk so that we can process it */
732 auth.skb = chunk->auth_chunk;
733 auth.asoc = chunk->asoc;
734 auth.sctp_hdr = chunk->sctp_hdr;
735 auth.chunk_hdr = (sctp_chunkhdr_t *)skb_push(chunk->auth_chunk,
736 sizeof(sctp_chunkhdr_t));
737 skb_pull(chunk->auth_chunk, sizeof(sctp_chunkhdr_t));
738 auth.transport = chunk->transport;
740 ret = sctp_sf_authenticate(ep, new_asoc, type, &auth);
742 /* We can now safely free the auth_chunk clone */
743 kfree_skb(chunk->auth_chunk);
745 if (ret != SCTP_IERROR_NO_ERROR) {
746 sctp_association_free(new_asoc);
747 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
751 repl = sctp_make_cookie_ack(new_asoc, chunk);
752 if (!repl)
753 goto nomem_init;
755 /* RFC 2960 5.1 Normal Establishment of an Association
757 * D) IMPLEMENTATION NOTE: An implementation may choose to
758 * send the Communication Up notification to the SCTP user
759 * upon reception of a valid COOKIE ECHO chunk.
761 ev = sctp_ulpevent_make_assoc_change(new_asoc, 0, SCTP_COMM_UP, 0,
762 new_asoc->c.sinit_num_ostreams,
763 new_asoc->c.sinit_max_instreams,
764 NULL, GFP_ATOMIC);
765 if (!ev)
766 goto nomem_ev;
768 /* Sockets API Draft Section 5.3.1.6
769 * When a peer sends a Adaptation Layer Indication parameter , SCTP
770 * delivers this notification to inform the application that of the
771 * peers requested adaptation layer.
773 if (new_asoc->peer.adaptation_ind) {
774 ai_ev = sctp_ulpevent_make_adaptation_indication(new_asoc,
775 GFP_ATOMIC);
776 if (!ai_ev)
777 goto nomem_aiev;
780 /* Add all the state machine commands now since we've created
781 * everything. This way we don't introduce memory corruptions
782 * during side-effect processing and correclty count established
783 * associations.
785 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_ASOC, SCTP_ASOC(new_asoc));
786 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
787 SCTP_STATE(SCTP_STATE_ESTABLISHED));
788 SCTP_INC_STATS(SCTP_MIB_CURRESTAB);
789 SCTP_INC_STATS(SCTP_MIB_PASSIVEESTABS);
790 sctp_add_cmd_sf(commands, SCTP_CMD_HB_TIMERS_START, SCTP_NULL());
792 if (new_asoc->autoclose)
793 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_START,
794 SCTP_TO(SCTP_EVENT_TIMEOUT_AUTOCLOSE));
796 sctp_add_cmd_sf(commands, SCTP_CMD_TRANSMIT, SCTP_NULL());
798 /* This will send the COOKIE ACK */
799 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(repl));
801 /* Queue the ASSOC_CHANGE event */
802 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP, SCTP_ULPEVENT(ev));
804 /* Send up the Adaptation Layer Indication event */
805 if (ai_ev)
806 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP,
807 SCTP_ULPEVENT(ai_ev));
809 return SCTP_DISPOSITION_CONSUME;
811 nomem_aiev:
812 sctp_ulpevent_free(ev);
813 nomem_ev:
814 sctp_chunk_free(repl);
815 nomem_init:
816 sctp_association_free(new_asoc);
817 nomem:
818 return SCTP_DISPOSITION_NOMEM;
822 * Respond to a normal COOKIE ACK chunk.
823 * We are the side that is being asked for an association.
825 * RFC 2960 5.1 Normal Establishment of an Association
827 * E) Upon reception of the COOKIE ACK, endpoint "A" will move from the
828 * COOKIE-ECHOED state to the ESTABLISHED state, stopping the T1-cookie
829 * timer. It may also notify its ULP about the successful
830 * establishment of the association with a Communication Up
831 * notification (see Section 10).
833 * Verification Tag:
834 * Inputs
835 * (endpoint, asoc, chunk)
837 * Outputs
838 * (asoc, reply_msg, msg_up, timers, counters)
840 * The return value is the disposition of the chunk.
842 sctp_disposition_t sctp_sf_do_5_1E_ca(const struct sctp_endpoint *ep,
843 const struct sctp_association *asoc,
844 const sctp_subtype_t type, void *arg,
845 sctp_cmd_seq_t *commands)
847 struct sctp_chunk *chunk = arg;
848 struct sctp_ulpevent *ev;
850 if (!sctp_vtag_verify(chunk, asoc))
851 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
853 /* Verify that the chunk length for the COOKIE-ACK is OK.
854 * If we don't do this, any bundled chunks may be junked.
856 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_chunkhdr_t)))
857 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
858 commands);
860 /* Reset init error count upon receipt of COOKIE-ACK,
861 * to avoid problems with the managemement of this
862 * counter in stale cookie situations when a transition back
863 * from the COOKIE-ECHOED state to the COOKIE-WAIT
864 * state is performed.
866 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_COUNTER_RESET, SCTP_NULL());
868 /* RFC 2960 5.1 Normal Establishment of an Association
870 * E) Upon reception of the COOKIE ACK, endpoint "A" will move
871 * from the COOKIE-ECHOED state to the ESTABLISHED state,
872 * stopping the T1-cookie timer.
874 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
875 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_COOKIE));
876 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
877 SCTP_STATE(SCTP_STATE_ESTABLISHED));
878 SCTP_INC_STATS(SCTP_MIB_CURRESTAB);
879 SCTP_INC_STATS(SCTP_MIB_ACTIVEESTABS);
880 sctp_add_cmd_sf(commands, SCTP_CMD_HB_TIMERS_START, SCTP_NULL());
881 if (asoc->autoclose)
882 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_START,
883 SCTP_TO(SCTP_EVENT_TIMEOUT_AUTOCLOSE));
884 sctp_add_cmd_sf(commands, SCTP_CMD_TRANSMIT, SCTP_NULL());
886 /* It may also notify its ULP about the successful
887 * establishment of the association with a Communication Up
888 * notification (see Section 10).
890 ev = sctp_ulpevent_make_assoc_change(asoc, 0, SCTP_COMM_UP,
891 0, asoc->c.sinit_num_ostreams,
892 asoc->c.sinit_max_instreams,
893 NULL, GFP_ATOMIC);
895 if (!ev)
896 goto nomem;
898 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP, SCTP_ULPEVENT(ev));
900 /* Sockets API Draft Section 5.3.1.6
901 * When a peer sends a Adaptation Layer Indication parameter , SCTP
902 * delivers this notification to inform the application that of the
903 * peers requested adaptation layer.
905 if (asoc->peer.adaptation_ind) {
906 ev = sctp_ulpevent_make_adaptation_indication(asoc, GFP_ATOMIC);
907 if (!ev)
908 goto nomem;
910 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP,
911 SCTP_ULPEVENT(ev));
914 return SCTP_DISPOSITION_CONSUME;
915 nomem:
916 return SCTP_DISPOSITION_NOMEM;
919 /* Generate and sendout a heartbeat packet. */
920 static sctp_disposition_t sctp_sf_heartbeat(const struct sctp_endpoint *ep,
921 const struct sctp_association *asoc,
922 const sctp_subtype_t type,
923 void *arg,
924 sctp_cmd_seq_t *commands)
926 struct sctp_transport *transport = (struct sctp_transport *) arg;
927 struct sctp_chunk *reply;
928 sctp_sender_hb_info_t hbinfo;
929 size_t paylen = 0;
931 hbinfo.param_hdr.type = SCTP_PARAM_HEARTBEAT_INFO;
932 hbinfo.param_hdr.length = htons(sizeof(sctp_sender_hb_info_t));
933 hbinfo.daddr = transport->ipaddr;
934 hbinfo.sent_at = jiffies;
935 hbinfo.hb_nonce = transport->hb_nonce;
937 /* Send a heartbeat to our peer. */
938 paylen = sizeof(sctp_sender_hb_info_t);
939 reply = sctp_make_heartbeat(asoc, transport, &hbinfo, paylen);
940 if (!reply)
941 return SCTP_DISPOSITION_NOMEM;
943 /* Set rto_pending indicating that an RTT measurement
944 * is started with this heartbeat chunk.
946 sctp_add_cmd_sf(commands, SCTP_CMD_RTO_PENDING,
947 SCTP_TRANSPORT(transport));
949 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(reply));
950 return SCTP_DISPOSITION_CONSUME;
953 /* Generate a HEARTBEAT packet on the given transport. */
954 sctp_disposition_t sctp_sf_sendbeat_8_3(const struct sctp_endpoint *ep,
955 const struct sctp_association *asoc,
956 const sctp_subtype_t type,
957 void *arg,
958 sctp_cmd_seq_t *commands)
960 struct sctp_transport *transport = (struct sctp_transport *) arg;
962 if (asoc->overall_error_count > asoc->max_retrans) {
963 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
964 SCTP_ERROR(ETIMEDOUT));
965 /* CMD_ASSOC_FAILED calls CMD_DELETE_TCB. */
966 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
967 SCTP_PERR(SCTP_ERROR_NO_ERROR));
968 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
969 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
970 return SCTP_DISPOSITION_DELETE_TCB;
973 /* Section 3.3.5.
974 * The Sender-specific Heartbeat Info field should normally include
975 * information about the sender's current time when this HEARTBEAT
976 * chunk is sent and the destination transport address to which this
977 * HEARTBEAT is sent (see Section 8.3).
980 if (transport->param_flags & SPP_HB_ENABLE) {
981 if (SCTP_DISPOSITION_NOMEM ==
982 sctp_sf_heartbeat(ep, asoc, type, arg,
983 commands))
984 return SCTP_DISPOSITION_NOMEM;
985 /* Set transport error counter and association error counter
986 * when sending heartbeat.
988 sctp_add_cmd_sf(commands, SCTP_CMD_TRANSPORT_RESET,
989 SCTP_TRANSPORT(transport));
991 sctp_add_cmd_sf(commands, SCTP_CMD_HB_TIMER_UPDATE,
992 SCTP_TRANSPORT(transport));
994 return SCTP_DISPOSITION_CONSUME;
998 * Process an heartbeat request.
1000 * Section: 8.3 Path Heartbeat
1001 * The receiver of the HEARTBEAT should immediately respond with a
1002 * HEARTBEAT ACK that contains the Heartbeat Information field copied
1003 * from the received HEARTBEAT chunk.
1005 * Verification Tag: 8.5 Verification Tag [Normal verification]
1006 * When receiving an SCTP packet, the endpoint MUST ensure that the
1007 * value in the Verification Tag field of the received SCTP packet
1008 * matches its own Tag. If the received Verification Tag value does not
1009 * match the receiver's own tag value, the receiver shall silently
1010 * discard the packet and shall not process it any further except for
1011 * those cases listed in Section 8.5.1 below.
1013 * Inputs
1014 * (endpoint, asoc, chunk)
1016 * Outputs
1017 * (asoc, reply_msg, msg_up, timers, counters)
1019 * The return value is the disposition of the chunk.
1021 sctp_disposition_t sctp_sf_beat_8_3(const struct sctp_endpoint *ep,
1022 const struct sctp_association *asoc,
1023 const sctp_subtype_t type,
1024 void *arg,
1025 sctp_cmd_seq_t *commands)
1027 struct sctp_chunk *chunk = arg;
1028 struct sctp_chunk *reply;
1029 size_t paylen = 0;
1031 if (!sctp_vtag_verify(chunk, asoc))
1032 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
1034 /* Make sure that the HEARTBEAT chunk has a valid length. */
1035 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_heartbeat_chunk_t)))
1036 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
1037 commands);
1039 /* 8.3 The receiver of the HEARTBEAT should immediately
1040 * respond with a HEARTBEAT ACK that contains the Heartbeat
1041 * Information field copied from the received HEARTBEAT chunk.
1043 chunk->subh.hb_hdr = (sctp_heartbeathdr_t *) chunk->skb->data;
1044 paylen = ntohs(chunk->chunk_hdr->length) - sizeof(sctp_chunkhdr_t);
1045 if (!pskb_pull(chunk->skb, paylen))
1046 goto nomem;
1048 reply = sctp_make_heartbeat_ack(asoc, chunk,
1049 chunk->subh.hb_hdr, paylen);
1050 if (!reply)
1051 goto nomem;
1053 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(reply));
1054 return SCTP_DISPOSITION_CONSUME;
1056 nomem:
1057 return SCTP_DISPOSITION_NOMEM;
1061 * Process the returning HEARTBEAT ACK.
1063 * Section: 8.3 Path Heartbeat
1064 * Upon the receipt of the HEARTBEAT ACK, the sender of the HEARTBEAT
1065 * should clear the error counter of the destination transport
1066 * address to which the HEARTBEAT was sent, and mark the destination
1067 * transport address as active if it is not so marked. The endpoint may
1068 * optionally report to the upper layer when an inactive destination
1069 * address is marked as active due to the reception of the latest
1070 * HEARTBEAT ACK. The receiver of the HEARTBEAT ACK must also
1071 * clear the association overall error count as well (as defined
1072 * in section 8.1).
1074 * The receiver of the HEARTBEAT ACK should also perform an RTT
1075 * measurement for that destination transport address using the time
1076 * value carried in the HEARTBEAT ACK chunk.
1078 * Verification Tag: 8.5 Verification Tag [Normal verification]
1080 * Inputs
1081 * (endpoint, asoc, chunk)
1083 * Outputs
1084 * (asoc, reply_msg, msg_up, timers, counters)
1086 * The return value is the disposition of the chunk.
1088 sctp_disposition_t sctp_sf_backbeat_8_3(const struct sctp_endpoint *ep,
1089 const struct sctp_association *asoc,
1090 const sctp_subtype_t type,
1091 void *arg,
1092 sctp_cmd_seq_t *commands)
1094 struct sctp_chunk *chunk = arg;
1095 union sctp_addr from_addr;
1096 struct sctp_transport *link;
1097 sctp_sender_hb_info_t *hbinfo;
1098 unsigned long max_interval;
1100 if (!sctp_vtag_verify(chunk, asoc))
1101 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
1103 /* Make sure that the HEARTBEAT-ACK chunk has a valid length. */
1104 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_heartbeat_chunk_t)))
1105 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
1106 commands);
1108 hbinfo = (sctp_sender_hb_info_t *) chunk->skb->data;
1109 /* Make sure that the length of the parameter is what we expect */
1110 if (ntohs(hbinfo->param_hdr.length) !=
1111 sizeof(sctp_sender_hb_info_t)) {
1112 return SCTP_DISPOSITION_DISCARD;
1115 from_addr = hbinfo->daddr;
1116 link = sctp_assoc_lookup_paddr(asoc, &from_addr);
1118 /* This should never happen, but lets log it if so. */
1119 if (unlikely(!link)) {
1120 if (from_addr.sa.sa_family == AF_INET6) {
1121 if (net_ratelimit())
1122 printk(KERN_WARNING
1123 "%s association %p could not find address "
1124 NIP6_FMT "\n",
1125 __FUNCTION__,
1126 asoc,
1127 NIP6(from_addr.v6.sin6_addr));
1128 } else {
1129 if (net_ratelimit())
1130 printk(KERN_WARNING
1131 "%s association %p could not find address "
1132 NIPQUAD_FMT "\n",
1133 __FUNCTION__,
1134 asoc,
1135 NIPQUAD(from_addr.v4.sin_addr.s_addr));
1137 return SCTP_DISPOSITION_DISCARD;
1140 /* Validate the 64-bit random nonce. */
1141 if (hbinfo->hb_nonce != link->hb_nonce)
1142 return SCTP_DISPOSITION_DISCARD;
1144 max_interval = link->hbinterval + link->rto;
1146 /* Check if the timestamp looks valid. */
1147 if (time_after(hbinfo->sent_at, jiffies) ||
1148 time_after(jiffies, hbinfo->sent_at + max_interval)) {
1149 SCTP_DEBUG_PRINTK("%s: HEARTBEAT ACK with invalid timestamp "
1150 "received for transport: %p\n",
1151 __FUNCTION__, link);
1152 return SCTP_DISPOSITION_DISCARD;
1155 /* 8.3 Upon the receipt of the HEARTBEAT ACK, the sender of
1156 * the HEARTBEAT should clear the error counter of the
1157 * destination transport address to which the HEARTBEAT was
1158 * sent and mark the destination transport address as active if
1159 * it is not so marked.
1161 sctp_add_cmd_sf(commands, SCTP_CMD_TRANSPORT_ON, SCTP_TRANSPORT(link));
1163 return SCTP_DISPOSITION_CONSUME;
1166 /* Helper function to send out an abort for the restart
1167 * condition.
1169 static int sctp_sf_send_restart_abort(union sctp_addr *ssa,
1170 struct sctp_chunk *init,
1171 sctp_cmd_seq_t *commands)
1173 int len;
1174 struct sctp_packet *pkt;
1175 union sctp_addr_param *addrparm;
1176 struct sctp_errhdr *errhdr;
1177 struct sctp_endpoint *ep;
1178 char buffer[sizeof(struct sctp_errhdr)+sizeof(union sctp_addr_param)];
1179 struct sctp_af *af = sctp_get_af_specific(ssa->v4.sin_family);
1181 /* Build the error on the stack. We are way to malloc crazy
1182 * throughout the code today.
1184 errhdr = (struct sctp_errhdr *)buffer;
1185 addrparm = (union sctp_addr_param *)errhdr->variable;
1187 /* Copy into a parm format. */
1188 len = af->to_addr_param(ssa, addrparm);
1189 len += sizeof(sctp_errhdr_t);
1191 errhdr->cause = SCTP_ERROR_RESTART;
1192 errhdr->length = htons(len);
1194 /* Assign to the control socket. */
1195 ep = sctp_sk((sctp_get_ctl_sock()))->ep;
1197 /* Association is NULL since this may be a restart attack and we
1198 * want to send back the attacker's vtag.
1200 pkt = sctp_abort_pkt_new(ep, NULL, init, errhdr, len);
1202 if (!pkt)
1203 goto out;
1204 sctp_add_cmd_sf(commands, SCTP_CMD_SEND_PKT, SCTP_PACKET(pkt));
1206 SCTP_INC_STATS(SCTP_MIB_OUTCTRLCHUNKS);
1208 /* Discard the rest of the inbound packet. */
1209 sctp_add_cmd_sf(commands, SCTP_CMD_DISCARD_PACKET, SCTP_NULL());
1211 out:
1212 /* Even if there is no memory, treat as a failure so
1213 * the packet will get dropped.
1215 return 0;
1218 /* A restart is occurring, check to make sure no new addresses
1219 * are being added as we may be under a takeover attack.
1221 static int sctp_sf_check_restart_addrs(const struct sctp_association *new_asoc,
1222 const struct sctp_association *asoc,
1223 struct sctp_chunk *init,
1224 sctp_cmd_seq_t *commands)
1226 struct sctp_transport *new_addr, *addr;
1227 struct list_head *pos, *pos2;
1228 int found;
1230 /* Implementor's Guide - Sectin 5.2.2
1231 * ...
1232 * Before responding the endpoint MUST check to see if the
1233 * unexpected INIT adds new addresses to the association. If new
1234 * addresses are added to the association, the endpoint MUST respond
1235 * with an ABORT..
1238 /* Search through all current addresses and make sure
1239 * we aren't adding any new ones.
1241 new_addr = NULL;
1242 found = 0;
1244 list_for_each(pos, &new_asoc->peer.transport_addr_list) {
1245 new_addr = list_entry(pos, struct sctp_transport, transports);
1246 found = 0;
1247 list_for_each(pos2, &asoc->peer.transport_addr_list) {
1248 addr = list_entry(pos2, struct sctp_transport,
1249 transports);
1250 if (sctp_cmp_addr_exact(&new_addr->ipaddr,
1251 &addr->ipaddr)) {
1252 found = 1;
1253 break;
1256 if (!found)
1257 break;
1260 /* If a new address was added, ABORT the sender. */
1261 if (!found && new_addr) {
1262 sctp_sf_send_restart_abort(&new_addr->ipaddr, init, commands);
1265 /* Return success if all addresses were found. */
1266 return found;
1269 /* Populate the verification/tie tags based on overlapping INIT
1270 * scenario.
1272 * Note: Do not use in CLOSED or SHUTDOWN-ACK-SENT state.
1274 static void sctp_tietags_populate(struct sctp_association *new_asoc,
1275 const struct sctp_association *asoc)
1277 switch (asoc->state) {
1279 /* 5.2.1 INIT received in COOKIE-WAIT or COOKIE-ECHOED State */
1281 case SCTP_STATE_COOKIE_WAIT:
1282 new_asoc->c.my_vtag = asoc->c.my_vtag;
1283 new_asoc->c.my_ttag = asoc->c.my_vtag;
1284 new_asoc->c.peer_ttag = 0;
1285 break;
1287 case SCTP_STATE_COOKIE_ECHOED:
1288 new_asoc->c.my_vtag = asoc->c.my_vtag;
1289 new_asoc->c.my_ttag = asoc->c.my_vtag;
1290 new_asoc->c.peer_ttag = asoc->c.peer_vtag;
1291 break;
1293 /* 5.2.2 Unexpected INIT in States Other than CLOSED, COOKIE-ECHOED,
1294 * COOKIE-WAIT and SHUTDOWN-ACK-SENT
1296 default:
1297 new_asoc->c.my_ttag = asoc->c.my_vtag;
1298 new_asoc->c.peer_ttag = asoc->c.peer_vtag;
1299 break;
1302 /* Other parameters for the endpoint SHOULD be copied from the
1303 * existing parameters of the association (e.g. number of
1304 * outbound streams) into the INIT ACK and cookie.
1306 new_asoc->rwnd = asoc->rwnd;
1307 new_asoc->c.sinit_num_ostreams = asoc->c.sinit_num_ostreams;
1308 new_asoc->c.sinit_max_instreams = asoc->c.sinit_max_instreams;
1309 new_asoc->c.initial_tsn = asoc->c.initial_tsn;
1313 * Compare vtag/tietag values to determine unexpected COOKIE-ECHO
1314 * handling action.
1316 * RFC 2960 5.2.4 Handle a COOKIE ECHO when a TCB exists.
1318 * Returns value representing action to be taken. These action values
1319 * correspond to Action/Description values in RFC 2960, Table 2.
1321 static char sctp_tietags_compare(struct sctp_association *new_asoc,
1322 const struct sctp_association *asoc)
1324 /* In this case, the peer may have restarted. */
1325 if ((asoc->c.my_vtag != new_asoc->c.my_vtag) &&
1326 (asoc->c.peer_vtag != new_asoc->c.peer_vtag) &&
1327 (asoc->c.my_vtag == new_asoc->c.my_ttag) &&
1328 (asoc->c.peer_vtag == new_asoc->c.peer_ttag))
1329 return 'A';
1331 /* Collision case B. */
1332 if ((asoc->c.my_vtag == new_asoc->c.my_vtag) &&
1333 ((asoc->c.peer_vtag != new_asoc->c.peer_vtag) ||
1334 (0 == asoc->c.peer_vtag))) {
1335 return 'B';
1338 /* Collision case D. */
1339 if ((asoc->c.my_vtag == new_asoc->c.my_vtag) &&
1340 (asoc->c.peer_vtag == new_asoc->c.peer_vtag))
1341 return 'D';
1343 /* Collision case C. */
1344 if ((asoc->c.my_vtag != new_asoc->c.my_vtag) &&
1345 (asoc->c.peer_vtag == new_asoc->c.peer_vtag) &&
1346 (0 == new_asoc->c.my_ttag) &&
1347 (0 == new_asoc->c.peer_ttag))
1348 return 'C';
1350 /* No match to any of the special cases; discard this packet. */
1351 return 'E';
1354 /* Common helper routine for both duplicate and simulataneous INIT
1355 * chunk handling.
1357 static sctp_disposition_t sctp_sf_do_unexpected_init(
1358 const struct sctp_endpoint *ep,
1359 const struct sctp_association *asoc,
1360 const sctp_subtype_t type,
1361 void *arg, sctp_cmd_seq_t *commands)
1363 sctp_disposition_t retval;
1364 struct sctp_chunk *chunk = arg;
1365 struct sctp_chunk *repl;
1366 struct sctp_association *new_asoc;
1367 struct sctp_chunk *err_chunk;
1368 struct sctp_packet *packet;
1369 sctp_unrecognized_param_t *unk_param;
1370 int len;
1372 /* 6.10 Bundling
1373 * An endpoint MUST NOT bundle INIT, INIT ACK or
1374 * SHUTDOWN COMPLETE with any other chunks.
1376 * IG Section 2.11.2
1377 * Furthermore, we require that the receiver of an INIT chunk MUST
1378 * enforce these rules by silently discarding an arriving packet
1379 * with an INIT chunk that is bundled with other chunks.
1381 if (!chunk->singleton)
1382 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
1384 /* 3.1 A packet containing an INIT chunk MUST have a zero Verification
1385 * Tag.
1387 if (chunk->sctp_hdr->vtag != 0)
1388 return sctp_sf_tabort_8_4_8(ep, asoc, type, arg, commands);
1390 /* Make sure that the INIT chunk has a valid length.
1391 * In this case, we generate a protocol violation since we have
1392 * an association established.
1394 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_init_chunk_t)))
1395 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
1396 commands);
1397 /* Grab the INIT header. */
1398 chunk->subh.init_hdr = (sctp_inithdr_t *) chunk->skb->data;
1400 /* Tag the variable length parameters. */
1401 chunk->param_hdr.v = skb_pull(chunk->skb, sizeof(sctp_inithdr_t));
1403 /* Verify the INIT chunk before processing it. */
1404 err_chunk = NULL;
1405 if (!sctp_verify_init(asoc, chunk->chunk_hdr->type,
1406 (sctp_init_chunk_t *)chunk->chunk_hdr, chunk,
1407 &err_chunk)) {
1408 /* This chunk contains fatal error. It is to be discarded.
1409 * Send an ABORT, with causes if there is any.
1411 if (err_chunk) {
1412 packet = sctp_abort_pkt_new(ep, asoc, arg,
1413 (__u8 *)(err_chunk->chunk_hdr) +
1414 sizeof(sctp_chunkhdr_t),
1415 ntohs(err_chunk->chunk_hdr->length) -
1416 sizeof(sctp_chunkhdr_t));
1418 if (packet) {
1419 sctp_add_cmd_sf(commands, SCTP_CMD_SEND_PKT,
1420 SCTP_PACKET(packet));
1421 SCTP_INC_STATS(SCTP_MIB_OUTCTRLCHUNKS);
1422 retval = SCTP_DISPOSITION_CONSUME;
1423 } else {
1424 retval = SCTP_DISPOSITION_NOMEM;
1426 goto cleanup;
1427 } else {
1428 return sctp_sf_tabort_8_4_8(ep, asoc, type, arg,
1429 commands);
1434 * Other parameters for the endpoint SHOULD be copied from the
1435 * existing parameters of the association (e.g. number of
1436 * outbound streams) into the INIT ACK and cookie.
1437 * FIXME: We are copying parameters from the endpoint not the
1438 * association.
1440 new_asoc = sctp_make_temp_asoc(ep, chunk, GFP_ATOMIC);
1441 if (!new_asoc)
1442 goto nomem;
1444 /* In the outbound INIT ACK the endpoint MUST copy its current
1445 * Verification Tag and Peers Verification tag into a reserved
1446 * place (local tie-tag and per tie-tag) within the state cookie.
1448 if (!sctp_process_init(new_asoc, chunk->chunk_hdr->type,
1449 sctp_source(chunk),
1450 (sctp_init_chunk_t *)chunk->chunk_hdr,
1451 GFP_ATOMIC))
1452 goto nomem;
1454 /* Make sure no new addresses are being added during the
1455 * restart. Do not do this check for COOKIE-WAIT state,
1456 * since there are no peer addresses to check against.
1457 * Upon return an ABORT will have been sent if needed.
1459 if (!sctp_state(asoc, COOKIE_WAIT)) {
1460 if (!sctp_sf_check_restart_addrs(new_asoc, asoc, chunk,
1461 commands)) {
1462 retval = SCTP_DISPOSITION_CONSUME;
1463 goto nomem_retval;
1467 sctp_tietags_populate(new_asoc, asoc);
1469 /* B) "Z" shall respond immediately with an INIT ACK chunk. */
1471 /* If there are errors need to be reported for unknown parameters,
1472 * make sure to reserve enough room in the INIT ACK for them.
1474 len = 0;
1475 if (err_chunk) {
1476 len = ntohs(err_chunk->chunk_hdr->length) -
1477 sizeof(sctp_chunkhdr_t);
1480 if (sctp_assoc_set_bind_addr_from_ep(new_asoc, GFP_ATOMIC) < 0)
1481 goto nomem;
1483 repl = sctp_make_init_ack(new_asoc, chunk, GFP_ATOMIC, len);
1484 if (!repl)
1485 goto nomem;
1487 /* If there are errors need to be reported for unknown parameters,
1488 * include them in the outgoing INIT ACK as "Unrecognized parameter"
1489 * parameter.
1491 if (err_chunk) {
1492 /* Get the "Unrecognized parameter" parameter(s) out of the
1493 * ERROR chunk generated by sctp_verify_init(). Since the
1494 * error cause code for "unknown parameter" and the
1495 * "Unrecognized parameter" type is the same, we can
1496 * construct the parameters in INIT ACK by copying the
1497 * ERROR causes over.
1499 unk_param = (sctp_unrecognized_param_t *)
1500 ((__u8 *)(err_chunk->chunk_hdr) +
1501 sizeof(sctp_chunkhdr_t));
1502 /* Replace the cause code with the "Unrecognized parameter"
1503 * parameter type.
1505 sctp_addto_chunk(repl, len, unk_param);
1508 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_ASOC, SCTP_ASOC(new_asoc));
1509 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(repl));
1512 * Note: After sending out INIT ACK with the State Cookie parameter,
1513 * "Z" MUST NOT allocate any resources for this new association.
1514 * Otherwise, "Z" will be vulnerable to resource attacks.
1516 sctp_add_cmd_sf(commands, SCTP_CMD_DELETE_TCB, SCTP_NULL());
1517 retval = SCTP_DISPOSITION_CONSUME;
1519 return retval;
1521 nomem:
1522 retval = SCTP_DISPOSITION_NOMEM;
1523 nomem_retval:
1524 if (new_asoc)
1525 sctp_association_free(new_asoc);
1526 cleanup:
1527 if (err_chunk)
1528 sctp_chunk_free(err_chunk);
1529 return retval;
1533 * Handle simultanous INIT.
1534 * This means we started an INIT and then we got an INIT request from
1535 * our peer.
1537 * Section: 5.2.1 INIT received in COOKIE-WAIT or COOKIE-ECHOED State (Item B)
1538 * This usually indicates an initialization collision, i.e., each
1539 * endpoint is attempting, at about the same time, to establish an
1540 * association with the other endpoint.
1542 * Upon receipt of an INIT in the COOKIE-WAIT or COOKIE-ECHOED state, an
1543 * endpoint MUST respond with an INIT ACK using the same parameters it
1544 * sent in its original INIT chunk (including its Verification Tag,
1545 * unchanged). These original parameters are combined with those from the
1546 * newly received INIT chunk. The endpoint shall also generate a State
1547 * Cookie with the INIT ACK. The endpoint uses the parameters sent in its
1548 * INIT to calculate the State Cookie.
1550 * After that, the endpoint MUST NOT change its state, the T1-init
1551 * timer shall be left running and the corresponding TCB MUST NOT be
1552 * destroyed. The normal procedures for handling State Cookies when
1553 * a TCB exists will resolve the duplicate INITs to a single association.
1555 * For an endpoint that is in the COOKIE-ECHOED state it MUST populate
1556 * its Tie-Tags with the Tag information of itself and its peer (see
1557 * section 5.2.2 for a description of the Tie-Tags).
1559 * Verification Tag: Not explicit, but an INIT can not have a valid
1560 * verification tag, so we skip the check.
1562 * Inputs
1563 * (endpoint, asoc, chunk)
1565 * Outputs
1566 * (asoc, reply_msg, msg_up, timers, counters)
1568 * The return value is the disposition of the chunk.
1570 sctp_disposition_t sctp_sf_do_5_2_1_siminit(const struct sctp_endpoint *ep,
1571 const struct sctp_association *asoc,
1572 const sctp_subtype_t type,
1573 void *arg,
1574 sctp_cmd_seq_t *commands)
1576 /* Call helper to do the real work for both simulataneous and
1577 * duplicate INIT chunk handling.
1579 return sctp_sf_do_unexpected_init(ep, asoc, type, arg, commands);
1583 * Handle duplicated INIT messages. These are usually delayed
1584 * restransmissions.
1586 * Section: 5.2.2 Unexpected INIT in States Other than CLOSED,
1587 * COOKIE-ECHOED and COOKIE-WAIT
1589 * Unless otherwise stated, upon reception of an unexpected INIT for
1590 * this association, the endpoint shall generate an INIT ACK with a
1591 * State Cookie. In the outbound INIT ACK the endpoint MUST copy its
1592 * current Verification Tag and peer's Verification Tag into a reserved
1593 * place within the state cookie. We shall refer to these locations as
1594 * the Peer's-Tie-Tag and the Local-Tie-Tag. The outbound SCTP packet
1595 * containing this INIT ACK MUST carry a Verification Tag value equal to
1596 * the Initiation Tag found in the unexpected INIT. And the INIT ACK
1597 * MUST contain a new Initiation Tag (randomly generated see Section
1598 * 5.3.1). Other parameters for the endpoint SHOULD be copied from the
1599 * existing parameters of the association (e.g. number of outbound
1600 * streams) into the INIT ACK and cookie.
1602 * After sending out the INIT ACK, the endpoint shall take no further
1603 * actions, i.e., the existing association, including its current state,
1604 * and the corresponding TCB MUST NOT be changed.
1606 * Note: Only when a TCB exists and the association is not in a COOKIE-
1607 * WAIT state are the Tie-Tags populated. For a normal association INIT
1608 * (i.e. the endpoint is in a COOKIE-WAIT state), the Tie-Tags MUST be
1609 * set to 0 (indicating that no previous TCB existed). The INIT ACK and
1610 * State Cookie are populated as specified in section 5.2.1.
1612 * Verification Tag: Not specified, but an INIT has no way of knowing
1613 * what the verification tag could be, so we ignore it.
1615 * Inputs
1616 * (endpoint, asoc, chunk)
1618 * Outputs
1619 * (asoc, reply_msg, msg_up, timers, counters)
1621 * The return value is the disposition of the chunk.
1623 sctp_disposition_t sctp_sf_do_5_2_2_dupinit(const struct sctp_endpoint *ep,
1624 const struct sctp_association *asoc,
1625 const sctp_subtype_t type,
1626 void *arg,
1627 sctp_cmd_seq_t *commands)
1629 /* Call helper to do the real work for both simulataneous and
1630 * duplicate INIT chunk handling.
1632 return sctp_sf_do_unexpected_init(ep, asoc, type, arg, commands);
1637 * Unexpected INIT-ACK handler.
1639 * Section 5.2.3
1640 * If an INIT ACK received by an endpoint in any state other than the
1641 * COOKIE-WAIT state, the endpoint should discard the INIT ACK chunk.
1642 * An unexpected INIT ACK usually indicates the processing of an old or
1643 * duplicated INIT chunk.
1645 sctp_disposition_t sctp_sf_do_5_2_3_initack(const struct sctp_endpoint *ep,
1646 const struct sctp_association *asoc,
1647 const sctp_subtype_t type,
1648 void *arg, sctp_cmd_seq_t *commands)
1650 /* Per the above section, we'll discard the chunk if we have an
1651 * endpoint. If this is an OOTB INIT-ACK, treat it as such.
1653 if (ep == sctp_sk((sctp_get_ctl_sock()))->ep)
1654 return sctp_sf_ootb(ep, asoc, type, arg, commands);
1655 else
1656 return sctp_sf_discard_chunk(ep, asoc, type, arg, commands);
1659 /* Unexpected COOKIE-ECHO handler for peer restart (Table 2, action 'A')
1661 * Section 5.2.4
1662 * A) In this case, the peer may have restarted.
1664 static sctp_disposition_t sctp_sf_do_dupcook_a(const struct sctp_endpoint *ep,
1665 const struct sctp_association *asoc,
1666 struct sctp_chunk *chunk,
1667 sctp_cmd_seq_t *commands,
1668 struct sctp_association *new_asoc)
1670 sctp_init_chunk_t *peer_init;
1671 struct sctp_ulpevent *ev;
1672 struct sctp_chunk *repl;
1673 struct sctp_chunk *err;
1674 sctp_disposition_t disposition;
1676 /* new_asoc is a brand-new association, so these are not yet
1677 * side effects--it is safe to run them here.
1679 peer_init = &chunk->subh.cookie_hdr->c.peer_init[0];
1681 if (!sctp_process_init(new_asoc, chunk->chunk_hdr->type,
1682 sctp_source(chunk), peer_init,
1683 GFP_ATOMIC))
1684 goto nomem;
1686 /* Make sure no new addresses are being added during the
1687 * restart. Though this is a pretty complicated attack
1688 * since you'd have to get inside the cookie.
1690 if (!sctp_sf_check_restart_addrs(new_asoc, asoc, chunk, commands)) {
1691 return SCTP_DISPOSITION_CONSUME;
1694 /* If the endpoint is in the SHUTDOWN-ACK-SENT state and recognizes
1695 * the peer has restarted (Action A), it MUST NOT setup a new
1696 * association but instead resend the SHUTDOWN ACK and send an ERROR
1697 * chunk with a "Cookie Received while Shutting Down" error cause to
1698 * its peer.
1700 if (sctp_state(asoc, SHUTDOWN_ACK_SENT)) {
1701 disposition = sctp_sf_do_9_2_reshutack(ep, asoc,
1702 SCTP_ST_CHUNK(chunk->chunk_hdr->type),
1703 chunk, commands);
1704 if (SCTP_DISPOSITION_NOMEM == disposition)
1705 goto nomem;
1707 err = sctp_make_op_error(asoc, chunk,
1708 SCTP_ERROR_COOKIE_IN_SHUTDOWN,
1709 NULL, 0);
1710 if (err)
1711 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
1712 SCTP_CHUNK(err));
1714 return SCTP_DISPOSITION_CONSUME;
1717 /* For now, fail any unsent/unacked data. Consider the optional
1718 * choice of resending of this data.
1720 sctp_add_cmd_sf(commands, SCTP_CMD_PURGE_OUTQUEUE, SCTP_NULL());
1722 repl = sctp_make_cookie_ack(new_asoc, chunk);
1723 if (!repl)
1724 goto nomem;
1726 /* Report association restart to upper layer. */
1727 ev = sctp_ulpevent_make_assoc_change(asoc, 0, SCTP_RESTART, 0,
1728 new_asoc->c.sinit_num_ostreams,
1729 new_asoc->c.sinit_max_instreams,
1730 NULL, GFP_ATOMIC);
1731 if (!ev)
1732 goto nomem_ev;
1734 /* Update the content of current association. */
1735 sctp_add_cmd_sf(commands, SCTP_CMD_UPDATE_ASSOC, SCTP_ASOC(new_asoc));
1736 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(repl));
1737 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP, SCTP_ULPEVENT(ev));
1738 return SCTP_DISPOSITION_CONSUME;
1740 nomem_ev:
1741 sctp_chunk_free(repl);
1742 nomem:
1743 return SCTP_DISPOSITION_NOMEM;
1746 /* Unexpected COOKIE-ECHO handler for setup collision (Table 2, action 'B')
1748 * Section 5.2.4
1749 * B) In this case, both sides may be attempting to start an association
1750 * at about the same time but the peer endpoint started its INIT
1751 * after responding to the local endpoint's INIT
1753 /* This case represents an initialization collision. */
1754 static sctp_disposition_t sctp_sf_do_dupcook_b(const struct sctp_endpoint *ep,
1755 const struct sctp_association *asoc,
1756 struct sctp_chunk *chunk,
1757 sctp_cmd_seq_t *commands,
1758 struct sctp_association *new_asoc)
1760 sctp_init_chunk_t *peer_init;
1761 struct sctp_chunk *repl;
1763 /* new_asoc is a brand-new association, so these are not yet
1764 * side effects--it is safe to run them here.
1766 peer_init = &chunk->subh.cookie_hdr->c.peer_init[0];
1767 if (!sctp_process_init(new_asoc, chunk->chunk_hdr->type,
1768 sctp_source(chunk), peer_init,
1769 GFP_ATOMIC))
1770 goto nomem;
1772 /* Update the content of current association. */
1773 sctp_add_cmd_sf(commands, SCTP_CMD_UPDATE_ASSOC, SCTP_ASOC(new_asoc));
1774 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
1775 SCTP_STATE(SCTP_STATE_ESTABLISHED));
1776 SCTP_INC_STATS(SCTP_MIB_CURRESTAB);
1777 sctp_add_cmd_sf(commands, SCTP_CMD_HB_TIMERS_START, SCTP_NULL());
1779 repl = sctp_make_cookie_ack(new_asoc, chunk);
1780 if (!repl)
1781 goto nomem;
1783 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(repl));
1784 sctp_add_cmd_sf(commands, SCTP_CMD_TRANSMIT, SCTP_NULL());
1786 /* RFC 2960 5.1 Normal Establishment of an Association
1788 * D) IMPLEMENTATION NOTE: An implementation may choose to
1789 * send the Communication Up notification to the SCTP user
1790 * upon reception of a valid COOKIE ECHO chunk.
1792 * Sadly, this needs to be implemented as a side-effect, because
1793 * we are not guaranteed to have set the association id of the real
1794 * association and so these notifications need to be delayed until
1795 * the association id is allocated.
1798 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_CHANGE, SCTP_U8(SCTP_COMM_UP));
1800 /* Sockets API Draft Section 5.3.1.6
1801 * When a peer sends a Adaptation Layer Indication parameter , SCTP
1802 * delivers this notification to inform the application that of the
1803 * peers requested adaptation layer.
1805 * This also needs to be done as a side effect for the same reason as
1806 * above.
1808 if (asoc->peer.adaptation_ind)
1809 sctp_add_cmd_sf(commands, SCTP_CMD_ADAPTATION_IND, SCTP_NULL());
1811 return SCTP_DISPOSITION_CONSUME;
1813 nomem:
1814 return SCTP_DISPOSITION_NOMEM;
1817 /* Unexpected COOKIE-ECHO handler for setup collision (Table 2, action 'C')
1819 * Section 5.2.4
1820 * C) In this case, the local endpoint's cookie has arrived late.
1821 * Before it arrived, the local endpoint sent an INIT and received an
1822 * INIT-ACK and finally sent a COOKIE ECHO with the peer's same tag
1823 * but a new tag of its own.
1825 /* This case represents an initialization collision. */
1826 static sctp_disposition_t sctp_sf_do_dupcook_c(const struct sctp_endpoint *ep,
1827 const struct sctp_association *asoc,
1828 struct sctp_chunk *chunk,
1829 sctp_cmd_seq_t *commands,
1830 struct sctp_association *new_asoc)
1832 /* The cookie should be silently discarded.
1833 * The endpoint SHOULD NOT change states and should leave
1834 * any timers running.
1836 return SCTP_DISPOSITION_DISCARD;
1839 /* Unexpected COOKIE-ECHO handler lost chunk (Table 2, action 'D')
1841 * Section 5.2.4
1843 * D) When both local and remote tags match the endpoint should always
1844 * enter the ESTABLISHED state, if it has not already done so.
1846 /* This case represents an initialization collision. */
1847 static sctp_disposition_t sctp_sf_do_dupcook_d(const struct sctp_endpoint *ep,
1848 const struct sctp_association *asoc,
1849 struct sctp_chunk *chunk,
1850 sctp_cmd_seq_t *commands,
1851 struct sctp_association *new_asoc)
1853 struct sctp_ulpevent *ev = NULL, *ai_ev = NULL;
1854 struct sctp_chunk *repl;
1856 /* Clarification from Implementor's Guide:
1857 * D) When both local and remote tags match the endpoint should
1858 * enter the ESTABLISHED state, if it is in the COOKIE-ECHOED state.
1859 * It should stop any cookie timer that may be running and send
1860 * a COOKIE ACK.
1863 /* Don't accidentally move back into established state. */
1864 if (asoc->state < SCTP_STATE_ESTABLISHED) {
1865 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
1866 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_COOKIE));
1867 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
1868 SCTP_STATE(SCTP_STATE_ESTABLISHED));
1869 SCTP_INC_STATS(SCTP_MIB_CURRESTAB);
1870 sctp_add_cmd_sf(commands, SCTP_CMD_HB_TIMERS_START,
1871 SCTP_NULL());
1873 /* RFC 2960 5.1 Normal Establishment of an Association
1875 * D) IMPLEMENTATION NOTE: An implementation may choose
1876 * to send the Communication Up notification to the
1877 * SCTP user upon reception of a valid COOKIE
1878 * ECHO chunk.
1880 ev = sctp_ulpevent_make_assoc_change(asoc, 0,
1881 SCTP_COMM_UP, 0,
1882 asoc->c.sinit_num_ostreams,
1883 asoc->c.sinit_max_instreams,
1884 NULL, GFP_ATOMIC);
1885 if (!ev)
1886 goto nomem;
1888 /* Sockets API Draft Section 5.3.1.6
1889 * When a peer sends a Adaptation Layer Indication parameter,
1890 * SCTP delivers this notification to inform the application
1891 * that of the peers requested adaptation layer.
1893 if (asoc->peer.adaptation_ind) {
1894 ai_ev = sctp_ulpevent_make_adaptation_indication(asoc,
1895 GFP_ATOMIC);
1896 if (!ai_ev)
1897 goto nomem;
1901 sctp_add_cmd_sf(commands, SCTP_CMD_TRANSMIT, SCTP_NULL());
1903 repl = sctp_make_cookie_ack(new_asoc, chunk);
1904 if (!repl)
1905 goto nomem;
1907 if (ev)
1908 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP,
1909 SCTP_ULPEVENT(ev));
1910 if (ai_ev)
1911 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP,
1912 SCTP_ULPEVENT(ai_ev));
1914 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(repl));
1915 sctp_add_cmd_sf(commands, SCTP_CMD_TRANSMIT, SCTP_NULL());
1917 return SCTP_DISPOSITION_CONSUME;
1919 nomem:
1920 if (ai_ev)
1921 sctp_ulpevent_free(ai_ev);
1922 if (ev)
1923 sctp_ulpevent_free(ev);
1924 return SCTP_DISPOSITION_NOMEM;
1928 * Handle a duplicate COOKIE-ECHO. This usually means a cookie-carrying
1929 * chunk was retransmitted and then delayed in the network.
1931 * Section: 5.2.4 Handle a COOKIE ECHO when a TCB exists
1933 * Verification Tag: None. Do cookie validation.
1935 * Inputs
1936 * (endpoint, asoc, chunk)
1938 * Outputs
1939 * (asoc, reply_msg, msg_up, timers, counters)
1941 * The return value is the disposition of the chunk.
1943 sctp_disposition_t sctp_sf_do_5_2_4_dupcook(const struct sctp_endpoint *ep,
1944 const struct sctp_association *asoc,
1945 const sctp_subtype_t type,
1946 void *arg,
1947 sctp_cmd_seq_t *commands)
1949 sctp_disposition_t retval;
1950 struct sctp_chunk *chunk = arg;
1951 struct sctp_association *new_asoc;
1952 int error = 0;
1953 char action;
1954 struct sctp_chunk *err_chk_p;
1956 /* Make sure that the chunk has a valid length from the protocol
1957 * perspective. In this case check to make sure we have at least
1958 * enough for the chunk header. Cookie length verification is
1959 * done later.
1961 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_chunkhdr_t)))
1962 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
1963 commands);
1965 /* "Decode" the chunk. We have no optional parameters so we
1966 * are in good shape.
1968 chunk->subh.cookie_hdr = (struct sctp_signed_cookie *)chunk->skb->data;
1969 if (!pskb_pull(chunk->skb, ntohs(chunk->chunk_hdr->length) -
1970 sizeof(sctp_chunkhdr_t)))
1971 goto nomem;
1973 /* In RFC 2960 5.2.4 3, if both Verification Tags in the State Cookie
1974 * of a duplicate COOKIE ECHO match the Verification Tags of the
1975 * current association, consider the State Cookie valid even if
1976 * the lifespan is exceeded.
1978 new_asoc = sctp_unpack_cookie(ep, asoc, chunk, GFP_ATOMIC, &error,
1979 &err_chk_p);
1981 /* FIXME:
1982 * If the re-build failed, what is the proper error path
1983 * from here?
1985 * [We should abort the association. --piggy]
1987 if (!new_asoc) {
1988 /* FIXME: Several errors are possible. A bad cookie should
1989 * be silently discarded, but think about logging it too.
1991 switch (error) {
1992 case -SCTP_IERROR_NOMEM:
1993 goto nomem;
1995 case -SCTP_IERROR_STALE_COOKIE:
1996 sctp_send_stale_cookie_err(ep, asoc, chunk, commands,
1997 err_chk_p);
1998 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
1999 case -SCTP_IERROR_BAD_SIG:
2000 default:
2001 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2005 /* Compare the tie_tag in cookie with the verification tag of
2006 * current association.
2008 action = sctp_tietags_compare(new_asoc, asoc);
2010 switch (action) {
2011 case 'A': /* Association restart. */
2012 retval = sctp_sf_do_dupcook_a(ep, asoc, chunk, commands,
2013 new_asoc);
2014 break;
2016 case 'B': /* Collision case B. */
2017 retval = sctp_sf_do_dupcook_b(ep, asoc, chunk, commands,
2018 new_asoc);
2019 break;
2021 case 'C': /* Collision case C. */
2022 retval = sctp_sf_do_dupcook_c(ep, asoc, chunk, commands,
2023 new_asoc);
2024 break;
2026 case 'D': /* Collision case D. */
2027 retval = sctp_sf_do_dupcook_d(ep, asoc, chunk, commands,
2028 new_asoc);
2029 break;
2031 default: /* Discard packet for all others. */
2032 retval = sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2033 break;
2036 /* Delete the tempory new association. */
2037 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_ASOC, SCTP_ASOC(new_asoc));
2038 sctp_add_cmd_sf(commands, SCTP_CMD_DELETE_TCB, SCTP_NULL());
2040 return retval;
2042 nomem:
2043 return SCTP_DISPOSITION_NOMEM;
2047 * Process an ABORT. (SHUTDOWN-PENDING state)
2049 * See sctp_sf_do_9_1_abort().
2051 sctp_disposition_t sctp_sf_shutdown_pending_abort(
2052 const struct sctp_endpoint *ep,
2053 const struct sctp_association *asoc,
2054 const sctp_subtype_t type,
2055 void *arg,
2056 sctp_cmd_seq_t *commands)
2058 struct sctp_chunk *chunk = arg;
2060 if (!sctp_vtag_verify_either(chunk, asoc))
2061 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2063 /* Make sure that the ABORT chunk has a valid length.
2064 * Since this is an ABORT chunk, we have to discard it
2065 * because of the following text:
2066 * RFC 2960, Section 3.3.7
2067 * If an endpoint receives an ABORT with a format error or for an
2068 * association that doesn't exist, it MUST silently discard it.
2069 * Becasue the length is "invalid", we can't really discard just
2070 * as we do not know its true length. So, to be safe, discard the
2071 * packet.
2073 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_abort_chunk_t)))
2074 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2076 /* Stop the T5-shutdown guard timer. */
2077 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
2078 SCTP_TO(SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD));
2080 return sctp_sf_do_9_1_abort(ep, asoc, type, arg, commands);
2084 * Process an ABORT. (SHUTDOWN-SENT state)
2086 * See sctp_sf_do_9_1_abort().
2088 sctp_disposition_t sctp_sf_shutdown_sent_abort(const struct sctp_endpoint *ep,
2089 const struct sctp_association *asoc,
2090 const sctp_subtype_t type,
2091 void *arg,
2092 sctp_cmd_seq_t *commands)
2094 struct sctp_chunk *chunk = arg;
2096 if (!sctp_vtag_verify_either(chunk, asoc))
2097 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2099 /* Make sure that the ABORT chunk has a valid length.
2100 * Since this is an ABORT chunk, we have to discard it
2101 * because of the following text:
2102 * RFC 2960, Section 3.3.7
2103 * If an endpoint receives an ABORT with a format error or for an
2104 * association that doesn't exist, it MUST silently discard it.
2105 * Becasue the length is "invalid", we can't really discard just
2106 * as we do not know its true length. So, to be safe, discard the
2107 * packet.
2109 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_abort_chunk_t)))
2110 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2112 /* Stop the T2-shutdown timer. */
2113 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
2114 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
2116 /* Stop the T5-shutdown guard timer. */
2117 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
2118 SCTP_TO(SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD));
2120 return sctp_sf_do_9_1_abort(ep, asoc, type, arg, commands);
2124 * Process an ABORT. (SHUTDOWN-ACK-SENT state)
2126 * See sctp_sf_do_9_1_abort().
2128 sctp_disposition_t sctp_sf_shutdown_ack_sent_abort(
2129 const struct sctp_endpoint *ep,
2130 const struct sctp_association *asoc,
2131 const sctp_subtype_t type,
2132 void *arg,
2133 sctp_cmd_seq_t *commands)
2135 /* The same T2 timer, so we should be able to use
2136 * common function with the SHUTDOWN-SENT state.
2138 return sctp_sf_shutdown_sent_abort(ep, asoc, type, arg, commands);
2142 * Handle an Error received in COOKIE_ECHOED state.
2144 * Only handle the error type of stale COOKIE Error, the other errors will
2145 * be ignored.
2147 * Inputs
2148 * (endpoint, asoc, chunk)
2150 * Outputs
2151 * (asoc, reply_msg, msg_up, timers, counters)
2153 * The return value is the disposition of the chunk.
2155 sctp_disposition_t sctp_sf_cookie_echoed_err(const struct sctp_endpoint *ep,
2156 const struct sctp_association *asoc,
2157 const sctp_subtype_t type,
2158 void *arg,
2159 sctp_cmd_seq_t *commands)
2161 struct sctp_chunk *chunk = arg;
2162 sctp_errhdr_t *err;
2164 if (!sctp_vtag_verify(chunk, asoc))
2165 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2167 /* Make sure that the ERROR chunk has a valid length.
2168 * The parameter walking depends on this as well.
2170 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_operr_chunk_t)))
2171 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
2172 commands);
2174 /* Process the error here */
2175 /* FUTURE FIXME: When PR-SCTP related and other optional
2176 * parms are emitted, this will have to change to handle multiple
2177 * errors.
2179 sctp_walk_errors(err, chunk->chunk_hdr) {
2180 if (SCTP_ERROR_STALE_COOKIE == err->cause)
2181 return sctp_sf_do_5_2_6_stale(ep, asoc, type,
2182 arg, commands);
2185 /* It is possible to have malformed error causes, and that
2186 * will cause us to end the walk early. However, since
2187 * we are discarding the packet, there should be no adverse
2188 * affects.
2190 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2194 * Handle a Stale COOKIE Error
2196 * Section: 5.2.6 Handle Stale COOKIE Error
2197 * If the association is in the COOKIE-ECHOED state, the endpoint may elect
2198 * one of the following three alternatives.
2199 * ...
2200 * 3) Send a new INIT chunk to the endpoint, adding a Cookie
2201 * Preservative parameter requesting an extension to the lifetime of
2202 * the State Cookie. When calculating the time extension, an
2203 * implementation SHOULD use the RTT information measured based on the
2204 * previous COOKIE ECHO / ERROR exchange, and should add no more
2205 * than 1 second beyond the measured RTT, due to long State Cookie
2206 * lifetimes making the endpoint more subject to a replay attack.
2208 * Verification Tag: Not explicit, but safe to ignore.
2210 * Inputs
2211 * (endpoint, asoc, chunk)
2213 * Outputs
2214 * (asoc, reply_msg, msg_up, timers, counters)
2216 * The return value is the disposition of the chunk.
2218 static sctp_disposition_t sctp_sf_do_5_2_6_stale(const struct sctp_endpoint *ep,
2219 const struct sctp_association *asoc,
2220 const sctp_subtype_t type,
2221 void *arg,
2222 sctp_cmd_seq_t *commands)
2224 struct sctp_chunk *chunk = arg;
2225 time_t stale;
2226 sctp_cookie_preserve_param_t bht;
2227 sctp_errhdr_t *err;
2228 struct sctp_chunk *reply;
2229 struct sctp_bind_addr *bp;
2230 int attempts = asoc->init_err_counter + 1;
2232 if (attempts > asoc->max_init_attempts) {
2233 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
2234 SCTP_ERROR(ETIMEDOUT));
2235 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_FAILED,
2236 SCTP_PERR(SCTP_ERROR_STALE_COOKIE));
2237 return SCTP_DISPOSITION_DELETE_TCB;
2240 err = (sctp_errhdr_t *)(chunk->skb->data);
2242 /* When calculating the time extension, an implementation
2243 * SHOULD use the RTT information measured based on the
2244 * previous COOKIE ECHO / ERROR exchange, and should add no
2245 * more than 1 second beyond the measured RTT, due to long
2246 * State Cookie lifetimes making the endpoint more subject to
2247 * a replay attack.
2248 * Measure of Staleness's unit is usec. (1/1000000 sec)
2249 * Suggested Cookie Life-span Increment's unit is msec.
2250 * (1/1000 sec)
2251 * In general, if you use the suggested cookie life, the value
2252 * found in the field of measure of staleness should be doubled
2253 * to give ample time to retransmit the new cookie and thus
2254 * yield a higher probability of success on the reattempt.
2256 stale = ntohl(*(__be32 *)((u8 *)err + sizeof(sctp_errhdr_t)));
2257 stale = (stale * 2) / 1000;
2259 bht.param_hdr.type = SCTP_PARAM_COOKIE_PRESERVATIVE;
2260 bht.param_hdr.length = htons(sizeof(bht));
2261 bht.lifespan_increment = htonl(stale);
2263 /* Build that new INIT chunk. */
2264 bp = (struct sctp_bind_addr *) &asoc->base.bind_addr;
2265 reply = sctp_make_init(asoc, bp, GFP_ATOMIC, sizeof(bht));
2266 if (!reply)
2267 goto nomem;
2269 sctp_addto_chunk(reply, sizeof(bht), &bht);
2271 /* Clear peer's init_tag cached in assoc as we are sending a new INIT */
2272 sctp_add_cmd_sf(commands, SCTP_CMD_CLEAR_INIT_TAG, SCTP_NULL());
2274 /* Stop pending T3-rtx and heartbeat timers */
2275 sctp_add_cmd_sf(commands, SCTP_CMD_T3_RTX_TIMERS_STOP, SCTP_NULL());
2276 sctp_add_cmd_sf(commands, SCTP_CMD_HB_TIMERS_STOP, SCTP_NULL());
2278 /* Delete non-primary peer ip addresses since we are transitioning
2279 * back to the COOKIE-WAIT state
2281 sctp_add_cmd_sf(commands, SCTP_CMD_DEL_NON_PRIMARY, SCTP_NULL());
2283 /* If we've sent any data bundled with COOKIE-ECHO we will need to
2284 * resend
2286 sctp_add_cmd_sf(commands, SCTP_CMD_T1_RETRAN,
2287 SCTP_TRANSPORT(asoc->peer.primary_path));
2289 /* Cast away the const modifier, as we want to just
2290 * rerun it through as a sideffect.
2292 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_COUNTER_INC, SCTP_NULL());
2294 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
2295 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_COOKIE));
2296 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
2297 SCTP_STATE(SCTP_STATE_COOKIE_WAIT));
2298 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_START,
2299 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_INIT));
2301 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(reply));
2303 return SCTP_DISPOSITION_CONSUME;
2305 nomem:
2306 return SCTP_DISPOSITION_NOMEM;
2310 * Process an ABORT.
2312 * Section: 9.1
2313 * After checking the Verification Tag, the receiving endpoint shall
2314 * remove the association from its record, and shall report the
2315 * termination to its upper layer.
2317 * Verification Tag: 8.5.1 Exceptions in Verification Tag Rules
2318 * B) Rules for packet carrying ABORT:
2320 * - The endpoint shall always fill in the Verification Tag field of the
2321 * outbound packet with the destination endpoint's tag value if it
2322 * is known.
2324 * - If the ABORT is sent in response to an OOTB packet, the endpoint
2325 * MUST follow the procedure described in Section 8.4.
2327 * - The receiver MUST accept the packet if the Verification Tag
2328 * matches either its own tag, OR the tag of its peer. Otherwise, the
2329 * receiver MUST silently discard the packet and take no further
2330 * action.
2332 * Inputs
2333 * (endpoint, asoc, chunk)
2335 * Outputs
2336 * (asoc, reply_msg, msg_up, timers, counters)
2338 * The return value is the disposition of the chunk.
2340 sctp_disposition_t sctp_sf_do_9_1_abort(const struct sctp_endpoint *ep,
2341 const struct sctp_association *asoc,
2342 const sctp_subtype_t type,
2343 void *arg,
2344 sctp_cmd_seq_t *commands)
2346 struct sctp_chunk *chunk = arg;
2347 unsigned len;
2348 __be16 error = SCTP_ERROR_NO_ERROR;
2350 if (!sctp_vtag_verify_either(chunk, asoc))
2351 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2353 /* Make sure that the ABORT chunk has a valid length.
2354 * Since this is an ABORT chunk, we have to discard it
2355 * because of the following text:
2356 * RFC 2960, Section 3.3.7
2357 * If an endpoint receives an ABORT with a format error or for an
2358 * association that doesn't exist, it MUST silently discard it.
2359 * Becasue the length is "invalid", we can't really discard just
2360 * as we do not know its true length. So, to be safe, discard the
2361 * packet.
2363 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_abort_chunk_t)))
2364 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2366 /* See if we have an error cause code in the chunk. */
2367 len = ntohs(chunk->chunk_hdr->length);
2368 if (len >= sizeof(struct sctp_chunkhdr) + sizeof(struct sctp_errhdr))
2369 error = ((sctp_errhdr_t *)chunk->skb->data)->cause;
2371 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR, SCTP_ERROR(ECONNRESET));
2372 /* ASSOC_FAILED will DELETE_TCB. */
2373 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED, SCTP_PERR(error));
2374 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
2375 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
2377 return SCTP_DISPOSITION_ABORT;
2381 * Process an ABORT. (COOKIE-WAIT state)
2383 * See sctp_sf_do_9_1_abort() above.
2385 sctp_disposition_t sctp_sf_cookie_wait_abort(const struct sctp_endpoint *ep,
2386 const struct sctp_association *asoc,
2387 const sctp_subtype_t type,
2388 void *arg,
2389 sctp_cmd_seq_t *commands)
2391 struct sctp_chunk *chunk = arg;
2392 unsigned len;
2393 __be16 error = SCTP_ERROR_NO_ERROR;
2395 if (!sctp_vtag_verify_either(chunk, asoc))
2396 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2398 /* Make sure that the ABORT chunk has a valid length.
2399 * Since this is an ABORT chunk, we have to discard it
2400 * because of the following text:
2401 * RFC 2960, Section 3.3.7
2402 * If an endpoint receives an ABORT with a format error or for an
2403 * association that doesn't exist, it MUST silently discard it.
2404 * Becasue the length is "invalid", we can't really discard just
2405 * as we do not know its true length. So, to be safe, discard the
2406 * packet.
2408 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_abort_chunk_t)))
2409 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2411 /* See if we have an error cause code in the chunk. */
2412 len = ntohs(chunk->chunk_hdr->length);
2413 if (len >= sizeof(struct sctp_chunkhdr) + sizeof(struct sctp_errhdr))
2414 error = ((sctp_errhdr_t *)chunk->skb->data)->cause;
2416 return sctp_stop_t1_and_abort(commands, error, ECONNREFUSED, asoc,
2417 chunk->transport);
2421 * Process an incoming ICMP as an ABORT. (COOKIE-WAIT state)
2423 sctp_disposition_t sctp_sf_cookie_wait_icmp_abort(const struct sctp_endpoint *ep,
2424 const struct sctp_association *asoc,
2425 const sctp_subtype_t type,
2426 void *arg,
2427 sctp_cmd_seq_t *commands)
2429 return sctp_stop_t1_and_abort(commands, SCTP_ERROR_NO_ERROR,
2430 ENOPROTOOPT, asoc,
2431 (struct sctp_transport *)arg);
2435 * Process an ABORT. (COOKIE-ECHOED state)
2437 sctp_disposition_t sctp_sf_cookie_echoed_abort(const struct sctp_endpoint *ep,
2438 const struct sctp_association *asoc,
2439 const sctp_subtype_t type,
2440 void *arg,
2441 sctp_cmd_seq_t *commands)
2443 /* There is a single T1 timer, so we should be able to use
2444 * common function with the COOKIE-WAIT state.
2446 return sctp_sf_cookie_wait_abort(ep, asoc, type, arg, commands);
2450 * Stop T1 timer and abort association with "INIT failed".
2452 * This is common code called by several sctp_sf_*_abort() functions above.
2454 static sctp_disposition_t sctp_stop_t1_and_abort(sctp_cmd_seq_t *commands,
2455 __be16 error, int sk_err,
2456 const struct sctp_association *asoc,
2457 struct sctp_transport *transport)
2459 SCTP_DEBUG_PRINTK("ABORT received (INIT).\n");
2460 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
2461 SCTP_STATE(SCTP_STATE_CLOSED));
2462 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
2463 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
2464 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_INIT));
2465 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR, SCTP_ERROR(sk_err));
2466 /* CMD_INIT_FAILED will DELETE_TCB. */
2467 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_FAILED,
2468 SCTP_PERR(error));
2469 return SCTP_DISPOSITION_ABORT;
2473 * sctp_sf_do_9_2_shut
2475 * Section: 9.2
2476 * Upon the reception of the SHUTDOWN, the peer endpoint shall
2477 * - enter the SHUTDOWN-RECEIVED state,
2479 * - stop accepting new data from its SCTP user
2481 * - verify, by checking the Cumulative TSN Ack field of the chunk,
2482 * that all its outstanding DATA chunks have been received by the
2483 * SHUTDOWN sender.
2485 * Once an endpoint as reached the SHUTDOWN-RECEIVED state it MUST NOT
2486 * send a SHUTDOWN in response to a ULP request. And should discard
2487 * subsequent SHUTDOWN chunks.
2489 * If there are still outstanding DATA chunks left, the SHUTDOWN
2490 * receiver shall continue to follow normal data transmission
2491 * procedures defined in Section 6 until all outstanding DATA chunks
2492 * are acknowledged; however, the SHUTDOWN receiver MUST NOT accept
2493 * new data from its SCTP user.
2495 * Verification Tag: 8.5 Verification Tag [Normal verification]
2497 * Inputs
2498 * (endpoint, asoc, chunk)
2500 * Outputs
2501 * (asoc, reply_msg, msg_up, timers, counters)
2503 * The return value is the disposition of the chunk.
2505 sctp_disposition_t sctp_sf_do_9_2_shutdown(const struct sctp_endpoint *ep,
2506 const struct sctp_association *asoc,
2507 const sctp_subtype_t type,
2508 void *arg,
2509 sctp_cmd_seq_t *commands)
2511 struct sctp_chunk *chunk = arg;
2512 sctp_shutdownhdr_t *sdh;
2513 sctp_disposition_t disposition;
2514 struct sctp_ulpevent *ev;
2516 if (!sctp_vtag_verify(chunk, asoc))
2517 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2519 /* Make sure that the SHUTDOWN chunk has a valid length. */
2520 if (!sctp_chunk_length_valid(chunk,
2521 sizeof(struct sctp_shutdown_chunk_t)))
2522 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
2523 commands);
2525 /* Convert the elaborate header. */
2526 sdh = (sctp_shutdownhdr_t *)chunk->skb->data;
2527 skb_pull(chunk->skb, sizeof(sctp_shutdownhdr_t));
2528 chunk->subh.shutdown_hdr = sdh;
2530 /* API 5.3.1.5 SCTP_SHUTDOWN_EVENT
2531 * When a peer sends a SHUTDOWN, SCTP delivers this notification to
2532 * inform the application that it should cease sending data.
2534 ev = sctp_ulpevent_make_shutdown_event(asoc, 0, GFP_ATOMIC);
2535 if (!ev) {
2536 disposition = SCTP_DISPOSITION_NOMEM;
2537 goto out;
2539 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP, SCTP_ULPEVENT(ev));
2541 /* Upon the reception of the SHUTDOWN, the peer endpoint shall
2542 * - enter the SHUTDOWN-RECEIVED state,
2543 * - stop accepting new data from its SCTP user
2545 * [This is implicit in the new state.]
2547 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
2548 SCTP_STATE(SCTP_STATE_SHUTDOWN_RECEIVED));
2549 disposition = SCTP_DISPOSITION_CONSUME;
2551 if (sctp_outq_is_empty(&asoc->outqueue)) {
2552 disposition = sctp_sf_do_9_2_shutdown_ack(ep, asoc, type,
2553 arg, commands);
2556 if (SCTP_DISPOSITION_NOMEM == disposition)
2557 goto out;
2559 /* - verify, by checking the Cumulative TSN Ack field of the
2560 * chunk, that all its outstanding DATA chunks have been
2561 * received by the SHUTDOWN sender.
2563 sctp_add_cmd_sf(commands, SCTP_CMD_PROCESS_CTSN,
2564 SCTP_BE32(chunk->subh.shutdown_hdr->cum_tsn_ack));
2566 out:
2567 return disposition;
2570 /* RFC 2960 9.2
2571 * If an endpoint is in SHUTDOWN-ACK-SENT state and receives an INIT chunk
2572 * (e.g., if the SHUTDOWN COMPLETE was lost) with source and destination
2573 * transport addresses (either in the IP addresses or in the INIT chunk)
2574 * that belong to this association, it should discard the INIT chunk and
2575 * retransmit the SHUTDOWN ACK chunk.
2577 sctp_disposition_t sctp_sf_do_9_2_reshutack(const struct sctp_endpoint *ep,
2578 const struct sctp_association *asoc,
2579 const sctp_subtype_t type,
2580 void *arg,
2581 sctp_cmd_seq_t *commands)
2583 struct sctp_chunk *chunk = (struct sctp_chunk *) arg;
2584 struct sctp_chunk *reply;
2586 /* Make sure that the chunk has a valid length */
2587 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_chunkhdr_t)))
2588 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
2589 commands);
2591 /* Since we are not going to really process this INIT, there
2592 * is no point in verifying chunk boundries. Just generate
2593 * the SHUTDOWN ACK.
2595 reply = sctp_make_shutdown_ack(asoc, chunk);
2596 if (NULL == reply)
2597 goto nomem;
2599 /* Set the transport for the SHUTDOWN ACK chunk and the timeout for
2600 * the T2-SHUTDOWN timer.
2602 sctp_add_cmd_sf(commands, SCTP_CMD_SETUP_T2, SCTP_CHUNK(reply));
2604 /* and restart the T2-shutdown timer. */
2605 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
2606 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
2608 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(reply));
2610 return SCTP_DISPOSITION_CONSUME;
2611 nomem:
2612 return SCTP_DISPOSITION_NOMEM;
2616 * sctp_sf_do_ecn_cwr
2618 * Section: Appendix A: Explicit Congestion Notification
2620 * CWR:
2622 * RFC 2481 details a specific bit for a sender to send in the header of
2623 * its next outbound TCP segment to indicate to its peer that it has
2624 * reduced its congestion window. This is termed the CWR bit. For
2625 * SCTP the same indication is made by including the CWR chunk.
2626 * This chunk contains one data element, i.e. the TSN number that
2627 * was sent in the ECNE chunk. This element represents the lowest
2628 * TSN number in the datagram that was originally marked with the
2629 * CE bit.
2631 * Verification Tag: 8.5 Verification Tag [Normal verification]
2632 * Inputs
2633 * (endpoint, asoc, chunk)
2635 * Outputs
2636 * (asoc, reply_msg, msg_up, timers, counters)
2638 * The return value is the disposition of the chunk.
2640 sctp_disposition_t sctp_sf_do_ecn_cwr(const struct sctp_endpoint *ep,
2641 const struct sctp_association *asoc,
2642 const sctp_subtype_t type,
2643 void *arg,
2644 sctp_cmd_seq_t *commands)
2646 sctp_cwrhdr_t *cwr;
2647 struct sctp_chunk *chunk = arg;
2648 u32 lowest_tsn;
2650 if (!sctp_vtag_verify(chunk, asoc))
2651 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2653 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_ecne_chunk_t)))
2654 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
2655 commands);
2657 cwr = (sctp_cwrhdr_t *) chunk->skb->data;
2658 skb_pull(chunk->skb, sizeof(sctp_cwrhdr_t));
2660 lowest_tsn = ntohl(cwr->lowest_tsn);
2662 /* Does this CWR ack the last sent congestion notification? */
2663 if (TSN_lte(asoc->last_ecne_tsn, lowest_tsn)) {
2664 /* Stop sending ECNE. */
2665 sctp_add_cmd_sf(commands,
2666 SCTP_CMD_ECN_CWR,
2667 SCTP_U32(lowest_tsn));
2669 return SCTP_DISPOSITION_CONSUME;
2673 * sctp_sf_do_ecne
2675 * Section: Appendix A: Explicit Congestion Notification
2677 * ECN-Echo
2679 * RFC 2481 details a specific bit for a receiver to send back in its
2680 * TCP acknowledgements to notify the sender of the Congestion
2681 * Experienced (CE) bit having arrived from the network. For SCTP this
2682 * same indication is made by including the ECNE chunk. This chunk
2683 * contains one data element, i.e. the lowest TSN associated with the IP
2684 * datagram marked with the CE bit.....
2686 * Verification Tag: 8.5 Verification Tag [Normal verification]
2687 * Inputs
2688 * (endpoint, asoc, chunk)
2690 * Outputs
2691 * (asoc, reply_msg, msg_up, timers, counters)
2693 * The return value is the disposition of the chunk.
2695 sctp_disposition_t sctp_sf_do_ecne(const struct sctp_endpoint *ep,
2696 const struct sctp_association *asoc,
2697 const sctp_subtype_t type,
2698 void *arg,
2699 sctp_cmd_seq_t *commands)
2701 sctp_ecnehdr_t *ecne;
2702 struct sctp_chunk *chunk = arg;
2704 if (!sctp_vtag_verify(chunk, asoc))
2705 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2707 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_ecne_chunk_t)))
2708 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
2709 commands);
2711 ecne = (sctp_ecnehdr_t *) chunk->skb->data;
2712 skb_pull(chunk->skb, sizeof(sctp_ecnehdr_t));
2714 /* If this is a newer ECNE than the last CWR packet we sent out */
2715 sctp_add_cmd_sf(commands, SCTP_CMD_ECN_ECNE,
2716 SCTP_U32(ntohl(ecne->lowest_tsn)));
2718 return SCTP_DISPOSITION_CONSUME;
2722 * Section: 6.2 Acknowledgement on Reception of DATA Chunks
2724 * The SCTP endpoint MUST always acknowledge the reception of each valid
2725 * DATA chunk.
2727 * The guidelines on delayed acknowledgement algorithm specified in
2728 * Section 4.2 of [RFC2581] SHOULD be followed. Specifically, an
2729 * acknowledgement SHOULD be generated for at least every second packet
2730 * (not every second DATA chunk) received, and SHOULD be generated within
2731 * 200 ms of the arrival of any unacknowledged DATA chunk. In some
2732 * situations it may be beneficial for an SCTP transmitter to be more
2733 * conservative than the algorithms detailed in this document allow.
2734 * However, an SCTP transmitter MUST NOT be more aggressive than the
2735 * following algorithms allow.
2737 * A SCTP receiver MUST NOT generate more than one SACK for every
2738 * incoming packet, other than to update the offered window as the
2739 * receiving application consumes new data.
2741 * Verification Tag: 8.5 Verification Tag [Normal verification]
2743 * Inputs
2744 * (endpoint, asoc, chunk)
2746 * Outputs
2747 * (asoc, reply_msg, msg_up, timers, counters)
2749 * The return value is the disposition of the chunk.
2751 sctp_disposition_t sctp_sf_eat_data_6_2(const struct sctp_endpoint *ep,
2752 const struct sctp_association *asoc,
2753 const sctp_subtype_t type,
2754 void *arg,
2755 sctp_cmd_seq_t *commands)
2757 struct sctp_chunk *chunk = arg;
2758 int error;
2760 if (!sctp_vtag_verify(chunk, asoc)) {
2761 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_BAD_TAG,
2762 SCTP_NULL());
2763 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2766 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_data_chunk_t)))
2767 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
2768 commands);
2770 error = sctp_eat_data(asoc, chunk, commands );
2771 switch (error) {
2772 case SCTP_IERROR_NO_ERROR:
2773 break;
2774 case SCTP_IERROR_HIGH_TSN:
2775 case SCTP_IERROR_BAD_STREAM:
2776 SCTP_INC_STATS(SCTP_MIB_IN_DATA_CHUNK_DISCARDS);
2777 goto discard_noforce;
2778 case SCTP_IERROR_DUP_TSN:
2779 case SCTP_IERROR_IGNORE_TSN:
2780 SCTP_INC_STATS(SCTP_MIB_IN_DATA_CHUNK_DISCARDS);
2781 goto discard_force;
2782 case SCTP_IERROR_NO_DATA:
2783 goto consume;
2784 default:
2785 BUG();
2788 if (asoc->autoclose) {
2789 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
2790 SCTP_TO(SCTP_EVENT_TIMEOUT_AUTOCLOSE));
2793 /* If this is the last chunk in a packet, we need to count it
2794 * toward sack generation. Note that we need to SACK every
2795 * OTHER packet containing data chunks, EVEN IF WE DISCARD
2796 * THEM. We elect to NOT generate SACK's if the chunk fails
2797 * the verification tag test.
2799 * RFC 2960 6.2 Acknowledgement on Reception of DATA Chunks
2801 * The SCTP endpoint MUST always acknowledge the reception of
2802 * each valid DATA chunk.
2804 * The guidelines on delayed acknowledgement algorithm
2805 * specified in Section 4.2 of [RFC2581] SHOULD be followed.
2806 * Specifically, an acknowledgement SHOULD be generated for at
2807 * least every second packet (not every second DATA chunk)
2808 * received, and SHOULD be generated within 200 ms of the
2809 * arrival of any unacknowledged DATA chunk. In some
2810 * situations it may be beneficial for an SCTP transmitter to
2811 * be more conservative than the algorithms detailed in this
2812 * document allow. However, an SCTP transmitter MUST NOT be
2813 * more aggressive than the following algorithms allow.
2815 if (chunk->end_of_packet)
2816 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_SACK, SCTP_NOFORCE());
2818 return SCTP_DISPOSITION_CONSUME;
2820 discard_force:
2821 /* RFC 2960 6.2 Acknowledgement on Reception of DATA Chunks
2823 * When a packet arrives with duplicate DATA chunk(s) and with
2824 * no new DATA chunk(s), the endpoint MUST immediately send a
2825 * SACK with no delay. If a packet arrives with duplicate
2826 * DATA chunk(s) bundled with new DATA chunks, the endpoint
2827 * MAY immediately send a SACK. Normally receipt of duplicate
2828 * DATA chunks will occur when the original SACK chunk was lost
2829 * and the peer's RTO has expired. The duplicate TSN number(s)
2830 * SHOULD be reported in the SACK as duplicate.
2832 /* In our case, we split the MAY SACK advice up whether or not
2833 * the last chunk is a duplicate.'
2835 if (chunk->end_of_packet)
2836 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_SACK, SCTP_FORCE());
2837 return SCTP_DISPOSITION_DISCARD;
2839 discard_noforce:
2840 if (chunk->end_of_packet)
2841 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_SACK, SCTP_NOFORCE());
2843 return SCTP_DISPOSITION_DISCARD;
2844 consume:
2845 return SCTP_DISPOSITION_CONSUME;
2850 * sctp_sf_eat_data_fast_4_4
2852 * Section: 4 (4)
2853 * (4) In SHUTDOWN-SENT state the endpoint MUST acknowledge any received
2854 * DATA chunks without delay.
2856 * Verification Tag: 8.5 Verification Tag [Normal verification]
2857 * Inputs
2858 * (endpoint, asoc, chunk)
2860 * Outputs
2861 * (asoc, reply_msg, msg_up, timers, counters)
2863 * The return value is the disposition of the chunk.
2865 sctp_disposition_t sctp_sf_eat_data_fast_4_4(const struct sctp_endpoint *ep,
2866 const struct sctp_association *asoc,
2867 const sctp_subtype_t type,
2868 void *arg,
2869 sctp_cmd_seq_t *commands)
2871 struct sctp_chunk *chunk = arg;
2872 int error;
2874 if (!sctp_vtag_verify(chunk, asoc)) {
2875 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_BAD_TAG,
2876 SCTP_NULL());
2877 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2880 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_data_chunk_t)))
2881 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
2882 commands);
2884 error = sctp_eat_data(asoc, chunk, commands );
2885 switch (error) {
2886 case SCTP_IERROR_NO_ERROR:
2887 case SCTP_IERROR_HIGH_TSN:
2888 case SCTP_IERROR_DUP_TSN:
2889 case SCTP_IERROR_IGNORE_TSN:
2890 case SCTP_IERROR_BAD_STREAM:
2891 break;
2892 case SCTP_IERROR_NO_DATA:
2893 goto consume;
2894 default:
2895 BUG();
2898 /* Go a head and force a SACK, since we are shutting down. */
2900 /* Implementor's Guide.
2902 * While in SHUTDOWN-SENT state, the SHUTDOWN sender MUST immediately
2903 * respond to each received packet containing one or more DATA chunk(s)
2904 * with a SACK, a SHUTDOWN chunk, and restart the T2-shutdown timer
2906 if (chunk->end_of_packet) {
2907 /* We must delay the chunk creation since the cumulative
2908 * TSN has not been updated yet.
2910 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_SHUTDOWN, SCTP_NULL());
2911 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_SACK, SCTP_FORCE());
2912 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
2913 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
2916 consume:
2917 return SCTP_DISPOSITION_CONSUME;
2921 * Section: 6.2 Processing a Received SACK
2922 * D) Any time a SACK arrives, the endpoint performs the following:
2924 * i) If Cumulative TSN Ack is less than the Cumulative TSN Ack Point,
2925 * then drop the SACK. Since Cumulative TSN Ack is monotonically
2926 * increasing, a SACK whose Cumulative TSN Ack is less than the
2927 * Cumulative TSN Ack Point indicates an out-of-order SACK.
2929 * ii) Set rwnd equal to the newly received a_rwnd minus the number
2930 * of bytes still outstanding after processing the Cumulative TSN Ack
2931 * and the Gap Ack Blocks.
2933 * iii) If the SACK is missing a TSN that was previously
2934 * acknowledged via a Gap Ack Block (e.g., the data receiver
2935 * reneged on the data), then mark the corresponding DATA chunk
2936 * as available for retransmit: Mark it as missing for fast
2937 * retransmit as described in Section 7.2.4 and if no retransmit
2938 * timer is running for the destination address to which the DATA
2939 * chunk was originally transmitted, then T3-rtx is started for
2940 * that destination address.
2942 * Verification Tag: 8.5 Verification Tag [Normal verification]
2944 * Inputs
2945 * (endpoint, asoc, chunk)
2947 * Outputs
2948 * (asoc, reply_msg, msg_up, timers, counters)
2950 * The return value is the disposition of the chunk.
2952 sctp_disposition_t sctp_sf_eat_sack_6_2(const struct sctp_endpoint *ep,
2953 const struct sctp_association *asoc,
2954 const sctp_subtype_t type,
2955 void *arg,
2956 sctp_cmd_seq_t *commands)
2958 struct sctp_chunk *chunk = arg;
2959 sctp_sackhdr_t *sackh;
2960 __u32 ctsn;
2962 if (!sctp_vtag_verify(chunk, asoc))
2963 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2965 /* Make sure that the SACK chunk has a valid length. */
2966 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_sack_chunk_t)))
2967 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
2968 commands);
2970 /* Pull the SACK chunk from the data buffer */
2971 sackh = sctp_sm_pull_sack(chunk);
2972 /* Was this a bogus SACK? */
2973 if (!sackh)
2974 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2975 chunk->subh.sack_hdr = sackh;
2976 ctsn = ntohl(sackh->cum_tsn_ack);
2978 /* i) If Cumulative TSN Ack is less than the Cumulative TSN
2979 * Ack Point, then drop the SACK. Since Cumulative TSN
2980 * Ack is monotonically increasing, a SACK whose
2981 * Cumulative TSN Ack is less than the Cumulative TSN Ack
2982 * Point indicates an out-of-order SACK.
2984 if (TSN_lt(ctsn, asoc->ctsn_ack_point)) {
2985 SCTP_DEBUG_PRINTK("ctsn %x\n", ctsn);
2986 SCTP_DEBUG_PRINTK("ctsn_ack_point %x\n", asoc->ctsn_ack_point);
2987 return SCTP_DISPOSITION_DISCARD;
2990 /* If Cumulative TSN Ack beyond the max tsn currently
2991 * send, terminating the association and respond to the
2992 * sender with an ABORT.
2994 if (!TSN_lt(ctsn, asoc->next_tsn))
2995 return sctp_sf_violation_ctsn(ep, asoc, type, arg, commands);
2997 /* Return this SACK for further processing. */
2998 sctp_add_cmd_sf(commands, SCTP_CMD_PROCESS_SACK, SCTP_SACKH(sackh));
3000 /* Note: We do the rest of the work on the PROCESS_SACK
3001 * sideeffect.
3003 return SCTP_DISPOSITION_CONSUME;
3007 * Generate an ABORT in response to a packet.
3009 * Section: 8.4 Handle "Out of the blue" Packets, sctpimpguide 2.41
3011 * 8) The receiver should respond to the sender of the OOTB packet with
3012 * an ABORT. When sending the ABORT, the receiver of the OOTB packet
3013 * MUST fill in the Verification Tag field of the outbound packet
3014 * with the value found in the Verification Tag field of the OOTB
3015 * packet and set the T-bit in the Chunk Flags to indicate that the
3016 * Verification Tag is reflected. After sending this ABORT, the
3017 * receiver of the OOTB packet shall discard the OOTB packet and take
3018 * no further action.
3020 * Verification Tag:
3022 * The return value is the disposition of the chunk.
3024 static sctp_disposition_t sctp_sf_tabort_8_4_8(const struct sctp_endpoint *ep,
3025 const struct sctp_association *asoc,
3026 const sctp_subtype_t type,
3027 void *arg,
3028 sctp_cmd_seq_t *commands)
3030 struct sctp_packet *packet = NULL;
3031 struct sctp_chunk *chunk = arg;
3032 struct sctp_chunk *abort;
3034 packet = sctp_ootb_pkt_new(asoc, chunk);
3036 if (packet) {
3037 /* Make an ABORT. The T bit will be set if the asoc
3038 * is NULL.
3040 abort = sctp_make_abort(asoc, chunk, 0);
3041 if (!abort) {
3042 sctp_ootb_pkt_free(packet);
3043 return SCTP_DISPOSITION_NOMEM;
3046 /* Reflect vtag if T-Bit is set */
3047 if (sctp_test_T_bit(abort))
3048 packet->vtag = ntohl(chunk->sctp_hdr->vtag);
3050 /* Set the skb to the belonging sock for accounting. */
3051 abort->skb->sk = ep->base.sk;
3053 sctp_packet_append_chunk(packet, abort);
3055 sctp_add_cmd_sf(commands, SCTP_CMD_SEND_PKT,
3056 SCTP_PACKET(packet));
3058 SCTP_INC_STATS(SCTP_MIB_OUTCTRLCHUNKS);
3060 sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3061 return SCTP_DISPOSITION_CONSUME;
3064 return SCTP_DISPOSITION_NOMEM;
3068 * Received an ERROR chunk from peer. Generate SCTP_REMOTE_ERROR
3069 * event as ULP notification for each cause included in the chunk.
3071 * API 5.3.1.3 - SCTP_REMOTE_ERROR
3073 * The return value is the disposition of the chunk.
3075 sctp_disposition_t sctp_sf_operr_notify(const struct sctp_endpoint *ep,
3076 const struct sctp_association *asoc,
3077 const sctp_subtype_t type,
3078 void *arg,
3079 sctp_cmd_seq_t *commands)
3081 struct sctp_chunk *chunk = arg;
3082 struct sctp_ulpevent *ev;
3084 if (!sctp_vtag_verify(chunk, asoc))
3085 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3087 /* Make sure that the ERROR chunk has a valid length. */
3088 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_operr_chunk_t)))
3089 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3090 commands);
3092 while (chunk->chunk_end > chunk->skb->data) {
3093 ev = sctp_ulpevent_make_remote_error(asoc, chunk, 0,
3094 GFP_ATOMIC);
3095 if (!ev)
3096 goto nomem;
3098 if (!sctp_add_cmd(commands, SCTP_CMD_EVENT_ULP,
3099 SCTP_ULPEVENT(ev))) {
3100 sctp_ulpevent_free(ev);
3101 goto nomem;
3104 sctp_add_cmd_sf(commands, SCTP_CMD_PROCESS_OPERR,
3105 SCTP_CHUNK(chunk));
3107 return SCTP_DISPOSITION_CONSUME;
3109 nomem:
3110 return SCTP_DISPOSITION_NOMEM;
3114 * Process an inbound SHUTDOWN ACK.
3116 * From Section 9.2:
3117 * Upon the receipt of the SHUTDOWN ACK, the SHUTDOWN sender shall
3118 * stop the T2-shutdown timer, send a SHUTDOWN COMPLETE chunk to its
3119 * peer, and remove all record of the association.
3121 * The return value is the disposition.
3123 sctp_disposition_t sctp_sf_do_9_2_final(const struct sctp_endpoint *ep,
3124 const struct sctp_association *asoc,
3125 const sctp_subtype_t type,
3126 void *arg,
3127 sctp_cmd_seq_t *commands)
3129 struct sctp_chunk *chunk = arg;
3130 struct sctp_chunk *reply;
3131 struct sctp_ulpevent *ev;
3133 if (!sctp_vtag_verify(chunk, asoc))
3134 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3136 /* Make sure that the SHUTDOWN_ACK chunk has a valid length. */
3137 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_chunkhdr_t)))
3138 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3139 commands);
3140 /* 10.2 H) SHUTDOWN COMPLETE notification
3142 * When SCTP completes the shutdown procedures (section 9.2) this
3143 * notification is passed to the upper layer.
3145 ev = sctp_ulpevent_make_assoc_change(asoc, 0, SCTP_SHUTDOWN_COMP,
3146 0, 0, 0, NULL, GFP_ATOMIC);
3147 if (!ev)
3148 goto nomem;
3150 /* ...send a SHUTDOWN COMPLETE chunk to its peer, */
3151 reply = sctp_make_shutdown_complete(asoc, chunk);
3152 if (!reply)
3153 goto nomem_chunk;
3155 /* Do all the commands now (after allocation), so that we
3156 * have consistent state if memory allocation failes
3158 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP, SCTP_ULPEVENT(ev));
3160 /* Upon the receipt of the SHUTDOWN ACK, the SHUTDOWN sender shall
3161 * stop the T2-shutdown timer,
3163 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
3164 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
3166 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
3167 SCTP_TO(SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD));
3169 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
3170 SCTP_STATE(SCTP_STATE_CLOSED));
3171 SCTP_INC_STATS(SCTP_MIB_SHUTDOWNS);
3172 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
3173 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(reply));
3175 /* ...and remove all record of the association. */
3176 sctp_add_cmd_sf(commands, SCTP_CMD_DELETE_TCB, SCTP_NULL());
3177 return SCTP_DISPOSITION_DELETE_TCB;
3179 nomem_chunk:
3180 sctp_ulpevent_free(ev);
3181 nomem:
3182 return SCTP_DISPOSITION_NOMEM;
3186 * RFC 2960, 8.4 - Handle "Out of the blue" Packets, sctpimpguide 2.41.
3188 * 5) If the packet contains a SHUTDOWN ACK chunk, the receiver should
3189 * respond to the sender of the OOTB packet with a SHUTDOWN COMPLETE.
3190 * When sending the SHUTDOWN COMPLETE, the receiver of the OOTB
3191 * packet must fill in the Verification Tag field of the outbound
3192 * packet with the Verification Tag received in the SHUTDOWN ACK and
3193 * set the T-bit in the Chunk Flags to indicate that the Verification
3194 * Tag is reflected.
3196 * 8) The receiver should respond to the sender of the OOTB packet with
3197 * an ABORT. When sending the ABORT, the receiver of the OOTB packet
3198 * MUST fill in the Verification Tag field of the outbound packet
3199 * with the value found in the Verification Tag field of the OOTB
3200 * packet and set the T-bit in the Chunk Flags to indicate that the
3201 * Verification Tag is reflected. After sending this ABORT, the
3202 * receiver of the OOTB packet shall discard the OOTB packet and take
3203 * no further action.
3205 sctp_disposition_t sctp_sf_ootb(const struct sctp_endpoint *ep,
3206 const struct sctp_association *asoc,
3207 const sctp_subtype_t type,
3208 void *arg,
3209 sctp_cmd_seq_t *commands)
3211 struct sctp_chunk *chunk = arg;
3212 struct sk_buff *skb = chunk->skb;
3213 sctp_chunkhdr_t *ch;
3214 __u8 *ch_end;
3215 int ootb_shut_ack = 0;
3217 SCTP_INC_STATS(SCTP_MIB_OUTOFBLUES);
3219 ch = (sctp_chunkhdr_t *) chunk->chunk_hdr;
3220 do {
3221 /* Report violation if the chunk is less then minimal */
3222 if (ntohs(ch->length) < sizeof(sctp_chunkhdr_t))
3223 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3224 commands);
3226 /* Now that we know we at least have a chunk header,
3227 * do things that are type appropriate.
3229 if (SCTP_CID_SHUTDOWN_ACK == ch->type)
3230 ootb_shut_ack = 1;
3232 /* RFC 2960, Section 3.3.7
3233 * Moreover, under any circumstances, an endpoint that
3234 * receives an ABORT MUST NOT respond to that ABORT by
3235 * sending an ABORT of its own.
3237 if (SCTP_CID_ABORT == ch->type)
3238 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3240 /* Report violation if chunk len overflows */
3241 ch_end = ((__u8 *)ch) + WORD_ROUND(ntohs(ch->length));
3242 if (ch_end > skb_tail_pointer(skb))
3243 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3244 commands);
3246 ch = (sctp_chunkhdr_t *) ch_end;
3247 } while (ch_end < skb_tail_pointer(skb));
3249 if (ootb_shut_ack)
3250 return sctp_sf_shut_8_4_5(ep, asoc, type, arg, commands);
3251 else
3252 return sctp_sf_tabort_8_4_8(ep, asoc, type, arg, commands);
3256 * Handle an "Out of the blue" SHUTDOWN ACK.
3258 * Section: 8.4 5, sctpimpguide 2.41.
3260 * 5) If the packet contains a SHUTDOWN ACK chunk, the receiver should
3261 * respond to the sender of the OOTB packet with a SHUTDOWN COMPLETE.
3262 * When sending the SHUTDOWN COMPLETE, the receiver of the OOTB
3263 * packet must fill in the Verification Tag field of the outbound
3264 * packet with the Verification Tag received in the SHUTDOWN ACK and
3265 * set the T-bit in the Chunk Flags to indicate that the Verification
3266 * Tag is reflected.
3268 * Inputs
3269 * (endpoint, asoc, type, arg, commands)
3271 * Outputs
3272 * (sctp_disposition_t)
3274 * The return value is the disposition of the chunk.
3276 static sctp_disposition_t sctp_sf_shut_8_4_5(const struct sctp_endpoint *ep,
3277 const struct sctp_association *asoc,
3278 const sctp_subtype_t type,
3279 void *arg,
3280 sctp_cmd_seq_t *commands)
3282 struct sctp_packet *packet = NULL;
3283 struct sctp_chunk *chunk = arg;
3284 struct sctp_chunk *shut;
3286 packet = sctp_ootb_pkt_new(asoc, chunk);
3288 if (packet) {
3289 /* Make an SHUTDOWN_COMPLETE.
3290 * The T bit will be set if the asoc is NULL.
3292 shut = sctp_make_shutdown_complete(asoc, chunk);
3293 if (!shut) {
3294 sctp_ootb_pkt_free(packet);
3295 return SCTP_DISPOSITION_NOMEM;
3298 /* Reflect vtag if T-Bit is set */
3299 if (sctp_test_T_bit(shut))
3300 packet->vtag = ntohl(chunk->sctp_hdr->vtag);
3302 /* Set the skb to the belonging sock for accounting. */
3303 shut->skb->sk = ep->base.sk;
3305 sctp_packet_append_chunk(packet, shut);
3307 sctp_add_cmd_sf(commands, SCTP_CMD_SEND_PKT,
3308 SCTP_PACKET(packet));
3310 SCTP_INC_STATS(SCTP_MIB_OUTCTRLCHUNKS);
3312 /* If the chunk length is invalid, we don't want to process
3313 * the reset of the packet.
3315 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_chunkhdr_t)))
3316 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3318 /* We need to discard the rest of the packet to prevent
3319 * potential bomming attacks from additional bundled chunks.
3320 * This is documented in SCTP Threats ID.
3322 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3325 return SCTP_DISPOSITION_NOMEM;
3329 * Handle SHUTDOWN ACK in COOKIE_ECHOED or COOKIE_WAIT state.
3331 * Verification Tag: 8.5.1 E) Rules for packet carrying a SHUTDOWN ACK
3332 * If the receiver is in COOKIE-ECHOED or COOKIE-WAIT state the
3333 * procedures in section 8.4 SHOULD be followed, in other words it
3334 * should be treated as an Out Of The Blue packet.
3335 * [This means that we do NOT check the Verification Tag on these
3336 * chunks. --piggy ]
3339 sctp_disposition_t sctp_sf_do_8_5_1_E_sa(const struct sctp_endpoint *ep,
3340 const struct sctp_association *asoc,
3341 const sctp_subtype_t type,
3342 void *arg,
3343 sctp_cmd_seq_t *commands)
3345 struct sctp_chunk *chunk = arg;
3347 /* Make sure that the SHUTDOWN_ACK chunk has a valid length. */
3348 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_chunkhdr_t)))
3349 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3350 commands);
3352 /* Although we do have an association in this case, it corresponds
3353 * to a restarted association. So the packet is treated as an OOTB
3354 * packet and the state function that handles OOTB SHUTDOWN_ACK is
3355 * called with a NULL association.
3357 return sctp_sf_shut_8_4_5(ep, NULL, type, arg, commands);
3360 /* ADDIP Section 4.2 Upon reception of an ASCONF Chunk. */
3361 sctp_disposition_t sctp_sf_do_asconf(const struct sctp_endpoint *ep,
3362 const struct sctp_association *asoc,
3363 const sctp_subtype_t type, void *arg,
3364 sctp_cmd_seq_t *commands)
3366 struct sctp_chunk *chunk = arg;
3367 struct sctp_chunk *asconf_ack = NULL;
3368 struct sctp_paramhdr *err_param = NULL;
3369 sctp_addiphdr_t *hdr;
3370 union sctp_addr_param *addr_param;
3371 __u32 serial;
3372 int length;
3374 if (!sctp_vtag_verify(chunk, asoc)) {
3375 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_BAD_TAG,
3376 SCTP_NULL());
3377 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3380 /* Make sure that the ASCONF ADDIP chunk has a valid length. */
3381 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_addip_chunk_t)))
3382 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3383 commands);
3385 hdr = (sctp_addiphdr_t *)chunk->skb->data;
3386 serial = ntohl(hdr->serial);
3388 addr_param = (union sctp_addr_param *)hdr->params;
3389 length = ntohs(addr_param->p.length);
3390 if (length < sizeof(sctp_paramhdr_t))
3391 return sctp_sf_violation_paramlen(ep, asoc, type,
3392 (void *)addr_param, commands);
3394 /* Verify the ASCONF chunk before processing it. */
3395 if (!sctp_verify_asconf(asoc,
3396 (sctp_paramhdr_t *)((void *)addr_param + length),
3397 (void *)chunk->chunk_end,
3398 &err_param))
3399 return sctp_sf_violation_paramlen(ep, asoc, type,
3400 (void *)&err_param, commands);
3402 /* ADDIP 4.2 C1) Compare the value of the serial number to the value
3403 * the endpoint stored in a new association variable
3404 * 'Peer-Serial-Number'.
3406 if (serial == asoc->peer.addip_serial + 1) {
3407 /* ADDIP 4.2 C2) If the value found in the serial number is
3408 * equal to the ('Peer-Serial-Number' + 1), the endpoint MUST
3409 * do V1-V5.
3411 asconf_ack = sctp_process_asconf((struct sctp_association *)
3412 asoc, chunk);
3413 if (!asconf_ack)
3414 return SCTP_DISPOSITION_NOMEM;
3415 } else if (serial == asoc->peer.addip_serial) {
3416 /* ADDIP 4.2 C3) If the value found in the serial number is
3417 * equal to the value stored in the 'Peer-Serial-Number'
3418 * IMPLEMENTATION NOTE: As an optimization a receiver may wish
3419 * to save the last ASCONF-ACK for some predetermined period of
3420 * time and instead of re-processing the ASCONF (with the same
3421 * serial number) it may just re-transmit the ASCONF-ACK.
3423 if (asoc->addip_last_asconf_ack)
3424 asconf_ack = asoc->addip_last_asconf_ack;
3425 else
3426 return SCTP_DISPOSITION_DISCARD;
3427 } else {
3428 /* ADDIP 4.2 C4) Otherwise, the ASCONF Chunk is discarded since
3429 * it must be either a stale packet or from an attacker.
3431 return SCTP_DISPOSITION_DISCARD;
3434 /* ADDIP 4.2 C5) In both cases C2 and C3 the ASCONF-ACK MUST be sent
3435 * back to the source address contained in the IP header of the ASCONF
3436 * being responded to.
3438 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(asconf_ack));
3440 return SCTP_DISPOSITION_CONSUME;
3444 * ADDIP Section 4.3 General rules for address manipulation
3445 * When building TLV parameters for the ASCONF Chunk that will add or
3446 * delete IP addresses the D0 to D13 rules should be applied:
3448 sctp_disposition_t sctp_sf_do_asconf_ack(const struct sctp_endpoint *ep,
3449 const struct sctp_association *asoc,
3450 const sctp_subtype_t type, void *arg,
3451 sctp_cmd_seq_t *commands)
3453 struct sctp_chunk *asconf_ack = arg;
3454 struct sctp_chunk *last_asconf = asoc->addip_last_asconf;
3455 struct sctp_chunk *abort;
3456 struct sctp_paramhdr *err_param = NULL;
3457 sctp_addiphdr_t *addip_hdr;
3458 __u32 sent_serial, rcvd_serial;
3460 if (!sctp_vtag_verify(asconf_ack, asoc)) {
3461 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_BAD_TAG,
3462 SCTP_NULL());
3463 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3466 /* Make sure that the ADDIP chunk has a valid length. */
3467 if (!sctp_chunk_length_valid(asconf_ack, sizeof(sctp_addip_chunk_t)))
3468 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3469 commands);
3471 addip_hdr = (sctp_addiphdr_t *)asconf_ack->skb->data;
3472 rcvd_serial = ntohl(addip_hdr->serial);
3474 /* Verify the ASCONF-ACK chunk before processing it. */
3475 if (!sctp_verify_asconf(asoc,
3476 (sctp_paramhdr_t *)addip_hdr->params,
3477 (void *)asconf_ack->chunk_end,
3478 &err_param))
3479 return sctp_sf_violation_paramlen(ep, asoc, type,
3480 (void *)&err_param, commands);
3482 if (last_asconf) {
3483 addip_hdr = (sctp_addiphdr_t *)last_asconf->subh.addip_hdr;
3484 sent_serial = ntohl(addip_hdr->serial);
3485 } else {
3486 sent_serial = asoc->addip_serial - 1;
3489 /* D0) If an endpoint receives an ASCONF-ACK that is greater than or
3490 * equal to the next serial number to be used but no ASCONF chunk is
3491 * outstanding the endpoint MUST ABORT the association. Note that a
3492 * sequence number is greater than if it is no more than 2^^31-1
3493 * larger than the current sequence number (using serial arithmetic).
3495 if (ADDIP_SERIAL_gte(rcvd_serial, sent_serial + 1) &&
3496 !(asoc->addip_last_asconf)) {
3497 abort = sctp_make_abort(asoc, asconf_ack,
3498 sizeof(sctp_errhdr_t));
3499 if (abort) {
3500 sctp_init_cause(abort, SCTP_ERROR_ASCONF_ACK, 0);
3501 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
3502 SCTP_CHUNK(abort));
3504 /* We are going to ABORT, so we might as well stop
3505 * processing the rest of the chunks in the packet.
3507 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
3508 SCTP_TO(SCTP_EVENT_TIMEOUT_T4_RTO));
3509 sctp_add_cmd_sf(commands, SCTP_CMD_DISCARD_PACKET,SCTP_NULL());
3510 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
3511 SCTP_ERROR(ECONNABORTED));
3512 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
3513 SCTP_PERR(SCTP_ERROR_ASCONF_ACK));
3514 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
3515 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
3516 return SCTP_DISPOSITION_ABORT;
3519 if ((rcvd_serial == sent_serial) && asoc->addip_last_asconf) {
3520 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
3521 SCTP_TO(SCTP_EVENT_TIMEOUT_T4_RTO));
3523 if (!sctp_process_asconf_ack((struct sctp_association *)asoc,
3524 asconf_ack))
3525 return SCTP_DISPOSITION_CONSUME;
3527 abort = sctp_make_abort(asoc, asconf_ack,
3528 sizeof(sctp_errhdr_t));
3529 if (abort) {
3530 sctp_init_cause(abort, SCTP_ERROR_RSRC_LOW, 0);
3531 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
3532 SCTP_CHUNK(abort));
3534 /* We are going to ABORT, so we might as well stop
3535 * processing the rest of the chunks in the packet.
3537 sctp_add_cmd_sf(commands, SCTP_CMD_DISCARD_PACKET,SCTP_NULL());
3538 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
3539 SCTP_ERROR(ECONNABORTED));
3540 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
3541 SCTP_PERR(SCTP_ERROR_ASCONF_ACK));
3542 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
3543 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
3544 return SCTP_DISPOSITION_ABORT;
3547 return SCTP_DISPOSITION_DISCARD;
3551 * PR-SCTP Section 3.6 Receiver Side Implementation of PR-SCTP
3553 * When a FORWARD TSN chunk arrives, the data receiver MUST first update
3554 * its cumulative TSN point to the value carried in the FORWARD TSN
3555 * chunk, and then MUST further advance its cumulative TSN point locally
3556 * if possible.
3557 * After the above processing, the data receiver MUST stop reporting any
3558 * missing TSNs earlier than or equal to the new cumulative TSN point.
3560 * Verification Tag: 8.5 Verification Tag [Normal verification]
3562 * The return value is the disposition of the chunk.
3564 sctp_disposition_t sctp_sf_eat_fwd_tsn(const struct sctp_endpoint *ep,
3565 const struct sctp_association *asoc,
3566 const sctp_subtype_t type,
3567 void *arg,
3568 sctp_cmd_seq_t *commands)
3570 struct sctp_chunk *chunk = arg;
3571 struct sctp_fwdtsn_hdr *fwdtsn_hdr;
3572 __u16 len;
3573 __u32 tsn;
3575 if (!sctp_vtag_verify(chunk, asoc)) {
3576 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_BAD_TAG,
3577 SCTP_NULL());
3578 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3581 /* Make sure that the FORWARD_TSN chunk has valid length. */
3582 if (!sctp_chunk_length_valid(chunk, sizeof(struct sctp_fwdtsn_chunk)))
3583 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3584 commands);
3586 fwdtsn_hdr = (struct sctp_fwdtsn_hdr *)chunk->skb->data;
3587 chunk->subh.fwdtsn_hdr = fwdtsn_hdr;
3588 len = ntohs(chunk->chunk_hdr->length);
3589 len -= sizeof(struct sctp_chunkhdr);
3590 skb_pull(chunk->skb, len);
3592 tsn = ntohl(fwdtsn_hdr->new_cum_tsn);
3593 SCTP_DEBUG_PRINTK("%s: TSN 0x%x.\n", __FUNCTION__, tsn);
3595 /* The TSN is too high--silently discard the chunk and count on it
3596 * getting retransmitted later.
3598 if (sctp_tsnmap_check(&asoc->peer.tsn_map, tsn) < 0)
3599 goto discard_noforce;
3601 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_FWDTSN, SCTP_U32(tsn));
3602 if (len > sizeof(struct sctp_fwdtsn_hdr))
3603 sctp_add_cmd_sf(commands, SCTP_CMD_PROCESS_FWDTSN,
3604 SCTP_CHUNK(chunk));
3606 /* Count this as receiving DATA. */
3607 if (asoc->autoclose) {
3608 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
3609 SCTP_TO(SCTP_EVENT_TIMEOUT_AUTOCLOSE));
3612 /* FIXME: For now send a SACK, but DATA processing may
3613 * send another.
3615 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_SACK, SCTP_NOFORCE());
3617 return SCTP_DISPOSITION_CONSUME;
3619 discard_noforce:
3620 return SCTP_DISPOSITION_DISCARD;
3623 sctp_disposition_t sctp_sf_eat_fwd_tsn_fast(
3624 const struct sctp_endpoint *ep,
3625 const struct sctp_association *asoc,
3626 const sctp_subtype_t type,
3627 void *arg,
3628 sctp_cmd_seq_t *commands)
3630 struct sctp_chunk *chunk = arg;
3631 struct sctp_fwdtsn_hdr *fwdtsn_hdr;
3632 __u16 len;
3633 __u32 tsn;
3635 if (!sctp_vtag_verify(chunk, asoc)) {
3636 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_BAD_TAG,
3637 SCTP_NULL());
3638 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3641 /* Make sure that the FORWARD_TSN chunk has a valid length. */
3642 if (!sctp_chunk_length_valid(chunk, sizeof(struct sctp_fwdtsn_chunk)))
3643 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3644 commands);
3646 fwdtsn_hdr = (struct sctp_fwdtsn_hdr *)chunk->skb->data;
3647 chunk->subh.fwdtsn_hdr = fwdtsn_hdr;
3648 len = ntohs(chunk->chunk_hdr->length);
3649 len -= sizeof(struct sctp_chunkhdr);
3650 skb_pull(chunk->skb, len);
3652 tsn = ntohl(fwdtsn_hdr->new_cum_tsn);
3653 SCTP_DEBUG_PRINTK("%s: TSN 0x%x.\n", __FUNCTION__, tsn);
3655 /* The TSN is too high--silently discard the chunk and count on it
3656 * getting retransmitted later.
3658 if (sctp_tsnmap_check(&asoc->peer.tsn_map, tsn) < 0)
3659 goto gen_shutdown;
3661 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_FWDTSN, SCTP_U32(tsn));
3662 if (len > sizeof(struct sctp_fwdtsn_hdr))
3663 sctp_add_cmd_sf(commands, SCTP_CMD_PROCESS_FWDTSN,
3664 SCTP_CHUNK(chunk));
3666 /* Go a head and force a SACK, since we are shutting down. */
3667 gen_shutdown:
3668 /* Implementor's Guide.
3670 * While in SHUTDOWN-SENT state, the SHUTDOWN sender MUST immediately
3671 * respond to each received packet containing one or more DATA chunk(s)
3672 * with a SACK, a SHUTDOWN chunk, and restart the T2-shutdown timer
3674 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_SHUTDOWN, SCTP_NULL());
3675 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_SACK, SCTP_FORCE());
3676 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
3677 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
3679 return SCTP_DISPOSITION_CONSUME;
3683 * SCTP-AUTH Section 6.3 Receving authenticated chukns
3685 * The receiver MUST use the HMAC algorithm indicated in the HMAC
3686 * Identifier field. If this algorithm was not specified by the
3687 * receiver in the HMAC-ALGO parameter in the INIT or INIT-ACK chunk
3688 * during association setup, the AUTH chunk and all chunks after it MUST
3689 * be discarded and an ERROR chunk SHOULD be sent with the error cause
3690 * defined in Section 4.1.
3692 * If an endpoint with no shared key receives a Shared Key Identifier
3693 * other than 0, it MUST silently discard all authenticated chunks. If
3694 * the endpoint has at least one endpoint pair shared key for the peer,
3695 * it MUST use the key specified by the Shared Key Identifier if a
3696 * key has been configured for that Shared Key Identifier. If no
3697 * endpoint pair shared key has been configured for that Shared Key
3698 * Identifier, all authenticated chunks MUST be silently discarded.
3700 * Verification Tag: 8.5 Verification Tag [Normal verification]
3702 * The return value is the disposition of the chunk.
3704 static sctp_ierror_t sctp_sf_authenticate(const struct sctp_endpoint *ep,
3705 const struct sctp_association *asoc,
3706 const sctp_subtype_t type,
3707 struct sctp_chunk *chunk)
3709 struct sctp_authhdr *auth_hdr;
3710 struct sctp_hmac *hmac;
3711 unsigned int sig_len;
3712 __u16 key_id;
3713 __u8 *save_digest;
3714 __u8 *digest;
3716 /* Pull in the auth header, so we can do some more verification */
3717 auth_hdr = (struct sctp_authhdr *)chunk->skb->data;
3718 chunk->subh.auth_hdr = auth_hdr;
3719 skb_pull(chunk->skb, sizeof(struct sctp_authhdr));
3721 /* Make sure that we suport the HMAC algorithm from the auth
3722 * chunk.
3724 if (!sctp_auth_asoc_verify_hmac_id(asoc, auth_hdr->hmac_id))
3725 return SCTP_IERROR_AUTH_BAD_HMAC;
3727 /* Make sure that the provided shared key identifier has been
3728 * configured
3730 key_id = ntohs(auth_hdr->shkey_id);
3731 if (key_id != asoc->active_key_id && !sctp_auth_get_shkey(asoc, key_id))
3732 return SCTP_IERROR_AUTH_BAD_KEYID;
3735 /* Make sure that the length of the signature matches what
3736 * we expect.
3738 sig_len = ntohs(chunk->chunk_hdr->length) - sizeof(sctp_auth_chunk_t);
3739 hmac = sctp_auth_get_hmac(ntohs(auth_hdr->hmac_id));
3740 if (sig_len != hmac->hmac_len)
3741 return SCTP_IERROR_PROTO_VIOLATION;
3743 /* Now that we've done validation checks, we can compute and
3744 * verify the hmac. The steps involved are:
3745 * 1. Save the digest from the chunk.
3746 * 2. Zero out the digest in the chunk.
3747 * 3. Compute the new digest
3748 * 4. Compare saved and new digests.
3750 digest = auth_hdr->hmac;
3751 skb_pull(chunk->skb, sig_len);
3753 save_digest = kmemdup(digest, sig_len, GFP_ATOMIC);
3754 if (!save_digest)
3755 goto nomem;
3757 memset(digest, 0, sig_len);
3759 sctp_auth_calculate_hmac(asoc, chunk->skb,
3760 (struct sctp_auth_chunk *)chunk->chunk_hdr,
3761 GFP_ATOMIC);
3763 /* Discard the packet if the digests do not match */
3764 if (memcmp(save_digest, digest, sig_len)) {
3765 kfree(save_digest);
3766 return SCTP_IERROR_BAD_SIG;
3769 kfree(save_digest);
3770 chunk->auth = 1;
3772 return SCTP_IERROR_NO_ERROR;
3773 nomem:
3774 return SCTP_IERROR_NOMEM;
3777 sctp_disposition_t sctp_sf_eat_auth(const struct sctp_endpoint *ep,
3778 const struct sctp_association *asoc,
3779 const sctp_subtype_t type,
3780 void *arg,
3781 sctp_cmd_seq_t *commands)
3783 struct sctp_authhdr *auth_hdr;
3784 struct sctp_chunk *chunk = arg;
3785 struct sctp_chunk *err_chunk;
3786 sctp_ierror_t error;
3788 if (!sctp_vtag_verify(chunk, asoc)) {
3789 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_BAD_TAG,
3790 SCTP_NULL());
3791 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3794 /* Make sure that the AUTH chunk has valid length. */
3795 if (!sctp_chunk_length_valid(chunk, sizeof(struct sctp_auth_chunk)))
3796 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3797 commands);
3799 auth_hdr = (struct sctp_authhdr *)chunk->skb->data;
3800 error = sctp_sf_authenticate(ep, asoc, type, chunk);
3801 switch (error) {
3802 case SCTP_IERROR_AUTH_BAD_HMAC:
3803 /* Generate the ERROR chunk and discard the rest
3804 * of the packet
3806 err_chunk = sctp_make_op_error(asoc, chunk,
3807 SCTP_ERROR_UNSUP_HMAC,
3808 &auth_hdr->hmac_id,
3809 sizeof(__u16));
3810 if (err_chunk) {
3811 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
3812 SCTP_CHUNK(err_chunk));
3814 /* Fall Through */
3815 case SCTP_IERROR_AUTH_BAD_KEYID:
3816 case SCTP_IERROR_BAD_SIG:
3817 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3818 break;
3819 case SCTP_IERROR_PROTO_VIOLATION:
3820 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3821 commands);
3822 break;
3823 case SCTP_IERROR_NOMEM:
3824 return SCTP_DISPOSITION_NOMEM;
3825 default:
3826 break;
3829 if (asoc->active_key_id != ntohs(auth_hdr->shkey_id)) {
3830 struct sctp_ulpevent *ev;
3832 ev = sctp_ulpevent_make_authkey(asoc, ntohs(auth_hdr->shkey_id),
3833 SCTP_AUTH_NEWKEY, GFP_ATOMIC);
3835 if (!ev)
3836 return -ENOMEM;
3838 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP,
3839 SCTP_ULPEVENT(ev));
3842 return SCTP_DISPOSITION_CONSUME;
3846 * Process an unknown chunk.
3848 * Section: 3.2. Also, 2.1 in the implementor's guide.
3850 * Chunk Types are encoded such that the highest-order two bits specify
3851 * the action that must be taken if the processing endpoint does not
3852 * recognize the Chunk Type.
3854 * 00 - Stop processing this SCTP packet and discard it, do not process
3855 * any further chunks within it.
3857 * 01 - Stop processing this SCTP packet and discard it, do not process
3858 * any further chunks within it, and report the unrecognized
3859 * chunk in an 'Unrecognized Chunk Type'.
3861 * 10 - Skip this chunk and continue processing.
3863 * 11 - Skip this chunk and continue processing, but report in an ERROR
3864 * Chunk using the 'Unrecognized Chunk Type' cause of error.
3866 * The return value is the disposition of the chunk.
3868 sctp_disposition_t sctp_sf_unk_chunk(const struct sctp_endpoint *ep,
3869 const struct sctp_association *asoc,
3870 const sctp_subtype_t type,
3871 void *arg,
3872 sctp_cmd_seq_t *commands)
3874 struct sctp_chunk *unk_chunk = arg;
3875 struct sctp_chunk *err_chunk;
3876 sctp_chunkhdr_t *hdr;
3878 SCTP_DEBUG_PRINTK("Processing the unknown chunk id %d.\n", type.chunk);
3880 if (!sctp_vtag_verify(unk_chunk, asoc))
3881 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3883 /* Make sure that the chunk has a valid length.
3884 * Since we don't know the chunk type, we use a general
3885 * chunkhdr structure to make a comparison.
3887 if (!sctp_chunk_length_valid(unk_chunk, sizeof(sctp_chunkhdr_t)))
3888 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3889 commands);
3891 switch (type.chunk & SCTP_CID_ACTION_MASK) {
3892 case SCTP_CID_ACTION_DISCARD:
3893 /* Discard the packet. */
3894 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3895 break;
3896 case SCTP_CID_ACTION_DISCARD_ERR:
3897 /* Discard the packet. */
3898 sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3900 /* Generate an ERROR chunk as response. */
3901 hdr = unk_chunk->chunk_hdr;
3902 err_chunk = sctp_make_op_error(asoc, unk_chunk,
3903 SCTP_ERROR_UNKNOWN_CHUNK, hdr,
3904 WORD_ROUND(ntohs(hdr->length)));
3905 if (err_chunk) {
3906 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
3907 SCTP_CHUNK(err_chunk));
3909 return SCTP_DISPOSITION_CONSUME;
3910 break;
3911 case SCTP_CID_ACTION_SKIP:
3912 /* Skip the chunk. */
3913 return SCTP_DISPOSITION_DISCARD;
3914 break;
3915 case SCTP_CID_ACTION_SKIP_ERR:
3916 /* Generate an ERROR chunk as response. */
3917 hdr = unk_chunk->chunk_hdr;
3918 err_chunk = sctp_make_op_error(asoc, unk_chunk,
3919 SCTP_ERROR_UNKNOWN_CHUNK, hdr,
3920 WORD_ROUND(ntohs(hdr->length)));
3921 if (err_chunk) {
3922 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
3923 SCTP_CHUNK(err_chunk));
3925 /* Skip the chunk. */
3926 return SCTP_DISPOSITION_CONSUME;
3927 break;
3928 default:
3929 break;
3932 return SCTP_DISPOSITION_DISCARD;
3936 * Discard the chunk.
3938 * Section: 0.2, 5.2.3, 5.2.5, 5.2.6, 6.0, 8.4.6, 8.5.1c, 9.2
3939 * [Too numerous to mention...]
3940 * Verification Tag: No verification needed.
3941 * Inputs
3942 * (endpoint, asoc, chunk)
3944 * Outputs
3945 * (asoc, reply_msg, msg_up, timers, counters)
3947 * The return value is the disposition of the chunk.
3949 sctp_disposition_t sctp_sf_discard_chunk(const struct sctp_endpoint *ep,
3950 const struct sctp_association *asoc,
3951 const sctp_subtype_t type,
3952 void *arg,
3953 sctp_cmd_seq_t *commands)
3955 struct sctp_chunk *chunk = arg;
3957 /* Make sure that the chunk has a valid length.
3958 * Since we don't know the chunk type, we use a general
3959 * chunkhdr structure to make a comparison.
3961 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_chunkhdr_t)))
3962 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3963 commands);
3965 SCTP_DEBUG_PRINTK("Chunk %d is discarded\n", type.chunk);
3966 return SCTP_DISPOSITION_DISCARD;
3970 * Discard the whole packet.
3972 * Section: 8.4 2)
3974 * 2) If the OOTB packet contains an ABORT chunk, the receiver MUST
3975 * silently discard the OOTB packet and take no further action.
3977 * Verification Tag: No verification necessary
3979 * Inputs
3980 * (endpoint, asoc, chunk)
3982 * Outputs
3983 * (asoc, reply_msg, msg_up, timers, counters)
3985 * The return value is the disposition of the chunk.
3987 sctp_disposition_t sctp_sf_pdiscard(const struct sctp_endpoint *ep,
3988 const struct sctp_association *asoc,
3989 const sctp_subtype_t type,
3990 void *arg,
3991 sctp_cmd_seq_t *commands)
3993 SCTP_INC_STATS(SCTP_MIB_IN_PKT_DISCARDS);
3994 sctp_add_cmd_sf(commands, SCTP_CMD_DISCARD_PACKET, SCTP_NULL());
3996 return SCTP_DISPOSITION_CONSUME;
4001 * The other end is violating protocol.
4003 * Section: Not specified
4004 * Verification Tag: Not specified
4005 * Inputs
4006 * (endpoint, asoc, chunk)
4008 * Outputs
4009 * (asoc, reply_msg, msg_up, timers, counters)
4011 * We simply tag the chunk as a violation. The state machine will log
4012 * the violation and continue.
4014 sctp_disposition_t sctp_sf_violation(const struct sctp_endpoint *ep,
4015 const struct sctp_association *asoc,
4016 const sctp_subtype_t type,
4017 void *arg,
4018 sctp_cmd_seq_t *commands)
4020 struct sctp_chunk *chunk = arg;
4022 /* Make sure that the chunk has a valid length. */
4023 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_chunkhdr_t)))
4024 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
4025 commands);
4027 return SCTP_DISPOSITION_VIOLATION;
4031 * Common function to handle a protocol violation.
4033 static sctp_disposition_t sctp_sf_abort_violation(
4034 const struct sctp_endpoint *ep,
4035 const struct sctp_association *asoc,
4036 void *arg,
4037 sctp_cmd_seq_t *commands,
4038 const __u8 *payload,
4039 const size_t paylen)
4041 struct sctp_packet *packet = NULL;
4042 struct sctp_chunk *chunk = arg;
4043 struct sctp_chunk *abort = NULL;
4045 /* SCTP-AUTH, Section 6.3:
4046 * It should be noted that if the receiver wants to tear
4047 * down an association in an authenticated way only, the
4048 * handling of malformed packets should not result in
4049 * tearing down the association.
4051 * This means that if we only want to abort associations
4052 * in an authenticated way (i.e AUTH+ABORT), then we
4053 * can't destory this association just becuase the packet
4054 * was malformed.
4056 if (sctp_auth_recv_cid(SCTP_CID_ABORT, asoc))
4057 goto discard;
4059 /* Make the abort chunk. */
4060 abort = sctp_make_abort_violation(asoc, chunk, payload, paylen);
4061 if (!abort)
4062 goto nomem;
4064 if (asoc) {
4065 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(abort));
4066 SCTP_INC_STATS(SCTP_MIB_OUTCTRLCHUNKS);
4068 if (asoc->state <= SCTP_STATE_COOKIE_ECHOED) {
4069 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
4070 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_INIT));
4071 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
4072 SCTP_ERROR(ECONNREFUSED));
4073 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_FAILED,
4074 SCTP_PERR(SCTP_ERROR_PROTO_VIOLATION));
4075 } else {
4076 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
4077 SCTP_ERROR(ECONNABORTED));
4078 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
4079 SCTP_PERR(SCTP_ERROR_PROTO_VIOLATION));
4080 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
4082 } else {
4083 packet = sctp_ootb_pkt_new(asoc, chunk);
4085 if (!packet)
4086 goto nomem_pkt;
4088 if (sctp_test_T_bit(abort))
4089 packet->vtag = ntohl(chunk->sctp_hdr->vtag);
4091 abort->skb->sk = ep->base.sk;
4093 sctp_packet_append_chunk(packet, abort);
4095 sctp_add_cmd_sf(commands, SCTP_CMD_SEND_PKT,
4096 SCTP_PACKET(packet));
4098 SCTP_INC_STATS(SCTP_MIB_OUTCTRLCHUNKS);
4101 discard:
4102 sctp_sf_pdiscard(ep, asoc, SCTP_ST_CHUNK(0), arg, commands);
4104 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
4106 return SCTP_DISPOSITION_ABORT;
4108 nomem_pkt:
4109 sctp_chunk_free(abort);
4110 nomem:
4111 return SCTP_DISPOSITION_NOMEM;
4115 * Handle a protocol violation when the chunk length is invalid.
4116 * "Invalid" length is identified as smaller then the minimal length a
4117 * given chunk can be. For example, a SACK chunk has invalid length
4118 * if it's length is set to be smaller then the size of sctp_sack_chunk_t.
4120 * We inform the other end by sending an ABORT with a Protocol Violation
4121 * error code.
4123 * Section: Not specified
4124 * Verification Tag: Nothing to do
4125 * Inputs
4126 * (endpoint, asoc, chunk)
4128 * Outputs
4129 * (reply_msg, msg_up, counters)
4131 * Generate an ABORT chunk and terminate the association.
4133 static sctp_disposition_t sctp_sf_violation_chunklen(
4134 const struct sctp_endpoint *ep,
4135 const struct sctp_association *asoc,
4136 const sctp_subtype_t type,
4137 void *arg,
4138 sctp_cmd_seq_t *commands)
4140 char err_str[]="The following chunk had invalid length:";
4142 return sctp_sf_abort_violation(ep, asoc, arg, commands, err_str,
4143 sizeof(err_str));
4147 * Handle a protocol violation when the parameter length is invalid.
4148 * "Invalid" length is identified as smaller then the minimal length a
4149 * given parameter can be.
4151 static sctp_disposition_t sctp_sf_violation_paramlen(
4152 const struct sctp_endpoint *ep,
4153 const struct sctp_association *asoc,
4154 const sctp_subtype_t type,
4155 void *arg,
4156 sctp_cmd_seq_t *commands) {
4157 char err_str[] = "The following parameter had invalid length:";
4159 return sctp_sf_abort_violation(ep, asoc, arg, commands, err_str,
4160 sizeof(err_str));
4163 /* Handle a protocol violation when the peer trying to advance the
4164 * cumulative tsn ack to a point beyond the max tsn currently sent.
4166 * We inform the other end by sending an ABORT with a Protocol Violation
4167 * error code.
4169 static sctp_disposition_t sctp_sf_violation_ctsn(
4170 const struct sctp_endpoint *ep,
4171 const struct sctp_association *asoc,
4172 const sctp_subtype_t type,
4173 void *arg,
4174 sctp_cmd_seq_t *commands)
4176 char err_str[]="The cumulative tsn ack beyond the max tsn currently sent:";
4178 return sctp_sf_abort_violation(ep, asoc, arg, commands, err_str,
4179 sizeof(err_str));
4182 /* Handle protocol violation of an invalid chunk bundling. For example,
4183 * when we have an association and we recieve bundled INIT-ACK, or
4184 * SHUDOWN-COMPLETE, our peer is clearly violationg the "MUST NOT bundle"
4185 * statement from the specs. Additinally, there might be an attacker
4186 * on the path and we may not want to continue this communication.
4188 static sctp_disposition_t sctp_sf_violation_chunk(
4189 const struct sctp_endpoint *ep,
4190 const struct sctp_association *asoc,
4191 const sctp_subtype_t type,
4192 void *arg,
4193 sctp_cmd_seq_t *commands)
4195 char err_str[]="The following chunk violates protocol:";
4197 if (!asoc)
4198 return sctp_sf_violation(ep, asoc, type, arg, commands);
4200 return sctp_sf_abort_violation(ep, asoc, arg, commands, err_str,
4201 sizeof(err_str));
4203 /***************************************************************************
4204 * These are the state functions for handling primitive (Section 10) events.
4205 ***************************************************************************/
4207 * sctp_sf_do_prm_asoc
4209 * Section: 10.1 ULP-to-SCTP
4210 * B) Associate
4212 * Format: ASSOCIATE(local SCTP instance name, destination transport addr,
4213 * outbound stream count)
4214 * -> association id [,destination transport addr list] [,outbound stream
4215 * count]
4217 * This primitive allows the upper layer to initiate an association to a
4218 * specific peer endpoint.
4220 * The peer endpoint shall be specified by one of the transport addresses
4221 * which defines the endpoint (see Section 1.4). If the local SCTP
4222 * instance has not been initialized, the ASSOCIATE is considered an
4223 * error.
4224 * [This is not relevant for the kernel implementation since we do all
4225 * initialization at boot time. It we hadn't initialized we wouldn't
4226 * get anywhere near this code.]
4228 * An association id, which is a local handle to the SCTP association,
4229 * will be returned on successful establishment of the association. If
4230 * SCTP is not able to open an SCTP association with the peer endpoint,
4231 * an error is returned.
4232 * [In the kernel implementation, the struct sctp_association needs to
4233 * be created BEFORE causing this primitive to run.]
4235 * Other association parameters may be returned, including the
4236 * complete destination transport addresses of the peer as well as the
4237 * outbound stream count of the local endpoint. One of the transport
4238 * address from the returned destination addresses will be selected by
4239 * the local endpoint as default primary path for sending SCTP packets
4240 * to this peer. The returned "destination transport addr list" can
4241 * be used by the ULP to change the default primary path or to force
4242 * sending a packet to a specific transport address. [All of this
4243 * stuff happens when the INIT ACK arrives. This is a NON-BLOCKING
4244 * function.]
4246 * Mandatory attributes:
4248 * o local SCTP instance name - obtained from the INITIALIZE operation.
4249 * [This is the argument asoc.]
4250 * o destination transport addr - specified as one of the transport
4251 * addresses of the peer endpoint with which the association is to be
4252 * established.
4253 * [This is asoc->peer.active_path.]
4254 * o outbound stream count - the number of outbound streams the ULP
4255 * would like to open towards this peer endpoint.
4256 * [BUG: This is not currently implemented.]
4257 * Optional attributes:
4259 * None.
4261 * The return value is a disposition.
4263 sctp_disposition_t sctp_sf_do_prm_asoc(const struct sctp_endpoint *ep,
4264 const struct sctp_association *asoc,
4265 const sctp_subtype_t type,
4266 void *arg,
4267 sctp_cmd_seq_t *commands)
4269 struct sctp_chunk *repl;
4271 /* The comment below says that we enter COOKIE-WAIT AFTER
4272 * sending the INIT, but that doesn't actually work in our
4273 * implementation...
4275 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
4276 SCTP_STATE(SCTP_STATE_COOKIE_WAIT));
4278 /* RFC 2960 5.1 Normal Establishment of an Association
4280 * A) "A" first sends an INIT chunk to "Z". In the INIT, "A"
4281 * must provide its Verification Tag (Tag_A) in the Initiate
4282 * Tag field. Tag_A SHOULD be a random number in the range of
4283 * 1 to 4294967295 (see 5.3.1 for Tag value selection). ...
4286 repl = sctp_make_init(asoc, &asoc->base.bind_addr, GFP_ATOMIC, 0);
4287 if (!repl)
4288 goto nomem;
4290 /* Cast away the const modifier, as we want to just
4291 * rerun it through as a sideffect.
4293 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_ASOC,
4294 SCTP_ASOC((struct sctp_association *) asoc));
4296 /* Choose transport for INIT. */
4297 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_CHOOSE_TRANSPORT,
4298 SCTP_CHUNK(repl));
4300 /* After sending the INIT, "A" starts the T1-init timer and
4301 * enters the COOKIE-WAIT state.
4303 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_START,
4304 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_INIT));
4305 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(repl));
4306 return SCTP_DISPOSITION_CONSUME;
4308 nomem:
4309 return SCTP_DISPOSITION_NOMEM;
4313 * Process the SEND primitive.
4315 * Section: 10.1 ULP-to-SCTP
4316 * E) Send
4318 * Format: SEND(association id, buffer address, byte count [,context]
4319 * [,stream id] [,life time] [,destination transport address]
4320 * [,unorder flag] [,no-bundle flag] [,payload protocol-id] )
4321 * -> result
4323 * This is the main method to send user data via SCTP.
4325 * Mandatory attributes:
4327 * o association id - local handle to the SCTP association
4329 * o buffer address - the location where the user message to be
4330 * transmitted is stored;
4332 * o byte count - The size of the user data in number of bytes;
4334 * Optional attributes:
4336 * o context - an optional 32 bit integer that will be carried in the
4337 * sending failure notification to the ULP if the transportation of
4338 * this User Message fails.
4340 * o stream id - to indicate which stream to send the data on. If not
4341 * specified, stream 0 will be used.
4343 * o life time - specifies the life time of the user data. The user data
4344 * will not be sent by SCTP after the life time expires. This
4345 * parameter can be used to avoid efforts to transmit stale
4346 * user messages. SCTP notifies the ULP if the data cannot be
4347 * initiated to transport (i.e. sent to the destination via SCTP's
4348 * send primitive) within the life time variable. However, the
4349 * user data will be transmitted if SCTP has attempted to transmit a
4350 * chunk before the life time expired.
4352 * o destination transport address - specified as one of the destination
4353 * transport addresses of the peer endpoint to which this packet
4354 * should be sent. Whenever possible, SCTP should use this destination
4355 * transport address for sending the packets, instead of the current
4356 * primary path.
4358 * o unorder flag - this flag, if present, indicates that the user
4359 * would like the data delivered in an unordered fashion to the peer
4360 * (i.e., the U flag is set to 1 on all DATA chunks carrying this
4361 * message).
4363 * o no-bundle flag - instructs SCTP not to bundle this user data with
4364 * other outbound DATA chunks. SCTP MAY still bundle even when
4365 * this flag is present, when faced with network congestion.
4367 * o payload protocol-id - A 32 bit unsigned integer that is to be
4368 * passed to the peer indicating the type of payload protocol data
4369 * being transmitted. This value is passed as opaque data by SCTP.
4371 * The return value is the disposition.
4373 sctp_disposition_t sctp_sf_do_prm_send(const struct sctp_endpoint *ep,
4374 const struct sctp_association *asoc,
4375 const sctp_subtype_t type,
4376 void *arg,
4377 sctp_cmd_seq_t *commands)
4379 struct sctp_chunk *chunk = arg;
4381 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(chunk));
4382 return SCTP_DISPOSITION_CONSUME;
4386 * Process the SHUTDOWN primitive.
4388 * Section: 10.1:
4389 * C) Shutdown
4391 * Format: SHUTDOWN(association id)
4392 * -> result
4394 * Gracefully closes an association. Any locally queued user data
4395 * will be delivered to the peer. The association will be terminated only
4396 * after the peer acknowledges all the SCTP packets sent. A success code
4397 * will be returned on successful termination of the association. If
4398 * attempting to terminate the association results in a failure, an error
4399 * code shall be returned.
4401 * Mandatory attributes:
4403 * o association id - local handle to the SCTP association
4405 * Optional attributes:
4407 * None.
4409 * The return value is the disposition.
4411 sctp_disposition_t sctp_sf_do_9_2_prm_shutdown(
4412 const struct sctp_endpoint *ep,
4413 const struct sctp_association *asoc,
4414 const sctp_subtype_t type,
4415 void *arg,
4416 sctp_cmd_seq_t *commands)
4418 int disposition;
4420 /* From 9.2 Shutdown of an Association
4421 * Upon receipt of the SHUTDOWN primitive from its upper
4422 * layer, the endpoint enters SHUTDOWN-PENDING state and
4423 * remains there until all outstanding data has been
4424 * acknowledged by its peer. The endpoint accepts no new data
4425 * from its upper layer, but retransmits data to the far end
4426 * if necessary to fill gaps.
4428 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
4429 SCTP_STATE(SCTP_STATE_SHUTDOWN_PENDING));
4431 /* sctpimpguide-05 Section 2.12.2
4432 * The sender of the SHUTDOWN MAY also start an overall guard timer
4433 * 'T5-shutdown-guard' to bound the overall time for shutdown sequence.
4435 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_START,
4436 SCTP_TO(SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD));
4438 disposition = SCTP_DISPOSITION_CONSUME;
4439 if (sctp_outq_is_empty(&asoc->outqueue)) {
4440 disposition = sctp_sf_do_9_2_start_shutdown(ep, asoc, type,
4441 arg, commands);
4443 return disposition;
4447 * Process the ABORT primitive.
4449 * Section: 10.1:
4450 * C) Abort
4452 * Format: Abort(association id [, cause code])
4453 * -> result
4455 * Ungracefully closes an association. Any locally queued user data
4456 * will be discarded and an ABORT chunk is sent to the peer. A success code
4457 * will be returned on successful abortion of the association. If
4458 * attempting to abort the association results in a failure, an error
4459 * code shall be returned.
4461 * Mandatory attributes:
4463 * o association id - local handle to the SCTP association
4465 * Optional attributes:
4467 * o cause code - reason of the abort to be passed to the peer
4469 * None.
4471 * The return value is the disposition.
4473 sctp_disposition_t sctp_sf_do_9_1_prm_abort(
4474 const struct sctp_endpoint *ep,
4475 const struct sctp_association *asoc,
4476 const sctp_subtype_t type,
4477 void *arg,
4478 sctp_cmd_seq_t *commands)
4480 /* From 9.1 Abort of an Association
4481 * Upon receipt of the ABORT primitive from its upper
4482 * layer, the endpoint enters CLOSED state and
4483 * discard all outstanding data has been
4484 * acknowledged by its peer. The endpoint accepts no new data
4485 * from its upper layer, but retransmits data to the far end
4486 * if necessary to fill gaps.
4488 struct sctp_chunk *abort = arg;
4489 sctp_disposition_t retval;
4491 retval = SCTP_DISPOSITION_CONSUME;
4493 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(abort));
4495 /* Even if we can't send the ABORT due to low memory delete the
4496 * TCB. This is a departure from our typical NOMEM handling.
4499 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
4500 SCTP_ERROR(ECONNABORTED));
4501 /* Delete the established association. */
4502 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
4503 SCTP_PERR(SCTP_ERROR_USER_ABORT));
4505 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
4506 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
4508 return retval;
4511 /* We tried an illegal operation on an association which is closed. */
4512 sctp_disposition_t sctp_sf_error_closed(const struct sctp_endpoint *ep,
4513 const struct sctp_association *asoc,
4514 const sctp_subtype_t type,
4515 void *arg,
4516 sctp_cmd_seq_t *commands)
4518 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_ERROR, SCTP_ERROR(-EINVAL));
4519 return SCTP_DISPOSITION_CONSUME;
4522 /* We tried an illegal operation on an association which is shutting
4523 * down.
4525 sctp_disposition_t sctp_sf_error_shutdown(const struct sctp_endpoint *ep,
4526 const struct sctp_association *asoc,
4527 const sctp_subtype_t type,
4528 void *arg,
4529 sctp_cmd_seq_t *commands)
4531 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_ERROR,
4532 SCTP_ERROR(-ESHUTDOWN));
4533 return SCTP_DISPOSITION_CONSUME;
4537 * sctp_cookie_wait_prm_shutdown
4539 * Section: 4 Note: 2
4540 * Verification Tag:
4541 * Inputs
4542 * (endpoint, asoc)
4544 * The RFC does not explicitly address this issue, but is the route through the
4545 * state table when someone issues a shutdown while in COOKIE_WAIT state.
4547 * Outputs
4548 * (timers)
4550 sctp_disposition_t sctp_sf_cookie_wait_prm_shutdown(
4551 const struct sctp_endpoint *ep,
4552 const struct sctp_association *asoc,
4553 const sctp_subtype_t type,
4554 void *arg,
4555 sctp_cmd_seq_t *commands)
4557 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
4558 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_INIT));
4560 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
4561 SCTP_STATE(SCTP_STATE_CLOSED));
4563 SCTP_INC_STATS(SCTP_MIB_SHUTDOWNS);
4565 sctp_add_cmd_sf(commands, SCTP_CMD_DELETE_TCB, SCTP_NULL());
4567 return SCTP_DISPOSITION_DELETE_TCB;
4571 * sctp_cookie_echoed_prm_shutdown
4573 * Section: 4 Note: 2
4574 * Verification Tag:
4575 * Inputs
4576 * (endpoint, asoc)
4578 * The RFC does not explcitly address this issue, but is the route through the
4579 * state table when someone issues a shutdown while in COOKIE_ECHOED state.
4581 * Outputs
4582 * (timers)
4584 sctp_disposition_t sctp_sf_cookie_echoed_prm_shutdown(
4585 const struct sctp_endpoint *ep,
4586 const struct sctp_association *asoc,
4587 const sctp_subtype_t type,
4588 void *arg, sctp_cmd_seq_t *commands)
4590 /* There is a single T1 timer, so we should be able to use
4591 * common function with the COOKIE-WAIT state.
4593 return sctp_sf_cookie_wait_prm_shutdown(ep, asoc, type, arg, commands);
4597 * sctp_sf_cookie_wait_prm_abort
4599 * Section: 4 Note: 2
4600 * Verification Tag:
4601 * Inputs
4602 * (endpoint, asoc)
4604 * The RFC does not explicitly address this issue, but is the route through the
4605 * state table when someone issues an abort while in COOKIE_WAIT state.
4607 * Outputs
4608 * (timers)
4610 sctp_disposition_t sctp_sf_cookie_wait_prm_abort(
4611 const struct sctp_endpoint *ep,
4612 const struct sctp_association *asoc,
4613 const sctp_subtype_t type,
4614 void *arg,
4615 sctp_cmd_seq_t *commands)
4617 struct sctp_chunk *abort = arg;
4618 sctp_disposition_t retval;
4620 /* Stop T1-init timer */
4621 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
4622 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_INIT));
4623 retval = SCTP_DISPOSITION_CONSUME;
4625 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(abort));
4627 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
4628 SCTP_STATE(SCTP_STATE_CLOSED));
4630 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
4632 /* Even if we can't send the ABORT due to low memory delete the
4633 * TCB. This is a departure from our typical NOMEM handling.
4636 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
4637 SCTP_ERROR(ECONNREFUSED));
4638 /* Delete the established association. */
4639 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_FAILED,
4640 SCTP_PERR(SCTP_ERROR_USER_ABORT));
4642 return retval;
4646 * sctp_sf_cookie_echoed_prm_abort
4648 * Section: 4 Note: 3
4649 * Verification Tag:
4650 * Inputs
4651 * (endpoint, asoc)
4653 * The RFC does not explcitly address this issue, but is the route through the
4654 * state table when someone issues an abort while in COOKIE_ECHOED state.
4656 * Outputs
4657 * (timers)
4659 sctp_disposition_t sctp_sf_cookie_echoed_prm_abort(
4660 const struct sctp_endpoint *ep,
4661 const struct sctp_association *asoc,
4662 const sctp_subtype_t type,
4663 void *arg,
4664 sctp_cmd_seq_t *commands)
4666 /* There is a single T1 timer, so we should be able to use
4667 * common function with the COOKIE-WAIT state.
4669 return sctp_sf_cookie_wait_prm_abort(ep, asoc, type, arg, commands);
4673 * sctp_sf_shutdown_pending_prm_abort
4675 * Inputs
4676 * (endpoint, asoc)
4678 * The RFC does not explicitly address this issue, but is the route through the
4679 * state table when someone issues an abort while in SHUTDOWN-PENDING state.
4681 * Outputs
4682 * (timers)
4684 sctp_disposition_t sctp_sf_shutdown_pending_prm_abort(
4685 const struct sctp_endpoint *ep,
4686 const struct sctp_association *asoc,
4687 const sctp_subtype_t type,
4688 void *arg,
4689 sctp_cmd_seq_t *commands)
4691 /* Stop the T5-shutdown guard timer. */
4692 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
4693 SCTP_TO(SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD));
4695 return sctp_sf_do_9_1_prm_abort(ep, asoc, type, arg, commands);
4699 * sctp_sf_shutdown_sent_prm_abort
4701 * Inputs
4702 * (endpoint, asoc)
4704 * The RFC does not explicitly address this issue, but is the route through the
4705 * state table when someone issues an abort while in SHUTDOWN-SENT state.
4707 * Outputs
4708 * (timers)
4710 sctp_disposition_t sctp_sf_shutdown_sent_prm_abort(
4711 const struct sctp_endpoint *ep,
4712 const struct sctp_association *asoc,
4713 const sctp_subtype_t type,
4714 void *arg,
4715 sctp_cmd_seq_t *commands)
4717 /* Stop the T2-shutdown timer. */
4718 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
4719 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
4721 /* Stop the T5-shutdown guard timer. */
4722 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
4723 SCTP_TO(SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD));
4725 return sctp_sf_do_9_1_prm_abort(ep, asoc, type, arg, commands);
4729 * sctp_sf_cookie_echoed_prm_abort
4731 * Inputs
4732 * (endpoint, asoc)
4734 * The RFC does not explcitly address this issue, but is the route through the
4735 * state table when someone issues an abort while in COOKIE_ECHOED state.
4737 * Outputs
4738 * (timers)
4740 sctp_disposition_t sctp_sf_shutdown_ack_sent_prm_abort(
4741 const struct sctp_endpoint *ep,
4742 const struct sctp_association *asoc,
4743 const sctp_subtype_t type,
4744 void *arg,
4745 sctp_cmd_seq_t *commands)
4747 /* The same T2 timer, so we should be able to use
4748 * common function with the SHUTDOWN-SENT state.
4750 return sctp_sf_shutdown_sent_prm_abort(ep, asoc, type, arg, commands);
4754 * Process the REQUESTHEARTBEAT primitive
4756 * 10.1 ULP-to-SCTP
4757 * J) Request Heartbeat
4759 * Format: REQUESTHEARTBEAT(association id, destination transport address)
4761 * -> result
4763 * Instructs the local endpoint to perform a HeartBeat on the specified
4764 * destination transport address of the given association. The returned
4765 * result should indicate whether the transmission of the HEARTBEAT
4766 * chunk to the destination address is successful.
4768 * Mandatory attributes:
4770 * o association id - local handle to the SCTP association
4772 * o destination transport address - the transport address of the
4773 * association on which a heartbeat should be issued.
4775 sctp_disposition_t sctp_sf_do_prm_requestheartbeat(
4776 const struct sctp_endpoint *ep,
4777 const struct sctp_association *asoc,
4778 const sctp_subtype_t type,
4779 void *arg,
4780 sctp_cmd_seq_t *commands)
4782 if (SCTP_DISPOSITION_NOMEM == sctp_sf_heartbeat(ep, asoc, type,
4783 (struct sctp_transport *)arg, commands))
4784 return SCTP_DISPOSITION_NOMEM;
4787 * RFC 2960 (bis), section 8.3
4789 * D) Request an on-demand HEARTBEAT on a specific destination
4790 * transport address of a given association.
4792 * The endpoint should increment the respective error counter of
4793 * the destination transport address each time a HEARTBEAT is sent
4794 * to that address and not acknowledged within one RTO.
4797 sctp_add_cmd_sf(commands, SCTP_CMD_TRANSPORT_RESET,
4798 SCTP_TRANSPORT(arg));
4799 return SCTP_DISPOSITION_CONSUME;
4803 * ADDIP Section 4.1 ASCONF Chunk Procedures
4804 * When an endpoint has an ASCONF signaled change to be sent to the
4805 * remote endpoint it should do A1 to A9
4807 sctp_disposition_t sctp_sf_do_prm_asconf(const struct sctp_endpoint *ep,
4808 const struct sctp_association *asoc,
4809 const sctp_subtype_t type,
4810 void *arg,
4811 sctp_cmd_seq_t *commands)
4813 struct sctp_chunk *chunk = arg;
4815 sctp_add_cmd_sf(commands, SCTP_CMD_SETUP_T4, SCTP_CHUNK(chunk));
4816 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_START,
4817 SCTP_TO(SCTP_EVENT_TIMEOUT_T4_RTO));
4818 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(chunk));
4819 return SCTP_DISPOSITION_CONSUME;
4823 * Ignore the primitive event
4825 * The return value is the disposition of the primitive.
4827 sctp_disposition_t sctp_sf_ignore_primitive(
4828 const struct sctp_endpoint *ep,
4829 const struct sctp_association *asoc,
4830 const sctp_subtype_t type,
4831 void *arg,
4832 sctp_cmd_seq_t *commands)
4834 SCTP_DEBUG_PRINTK("Primitive type %d is ignored.\n", type.primitive);
4835 return SCTP_DISPOSITION_DISCARD;
4838 /***************************************************************************
4839 * These are the state functions for the OTHER events.
4840 ***************************************************************************/
4843 * Start the shutdown negotiation.
4845 * From Section 9.2:
4846 * Once all its outstanding data has been acknowledged, the endpoint
4847 * shall send a SHUTDOWN chunk to its peer including in the Cumulative
4848 * TSN Ack field the last sequential TSN it has received from the peer.
4849 * It shall then start the T2-shutdown timer and enter the SHUTDOWN-SENT
4850 * state. If the timer expires, the endpoint must re-send the SHUTDOWN
4851 * with the updated last sequential TSN received from its peer.
4853 * The return value is the disposition.
4855 sctp_disposition_t sctp_sf_do_9_2_start_shutdown(
4856 const struct sctp_endpoint *ep,
4857 const struct sctp_association *asoc,
4858 const sctp_subtype_t type,
4859 void *arg,
4860 sctp_cmd_seq_t *commands)
4862 struct sctp_chunk *reply;
4864 /* Once all its outstanding data has been acknowledged, the
4865 * endpoint shall send a SHUTDOWN chunk to its peer including
4866 * in the Cumulative TSN Ack field the last sequential TSN it
4867 * has received from the peer.
4869 reply = sctp_make_shutdown(asoc, NULL);
4870 if (!reply)
4871 goto nomem;
4873 /* Set the transport for the SHUTDOWN chunk and the timeout for the
4874 * T2-shutdown timer.
4876 sctp_add_cmd_sf(commands, SCTP_CMD_SETUP_T2, SCTP_CHUNK(reply));
4878 /* It shall then start the T2-shutdown timer */
4879 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_START,
4880 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
4882 if (asoc->autoclose)
4883 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
4884 SCTP_TO(SCTP_EVENT_TIMEOUT_AUTOCLOSE));
4886 /* and enter the SHUTDOWN-SENT state. */
4887 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
4888 SCTP_STATE(SCTP_STATE_SHUTDOWN_SENT));
4890 /* sctp-implguide 2.10 Issues with Heartbeating and failover
4892 * HEARTBEAT ... is discontinued after sending either SHUTDOWN
4893 * or SHUTDOWN-ACK.
4895 sctp_add_cmd_sf(commands, SCTP_CMD_HB_TIMERS_STOP, SCTP_NULL());
4897 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(reply));
4899 return SCTP_DISPOSITION_CONSUME;
4901 nomem:
4902 return SCTP_DISPOSITION_NOMEM;
4906 * Generate a SHUTDOWN ACK now that everything is SACK'd.
4908 * From Section 9.2:
4910 * If it has no more outstanding DATA chunks, the SHUTDOWN receiver
4911 * shall send a SHUTDOWN ACK and start a T2-shutdown timer of its own,
4912 * entering the SHUTDOWN-ACK-SENT state. If the timer expires, the
4913 * endpoint must re-send the SHUTDOWN ACK.
4915 * The return value is the disposition.
4917 sctp_disposition_t sctp_sf_do_9_2_shutdown_ack(
4918 const struct sctp_endpoint *ep,
4919 const struct sctp_association *asoc,
4920 const sctp_subtype_t type,
4921 void *arg,
4922 sctp_cmd_seq_t *commands)
4924 struct sctp_chunk *chunk = (struct sctp_chunk *) arg;
4925 struct sctp_chunk *reply;
4927 /* There are 2 ways of getting here:
4928 * 1) called in response to a SHUTDOWN chunk
4929 * 2) called when SCTP_EVENT_NO_PENDING_TSN event is issued.
4931 * For the case (2), the arg parameter is set to NULL. We need
4932 * to check that we have a chunk before accessing it's fields.
4934 if (chunk) {
4935 if (!sctp_vtag_verify(chunk, asoc))
4936 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
4938 /* Make sure that the SHUTDOWN chunk has a valid length. */
4939 if (!sctp_chunk_length_valid(chunk, sizeof(struct sctp_shutdown_chunk_t)))
4940 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
4941 commands);
4944 /* If it has no more outstanding DATA chunks, the SHUTDOWN receiver
4945 * shall send a SHUTDOWN ACK ...
4947 reply = sctp_make_shutdown_ack(asoc, chunk);
4948 if (!reply)
4949 goto nomem;
4951 /* Set the transport for the SHUTDOWN ACK chunk and the timeout for
4952 * the T2-shutdown timer.
4954 sctp_add_cmd_sf(commands, SCTP_CMD_SETUP_T2, SCTP_CHUNK(reply));
4956 /* and start/restart a T2-shutdown timer of its own, */
4957 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
4958 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
4960 if (asoc->autoclose)
4961 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
4962 SCTP_TO(SCTP_EVENT_TIMEOUT_AUTOCLOSE));
4964 /* Enter the SHUTDOWN-ACK-SENT state. */
4965 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
4966 SCTP_STATE(SCTP_STATE_SHUTDOWN_ACK_SENT));
4968 /* sctp-implguide 2.10 Issues with Heartbeating and failover
4970 * HEARTBEAT ... is discontinued after sending either SHUTDOWN
4971 * or SHUTDOWN-ACK.
4973 sctp_add_cmd_sf(commands, SCTP_CMD_HB_TIMERS_STOP, SCTP_NULL());
4975 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(reply));
4977 return SCTP_DISPOSITION_CONSUME;
4979 nomem:
4980 return SCTP_DISPOSITION_NOMEM;
4984 * Ignore the event defined as other
4986 * The return value is the disposition of the event.
4988 sctp_disposition_t sctp_sf_ignore_other(const struct sctp_endpoint *ep,
4989 const struct sctp_association *asoc,
4990 const sctp_subtype_t type,
4991 void *arg,
4992 sctp_cmd_seq_t *commands)
4994 SCTP_DEBUG_PRINTK("The event other type %d is ignored\n", type.other);
4995 return SCTP_DISPOSITION_DISCARD;
4998 /************************************************************
4999 * These are the state functions for handling timeout events.
5000 ************************************************************/
5003 * RTX Timeout
5005 * Section: 6.3.3 Handle T3-rtx Expiration
5007 * Whenever the retransmission timer T3-rtx expires for a destination
5008 * address, do the following:
5009 * [See below]
5011 * The return value is the disposition of the chunk.
5013 sctp_disposition_t sctp_sf_do_6_3_3_rtx(const struct sctp_endpoint *ep,
5014 const struct sctp_association *asoc,
5015 const sctp_subtype_t type,
5016 void *arg,
5017 sctp_cmd_seq_t *commands)
5019 struct sctp_transport *transport = arg;
5021 SCTP_INC_STATS(SCTP_MIB_T3_RTX_EXPIREDS);
5023 if (asoc->overall_error_count >= asoc->max_retrans) {
5024 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
5025 SCTP_ERROR(ETIMEDOUT));
5026 /* CMD_ASSOC_FAILED calls CMD_DELETE_TCB. */
5027 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
5028 SCTP_PERR(SCTP_ERROR_NO_ERROR));
5029 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
5030 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
5031 return SCTP_DISPOSITION_DELETE_TCB;
5034 /* E1) For the destination address for which the timer
5035 * expires, adjust its ssthresh with rules defined in Section
5036 * 7.2.3 and set the cwnd <- MTU.
5039 /* E2) For the destination address for which the timer
5040 * expires, set RTO <- RTO * 2 ("back off the timer"). The
5041 * maximum value discussed in rule C7 above (RTO.max) may be
5042 * used to provide an upper bound to this doubling operation.
5045 /* E3) Determine how many of the earliest (i.e., lowest TSN)
5046 * outstanding DATA chunks for the address for which the
5047 * T3-rtx has expired will fit into a single packet, subject
5048 * to the MTU constraint for the path corresponding to the
5049 * destination transport address to which the retransmission
5050 * is being sent (this may be different from the address for
5051 * which the timer expires [see Section 6.4]). Call this
5052 * value K. Bundle and retransmit those K DATA chunks in a
5053 * single packet to the destination endpoint.
5055 * Note: Any DATA chunks that were sent to the address for
5056 * which the T3-rtx timer expired but did not fit in one MTU
5057 * (rule E3 above), should be marked for retransmission and
5058 * sent as soon as cwnd allows (normally when a SACK arrives).
5061 /* Do some failure management (Section 8.2). */
5062 sctp_add_cmd_sf(commands, SCTP_CMD_STRIKE, SCTP_TRANSPORT(transport));
5064 /* NB: Rules E4 and F1 are implicit in R1. */
5065 sctp_add_cmd_sf(commands, SCTP_CMD_RETRAN, SCTP_TRANSPORT(transport));
5067 return SCTP_DISPOSITION_CONSUME;
5071 * Generate delayed SACK on timeout
5073 * Section: 6.2 Acknowledgement on Reception of DATA Chunks
5075 * The guidelines on delayed acknowledgement algorithm specified in
5076 * Section 4.2 of [RFC2581] SHOULD be followed. Specifically, an
5077 * acknowledgement SHOULD be generated for at least every second packet
5078 * (not every second DATA chunk) received, and SHOULD be generated
5079 * within 200 ms of the arrival of any unacknowledged DATA chunk. In
5080 * some situations it may be beneficial for an SCTP transmitter to be
5081 * more conservative than the algorithms detailed in this document
5082 * allow. However, an SCTP transmitter MUST NOT be more aggressive than
5083 * the following algorithms allow.
5085 sctp_disposition_t sctp_sf_do_6_2_sack(const struct sctp_endpoint *ep,
5086 const struct sctp_association *asoc,
5087 const sctp_subtype_t type,
5088 void *arg,
5089 sctp_cmd_seq_t *commands)
5091 SCTP_INC_STATS(SCTP_MIB_DELAY_SACK_EXPIREDS);
5092 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_SACK, SCTP_FORCE());
5093 return SCTP_DISPOSITION_CONSUME;
5097 * sctp_sf_t1_init_timer_expire
5099 * Section: 4 Note: 2
5100 * Verification Tag:
5101 * Inputs
5102 * (endpoint, asoc)
5104 * RFC 2960 Section 4 Notes
5105 * 2) If the T1-init timer expires, the endpoint MUST retransmit INIT
5106 * and re-start the T1-init timer without changing state. This MUST
5107 * be repeated up to 'Max.Init.Retransmits' times. After that, the
5108 * endpoint MUST abort the initialization process and report the
5109 * error to SCTP user.
5111 * Outputs
5112 * (timers, events)
5115 sctp_disposition_t sctp_sf_t1_init_timer_expire(const struct sctp_endpoint *ep,
5116 const struct sctp_association *asoc,
5117 const sctp_subtype_t type,
5118 void *arg,
5119 sctp_cmd_seq_t *commands)
5121 struct sctp_chunk *repl = NULL;
5122 struct sctp_bind_addr *bp;
5123 int attempts = asoc->init_err_counter + 1;
5125 SCTP_DEBUG_PRINTK("Timer T1 expired (INIT).\n");
5126 SCTP_INC_STATS(SCTP_MIB_T1_INIT_EXPIREDS);
5128 if (attempts <= asoc->max_init_attempts) {
5129 bp = (struct sctp_bind_addr *) &asoc->base.bind_addr;
5130 repl = sctp_make_init(asoc, bp, GFP_ATOMIC, 0);
5131 if (!repl)
5132 return SCTP_DISPOSITION_NOMEM;
5134 /* Choose transport for INIT. */
5135 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_CHOOSE_TRANSPORT,
5136 SCTP_CHUNK(repl));
5138 /* Issue a sideeffect to do the needed accounting. */
5139 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_RESTART,
5140 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_INIT));
5142 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(repl));
5143 } else {
5144 SCTP_DEBUG_PRINTK("Giving up on INIT, attempts: %d"
5145 " max_init_attempts: %d\n",
5146 attempts, asoc->max_init_attempts);
5147 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
5148 SCTP_ERROR(ETIMEDOUT));
5149 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_FAILED,
5150 SCTP_PERR(SCTP_ERROR_NO_ERROR));
5151 return SCTP_DISPOSITION_DELETE_TCB;
5154 return SCTP_DISPOSITION_CONSUME;
5158 * sctp_sf_t1_cookie_timer_expire
5160 * Section: 4 Note: 2
5161 * Verification Tag:
5162 * Inputs
5163 * (endpoint, asoc)
5165 * RFC 2960 Section 4 Notes
5166 * 3) If the T1-cookie timer expires, the endpoint MUST retransmit
5167 * COOKIE ECHO and re-start the T1-cookie timer without changing
5168 * state. This MUST be repeated up to 'Max.Init.Retransmits' times.
5169 * After that, the endpoint MUST abort the initialization process and
5170 * report the error to SCTP user.
5172 * Outputs
5173 * (timers, events)
5176 sctp_disposition_t sctp_sf_t1_cookie_timer_expire(const struct sctp_endpoint *ep,
5177 const struct sctp_association *asoc,
5178 const sctp_subtype_t type,
5179 void *arg,
5180 sctp_cmd_seq_t *commands)
5182 struct sctp_chunk *repl = NULL;
5183 int attempts = asoc->init_err_counter + 1;
5185 SCTP_DEBUG_PRINTK("Timer T1 expired (COOKIE-ECHO).\n");
5186 SCTP_INC_STATS(SCTP_MIB_T1_COOKIE_EXPIREDS);
5188 if (attempts <= asoc->max_init_attempts) {
5189 repl = sctp_make_cookie_echo(asoc, NULL);
5190 if (!repl)
5191 return SCTP_DISPOSITION_NOMEM;
5193 /* Issue a sideeffect to do the needed accounting. */
5194 sctp_add_cmd_sf(commands, SCTP_CMD_COOKIEECHO_RESTART,
5195 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_COOKIE));
5197 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(repl));
5198 } else {
5199 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
5200 SCTP_ERROR(ETIMEDOUT));
5201 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_FAILED,
5202 SCTP_PERR(SCTP_ERROR_NO_ERROR));
5203 return SCTP_DISPOSITION_DELETE_TCB;
5206 return SCTP_DISPOSITION_CONSUME;
5209 /* RFC2960 9.2 If the timer expires, the endpoint must re-send the SHUTDOWN
5210 * with the updated last sequential TSN received from its peer.
5212 * An endpoint should limit the number of retransmissions of the
5213 * SHUTDOWN chunk to the protocol parameter 'Association.Max.Retrans'.
5214 * If this threshold is exceeded the endpoint should destroy the TCB and
5215 * MUST report the peer endpoint unreachable to the upper layer (and
5216 * thus the association enters the CLOSED state). The reception of any
5217 * packet from its peer (i.e. as the peer sends all of its queued DATA
5218 * chunks) should clear the endpoint's retransmission count and restart
5219 * the T2-Shutdown timer, giving its peer ample opportunity to transmit
5220 * all of its queued DATA chunks that have not yet been sent.
5222 sctp_disposition_t sctp_sf_t2_timer_expire(const struct sctp_endpoint *ep,
5223 const struct sctp_association *asoc,
5224 const sctp_subtype_t type,
5225 void *arg,
5226 sctp_cmd_seq_t *commands)
5228 struct sctp_chunk *reply = NULL;
5230 SCTP_DEBUG_PRINTK("Timer T2 expired.\n");
5231 SCTP_INC_STATS(SCTP_MIB_T2_SHUTDOWN_EXPIREDS);
5233 if (asoc->overall_error_count >= asoc->max_retrans) {
5234 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
5235 SCTP_ERROR(ETIMEDOUT));
5236 /* Note: CMD_ASSOC_FAILED calls CMD_DELETE_TCB. */
5237 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
5238 SCTP_PERR(SCTP_ERROR_NO_ERROR));
5239 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
5240 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
5241 return SCTP_DISPOSITION_DELETE_TCB;
5244 switch (asoc->state) {
5245 case SCTP_STATE_SHUTDOWN_SENT:
5246 reply = sctp_make_shutdown(asoc, NULL);
5247 break;
5249 case SCTP_STATE_SHUTDOWN_ACK_SENT:
5250 reply = sctp_make_shutdown_ack(asoc, NULL);
5251 break;
5253 default:
5254 BUG();
5255 break;
5258 if (!reply)
5259 goto nomem;
5261 /* Do some failure management (Section 8.2). */
5262 sctp_add_cmd_sf(commands, SCTP_CMD_STRIKE,
5263 SCTP_TRANSPORT(asoc->shutdown_last_sent_to));
5265 /* Set the transport for the SHUTDOWN/ACK chunk and the timeout for
5266 * the T2-shutdown timer.
5268 sctp_add_cmd_sf(commands, SCTP_CMD_SETUP_T2, SCTP_CHUNK(reply));
5270 /* Restart the T2-shutdown timer. */
5271 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
5272 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
5273 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(reply));
5274 return SCTP_DISPOSITION_CONSUME;
5276 nomem:
5277 return SCTP_DISPOSITION_NOMEM;
5281 * ADDIP Section 4.1 ASCONF CHunk Procedures
5282 * If the T4 RTO timer expires the endpoint should do B1 to B5
5284 sctp_disposition_t sctp_sf_t4_timer_expire(
5285 const struct sctp_endpoint *ep,
5286 const struct sctp_association *asoc,
5287 const sctp_subtype_t type,
5288 void *arg,
5289 sctp_cmd_seq_t *commands)
5291 struct sctp_chunk *chunk = asoc->addip_last_asconf;
5292 struct sctp_transport *transport = chunk->transport;
5294 SCTP_INC_STATS(SCTP_MIB_T4_RTO_EXPIREDS);
5296 /* ADDIP 4.1 B1) Increment the error counters and perform path failure
5297 * detection on the appropriate destination address as defined in
5298 * RFC2960 [5] section 8.1 and 8.2.
5300 sctp_add_cmd_sf(commands, SCTP_CMD_STRIKE, SCTP_TRANSPORT(transport));
5302 /* Reconfig T4 timer and transport. */
5303 sctp_add_cmd_sf(commands, SCTP_CMD_SETUP_T4, SCTP_CHUNK(chunk));
5305 /* ADDIP 4.1 B2) Increment the association error counters and perform
5306 * endpoint failure detection on the association as defined in
5307 * RFC2960 [5] section 8.1 and 8.2.
5308 * association error counter is incremented in SCTP_CMD_STRIKE.
5310 if (asoc->overall_error_count >= asoc->max_retrans) {
5311 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
5312 SCTP_TO(SCTP_EVENT_TIMEOUT_T4_RTO));
5313 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
5314 SCTP_ERROR(ETIMEDOUT));
5315 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
5316 SCTP_PERR(SCTP_ERROR_NO_ERROR));
5317 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
5318 SCTP_INC_STATS(SCTP_MIB_CURRESTAB);
5319 return SCTP_DISPOSITION_ABORT;
5322 /* ADDIP 4.1 B3) Back-off the destination address RTO value to which
5323 * the ASCONF chunk was sent by doubling the RTO timer value.
5324 * This is done in SCTP_CMD_STRIKE.
5327 /* ADDIP 4.1 B4) Re-transmit the ASCONF Chunk last sent and if possible
5328 * choose an alternate destination address (please refer to RFC2960
5329 * [5] section 6.4.1). An endpoint MUST NOT add new parameters to this
5330 * chunk, it MUST be the same (including its serial number) as the last
5331 * ASCONF sent.
5333 sctp_chunk_hold(asoc->addip_last_asconf);
5334 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
5335 SCTP_CHUNK(asoc->addip_last_asconf));
5337 /* ADDIP 4.1 B5) Restart the T-4 RTO timer. Note that if a different
5338 * destination is selected, then the RTO used will be that of the new
5339 * destination address.
5341 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
5342 SCTP_TO(SCTP_EVENT_TIMEOUT_T4_RTO));
5344 return SCTP_DISPOSITION_CONSUME;
5347 /* sctpimpguide-05 Section 2.12.2
5348 * The sender of the SHUTDOWN MAY also start an overall guard timer
5349 * 'T5-shutdown-guard' to bound the overall time for shutdown sequence.
5350 * At the expiration of this timer the sender SHOULD abort the association
5351 * by sending an ABORT chunk.
5353 sctp_disposition_t sctp_sf_t5_timer_expire(const struct sctp_endpoint *ep,
5354 const struct sctp_association *asoc,
5355 const sctp_subtype_t type,
5356 void *arg,
5357 sctp_cmd_seq_t *commands)
5359 struct sctp_chunk *reply = NULL;
5361 SCTP_DEBUG_PRINTK("Timer T5 expired.\n");
5362 SCTP_INC_STATS(SCTP_MIB_T5_SHUTDOWN_GUARD_EXPIREDS);
5364 reply = sctp_make_abort(asoc, NULL, 0);
5365 if (!reply)
5366 goto nomem;
5368 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(reply));
5369 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
5370 SCTP_ERROR(ETIMEDOUT));
5371 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
5372 SCTP_PERR(SCTP_ERROR_NO_ERROR));
5374 return SCTP_DISPOSITION_DELETE_TCB;
5375 nomem:
5376 return SCTP_DISPOSITION_NOMEM;
5379 /* Handle expiration of AUTOCLOSE timer. When the autoclose timer expires,
5380 * the association is automatically closed by starting the shutdown process.
5381 * The work that needs to be done is same as when SHUTDOWN is initiated by
5382 * the user. So this routine looks same as sctp_sf_do_9_2_prm_shutdown().
5384 sctp_disposition_t sctp_sf_autoclose_timer_expire(
5385 const struct sctp_endpoint *ep,
5386 const struct sctp_association *asoc,
5387 const sctp_subtype_t type,
5388 void *arg,
5389 sctp_cmd_seq_t *commands)
5391 int disposition;
5393 SCTP_INC_STATS(SCTP_MIB_AUTOCLOSE_EXPIREDS);
5395 /* From 9.2 Shutdown of an Association
5396 * Upon receipt of the SHUTDOWN primitive from its upper
5397 * layer, the endpoint enters SHUTDOWN-PENDING state and
5398 * remains there until all outstanding data has been
5399 * acknowledged by its peer. The endpoint accepts no new data
5400 * from its upper layer, but retransmits data to the far end
5401 * if necessary to fill gaps.
5403 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
5404 SCTP_STATE(SCTP_STATE_SHUTDOWN_PENDING));
5406 /* sctpimpguide-05 Section 2.12.2
5407 * The sender of the SHUTDOWN MAY also start an overall guard timer
5408 * 'T5-shutdown-guard' to bound the overall time for shutdown sequence.
5410 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_START,
5411 SCTP_TO(SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD));
5412 disposition = SCTP_DISPOSITION_CONSUME;
5413 if (sctp_outq_is_empty(&asoc->outqueue)) {
5414 disposition = sctp_sf_do_9_2_start_shutdown(ep, asoc, type,
5415 arg, commands);
5417 return disposition;
5420 /*****************************************************************************
5421 * These are sa state functions which could apply to all types of events.
5422 ****************************************************************************/
5425 * This table entry is not implemented.
5427 * Inputs
5428 * (endpoint, asoc, chunk)
5430 * The return value is the disposition of the chunk.
5432 sctp_disposition_t sctp_sf_not_impl(const struct sctp_endpoint *ep,
5433 const struct sctp_association *asoc,
5434 const sctp_subtype_t type,
5435 void *arg,
5436 sctp_cmd_seq_t *commands)
5438 return SCTP_DISPOSITION_NOT_IMPL;
5442 * This table entry represents a bug.
5444 * Inputs
5445 * (endpoint, asoc, chunk)
5447 * The return value is the disposition of the chunk.
5449 sctp_disposition_t sctp_sf_bug(const struct sctp_endpoint *ep,
5450 const struct sctp_association *asoc,
5451 const sctp_subtype_t type,
5452 void *arg,
5453 sctp_cmd_seq_t *commands)
5455 return SCTP_DISPOSITION_BUG;
5459 * This table entry represents the firing of a timer in the wrong state.
5460 * Since timer deletion cannot be guaranteed a timer 'may' end up firing
5461 * when the association is in the wrong state. This event should
5462 * be ignored, so as to prevent any rearming of the timer.
5464 * Inputs
5465 * (endpoint, asoc, chunk)
5467 * The return value is the disposition of the chunk.
5469 sctp_disposition_t sctp_sf_timer_ignore(const struct sctp_endpoint *ep,
5470 const struct sctp_association *asoc,
5471 const sctp_subtype_t type,
5472 void *arg,
5473 sctp_cmd_seq_t *commands)
5475 SCTP_DEBUG_PRINTK("Timer %d ignored.\n", type.chunk);
5476 return SCTP_DISPOSITION_CONSUME;
5479 /********************************************************************
5480 * 2nd Level Abstractions
5481 ********************************************************************/
5483 /* Pull the SACK chunk based on the SACK header. */
5484 static struct sctp_sackhdr *sctp_sm_pull_sack(struct sctp_chunk *chunk)
5486 struct sctp_sackhdr *sack;
5487 unsigned int len;
5488 __u16 num_blocks;
5489 __u16 num_dup_tsns;
5491 /* Protect ourselves from reading too far into
5492 * the skb from a bogus sender.
5494 sack = (struct sctp_sackhdr *) chunk->skb->data;
5496 num_blocks = ntohs(sack->num_gap_ack_blocks);
5497 num_dup_tsns = ntohs(sack->num_dup_tsns);
5498 len = sizeof(struct sctp_sackhdr);
5499 len += (num_blocks + num_dup_tsns) * sizeof(__u32);
5500 if (len > chunk->skb->len)
5501 return NULL;
5503 skb_pull(chunk->skb, len);
5505 return sack;
5508 /* Create an ABORT packet to be sent as a response, with the specified
5509 * error causes.
5511 static struct sctp_packet *sctp_abort_pkt_new(const struct sctp_endpoint *ep,
5512 const struct sctp_association *asoc,
5513 struct sctp_chunk *chunk,
5514 const void *payload,
5515 size_t paylen)
5517 struct sctp_packet *packet;
5518 struct sctp_chunk *abort;
5520 packet = sctp_ootb_pkt_new(asoc, chunk);
5522 if (packet) {
5523 /* Make an ABORT.
5524 * The T bit will be set if the asoc is NULL.
5526 abort = sctp_make_abort(asoc, chunk, paylen);
5527 if (!abort) {
5528 sctp_ootb_pkt_free(packet);
5529 return NULL;
5532 /* Reflect vtag if T-Bit is set */
5533 if (sctp_test_T_bit(abort))
5534 packet->vtag = ntohl(chunk->sctp_hdr->vtag);
5536 /* Add specified error causes, i.e., payload, to the
5537 * end of the chunk.
5539 sctp_addto_chunk(abort, paylen, payload);
5541 /* Set the skb to the belonging sock for accounting. */
5542 abort->skb->sk = ep->base.sk;
5544 sctp_packet_append_chunk(packet, abort);
5548 return packet;
5551 /* Allocate a packet for responding in the OOTB conditions. */
5552 static struct sctp_packet *sctp_ootb_pkt_new(const struct sctp_association *asoc,
5553 const struct sctp_chunk *chunk)
5555 struct sctp_packet *packet;
5556 struct sctp_transport *transport;
5557 __u16 sport;
5558 __u16 dport;
5559 __u32 vtag;
5561 /* Get the source and destination port from the inbound packet. */
5562 sport = ntohs(chunk->sctp_hdr->dest);
5563 dport = ntohs(chunk->sctp_hdr->source);
5565 /* The V-tag is going to be the same as the inbound packet if no
5566 * association exists, otherwise, use the peer's vtag.
5568 if (asoc) {
5569 /* Special case the INIT-ACK as there is no peer's vtag
5570 * yet.
5572 switch(chunk->chunk_hdr->type) {
5573 case SCTP_CID_INIT_ACK:
5575 sctp_initack_chunk_t *initack;
5577 initack = (sctp_initack_chunk_t *)chunk->chunk_hdr;
5578 vtag = ntohl(initack->init_hdr.init_tag);
5579 break;
5581 default:
5582 vtag = asoc->peer.i.init_tag;
5583 break;
5585 } else {
5586 /* Special case the INIT and stale COOKIE_ECHO as there is no
5587 * vtag yet.
5589 switch(chunk->chunk_hdr->type) {
5590 case SCTP_CID_INIT:
5592 sctp_init_chunk_t *init;
5594 init = (sctp_init_chunk_t *)chunk->chunk_hdr;
5595 vtag = ntohl(init->init_hdr.init_tag);
5596 break;
5598 default:
5599 vtag = ntohl(chunk->sctp_hdr->vtag);
5600 break;
5604 /* Make a transport for the bucket, Eliza... */
5605 transport = sctp_transport_new(sctp_source(chunk), GFP_ATOMIC);
5606 if (!transport)
5607 goto nomem;
5609 /* Cache a route for the transport with the chunk's destination as
5610 * the source address.
5612 sctp_transport_route(transport, (union sctp_addr *)&chunk->dest,
5613 sctp_sk(sctp_get_ctl_sock()));
5615 packet = sctp_packet_init(&transport->packet, transport, sport, dport);
5616 packet = sctp_packet_config(packet, vtag, 0);
5618 return packet;
5620 nomem:
5621 return NULL;
5624 /* Free the packet allocated earlier for responding in the OOTB condition. */
5625 void sctp_ootb_pkt_free(struct sctp_packet *packet)
5627 sctp_transport_free(packet->transport);
5630 /* Send a stale cookie error when a invalid COOKIE ECHO chunk is found */
5631 static void sctp_send_stale_cookie_err(const struct sctp_endpoint *ep,
5632 const struct sctp_association *asoc,
5633 const struct sctp_chunk *chunk,
5634 sctp_cmd_seq_t *commands,
5635 struct sctp_chunk *err_chunk)
5637 struct sctp_packet *packet;
5639 if (err_chunk) {
5640 packet = sctp_ootb_pkt_new(asoc, chunk);
5641 if (packet) {
5642 struct sctp_signed_cookie *cookie;
5644 /* Override the OOTB vtag from the cookie. */
5645 cookie = chunk->subh.cookie_hdr;
5646 packet->vtag = cookie->c.peer_vtag;
5648 /* Set the skb to the belonging sock for accounting. */
5649 err_chunk->skb->sk = ep->base.sk;
5650 sctp_packet_append_chunk(packet, err_chunk);
5651 sctp_add_cmd_sf(commands, SCTP_CMD_SEND_PKT,
5652 SCTP_PACKET(packet));
5653 SCTP_INC_STATS(SCTP_MIB_OUTCTRLCHUNKS);
5654 } else
5655 sctp_chunk_free (err_chunk);
5660 /* Process a data chunk */
5661 static int sctp_eat_data(const struct sctp_association *asoc,
5662 struct sctp_chunk *chunk,
5663 sctp_cmd_seq_t *commands)
5665 sctp_datahdr_t *data_hdr;
5666 struct sctp_chunk *err;
5667 size_t datalen;
5668 sctp_verb_t deliver;
5669 int tmp;
5670 __u32 tsn;
5671 struct sctp_tsnmap *map = (struct sctp_tsnmap *)&asoc->peer.tsn_map;
5672 struct sock *sk = asoc->base.sk;
5674 data_hdr = chunk->subh.data_hdr = (sctp_datahdr_t *)chunk->skb->data;
5675 skb_pull(chunk->skb, sizeof(sctp_datahdr_t));
5677 tsn = ntohl(data_hdr->tsn);
5678 SCTP_DEBUG_PRINTK("eat_data: TSN 0x%x.\n", tsn);
5680 /* ASSERT: Now skb->data is really the user data. */
5682 /* Process ECN based congestion.
5684 * Since the chunk structure is reused for all chunks within
5685 * a packet, we use ecn_ce_done to track if we've already
5686 * done CE processing for this packet.
5688 * We need to do ECN processing even if we plan to discard the
5689 * chunk later.
5692 if (!chunk->ecn_ce_done) {
5693 struct sctp_af *af;
5694 chunk->ecn_ce_done = 1;
5696 af = sctp_get_af_specific(
5697 ipver2af(ip_hdr(chunk->skb)->version));
5699 if (af && af->is_ce(chunk->skb) && asoc->peer.ecn_capable) {
5700 /* Do real work as sideffect. */
5701 sctp_add_cmd_sf(commands, SCTP_CMD_ECN_CE,
5702 SCTP_U32(tsn));
5706 tmp = sctp_tsnmap_check(&asoc->peer.tsn_map, tsn);
5707 if (tmp < 0) {
5708 /* The TSN is too high--silently discard the chunk and
5709 * count on it getting retransmitted later.
5711 return SCTP_IERROR_HIGH_TSN;
5712 } else if (tmp > 0) {
5713 /* This is a duplicate. Record it. */
5714 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_DUP, SCTP_U32(tsn));
5715 return SCTP_IERROR_DUP_TSN;
5718 /* This is a new TSN. */
5720 /* Discard if there is no room in the receive window.
5721 * Actually, allow a little bit of overflow (up to a MTU).
5723 datalen = ntohs(chunk->chunk_hdr->length);
5724 datalen -= sizeof(sctp_data_chunk_t);
5726 deliver = SCTP_CMD_CHUNK_ULP;
5728 /* Think about partial delivery. */
5729 if ((datalen >= asoc->rwnd) && (!asoc->ulpq.pd_mode)) {
5731 /* Even if we don't accept this chunk there is
5732 * memory pressure.
5734 sctp_add_cmd_sf(commands, SCTP_CMD_PART_DELIVER, SCTP_NULL());
5737 /* Spill over rwnd a little bit. Note: While allowed, this spill over
5738 * seems a bit troublesome in that frag_point varies based on
5739 * PMTU. In cases, such as loopback, this might be a rather
5740 * large spill over.
5742 if ((!chunk->data_accepted) && (!asoc->rwnd || asoc->rwnd_over ||
5743 (datalen > asoc->rwnd + asoc->frag_point))) {
5745 /* If this is the next TSN, consider reneging to make
5746 * room. Note: Playing nice with a confused sender. A
5747 * malicious sender can still eat up all our buffer
5748 * space and in the future we may want to detect and
5749 * do more drastic reneging.
5751 if (sctp_tsnmap_has_gap(map) &&
5752 (sctp_tsnmap_get_ctsn(map) + 1) == tsn) {
5753 SCTP_DEBUG_PRINTK("Reneging for tsn:%u\n", tsn);
5754 deliver = SCTP_CMD_RENEGE;
5755 } else {
5756 SCTP_DEBUG_PRINTK("Discard tsn: %u len: %Zd, "
5757 "rwnd: %d\n", tsn, datalen,
5758 asoc->rwnd);
5759 return SCTP_IERROR_IGNORE_TSN;
5764 * Also try to renege to limit our memory usage in the event that
5765 * we are under memory pressure
5766 * If we can't renege, don't worry about it, the sk_stream_rmem_schedule
5767 * in sctp_ulpevent_make_rcvmsg will drop the frame if we grow our
5768 * memory usage too much
5770 if (*sk->sk_prot_creator->memory_pressure) {
5771 if (sctp_tsnmap_has_gap(map) &&
5772 (sctp_tsnmap_get_ctsn(map) + 1) == tsn) {
5773 SCTP_DEBUG_PRINTK("Under Pressure! Reneging for tsn:%u\n", tsn);
5774 deliver = SCTP_CMD_RENEGE;
5779 * Section 3.3.10.9 No User Data (9)
5781 * Cause of error
5782 * ---------------
5783 * No User Data: This error cause is returned to the originator of a
5784 * DATA chunk if a received DATA chunk has no user data.
5786 if (unlikely(0 == datalen)) {
5787 err = sctp_make_abort_no_data(asoc, chunk, tsn);
5788 if (err) {
5789 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
5790 SCTP_CHUNK(err));
5792 /* We are going to ABORT, so we might as well stop
5793 * processing the rest of the chunks in the packet.
5795 sctp_add_cmd_sf(commands, SCTP_CMD_DISCARD_PACKET,SCTP_NULL());
5796 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
5797 SCTP_ERROR(ECONNABORTED));
5798 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
5799 SCTP_PERR(SCTP_ERROR_NO_DATA));
5800 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
5801 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
5802 return SCTP_IERROR_NO_DATA;
5805 /* If definately accepting the DATA chunk, record its TSN, otherwise
5806 * wait for renege processing.
5808 if (SCTP_CMD_CHUNK_ULP == deliver)
5809 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_TSN, SCTP_U32(tsn));
5811 chunk->data_accepted = 1;
5813 /* Note: Some chunks may get overcounted (if we drop) or overcounted
5814 * if we renege and the chunk arrives again.
5816 if (chunk->chunk_hdr->flags & SCTP_DATA_UNORDERED)
5817 SCTP_INC_STATS(SCTP_MIB_INUNORDERCHUNKS);
5818 else
5819 SCTP_INC_STATS(SCTP_MIB_INORDERCHUNKS);
5821 /* RFC 2960 6.5 Stream Identifier and Stream Sequence Number
5823 * If an endpoint receive a DATA chunk with an invalid stream
5824 * identifier, it shall acknowledge the reception of the DATA chunk
5825 * following the normal procedure, immediately send an ERROR chunk
5826 * with cause set to "Invalid Stream Identifier" (See Section 3.3.10)
5827 * and discard the DATA chunk.
5829 if (ntohs(data_hdr->stream) >= asoc->c.sinit_max_instreams) {
5830 err = sctp_make_op_error(asoc, chunk, SCTP_ERROR_INV_STRM,
5831 &data_hdr->stream,
5832 sizeof(data_hdr->stream));
5833 if (err)
5834 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
5835 SCTP_CHUNK(err));
5836 return SCTP_IERROR_BAD_STREAM;
5839 /* Send the data up to the user. Note: Schedule the
5840 * SCTP_CMD_CHUNK_ULP cmd before the SCTP_CMD_GEN_SACK, as the SACK
5841 * chunk needs the updated rwnd.
5843 sctp_add_cmd_sf(commands, deliver, SCTP_CHUNK(chunk));
5845 return SCTP_IERROR_NO_ERROR;