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)
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
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>
58 #include <linux/ipv6.h>
59 #include <linux/net.h>
60 #include <linux/inet.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,
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,
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,
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,
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,
109 sctp_cmd_seq_t *commands,
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,
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,
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,
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,
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
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))
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:
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
186 * it is set to its peer's tag and the T bit is set in the Chunk
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.
193 * (endpoint, asoc, chunk)
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,
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,
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);
235 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP,
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
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.
278 * (endpoint, asoc, chunk)
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,
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;
300 * An endpoint MUST NOT bundle INIT, INIT ACK or
301 * SHUTDOWN COMPLETE with any other chunks.
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
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. */
333 if (!sctp_verify_init(asoc, chunk->chunk_hdr->type,
334 (sctp_init_chunk_t *)chunk->chunk_hdr, chunk,
336 /* This chunk contains fatal error. It is to be discarded.
337 * Send an ABORT, with causes if there is any.
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);
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;
354 return SCTP_DISPOSITION_NOMEM;
357 return sctp_sf_tabort_8_4_8(ep, asoc, type, arg,
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);
372 /* The call, sctp_process_init(), can fail on memory allocation. */
373 if (!sctp_process_init(new_asoc, chunk->chunk_hdr->type,
375 (sctp_init_chunk_t *)chunk->chunk_hdr,
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.
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)
392 repl = sctp_make_init_ack(new_asoc, chunk, GFP_ATOMIC, len);
396 /* If there are errors need to be reported for unknown parameters,
397 * include them in the outgoing INIT ACK as "Unrecognized parameter"
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
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"
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
428 sctp_add_cmd_sf(commands, SCTP_CMD_DELETE_TCB, SCTP_NULL());
430 return SCTP_DISPOSITION_DELETE_TCB;
433 sctp_association_free(new_asoc);
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.
461 * (endpoint, asoc, chunk)
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,
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;
480 if (!sctp_vtag_verify(chunk, asoc))
481 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
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,
494 /* Grab the INIT header. */
495 chunk->subh.init_hdr = (sctp_inithdr_t *) chunk->skb->data;
497 /* Verify the INIT chunk before processing it. */
499 if (!sctp_verify_init(asoc, chunk->chunk_hdr->type,
500 (sctp_init_chunk_t *)chunk->chunk_hdr, chunk,
503 /* This chunk contains fatal error. It is to be discarded.
504 * Send an ABORT, with causes if there is any.
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);
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;
521 error = SCTP_ERROR_NO_RESOURCE;
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
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.
612 * (endpoint, asoc, chunk)
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;
630 struct sctp_chunk *err_chk_p;
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
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
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)))
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,
673 * If the re-build failed, what is the proper error path
676 * [We should abort the association. --piggy]
679 /* FIXME: Several errors are possible. A bad cookie should
680 * be silently discarded, but think about logging it too.
683 case -SCTP_IERROR_NOMEM:
686 case -SCTP_IERROR_STALE_COOKIE:
687 sctp_send_stale_cookie_err(ep, asoc, chunk, commands,
689 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
691 case -SCTP_IERROR_BAD_SIG:
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))
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);
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;
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);
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,
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,
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
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 */
806 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP,
807 SCTP_ULPEVENT(ai_ev));
809 return SCTP_DISPOSITION_CONSUME;
812 sctp_ulpevent_free(ev);
814 sctp_chunk_free(repl);
816 sctp_association_free(new_asoc);
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).
835 * (endpoint, asoc, chunk)
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,
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());
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,
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);
910 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP,
914 return SCTP_DISPOSITION_CONSUME;
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,
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;
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);
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,
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;
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,
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.
1014 * (endpoint, asoc, chunk)
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,
1025 sctp_cmd_seq_t *commands)
1027 struct sctp_chunk *chunk = arg;
1028 struct sctp_chunk *reply;
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,
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))
1048 reply = sctp_make_heartbeat_ack(asoc, chunk,
1049 chunk->subh.hb_hdr, paylen);
1053 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(reply));
1054 return SCTP_DISPOSITION_CONSUME;
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
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]
1081 * (endpoint, asoc, chunk)
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,
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,
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())
1123 "%s association %p could not find address "
1127 NIP6(from_addr.v6.sin6_addr));
1129 if (net_ratelimit())
1131 "%s association %p could not find address "
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
1169 static int sctp_sf_send_restart_abort(union sctp_addr *ssa,
1170 struct sctp_chunk *init,
1171 sctp_cmd_seq_t *commands)
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);
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());
1212 /* Even if there is no memory, treat as a failure so
1213 * the packet will get dropped.
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;
1230 /* Implementor's Guide - Sectin 5.2.2
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
1238 /* Search through all current addresses and make sure
1239 * we aren't adding any new ones.
1244 list_for_each(pos, &new_asoc->peer.transport_addr_list) {
1245 new_addr = list_entry(pos, struct sctp_transport, transports);
1247 list_for_each(pos2, &asoc->peer.transport_addr_list) {
1248 addr = list_entry(pos2, struct sctp_transport,
1250 if (sctp_cmp_addr_exact(&new_addr->ipaddr,
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. */
1269 /* Populate the verification/tie tags based on overlapping INIT
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;
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;
1293 /* 5.2.2 Unexpected INIT in States Other than CLOSED, COOKIE-ECHOED,
1294 * COOKIE-WAIT and SHUTDOWN-ACK-SENT
1297 new_asoc->c.my_ttag = asoc->c.my_vtag;
1298 new_asoc->c.peer_ttag = asoc->c.peer_vtag;
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;
1312 static void sctp_auth_params_populate(struct sctp_association *new_asoc,
1313 const struct sctp_association *asoc)
1315 /* Only perform this if AUTH extension is enabled */
1316 if (!sctp_auth_enable)
1319 /* We need to provide the same parameter information as
1320 * was in the original INIT. This means that we need to copy
1321 * the HMACS, CHUNKS, and RANDOM parameter from the original
1324 memcpy(new_asoc->c.auth_random, asoc->c.auth_random,
1325 sizeof(asoc->c.auth_random));
1326 memcpy(new_asoc->c.auth_hmacs, asoc->c.auth_hmacs,
1327 sizeof(asoc->c.auth_hmacs));
1328 memcpy(new_asoc->c.auth_chunks, asoc->c.auth_chunks,
1329 sizeof(asoc->c.auth_chunks));
1333 * Compare vtag/tietag values to determine unexpected COOKIE-ECHO
1336 * RFC 2960 5.2.4 Handle a COOKIE ECHO when a TCB exists.
1338 * Returns value representing action to be taken. These action values
1339 * correspond to Action/Description values in RFC 2960, Table 2.
1341 static char sctp_tietags_compare(struct sctp_association *new_asoc,
1342 const struct sctp_association *asoc)
1344 /* In this case, the peer may have restarted. */
1345 if ((asoc->c.my_vtag != new_asoc->c.my_vtag) &&
1346 (asoc->c.peer_vtag != new_asoc->c.peer_vtag) &&
1347 (asoc->c.my_vtag == new_asoc->c.my_ttag) &&
1348 (asoc->c.peer_vtag == new_asoc->c.peer_ttag))
1351 /* Collision case B. */
1352 if ((asoc->c.my_vtag == new_asoc->c.my_vtag) &&
1353 ((asoc->c.peer_vtag != new_asoc->c.peer_vtag) ||
1354 (0 == asoc->c.peer_vtag))) {
1358 /* Collision case D. */
1359 if ((asoc->c.my_vtag == new_asoc->c.my_vtag) &&
1360 (asoc->c.peer_vtag == new_asoc->c.peer_vtag))
1363 /* Collision case C. */
1364 if ((asoc->c.my_vtag != new_asoc->c.my_vtag) &&
1365 (asoc->c.peer_vtag == new_asoc->c.peer_vtag) &&
1366 (0 == new_asoc->c.my_ttag) &&
1367 (0 == new_asoc->c.peer_ttag))
1370 /* No match to any of the special cases; discard this packet. */
1374 /* Common helper routine for both duplicate and simulataneous INIT
1377 static sctp_disposition_t sctp_sf_do_unexpected_init(
1378 const struct sctp_endpoint *ep,
1379 const struct sctp_association *asoc,
1380 const sctp_subtype_t type,
1381 void *arg, sctp_cmd_seq_t *commands)
1383 sctp_disposition_t retval;
1384 struct sctp_chunk *chunk = arg;
1385 struct sctp_chunk *repl;
1386 struct sctp_association *new_asoc;
1387 struct sctp_chunk *err_chunk;
1388 struct sctp_packet *packet;
1389 sctp_unrecognized_param_t *unk_param;
1393 * An endpoint MUST NOT bundle INIT, INIT ACK or
1394 * SHUTDOWN COMPLETE with any other chunks.
1397 * Furthermore, we require that the receiver of an INIT chunk MUST
1398 * enforce these rules by silently discarding an arriving packet
1399 * with an INIT chunk that is bundled with other chunks.
1401 if (!chunk->singleton)
1402 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
1404 /* 3.1 A packet containing an INIT chunk MUST have a zero Verification
1407 if (chunk->sctp_hdr->vtag != 0)
1408 return sctp_sf_tabort_8_4_8(ep, asoc, type, arg, commands);
1410 /* Make sure that the INIT chunk has a valid length.
1411 * In this case, we generate a protocol violation since we have
1412 * an association established.
1414 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_init_chunk_t)))
1415 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
1417 /* Grab the INIT header. */
1418 chunk->subh.init_hdr = (sctp_inithdr_t *) chunk->skb->data;
1420 /* Tag the variable length parameters. */
1421 chunk->param_hdr.v = skb_pull(chunk->skb, sizeof(sctp_inithdr_t));
1423 /* Verify the INIT chunk before processing it. */
1425 if (!sctp_verify_init(asoc, chunk->chunk_hdr->type,
1426 (sctp_init_chunk_t *)chunk->chunk_hdr, chunk,
1428 /* This chunk contains fatal error. It is to be discarded.
1429 * Send an ABORT, with causes if there is any.
1432 packet = sctp_abort_pkt_new(ep, asoc, arg,
1433 (__u8 *)(err_chunk->chunk_hdr) +
1434 sizeof(sctp_chunkhdr_t),
1435 ntohs(err_chunk->chunk_hdr->length) -
1436 sizeof(sctp_chunkhdr_t));
1439 sctp_add_cmd_sf(commands, SCTP_CMD_SEND_PKT,
1440 SCTP_PACKET(packet));
1441 SCTP_INC_STATS(SCTP_MIB_OUTCTRLCHUNKS);
1442 retval = SCTP_DISPOSITION_CONSUME;
1444 retval = SCTP_DISPOSITION_NOMEM;
1448 return sctp_sf_tabort_8_4_8(ep, asoc, type, arg,
1454 * Other parameters for the endpoint SHOULD be copied from the
1455 * existing parameters of the association (e.g. number of
1456 * outbound streams) into the INIT ACK and cookie.
1457 * FIXME: We are copying parameters from the endpoint not the
1460 new_asoc = sctp_make_temp_asoc(ep, chunk, GFP_ATOMIC);
1464 /* In the outbound INIT ACK the endpoint MUST copy its current
1465 * Verification Tag and Peers Verification tag into a reserved
1466 * place (local tie-tag and per tie-tag) within the state cookie.
1468 if (!sctp_process_init(new_asoc, chunk->chunk_hdr->type,
1470 (sctp_init_chunk_t *)chunk->chunk_hdr,
1474 /* Make sure no new addresses are being added during the
1475 * restart. Do not do this check for COOKIE-WAIT state,
1476 * since there are no peer addresses to check against.
1477 * Upon return an ABORT will have been sent if needed.
1479 if (!sctp_state(asoc, COOKIE_WAIT)) {
1480 if (!sctp_sf_check_restart_addrs(new_asoc, asoc, chunk,
1482 retval = SCTP_DISPOSITION_CONSUME;
1487 sctp_tietags_populate(new_asoc, asoc);
1489 sctp_auth_params_populate(new_asoc, asoc);
1491 /* B) "Z" shall respond immediately with an INIT ACK chunk. */
1493 /* If there are errors need to be reported for unknown parameters,
1494 * make sure to reserve enough room in the INIT ACK for them.
1498 len = ntohs(err_chunk->chunk_hdr->length) -
1499 sizeof(sctp_chunkhdr_t);
1502 if (sctp_assoc_set_bind_addr_from_ep(new_asoc, GFP_ATOMIC) < 0)
1505 repl = sctp_make_init_ack(new_asoc, chunk, GFP_ATOMIC, len);
1509 /* If there are errors need to be reported for unknown parameters,
1510 * include them in the outgoing INIT ACK as "Unrecognized parameter"
1514 /* Get the "Unrecognized parameter" parameter(s) out of the
1515 * ERROR chunk generated by sctp_verify_init(). Since the
1516 * error cause code for "unknown parameter" and the
1517 * "Unrecognized parameter" type is the same, we can
1518 * construct the parameters in INIT ACK by copying the
1519 * ERROR causes over.
1521 unk_param = (sctp_unrecognized_param_t *)
1522 ((__u8 *)(err_chunk->chunk_hdr) +
1523 sizeof(sctp_chunkhdr_t));
1524 /* Replace the cause code with the "Unrecognized parameter"
1527 sctp_addto_chunk(repl, len, unk_param);
1530 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_ASOC, SCTP_ASOC(new_asoc));
1531 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(repl));
1534 * Note: After sending out INIT ACK with the State Cookie parameter,
1535 * "Z" MUST NOT allocate any resources for this new association.
1536 * Otherwise, "Z" will be vulnerable to resource attacks.
1538 sctp_add_cmd_sf(commands, SCTP_CMD_DELETE_TCB, SCTP_NULL());
1539 retval = SCTP_DISPOSITION_CONSUME;
1544 retval = SCTP_DISPOSITION_NOMEM;
1547 sctp_association_free(new_asoc);
1550 sctp_chunk_free(err_chunk);
1555 * Handle simultanous INIT.
1556 * This means we started an INIT and then we got an INIT request from
1559 * Section: 5.2.1 INIT received in COOKIE-WAIT or COOKIE-ECHOED State (Item B)
1560 * This usually indicates an initialization collision, i.e., each
1561 * endpoint is attempting, at about the same time, to establish an
1562 * association with the other endpoint.
1564 * Upon receipt of an INIT in the COOKIE-WAIT or COOKIE-ECHOED state, an
1565 * endpoint MUST respond with an INIT ACK using the same parameters it
1566 * sent in its original INIT chunk (including its Verification Tag,
1567 * unchanged). These original parameters are combined with those from the
1568 * newly received INIT chunk. The endpoint shall also generate a State
1569 * Cookie with the INIT ACK. The endpoint uses the parameters sent in its
1570 * INIT to calculate the State Cookie.
1572 * After that, the endpoint MUST NOT change its state, the T1-init
1573 * timer shall be left running and the corresponding TCB MUST NOT be
1574 * destroyed. The normal procedures for handling State Cookies when
1575 * a TCB exists will resolve the duplicate INITs to a single association.
1577 * For an endpoint that is in the COOKIE-ECHOED state it MUST populate
1578 * its Tie-Tags with the Tag information of itself and its peer (see
1579 * section 5.2.2 for a description of the Tie-Tags).
1581 * Verification Tag: Not explicit, but an INIT can not have a valid
1582 * verification tag, so we skip the check.
1585 * (endpoint, asoc, chunk)
1588 * (asoc, reply_msg, msg_up, timers, counters)
1590 * The return value is the disposition of the chunk.
1592 sctp_disposition_t sctp_sf_do_5_2_1_siminit(const struct sctp_endpoint *ep,
1593 const struct sctp_association *asoc,
1594 const sctp_subtype_t type,
1596 sctp_cmd_seq_t *commands)
1598 /* Call helper to do the real work for both simulataneous and
1599 * duplicate INIT chunk handling.
1601 return sctp_sf_do_unexpected_init(ep, asoc, type, arg, commands);
1605 * Handle duplicated INIT messages. These are usually delayed
1608 * Section: 5.2.2 Unexpected INIT in States Other than CLOSED,
1609 * COOKIE-ECHOED and COOKIE-WAIT
1611 * Unless otherwise stated, upon reception of an unexpected INIT for
1612 * this association, the endpoint shall generate an INIT ACK with a
1613 * State Cookie. In the outbound INIT ACK the endpoint MUST copy its
1614 * current Verification Tag and peer's Verification Tag into a reserved
1615 * place within the state cookie. We shall refer to these locations as
1616 * the Peer's-Tie-Tag and the Local-Tie-Tag. The outbound SCTP packet
1617 * containing this INIT ACK MUST carry a Verification Tag value equal to
1618 * the Initiation Tag found in the unexpected INIT. And the INIT ACK
1619 * MUST contain a new Initiation Tag (randomly generated see Section
1620 * 5.3.1). Other parameters for the endpoint SHOULD be copied from the
1621 * existing parameters of the association (e.g. number of outbound
1622 * streams) into the INIT ACK and cookie.
1624 * After sending out the INIT ACK, the endpoint shall take no further
1625 * actions, i.e., the existing association, including its current state,
1626 * and the corresponding TCB MUST NOT be changed.
1628 * Note: Only when a TCB exists and the association is not in a COOKIE-
1629 * WAIT state are the Tie-Tags populated. For a normal association INIT
1630 * (i.e. the endpoint is in a COOKIE-WAIT state), the Tie-Tags MUST be
1631 * set to 0 (indicating that no previous TCB existed). The INIT ACK and
1632 * State Cookie are populated as specified in section 5.2.1.
1634 * Verification Tag: Not specified, but an INIT has no way of knowing
1635 * what the verification tag could be, so we ignore it.
1638 * (endpoint, asoc, chunk)
1641 * (asoc, reply_msg, msg_up, timers, counters)
1643 * The return value is the disposition of the chunk.
1645 sctp_disposition_t sctp_sf_do_5_2_2_dupinit(const struct sctp_endpoint *ep,
1646 const struct sctp_association *asoc,
1647 const sctp_subtype_t type,
1649 sctp_cmd_seq_t *commands)
1651 /* Call helper to do the real work for both simulataneous and
1652 * duplicate INIT chunk handling.
1654 return sctp_sf_do_unexpected_init(ep, asoc, type, arg, commands);
1659 * Unexpected INIT-ACK handler.
1662 * If an INIT ACK received by an endpoint in any state other than the
1663 * COOKIE-WAIT state, the endpoint should discard the INIT ACK chunk.
1664 * An unexpected INIT ACK usually indicates the processing of an old or
1665 * duplicated INIT chunk.
1667 sctp_disposition_t sctp_sf_do_5_2_3_initack(const struct sctp_endpoint *ep,
1668 const struct sctp_association *asoc,
1669 const sctp_subtype_t type,
1670 void *arg, sctp_cmd_seq_t *commands)
1672 /* Per the above section, we'll discard the chunk if we have an
1673 * endpoint. If this is an OOTB INIT-ACK, treat it as such.
1675 if (ep == sctp_sk((sctp_get_ctl_sock()))->ep)
1676 return sctp_sf_ootb(ep, asoc, type, arg, commands);
1678 return sctp_sf_discard_chunk(ep, asoc, type, arg, commands);
1681 /* Unexpected COOKIE-ECHO handler for peer restart (Table 2, action 'A')
1684 * A) In this case, the peer may have restarted.
1686 static sctp_disposition_t sctp_sf_do_dupcook_a(const struct sctp_endpoint *ep,
1687 const struct sctp_association *asoc,
1688 struct sctp_chunk *chunk,
1689 sctp_cmd_seq_t *commands,
1690 struct sctp_association *new_asoc)
1692 sctp_init_chunk_t *peer_init;
1693 struct sctp_ulpevent *ev;
1694 struct sctp_chunk *repl;
1695 struct sctp_chunk *err;
1696 sctp_disposition_t disposition;
1698 /* new_asoc is a brand-new association, so these are not yet
1699 * side effects--it is safe to run them here.
1701 peer_init = &chunk->subh.cookie_hdr->c.peer_init[0];
1703 if (!sctp_process_init(new_asoc, chunk->chunk_hdr->type,
1704 sctp_source(chunk), peer_init,
1708 /* Make sure no new addresses are being added during the
1709 * restart. Though this is a pretty complicated attack
1710 * since you'd have to get inside the cookie.
1712 if (!sctp_sf_check_restart_addrs(new_asoc, asoc, chunk, commands)) {
1713 return SCTP_DISPOSITION_CONSUME;
1716 /* If the endpoint is in the SHUTDOWN-ACK-SENT state and recognizes
1717 * the peer has restarted (Action A), it MUST NOT setup a new
1718 * association but instead resend the SHUTDOWN ACK and send an ERROR
1719 * chunk with a "Cookie Received while Shutting Down" error cause to
1722 if (sctp_state(asoc, SHUTDOWN_ACK_SENT)) {
1723 disposition = sctp_sf_do_9_2_reshutack(ep, asoc,
1724 SCTP_ST_CHUNK(chunk->chunk_hdr->type),
1726 if (SCTP_DISPOSITION_NOMEM == disposition)
1729 err = sctp_make_op_error(asoc, chunk,
1730 SCTP_ERROR_COOKIE_IN_SHUTDOWN,
1733 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
1736 return SCTP_DISPOSITION_CONSUME;
1739 /* For now, fail any unsent/unacked data. Consider the optional
1740 * choice of resending of this data.
1742 sctp_add_cmd_sf(commands, SCTP_CMD_PURGE_OUTQUEUE, SCTP_NULL());
1744 repl = sctp_make_cookie_ack(new_asoc, chunk);
1748 /* Report association restart to upper layer. */
1749 ev = sctp_ulpevent_make_assoc_change(asoc, 0, SCTP_RESTART, 0,
1750 new_asoc->c.sinit_num_ostreams,
1751 new_asoc->c.sinit_max_instreams,
1756 /* Update the content of current association. */
1757 sctp_add_cmd_sf(commands, SCTP_CMD_UPDATE_ASSOC, SCTP_ASOC(new_asoc));
1758 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(repl));
1759 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP, SCTP_ULPEVENT(ev));
1760 return SCTP_DISPOSITION_CONSUME;
1763 sctp_chunk_free(repl);
1765 return SCTP_DISPOSITION_NOMEM;
1768 /* Unexpected COOKIE-ECHO handler for setup collision (Table 2, action 'B')
1771 * B) In this case, both sides may be attempting to start an association
1772 * at about the same time but the peer endpoint started its INIT
1773 * after responding to the local endpoint's INIT
1775 /* This case represents an initialization collision. */
1776 static sctp_disposition_t sctp_sf_do_dupcook_b(const struct sctp_endpoint *ep,
1777 const struct sctp_association *asoc,
1778 struct sctp_chunk *chunk,
1779 sctp_cmd_seq_t *commands,
1780 struct sctp_association *new_asoc)
1782 sctp_init_chunk_t *peer_init;
1783 struct sctp_chunk *repl;
1785 /* new_asoc is a brand-new association, so these are not yet
1786 * side effects--it is safe to run them here.
1788 peer_init = &chunk->subh.cookie_hdr->c.peer_init[0];
1789 if (!sctp_process_init(new_asoc, chunk->chunk_hdr->type,
1790 sctp_source(chunk), peer_init,
1794 /* Update the content of current association. */
1795 sctp_add_cmd_sf(commands, SCTP_CMD_UPDATE_ASSOC, SCTP_ASOC(new_asoc));
1796 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
1797 SCTP_STATE(SCTP_STATE_ESTABLISHED));
1798 SCTP_INC_STATS(SCTP_MIB_CURRESTAB);
1799 sctp_add_cmd_sf(commands, SCTP_CMD_HB_TIMERS_START, SCTP_NULL());
1801 repl = sctp_make_cookie_ack(new_asoc, chunk);
1805 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(repl));
1806 sctp_add_cmd_sf(commands, SCTP_CMD_TRANSMIT, SCTP_NULL());
1808 /* RFC 2960 5.1 Normal Establishment of an Association
1810 * D) IMPLEMENTATION NOTE: An implementation may choose to
1811 * send the Communication Up notification to the SCTP user
1812 * upon reception of a valid COOKIE ECHO chunk.
1814 * Sadly, this needs to be implemented as a side-effect, because
1815 * we are not guaranteed to have set the association id of the real
1816 * association and so these notifications need to be delayed until
1817 * the association id is allocated.
1820 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_CHANGE, SCTP_U8(SCTP_COMM_UP));
1822 /* Sockets API Draft Section 5.3.1.6
1823 * When a peer sends a Adaptation Layer Indication parameter , SCTP
1824 * delivers this notification to inform the application that of the
1825 * peers requested adaptation layer.
1827 * This also needs to be done as a side effect for the same reason as
1830 if (asoc->peer.adaptation_ind)
1831 sctp_add_cmd_sf(commands, SCTP_CMD_ADAPTATION_IND, SCTP_NULL());
1833 return SCTP_DISPOSITION_CONSUME;
1836 return SCTP_DISPOSITION_NOMEM;
1839 /* Unexpected COOKIE-ECHO handler for setup collision (Table 2, action 'C')
1842 * C) In this case, the local endpoint's cookie has arrived late.
1843 * Before it arrived, the local endpoint sent an INIT and received an
1844 * INIT-ACK and finally sent a COOKIE ECHO with the peer's same tag
1845 * but a new tag of its own.
1847 /* This case represents an initialization collision. */
1848 static sctp_disposition_t sctp_sf_do_dupcook_c(const struct sctp_endpoint *ep,
1849 const struct sctp_association *asoc,
1850 struct sctp_chunk *chunk,
1851 sctp_cmd_seq_t *commands,
1852 struct sctp_association *new_asoc)
1854 /* The cookie should be silently discarded.
1855 * The endpoint SHOULD NOT change states and should leave
1856 * any timers running.
1858 return SCTP_DISPOSITION_DISCARD;
1861 /* Unexpected COOKIE-ECHO handler lost chunk (Table 2, action 'D')
1865 * D) When both local and remote tags match the endpoint should always
1866 * enter the ESTABLISHED state, if it has not already done so.
1868 /* This case represents an initialization collision. */
1869 static sctp_disposition_t sctp_sf_do_dupcook_d(const struct sctp_endpoint *ep,
1870 const struct sctp_association *asoc,
1871 struct sctp_chunk *chunk,
1872 sctp_cmd_seq_t *commands,
1873 struct sctp_association *new_asoc)
1875 struct sctp_ulpevent *ev = NULL, *ai_ev = NULL;
1876 struct sctp_chunk *repl;
1878 /* Clarification from Implementor's Guide:
1879 * D) When both local and remote tags match the endpoint should
1880 * enter the ESTABLISHED state, if it is in the COOKIE-ECHOED state.
1881 * It should stop any cookie timer that may be running and send
1885 /* Don't accidentally move back into established state. */
1886 if (asoc->state < SCTP_STATE_ESTABLISHED) {
1887 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
1888 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_COOKIE));
1889 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
1890 SCTP_STATE(SCTP_STATE_ESTABLISHED));
1891 SCTP_INC_STATS(SCTP_MIB_CURRESTAB);
1892 sctp_add_cmd_sf(commands, SCTP_CMD_HB_TIMERS_START,
1895 /* RFC 2960 5.1 Normal Establishment of an Association
1897 * D) IMPLEMENTATION NOTE: An implementation may choose
1898 * to send the Communication Up notification to the
1899 * SCTP user upon reception of a valid COOKIE
1902 ev = sctp_ulpevent_make_assoc_change(asoc, 0,
1904 asoc->c.sinit_num_ostreams,
1905 asoc->c.sinit_max_instreams,
1910 /* Sockets API Draft Section 5.3.1.6
1911 * When a peer sends a Adaptation Layer Indication parameter,
1912 * SCTP delivers this notification to inform the application
1913 * that of the peers requested adaptation layer.
1915 if (asoc->peer.adaptation_ind) {
1916 ai_ev = sctp_ulpevent_make_adaptation_indication(asoc,
1923 sctp_add_cmd_sf(commands, SCTP_CMD_TRANSMIT, SCTP_NULL());
1925 repl = sctp_make_cookie_ack(new_asoc, chunk);
1930 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP,
1933 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP,
1934 SCTP_ULPEVENT(ai_ev));
1936 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(repl));
1937 sctp_add_cmd_sf(commands, SCTP_CMD_TRANSMIT, SCTP_NULL());
1939 return SCTP_DISPOSITION_CONSUME;
1943 sctp_ulpevent_free(ai_ev);
1945 sctp_ulpevent_free(ev);
1946 return SCTP_DISPOSITION_NOMEM;
1950 * Handle a duplicate COOKIE-ECHO. This usually means a cookie-carrying
1951 * chunk was retransmitted and then delayed in the network.
1953 * Section: 5.2.4 Handle a COOKIE ECHO when a TCB exists
1955 * Verification Tag: None. Do cookie validation.
1958 * (endpoint, asoc, chunk)
1961 * (asoc, reply_msg, msg_up, timers, counters)
1963 * The return value is the disposition of the chunk.
1965 sctp_disposition_t sctp_sf_do_5_2_4_dupcook(const struct sctp_endpoint *ep,
1966 const struct sctp_association *asoc,
1967 const sctp_subtype_t type,
1969 sctp_cmd_seq_t *commands)
1971 sctp_disposition_t retval;
1972 struct sctp_chunk *chunk = arg;
1973 struct sctp_association *new_asoc;
1976 struct sctp_chunk *err_chk_p;
1978 /* Make sure that the chunk has a valid length from the protocol
1979 * perspective. In this case check to make sure we have at least
1980 * enough for the chunk header. Cookie length verification is
1983 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_chunkhdr_t)))
1984 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
1987 /* "Decode" the chunk. We have no optional parameters so we
1988 * are in good shape.
1990 chunk->subh.cookie_hdr = (struct sctp_signed_cookie *)chunk->skb->data;
1991 if (!pskb_pull(chunk->skb, ntohs(chunk->chunk_hdr->length) -
1992 sizeof(sctp_chunkhdr_t)))
1995 /* In RFC 2960 5.2.4 3, if both Verification Tags in the State Cookie
1996 * of a duplicate COOKIE ECHO match the Verification Tags of the
1997 * current association, consider the State Cookie valid even if
1998 * the lifespan is exceeded.
2000 new_asoc = sctp_unpack_cookie(ep, asoc, chunk, GFP_ATOMIC, &error,
2004 * If the re-build failed, what is the proper error path
2007 * [We should abort the association. --piggy]
2010 /* FIXME: Several errors are possible. A bad cookie should
2011 * be silently discarded, but think about logging it too.
2014 case -SCTP_IERROR_NOMEM:
2017 case -SCTP_IERROR_STALE_COOKIE:
2018 sctp_send_stale_cookie_err(ep, asoc, chunk, commands,
2020 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2021 case -SCTP_IERROR_BAD_SIG:
2023 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2027 /* Compare the tie_tag in cookie with the verification tag of
2028 * current association.
2030 action = sctp_tietags_compare(new_asoc, asoc);
2033 case 'A': /* Association restart. */
2034 retval = sctp_sf_do_dupcook_a(ep, asoc, chunk, commands,
2038 case 'B': /* Collision case B. */
2039 retval = sctp_sf_do_dupcook_b(ep, asoc, chunk, commands,
2043 case 'C': /* Collision case C. */
2044 retval = sctp_sf_do_dupcook_c(ep, asoc, chunk, commands,
2048 case 'D': /* Collision case D. */
2049 retval = sctp_sf_do_dupcook_d(ep, asoc, chunk, commands,
2053 default: /* Discard packet for all others. */
2054 retval = sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2058 /* Delete the tempory new association. */
2059 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_ASOC, SCTP_ASOC(new_asoc));
2060 sctp_add_cmd_sf(commands, SCTP_CMD_DELETE_TCB, SCTP_NULL());
2065 return SCTP_DISPOSITION_NOMEM;
2069 * Process an ABORT. (SHUTDOWN-PENDING state)
2071 * See sctp_sf_do_9_1_abort().
2073 sctp_disposition_t sctp_sf_shutdown_pending_abort(
2074 const struct sctp_endpoint *ep,
2075 const struct sctp_association *asoc,
2076 const sctp_subtype_t type,
2078 sctp_cmd_seq_t *commands)
2080 struct sctp_chunk *chunk = arg;
2082 if (!sctp_vtag_verify_either(chunk, asoc))
2083 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2085 /* Make sure that the ABORT chunk has a valid length.
2086 * Since this is an ABORT chunk, we have to discard it
2087 * because of the following text:
2088 * RFC 2960, Section 3.3.7
2089 * If an endpoint receives an ABORT with a format error or for an
2090 * association that doesn't exist, it MUST silently discard it.
2091 * Becasue the length is "invalid", we can't really discard just
2092 * as we do not know its true length. So, to be safe, discard the
2095 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_abort_chunk_t)))
2096 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2098 /* Stop the T5-shutdown guard timer. */
2099 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
2100 SCTP_TO(SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD));
2102 return sctp_sf_do_9_1_abort(ep, asoc, type, arg, commands);
2106 * Process an ABORT. (SHUTDOWN-SENT state)
2108 * See sctp_sf_do_9_1_abort().
2110 sctp_disposition_t sctp_sf_shutdown_sent_abort(const struct sctp_endpoint *ep,
2111 const struct sctp_association *asoc,
2112 const sctp_subtype_t type,
2114 sctp_cmd_seq_t *commands)
2116 struct sctp_chunk *chunk = arg;
2118 if (!sctp_vtag_verify_either(chunk, asoc))
2119 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2121 /* Make sure that the ABORT chunk has a valid length.
2122 * Since this is an ABORT chunk, we have to discard it
2123 * because of the following text:
2124 * RFC 2960, Section 3.3.7
2125 * If an endpoint receives an ABORT with a format error or for an
2126 * association that doesn't exist, it MUST silently discard it.
2127 * Becasue the length is "invalid", we can't really discard just
2128 * as we do not know its true length. So, to be safe, discard the
2131 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_abort_chunk_t)))
2132 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2134 /* Stop the T2-shutdown timer. */
2135 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
2136 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
2138 /* Stop the T5-shutdown guard timer. */
2139 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
2140 SCTP_TO(SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD));
2142 return sctp_sf_do_9_1_abort(ep, asoc, type, arg, commands);
2146 * Process an ABORT. (SHUTDOWN-ACK-SENT state)
2148 * See sctp_sf_do_9_1_abort().
2150 sctp_disposition_t sctp_sf_shutdown_ack_sent_abort(
2151 const struct sctp_endpoint *ep,
2152 const struct sctp_association *asoc,
2153 const sctp_subtype_t type,
2155 sctp_cmd_seq_t *commands)
2157 /* The same T2 timer, so we should be able to use
2158 * common function with the SHUTDOWN-SENT state.
2160 return sctp_sf_shutdown_sent_abort(ep, asoc, type, arg, commands);
2164 * Handle an Error received in COOKIE_ECHOED state.
2166 * Only handle the error type of stale COOKIE Error, the other errors will
2170 * (endpoint, asoc, chunk)
2173 * (asoc, reply_msg, msg_up, timers, counters)
2175 * The return value is the disposition of the chunk.
2177 sctp_disposition_t sctp_sf_cookie_echoed_err(const struct sctp_endpoint *ep,
2178 const struct sctp_association *asoc,
2179 const sctp_subtype_t type,
2181 sctp_cmd_seq_t *commands)
2183 struct sctp_chunk *chunk = arg;
2186 if (!sctp_vtag_verify(chunk, asoc))
2187 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2189 /* Make sure that the ERROR chunk has a valid length.
2190 * The parameter walking depends on this as well.
2192 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_operr_chunk_t)))
2193 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
2196 /* Process the error here */
2197 /* FUTURE FIXME: When PR-SCTP related and other optional
2198 * parms are emitted, this will have to change to handle multiple
2201 sctp_walk_errors(err, chunk->chunk_hdr) {
2202 if (SCTP_ERROR_STALE_COOKIE == err->cause)
2203 return sctp_sf_do_5_2_6_stale(ep, asoc, type,
2207 /* It is possible to have malformed error causes, and that
2208 * will cause us to end the walk early. However, since
2209 * we are discarding the packet, there should be no adverse
2212 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2216 * Handle a Stale COOKIE Error
2218 * Section: 5.2.6 Handle Stale COOKIE Error
2219 * If the association is in the COOKIE-ECHOED state, the endpoint may elect
2220 * one of the following three alternatives.
2222 * 3) Send a new INIT chunk to the endpoint, adding a Cookie
2223 * Preservative parameter requesting an extension to the lifetime of
2224 * the State Cookie. When calculating the time extension, an
2225 * implementation SHOULD use the RTT information measured based on the
2226 * previous COOKIE ECHO / ERROR exchange, and should add no more
2227 * than 1 second beyond the measured RTT, due to long State Cookie
2228 * lifetimes making the endpoint more subject to a replay attack.
2230 * Verification Tag: Not explicit, but safe to ignore.
2233 * (endpoint, asoc, chunk)
2236 * (asoc, reply_msg, msg_up, timers, counters)
2238 * The return value is the disposition of the chunk.
2240 static sctp_disposition_t sctp_sf_do_5_2_6_stale(const struct sctp_endpoint *ep,
2241 const struct sctp_association *asoc,
2242 const sctp_subtype_t type,
2244 sctp_cmd_seq_t *commands)
2246 struct sctp_chunk *chunk = arg;
2248 sctp_cookie_preserve_param_t bht;
2250 struct sctp_chunk *reply;
2251 struct sctp_bind_addr *bp;
2252 int attempts = asoc->init_err_counter + 1;
2254 if (attempts > asoc->max_init_attempts) {
2255 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
2256 SCTP_ERROR(ETIMEDOUT));
2257 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_FAILED,
2258 SCTP_PERR(SCTP_ERROR_STALE_COOKIE));
2259 return SCTP_DISPOSITION_DELETE_TCB;
2262 err = (sctp_errhdr_t *)(chunk->skb->data);
2264 /* When calculating the time extension, an implementation
2265 * SHOULD use the RTT information measured based on the
2266 * previous COOKIE ECHO / ERROR exchange, and should add no
2267 * more than 1 second beyond the measured RTT, due to long
2268 * State Cookie lifetimes making the endpoint more subject to
2270 * Measure of Staleness's unit is usec. (1/1000000 sec)
2271 * Suggested Cookie Life-span Increment's unit is msec.
2273 * In general, if you use the suggested cookie life, the value
2274 * found in the field of measure of staleness should be doubled
2275 * to give ample time to retransmit the new cookie and thus
2276 * yield a higher probability of success on the reattempt.
2278 stale = ntohl(*(__be32 *)((u8 *)err + sizeof(sctp_errhdr_t)));
2279 stale = (stale * 2) / 1000;
2281 bht.param_hdr.type = SCTP_PARAM_COOKIE_PRESERVATIVE;
2282 bht.param_hdr.length = htons(sizeof(bht));
2283 bht.lifespan_increment = htonl(stale);
2285 /* Build that new INIT chunk. */
2286 bp = (struct sctp_bind_addr *) &asoc->base.bind_addr;
2287 reply = sctp_make_init(asoc, bp, GFP_ATOMIC, sizeof(bht));
2291 sctp_addto_chunk(reply, sizeof(bht), &bht);
2293 /* Clear peer's init_tag cached in assoc as we are sending a new INIT */
2294 sctp_add_cmd_sf(commands, SCTP_CMD_CLEAR_INIT_TAG, SCTP_NULL());
2296 /* Stop pending T3-rtx and heartbeat timers */
2297 sctp_add_cmd_sf(commands, SCTP_CMD_T3_RTX_TIMERS_STOP, SCTP_NULL());
2298 sctp_add_cmd_sf(commands, SCTP_CMD_HB_TIMERS_STOP, SCTP_NULL());
2300 /* Delete non-primary peer ip addresses since we are transitioning
2301 * back to the COOKIE-WAIT state
2303 sctp_add_cmd_sf(commands, SCTP_CMD_DEL_NON_PRIMARY, SCTP_NULL());
2305 /* If we've sent any data bundled with COOKIE-ECHO we will need to
2308 sctp_add_cmd_sf(commands, SCTP_CMD_RETRAN,
2309 SCTP_TRANSPORT(asoc->peer.primary_path));
2311 /* Cast away the const modifier, as we want to just
2312 * rerun it through as a sideffect.
2314 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_COUNTER_INC, SCTP_NULL());
2316 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
2317 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_COOKIE));
2318 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
2319 SCTP_STATE(SCTP_STATE_COOKIE_WAIT));
2320 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_START,
2321 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_INIT));
2323 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(reply));
2325 return SCTP_DISPOSITION_CONSUME;
2328 return SCTP_DISPOSITION_NOMEM;
2335 * After checking the Verification Tag, the receiving endpoint shall
2336 * remove the association from its record, and shall report the
2337 * termination to its upper layer.
2339 * Verification Tag: 8.5.1 Exceptions in Verification Tag Rules
2340 * B) Rules for packet carrying ABORT:
2342 * - The endpoint shall always fill in the Verification Tag field of the
2343 * outbound packet with the destination endpoint's tag value if it
2346 * - If the ABORT is sent in response to an OOTB packet, the endpoint
2347 * MUST follow the procedure described in Section 8.4.
2349 * - The receiver MUST accept the packet if the Verification Tag
2350 * matches either its own tag, OR the tag of its peer. Otherwise, the
2351 * receiver MUST silently discard the packet and take no further
2355 * (endpoint, asoc, chunk)
2358 * (asoc, reply_msg, msg_up, timers, counters)
2360 * The return value is the disposition of the chunk.
2362 sctp_disposition_t sctp_sf_do_9_1_abort(const struct sctp_endpoint *ep,
2363 const struct sctp_association *asoc,
2364 const sctp_subtype_t type,
2366 sctp_cmd_seq_t *commands)
2368 struct sctp_chunk *chunk = arg;
2370 __be16 error = SCTP_ERROR_NO_ERROR;
2372 if (!sctp_vtag_verify_either(chunk, asoc))
2373 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2375 /* Make sure that the ABORT chunk has a valid length.
2376 * Since this is an ABORT chunk, we have to discard it
2377 * because of the following text:
2378 * RFC 2960, Section 3.3.7
2379 * If an endpoint receives an ABORT with a format error or for an
2380 * association that doesn't exist, it MUST silently discard it.
2381 * Becasue the length is "invalid", we can't really discard just
2382 * as we do not know its true length. So, to be safe, discard the
2385 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_abort_chunk_t)))
2386 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2388 /* See if we have an error cause code in the chunk. */
2389 len = ntohs(chunk->chunk_hdr->length);
2390 if (len >= sizeof(struct sctp_chunkhdr) + sizeof(struct sctp_errhdr))
2391 error = ((sctp_errhdr_t *)chunk->skb->data)->cause;
2393 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR, SCTP_ERROR(ECONNRESET));
2394 /* ASSOC_FAILED will DELETE_TCB. */
2395 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED, SCTP_PERR(error));
2396 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
2397 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
2399 return SCTP_DISPOSITION_ABORT;
2403 * Process an ABORT. (COOKIE-WAIT state)
2405 * See sctp_sf_do_9_1_abort() above.
2407 sctp_disposition_t sctp_sf_cookie_wait_abort(const struct sctp_endpoint *ep,
2408 const struct sctp_association *asoc,
2409 const sctp_subtype_t type,
2411 sctp_cmd_seq_t *commands)
2413 struct sctp_chunk *chunk = arg;
2415 __be16 error = SCTP_ERROR_NO_ERROR;
2417 if (!sctp_vtag_verify_either(chunk, asoc))
2418 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2420 /* Make sure that the ABORT chunk has a valid length.
2421 * Since this is an ABORT chunk, we have to discard it
2422 * because of the following text:
2423 * RFC 2960, Section 3.3.7
2424 * If an endpoint receives an ABORT with a format error or for an
2425 * association that doesn't exist, it MUST silently discard it.
2426 * Becasue the length is "invalid", we can't really discard just
2427 * as we do not know its true length. So, to be safe, discard the
2430 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_abort_chunk_t)))
2431 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2433 /* See if we have an error cause code in the chunk. */
2434 len = ntohs(chunk->chunk_hdr->length);
2435 if (len >= sizeof(struct sctp_chunkhdr) + sizeof(struct sctp_errhdr))
2436 error = ((sctp_errhdr_t *)chunk->skb->data)->cause;
2438 return sctp_stop_t1_and_abort(commands, error, ECONNREFUSED, asoc,
2443 * Process an incoming ICMP as an ABORT. (COOKIE-WAIT state)
2445 sctp_disposition_t sctp_sf_cookie_wait_icmp_abort(const struct sctp_endpoint *ep,
2446 const struct sctp_association *asoc,
2447 const sctp_subtype_t type,
2449 sctp_cmd_seq_t *commands)
2451 return sctp_stop_t1_and_abort(commands, SCTP_ERROR_NO_ERROR,
2453 (struct sctp_transport *)arg);
2457 * Process an ABORT. (COOKIE-ECHOED state)
2459 sctp_disposition_t sctp_sf_cookie_echoed_abort(const struct sctp_endpoint *ep,
2460 const struct sctp_association *asoc,
2461 const sctp_subtype_t type,
2463 sctp_cmd_seq_t *commands)
2465 /* There is a single T1 timer, so we should be able to use
2466 * common function with the COOKIE-WAIT state.
2468 return sctp_sf_cookie_wait_abort(ep, asoc, type, arg, commands);
2472 * Stop T1 timer and abort association with "INIT failed".
2474 * This is common code called by several sctp_sf_*_abort() functions above.
2476 static sctp_disposition_t sctp_stop_t1_and_abort(sctp_cmd_seq_t *commands,
2477 __be16 error, int sk_err,
2478 const struct sctp_association *asoc,
2479 struct sctp_transport *transport)
2481 SCTP_DEBUG_PRINTK("ABORT received (INIT).\n");
2482 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
2483 SCTP_STATE(SCTP_STATE_CLOSED));
2484 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
2485 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
2486 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_INIT));
2487 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR, SCTP_ERROR(sk_err));
2488 /* CMD_INIT_FAILED will DELETE_TCB. */
2489 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_FAILED,
2491 return SCTP_DISPOSITION_ABORT;
2495 * sctp_sf_do_9_2_shut
2498 * Upon the reception of the SHUTDOWN, the peer endpoint shall
2499 * - enter the SHUTDOWN-RECEIVED state,
2501 * - stop accepting new data from its SCTP user
2503 * - verify, by checking the Cumulative TSN Ack field of the chunk,
2504 * that all its outstanding DATA chunks have been received by the
2507 * Once an endpoint as reached the SHUTDOWN-RECEIVED state it MUST NOT
2508 * send a SHUTDOWN in response to a ULP request. And should discard
2509 * subsequent SHUTDOWN chunks.
2511 * If there are still outstanding DATA chunks left, the SHUTDOWN
2512 * receiver shall continue to follow normal data transmission
2513 * procedures defined in Section 6 until all outstanding DATA chunks
2514 * are acknowledged; however, the SHUTDOWN receiver MUST NOT accept
2515 * new data from its SCTP user.
2517 * Verification Tag: 8.5 Verification Tag [Normal verification]
2520 * (endpoint, asoc, chunk)
2523 * (asoc, reply_msg, msg_up, timers, counters)
2525 * The return value is the disposition of the chunk.
2527 sctp_disposition_t sctp_sf_do_9_2_shutdown(const struct sctp_endpoint *ep,
2528 const struct sctp_association *asoc,
2529 const sctp_subtype_t type,
2531 sctp_cmd_seq_t *commands)
2533 struct sctp_chunk *chunk = arg;
2534 sctp_shutdownhdr_t *sdh;
2535 sctp_disposition_t disposition;
2536 struct sctp_ulpevent *ev;
2538 if (!sctp_vtag_verify(chunk, asoc))
2539 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2541 /* Make sure that the SHUTDOWN chunk has a valid length. */
2542 if (!sctp_chunk_length_valid(chunk,
2543 sizeof(struct sctp_shutdown_chunk_t)))
2544 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
2547 /* Convert the elaborate header. */
2548 sdh = (sctp_shutdownhdr_t *)chunk->skb->data;
2549 skb_pull(chunk->skb, sizeof(sctp_shutdownhdr_t));
2550 chunk->subh.shutdown_hdr = sdh;
2552 /* API 5.3.1.5 SCTP_SHUTDOWN_EVENT
2553 * When a peer sends a SHUTDOWN, SCTP delivers this notification to
2554 * inform the application that it should cease sending data.
2556 ev = sctp_ulpevent_make_shutdown_event(asoc, 0, GFP_ATOMIC);
2558 disposition = SCTP_DISPOSITION_NOMEM;
2561 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP, SCTP_ULPEVENT(ev));
2563 /* Upon the reception of the SHUTDOWN, the peer endpoint shall
2564 * - enter the SHUTDOWN-RECEIVED state,
2565 * - stop accepting new data from its SCTP user
2567 * [This is implicit in the new state.]
2569 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
2570 SCTP_STATE(SCTP_STATE_SHUTDOWN_RECEIVED));
2571 disposition = SCTP_DISPOSITION_CONSUME;
2573 if (sctp_outq_is_empty(&asoc->outqueue)) {
2574 disposition = sctp_sf_do_9_2_shutdown_ack(ep, asoc, type,
2578 if (SCTP_DISPOSITION_NOMEM == disposition)
2581 /* - verify, by checking the Cumulative TSN Ack field of the
2582 * chunk, that all its outstanding DATA chunks have been
2583 * received by the SHUTDOWN sender.
2585 sctp_add_cmd_sf(commands, SCTP_CMD_PROCESS_CTSN,
2586 SCTP_BE32(chunk->subh.shutdown_hdr->cum_tsn_ack));
2593 * If an endpoint is in SHUTDOWN-ACK-SENT state and receives an INIT chunk
2594 * (e.g., if the SHUTDOWN COMPLETE was lost) with source and destination
2595 * transport addresses (either in the IP addresses or in the INIT chunk)
2596 * that belong to this association, it should discard the INIT chunk and
2597 * retransmit the SHUTDOWN ACK chunk.
2599 sctp_disposition_t sctp_sf_do_9_2_reshutack(const struct sctp_endpoint *ep,
2600 const struct sctp_association *asoc,
2601 const sctp_subtype_t type,
2603 sctp_cmd_seq_t *commands)
2605 struct sctp_chunk *chunk = (struct sctp_chunk *) arg;
2606 struct sctp_chunk *reply;
2608 /* Make sure that the chunk has a valid length */
2609 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_chunkhdr_t)))
2610 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
2613 /* Since we are not going to really process this INIT, there
2614 * is no point in verifying chunk boundries. Just generate
2617 reply = sctp_make_shutdown_ack(asoc, chunk);
2621 /* Set the transport for the SHUTDOWN ACK chunk and the timeout for
2622 * the T2-SHUTDOWN timer.
2624 sctp_add_cmd_sf(commands, SCTP_CMD_SETUP_T2, SCTP_CHUNK(reply));
2626 /* and restart the T2-shutdown timer. */
2627 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
2628 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
2630 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(reply));
2632 return SCTP_DISPOSITION_CONSUME;
2634 return SCTP_DISPOSITION_NOMEM;
2638 * sctp_sf_do_ecn_cwr
2640 * Section: Appendix A: Explicit Congestion Notification
2644 * RFC 2481 details a specific bit for a sender to send in the header of
2645 * its next outbound TCP segment to indicate to its peer that it has
2646 * reduced its congestion window. This is termed the CWR bit. For
2647 * SCTP the same indication is made by including the CWR chunk.
2648 * This chunk contains one data element, i.e. the TSN number that
2649 * was sent in the ECNE chunk. This element represents the lowest
2650 * TSN number in the datagram that was originally marked with the
2653 * Verification Tag: 8.5 Verification Tag [Normal verification]
2655 * (endpoint, asoc, chunk)
2658 * (asoc, reply_msg, msg_up, timers, counters)
2660 * The return value is the disposition of the chunk.
2662 sctp_disposition_t sctp_sf_do_ecn_cwr(const struct sctp_endpoint *ep,
2663 const struct sctp_association *asoc,
2664 const sctp_subtype_t type,
2666 sctp_cmd_seq_t *commands)
2669 struct sctp_chunk *chunk = arg;
2672 if (!sctp_vtag_verify(chunk, asoc))
2673 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2675 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_ecne_chunk_t)))
2676 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
2679 cwr = (sctp_cwrhdr_t *) chunk->skb->data;
2680 skb_pull(chunk->skb, sizeof(sctp_cwrhdr_t));
2682 lowest_tsn = ntohl(cwr->lowest_tsn);
2684 /* Does this CWR ack the last sent congestion notification? */
2685 if (TSN_lte(asoc->last_ecne_tsn, lowest_tsn)) {
2686 /* Stop sending ECNE. */
2687 sctp_add_cmd_sf(commands,
2689 SCTP_U32(lowest_tsn));
2691 return SCTP_DISPOSITION_CONSUME;
2697 * Section: Appendix A: Explicit Congestion Notification
2701 * RFC 2481 details a specific bit for a receiver to send back in its
2702 * TCP acknowledgements to notify the sender of the Congestion
2703 * Experienced (CE) bit having arrived from the network. For SCTP this
2704 * same indication is made by including the ECNE chunk. This chunk
2705 * contains one data element, i.e. the lowest TSN associated with the IP
2706 * datagram marked with the CE bit.....
2708 * Verification Tag: 8.5 Verification Tag [Normal verification]
2710 * (endpoint, asoc, chunk)
2713 * (asoc, reply_msg, msg_up, timers, counters)
2715 * The return value is the disposition of the chunk.
2717 sctp_disposition_t sctp_sf_do_ecne(const struct sctp_endpoint *ep,
2718 const struct sctp_association *asoc,
2719 const sctp_subtype_t type,
2721 sctp_cmd_seq_t *commands)
2723 sctp_ecnehdr_t *ecne;
2724 struct sctp_chunk *chunk = arg;
2726 if (!sctp_vtag_verify(chunk, asoc))
2727 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2729 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_ecne_chunk_t)))
2730 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
2733 ecne = (sctp_ecnehdr_t *) chunk->skb->data;
2734 skb_pull(chunk->skb, sizeof(sctp_ecnehdr_t));
2736 /* If this is a newer ECNE than the last CWR packet we sent out */
2737 sctp_add_cmd_sf(commands, SCTP_CMD_ECN_ECNE,
2738 SCTP_U32(ntohl(ecne->lowest_tsn)));
2740 return SCTP_DISPOSITION_CONSUME;
2744 * Section: 6.2 Acknowledgement on Reception of DATA Chunks
2746 * The SCTP endpoint MUST always acknowledge the reception of each valid
2749 * The guidelines on delayed acknowledgement algorithm specified in
2750 * Section 4.2 of [RFC2581] SHOULD be followed. Specifically, an
2751 * acknowledgement SHOULD be generated for at least every second packet
2752 * (not every second DATA chunk) received, and SHOULD be generated within
2753 * 200 ms of the arrival of any unacknowledged DATA chunk. In some
2754 * situations it may be beneficial for an SCTP transmitter to be more
2755 * conservative than the algorithms detailed in this document allow.
2756 * However, an SCTP transmitter MUST NOT be more aggressive than the
2757 * following algorithms allow.
2759 * A SCTP receiver MUST NOT generate more than one SACK for every
2760 * incoming packet, other than to update the offered window as the
2761 * receiving application consumes new data.
2763 * Verification Tag: 8.5 Verification Tag [Normal verification]
2766 * (endpoint, asoc, chunk)
2769 * (asoc, reply_msg, msg_up, timers, counters)
2771 * The return value is the disposition of the chunk.
2773 sctp_disposition_t sctp_sf_eat_data_6_2(const struct sctp_endpoint *ep,
2774 const struct sctp_association *asoc,
2775 const sctp_subtype_t type,
2777 sctp_cmd_seq_t *commands)
2779 struct sctp_chunk *chunk = arg;
2782 if (!sctp_vtag_verify(chunk, asoc)) {
2783 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_BAD_TAG,
2785 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2788 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_data_chunk_t)))
2789 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
2792 error = sctp_eat_data(asoc, chunk, commands );
2794 case SCTP_IERROR_NO_ERROR:
2796 case SCTP_IERROR_HIGH_TSN:
2797 case SCTP_IERROR_BAD_STREAM:
2798 SCTP_INC_STATS(SCTP_MIB_IN_DATA_CHUNK_DISCARDS);
2799 goto discard_noforce;
2800 case SCTP_IERROR_DUP_TSN:
2801 case SCTP_IERROR_IGNORE_TSN:
2802 SCTP_INC_STATS(SCTP_MIB_IN_DATA_CHUNK_DISCARDS);
2804 case SCTP_IERROR_NO_DATA:
2810 if (asoc->autoclose) {
2811 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
2812 SCTP_TO(SCTP_EVENT_TIMEOUT_AUTOCLOSE));
2815 /* If this is the last chunk in a packet, we need to count it
2816 * toward sack generation. Note that we need to SACK every
2817 * OTHER packet containing data chunks, EVEN IF WE DISCARD
2818 * THEM. We elect to NOT generate SACK's if the chunk fails
2819 * the verification tag test.
2821 * RFC 2960 6.2 Acknowledgement on Reception of DATA Chunks
2823 * The SCTP endpoint MUST always acknowledge the reception of
2824 * each valid DATA chunk.
2826 * The guidelines on delayed acknowledgement algorithm
2827 * specified in Section 4.2 of [RFC2581] SHOULD be followed.
2828 * Specifically, an acknowledgement SHOULD be generated for at
2829 * least every second packet (not every second DATA chunk)
2830 * received, and SHOULD be generated within 200 ms of the
2831 * arrival of any unacknowledged DATA chunk. In some
2832 * situations it may be beneficial for an SCTP transmitter to
2833 * be more conservative than the algorithms detailed in this
2834 * document allow. However, an SCTP transmitter MUST NOT be
2835 * more aggressive than the following algorithms allow.
2837 if (chunk->end_of_packet)
2838 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_SACK, SCTP_NOFORCE());
2840 return SCTP_DISPOSITION_CONSUME;
2843 /* RFC 2960 6.2 Acknowledgement on Reception of DATA Chunks
2845 * When a packet arrives with duplicate DATA chunk(s) and with
2846 * no new DATA chunk(s), the endpoint MUST immediately send a
2847 * SACK with no delay. If a packet arrives with duplicate
2848 * DATA chunk(s) bundled with new DATA chunks, the endpoint
2849 * MAY immediately send a SACK. Normally receipt of duplicate
2850 * DATA chunks will occur when the original SACK chunk was lost
2851 * and the peer's RTO has expired. The duplicate TSN number(s)
2852 * SHOULD be reported in the SACK as duplicate.
2854 /* In our case, we split the MAY SACK advice up whether or not
2855 * the last chunk is a duplicate.'
2857 if (chunk->end_of_packet)
2858 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_SACK, SCTP_FORCE());
2859 return SCTP_DISPOSITION_DISCARD;
2862 if (chunk->end_of_packet)
2863 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_SACK, SCTP_NOFORCE());
2865 return SCTP_DISPOSITION_DISCARD;
2867 return SCTP_DISPOSITION_CONSUME;
2872 * sctp_sf_eat_data_fast_4_4
2875 * (4) In SHUTDOWN-SENT state the endpoint MUST acknowledge any received
2876 * DATA chunks without delay.
2878 * Verification Tag: 8.5 Verification Tag [Normal verification]
2880 * (endpoint, asoc, chunk)
2883 * (asoc, reply_msg, msg_up, timers, counters)
2885 * The return value is the disposition of the chunk.
2887 sctp_disposition_t sctp_sf_eat_data_fast_4_4(const struct sctp_endpoint *ep,
2888 const struct sctp_association *asoc,
2889 const sctp_subtype_t type,
2891 sctp_cmd_seq_t *commands)
2893 struct sctp_chunk *chunk = arg;
2896 if (!sctp_vtag_verify(chunk, asoc)) {
2897 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_BAD_TAG,
2899 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2902 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_data_chunk_t)))
2903 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
2906 error = sctp_eat_data(asoc, chunk, commands );
2908 case SCTP_IERROR_NO_ERROR:
2909 case SCTP_IERROR_HIGH_TSN:
2910 case SCTP_IERROR_DUP_TSN:
2911 case SCTP_IERROR_IGNORE_TSN:
2912 case SCTP_IERROR_BAD_STREAM:
2914 case SCTP_IERROR_NO_DATA:
2920 /* Go a head and force a SACK, since we are shutting down. */
2922 /* Implementor's Guide.
2924 * While in SHUTDOWN-SENT state, the SHUTDOWN sender MUST immediately
2925 * respond to each received packet containing one or more DATA chunk(s)
2926 * with a SACK, a SHUTDOWN chunk, and restart the T2-shutdown timer
2928 if (chunk->end_of_packet) {
2929 /* We must delay the chunk creation since the cumulative
2930 * TSN has not been updated yet.
2932 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_SHUTDOWN, SCTP_NULL());
2933 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_SACK, SCTP_FORCE());
2934 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
2935 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
2939 return SCTP_DISPOSITION_CONSUME;
2943 * Section: 6.2 Processing a Received SACK
2944 * D) Any time a SACK arrives, the endpoint performs the following:
2946 * i) If Cumulative TSN Ack is less than the Cumulative TSN Ack Point,
2947 * then drop the SACK. Since Cumulative TSN Ack is monotonically
2948 * increasing, a SACK whose Cumulative TSN Ack is less than the
2949 * Cumulative TSN Ack Point indicates an out-of-order SACK.
2951 * ii) Set rwnd equal to the newly received a_rwnd minus the number
2952 * of bytes still outstanding after processing the Cumulative TSN Ack
2953 * and the Gap Ack Blocks.
2955 * iii) If the SACK is missing a TSN that was previously
2956 * acknowledged via a Gap Ack Block (e.g., the data receiver
2957 * reneged on the data), then mark the corresponding DATA chunk
2958 * as available for retransmit: Mark it as missing for fast
2959 * retransmit as described in Section 7.2.4 and if no retransmit
2960 * timer is running for the destination address to which the DATA
2961 * chunk was originally transmitted, then T3-rtx is started for
2962 * that destination address.
2964 * Verification Tag: 8.5 Verification Tag [Normal verification]
2967 * (endpoint, asoc, chunk)
2970 * (asoc, reply_msg, msg_up, timers, counters)
2972 * The return value is the disposition of the chunk.
2974 sctp_disposition_t sctp_sf_eat_sack_6_2(const struct sctp_endpoint *ep,
2975 const struct sctp_association *asoc,
2976 const sctp_subtype_t type,
2978 sctp_cmd_seq_t *commands)
2980 struct sctp_chunk *chunk = arg;
2981 sctp_sackhdr_t *sackh;
2984 if (!sctp_vtag_verify(chunk, asoc))
2985 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2987 /* Make sure that the SACK chunk has a valid length. */
2988 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_sack_chunk_t)))
2989 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
2992 /* Pull the SACK chunk from the data buffer */
2993 sackh = sctp_sm_pull_sack(chunk);
2994 /* Was this a bogus SACK? */
2996 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
2997 chunk->subh.sack_hdr = sackh;
2998 ctsn = ntohl(sackh->cum_tsn_ack);
3000 /* i) If Cumulative TSN Ack is less than the Cumulative TSN
3001 * Ack Point, then drop the SACK. Since Cumulative TSN
3002 * Ack is monotonically increasing, a SACK whose
3003 * Cumulative TSN Ack is less than the Cumulative TSN Ack
3004 * Point indicates an out-of-order SACK.
3006 if (TSN_lt(ctsn, asoc->ctsn_ack_point)) {
3007 SCTP_DEBUG_PRINTK("ctsn %x\n", ctsn);
3008 SCTP_DEBUG_PRINTK("ctsn_ack_point %x\n", asoc->ctsn_ack_point);
3009 return SCTP_DISPOSITION_DISCARD;
3012 /* If Cumulative TSN Ack beyond the max tsn currently
3013 * send, terminating the association and respond to the
3014 * sender with an ABORT.
3016 if (!TSN_lt(ctsn, asoc->next_tsn))
3017 return sctp_sf_violation_ctsn(ep, asoc, type, arg, commands);
3019 /* Return this SACK for further processing. */
3020 sctp_add_cmd_sf(commands, SCTP_CMD_PROCESS_SACK, SCTP_SACKH(sackh));
3022 /* Note: We do the rest of the work on the PROCESS_SACK
3025 return SCTP_DISPOSITION_CONSUME;
3029 * Generate an ABORT in response to a packet.
3031 * Section: 8.4 Handle "Out of the blue" Packets, sctpimpguide 2.41
3033 * 8) The receiver should respond to the sender of the OOTB packet with
3034 * an ABORT. When sending the ABORT, the receiver of the OOTB packet
3035 * MUST fill in the Verification Tag field of the outbound packet
3036 * with the value found in the Verification Tag field of the OOTB
3037 * packet and set the T-bit in the Chunk Flags to indicate that the
3038 * Verification Tag is reflected. After sending this ABORT, the
3039 * receiver of the OOTB packet shall discard the OOTB packet and take
3040 * no further action.
3044 * The return value is the disposition of the chunk.
3046 static sctp_disposition_t sctp_sf_tabort_8_4_8(const struct sctp_endpoint *ep,
3047 const struct sctp_association *asoc,
3048 const sctp_subtype_t type,
3050 sctp_cmd_seq_t *commands)
3052 struct sctp_packet *packet = NULL;
3053 struct sctp_chunk *chunk = arg;
3054 struct sctp_chunk *abort;
3056 packet = sctp_ootb_pkt_new(asoc, chunk);
3059 /* Make an ABORT. The T bit will be set if the asoc
3062 abort = sctp_make_abort(asoc, chunk, 0);
3064 sctp_ootb_pkt_free(packet);
3065 return SCTP_DISPOSITION_NOMEM;
3068 /* Reflect vtag if T-Bit is set */
3069 if (sctp_test_T_bit(abort))
3070 packet->vtag = ntohl(chunk->sctp_hdr->vtag);
3072 /* Set the skb to the belonging sock for accounting. */
3073 abort->skb->sk = ep->base.sk;
3075 sctp_packet_append_chunk(packet, abort);
3077 sctp_add_cmd_sf(commands, SCTP_CMD_SEND_PKT,
3078 SCTP_PACKET(packet));
3080 SCTP_INC_STATS(SCTP_MIB_OUTCTRLCHUNKS);
3082 sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3083 return SCTP_DISPOSITION_CONSUME;
3086 return SCTP_DISPOSITION_NOMEM;
3090 * Received an ERROR chunk from peer. Generate SCTP_REMOTE_ERROR
3091 * event as ULP notification for each cause included in the chunk.
3093 * API 5.3.1.3 - SCTP_REMOTE_ERROR
3095 * The return value is the disposition of the chunk.
3097 sctp_disposition_t sctp_sf_operr_notify(const struct sctp_endpoint *ep,
3098 const struct sctp_association *asoc,
3099 const sctp_subtype_t type,
3101 sctp_cmd_seq_t *commands)
3103 struct sctp_chunk *chunk = arg;
3104 struct sctp_ulpevent *ev;
3106 if (!sctp_vtag_verify(chunk, asoc))
3107 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3109 /* Make sure that the ERROR chunk has a valid length. */
3110 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_operr_chunk_t)))
3111 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3114 while (chunk->chunk_end > chunk->skb->data) {
3115 ev = sctp_ulpevent_make_remote_error(asoc, chunk, 0,
3120 if (!sctp_add_cmd(commands, SCTP_CMD_EVENT_ULP,
3121 SCTP_ULPEVENT(ev))) {
3122 sctp_ulpevent_free(ev);
3126 sctp_add_cmd_sf(commands, SCTP_CMD_PROCESS_OPERR,
3129 return SCTP_DISPOSITION_CONSUME;
3132 return SCTP_DISPOSITION_NOMEM;
3136 * Process an inbound SHUTDOWN ACK.
3139 * Upon the receipt of the SHUTDOWN ACK, the SHUTDOWN sender shall
3140 * stop the T2-shutdown timer, send a SHUTDOWN COMPLETE chunk to its
3141 * peer, and remove all record of the association.
3143 * The return value is the disposition.
3145 sctp_disposition_t sctp_sf_do_9_2_final(const struct sctp_endpoint *ep,
3146 const struct sctp_association *asoc,
3147 const sctp_subtype_t type,
3149 sctp_cmd_seq_t *commands)
3151 struct sctp_chunk *chunk = arg;
3152 struct sctp_chunk *reply;
3153 struct sctp_ulpevent *ev;
3155 if (!sctp_vtag_verify(chunk, asoc))
3156 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3158 /* Make sure that the SHUTDOWN_ACK chunk has a valid length. */
3159 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_chunkhdr_t)))
3160 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3162 /* 10.2 H) SHUTDOWN COMPLETE notification
3164 * When SCTP completes the shutdown procedures (section 9.2) this
3165 * notification is passed to the upper layer.
3167 ev = sctp_ulpevent_make_assoc_change(asoc, 0, SCTP_SHUTDOWN_COMP,
3168 0, 0, 0, NULL, GFP_ATOMIC);
3172 /* ...send a SHUTDOWN COMPLETE chunk to its peer, */
3173 reply = sctp_make_shutdown_complete(asoc, chunk);
3177 /* Do all the commands now (after allocation), so that we
3178 * have consistent state if memory allocation failes
3180 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP, SCTP_ULPEVENT(ev));
3182 /* Upon the receipt of the SHUTDOWN ACK, the SHUTDOWN sender shall
3183 * stop the T2-shutdown timer,
3185 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
3186 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
3188 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
3189 SCTP_TO(SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD));
3191 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
3192 SCTP_STATE(SCTP_STATE_CLOSED));
3193 SCTP_INC_STATS(SCTP_MIB_SHUTDOWNS);
3194 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
3195 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(reply));
3197 /* ...and remove all record of the association. */
3198 sctp_add_cmd_sf(commands, SCTP_CMD_DELETE_TCB, SCTP_NULL());
3199 return SCTP_DISPOSITION_DELETE_TCB;
3202 sctp_ulpevent_free(ev);
3204 return SCTP_DISPOSITION_NOMEM;
3208 * RFC 2960, 8.4 - Handle "Out of the blue" Packets, sctpimpguide 2.41.
3210 * 5) If the packet contains a SHUTDOWN ACK chunk, the receiver should
3211 * respond to the sender of the OOTB packet with a SHUTDOWN COMPLETE.
3212 * When sending the SHUTDOWN COMPLETE, the receiver of the OOTB
3213 * packet must fill in the Verification Tag field of the outbound
3214 * packet with the Verification Tag received in the SHUTDOWN ACK and
3215 * set the T-bit in the Chunk Flags to indicate that the Verification
3218 * 8) The receiver should respond to the sender of the OOTB packet with
3219 * an ABORT. When sending the ABORT, the receiver of the OOTB packet
3220 * MUST fill in the Verification Tag field of the outbound packet
3221 * with the value found in the Verification Tag field of the OOTB
3222 * packet and set the T-bit in the Chunk Flags to indicate that the
3223 * Verification Tag is reflected. After sending this ABORT, the
3224 * receiver of the OOTB packet shall discard the OOTB packet and take
3225 * no further action.
3227 sctp_disposition_t sctp_sf_ootb(const struct sctp_endpoint *ep,
3228 const struct sctp_association *asoc,
3229 const sctp_subtype_t type,
3231 sctp_cmd_seq_t *commands)
3233 struct sctp_chunk *chunk = arg;
3234 struct sk_buff *skb = chunk->skb;
3235 sctp_chunkhdr_t *ch;
3237 int ootb_shut_ack = 0;
3239 SCTP_INC_STATS(SCTP_MIB_OUTOFBLUES);
3241 ch = (sctp_chunkhdr_t *) chunk->chunk_hdr;
3243 /* Report violation if the chunk is less then minimal */
3244 if (ntohs(ch->length) < sizeof(sctp_chunkhdr_t))
3245 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3248 /* Now that we know we at least have a chunk header,
3249 * do things that are type appropriate.
3251 if (SCTP_CID_SHUTDOWN_ACK == ch->type)
3254 /* RFC 2960, Section 3.3.7
3255 * Moreover, under any circumstances, an endpoint that
3256 * receives an ABORT MUST NOT respond to that ABORT by
3257 * sending an ABORT of its own.
3259 if (SCTP_CID_ABORT == ch->type)
3260 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3262 /* Report violation if chunk len overflows */
3263 ch_end = ((__u8 *)ch) + WORD_ROUND(ntohs(ch->length));
3264 if (ch_end > skb_tail_pointer(skb))
3265 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3268 ch = (sctp_chunkhdr_t *) ch_end;
3269 } while (ch_end < skb_tail_pointer(skb));
3272 return sctp_sf_shut_8_4_5(ep, asoc, type, arg, commands);
3274 return sctp_sf_tabort_8_4_8(ep, asoc, type, arg, commands);
3278 * Handle an "Out of the blue" SHUTDOWN ACK.
3280 * Section: 8.4 5, sctpimpguide 2.41.
3282 * 5) If the packet contains a SHUTDOWN ACK chunk, the receiver should
3283 * respond to the sender of the OOTB packet with a SHUTDOWN COMPLETE.
3284 * When sending the SHUTDOWN COMPLETE, the receiver of the OOTB
3285 * packet must fill in the Verification Tag field of the outbound
3286 * packet with the Verification Tag received in the SHUTDOWN ACK and
3287 * set the T-bit in the Chunk Flags to indicate that the Verification
3291 * (endpoint, asoc, type, arg, commands)
3294 * (sctp_disposition_t)
3296 * The return value is the disposition of the chunk.
3298 static sctp_disposition_t sctp_sf_shut_8_4_5(const struct sctp_endpoint *ep,
3299 const struct sctp_association *asoc,
3300 const sctp_subtype_t type,
3302 sctp_cmd_seq_t *commands)
3304 struct sctp_packet *packet = NULL;
3305 struct sctp_chunk *chunk = arg;
3306 struct sctp_chunk *shut;
3308 packet = sctp_ootb_pkt_new(asoc, chunk);
3311 /* Make an SHUTDOWN_COMPLETE.
3312 * The T bit will be set if the asoc is NULL.
3314 shut = sctp_make_shutdown_complete(asoc, chunk);
3316 sctp_ootb_pkt_free(packet);
3317 return SCTP_DISPOSITION_NOMEM;
3320 /* Reflect vtag if T-Bit is set */
3321 if (sctp_test_T_bit(shut))
3322 packet->vtag = ntohl(chunk->sctp_hdr->vtag);
3324 /* Set the skb to the belonging sock for accounting. */
3325 shut->skb->sk = ep->base.sk;
3327 sctp_packet_append_chunk(packet, shut);
3329 sctp_add_cmd_sf(commands, SCTP_CMD_SEND_PKT,
3330 SCTP_PACKET(packet));
3332 SCTP_INC_STATS(SCTP_MIB_OUTCTRLCHUNKS);
3334 /* If the chunk length is invalid, we don't want to process
3335 * the reset of the packet.
3337 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_chunkhdr_t)))
3338 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3340 /* We need to discard the rest of the packet to prevent
3341 * potential bomming attacks from additional bundled chunks.
3342 * This is documented in SCTP Threats ID.
3344 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3347 return SCTP_DISPOSITION_NOMEM;
3351 * Handle SHUTDOWN ACK in COOKIE_ECHOED or COOKIE_WAIT state.
3353 * Verification Tag: 8.5.1 E) Rules for packet carrying a SHUTDOWN ACK
3354 * If the receiver is in COOKIE-ECHOED or COOKIE-WAIT state the
3355 * procedures in section 8.4 SHOULD be followed, in other words it
3356 * should be treated as an Out Of The Blue packet.
3357 * [This means that we do NOT check the Verification Tag on these
3361 sctp_disposition_t sctp_sf_do_8_5_1_E_sa(const struct sctp_endpoint *ep,
3362 const struct sctp_association *asoc,
3363 const sctp_subtype_t type,
3365 sctp_cmd_seq_t *commands)
3367 struct sctp_chunk *chunk = arg;
3369 /* Make sure that the SHUTDOWN_ACK chunk has a valid length. */
3370 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_chunkhdr_t)))
3371 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3374 /* Although we do have an association in this case, it corresponds
3375 * to a restarted association. So the packet is treated as an OOTB
3376 * packet and the state function that handles OOTB SHUTDOWN_ACK is
3377 * called with a NULL association.
3379 return sctp_sf_shut_8_4_5(ep, NULL, type, arg, commands);
3382 /* ADDIP Section 4.2 Upon reception of an ASCONF Chunk. */
3383 sctp_disposition_t sctp_sf_do_asconf(const struct sctp_endpoint *ep,
3384 const struct sctp_association *asoc,
3385 const sctp_subtype_t type, void *arg,
3386 sctp_cmd_seq_t *commands)
3388 struct sctp_chunk *chunk = arg;
3389 struct sctp_chunk *asconf_ack = NULL;
3390 struct sctp_paramhdr *err_param = NULL;
3391 sctp_addiphdr_t *hdr;
3392 union sctp_addr_param *addr_param;
3396 if (!sctp_vtag_verify(chunk, asoc)) {
3397 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_BAD_TAG,
3399 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3402 /* Make sure that the ASCONF ADDIP chunk has a valid length. */
3403 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_addip_chunk_t)))
3404 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3407 hdr = (sctp_addiphdr_t *)chunk->skb->data;
3408 serial = ntohl(hdr->serial);
3410 addr_param = (union sctp_addr_param *)hdr->params;
3411 length = ntohs(addr_param->p.length);
3412 if (length < sizeof(sctp_paramhdr_t))
3413 return sctp_sf_violation_paramlen(ep, asoc, type,
3414 (void *)addr_param, commands);
3416 /* Verify the ASCONF chunk before processing it. */
3417 if (!sctp_verify_asconf(asoc,
3418 (sctp_paramhdr_t *)((void *)addr_param + length),
3419 (void *)chunk->chunk_end,
3421 return sctp_sf_violation_paramlen(ep, asoc, type,
3422 (void *)&err_param, commands);
3424 /* ADDIP 4.2 C1) Compare the value of the serial number to the value
3425 * the endpoint stored in a new association variable
3426 * 'Peer-Serial-Number'.
3428 if (serial == asoc->peer.addip_serial + 1) {
3429 /* ADDIP 4.2 C2) If the value found in the serial number is
3430 * equal to the ('Peer-Serial-Number' + 1), the endpoint MUST
3433 asconf_ack = sctp_process_asconf((struct sctp_association *)
3436 return SCTP_DISPOSITION_NOMEM;
3437 } else if (serial == asoc->peer.addip_serial) {
3438 /* ADDIP 4.2 C3) If the value found in the serial number is
3439 * equal to the value stored in the 'Peer-Serial-Number'
3440 * IMPLEMENTATION NOTE: As an optimization a receiver may wish
3441 * to save the last ASCONF-ACK for some predetermined period of
3442 * time and instead of re-processing the ASCONF (with the same
3443 * serial number) it may just re-transmit the ASCONF-ACK.
3445 if (asoc->addip_last_asconf_ack)
3446 asconf_ack = asoc->addip_last_asconf_ack;
3448 return SCTP_DISPOSITION_DISCARD;
3450 /* ADDIP 4.2 C4) Otherwise, the ASCONF Chunk is discarded since
3451 * it must be either a stale packet or from an attacker.
3453 return SCTP_DISPOSITION_DISCARD;
3456 /* ADDIP 4.2 C5) In both cases C2 and C3 the ASCONF-ACK MUST be sent
3457 * back to the source address contained in the IP header of the ASCONF
3458 * being responded to.
3460 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(asconf_ack));
3462 return SCTP_DISPOSITION_CONSUME;
3466 * ADDIP Section 4.3 General rules for address manipulation
3467 * When building TLV parameters for the ASCONF Chunk that will add or
3468 * delete IP addresses the D0 to D13 rules should be applied:
3470 sctp_disposition_t sctp_sf_do_asconf_ack(const struct sctp_endpoint *ep,
3471 const struct sctp_association *asoc,
3472 const sctp_subtype_t type, void *arg,
3473 sctp_cmd_seq_t *commands)
3475 struct sctp_chunk *asconf_ack = arg;
3476 struct sctp_chunk *last_asconf = asoc->addip_last_asconf;
3477 struct sctp_chunk *abort;
3478 struct sctp_paramhdr *err_param = NULL;
3479 sctp_addiphdr_t *addip_hdr;
3480 __u32 sent_serial, rcvd_serial;
3482 if (!sctp_vtag_verify(asconf_ack, asoc)) {
3483 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_BAD_TAG,
3485 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3488 /* Make sure that the ADDIP chunk has a valid length. */
3489 if (!sctp_chunk_length_valid(asconf_ack, sizeof(sctp_addip_chunk_t)))
3490 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3493 addip_hdr = (sctp_addiphdr_t *)asconf_ack->skb->data;
3494 rcvd_serial = ntohl(addip_hdr->serial);
3496 /* Verify the ASCONF-ACK chunk before processing it. */
3497 if (!sctp_verify_asconf(asoc,
3498 (sctp_paramhdr_t *)addip_hdr->params,
3499 (void *)asconf_ack->chunk_end,
3501 return sctp_sf_violation_paramlen(ep, asoc, type,
3502 (void *)&err_param, commands);
3505 addip_hdr = (sctp_addiphdr_t *)last_asconf->subh.addip_hdr;
3506 sent_serial = ntohl(addip_hdr->serial);
3508 sent_serial = asoc->addip_serial - 1;
3511 /* D0) If an endpoint receives an ASCONF-ACK that is greater than or
3512 * equal to the next serial number to be used but no ASCONF chunk is
3513 * outstanding the endpoint MUST ABORT the association. Note that a
3514 * sequence number is greater than if it is no more than 2^^31-1
3515 * larger than the current sequence number (using serial arithmetic).
3517 if (ADDIP_SERIAL_gte(rcvd_serial, sent_serial + 1) &&
3518 !(asoc->addip_last_asconf)) {
3519 abort = sctp_make_abort(asoc, asconf_ack,
3520 sizeof(sctp_errhdr_t));
3522 sctp_init_cause(abort, SCTP_ERROR_ASCONF_ACK, 0);
3523 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
3526 /* We are going to ABORT, so we might as well stop
3527 * processing the rest of the chunks in the packet.
3529 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
3530 SCTP_TO(SCTP_EVENT_TIMEOUT_T4_RTO));
3531 sctp_add_cmd_sf(commands, SCTP_CMD_DISCARD_PACKET,SCTP_NULL());
3532 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
3533 SCTP_ERROR(ECONNABORTED));
3534 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
3535 SCTP_PERR(SCTP_ERROR_ASCONF_ACK));
3536 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
3537 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
3538 return SCTP_DISPOSITION_ABORT;
3541 if ((rcvd_serial == sent_serial) && asoc->addip_last_asconf) {
3542 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
3543 SCTP_TO(SCTP_EVENT_TIMEOUT_T4_RTO));
3545 if (!sctp_process_asconf_ack((struct sctp_association *)asoc,
3547 return SCTP_DISPOSITION_CONSUME;
3549 abort = sctp_make_abort(asoc, asconf_ack,
3550 sizeof(sctp_errhdr_t));
3552 sctp_init_cause(abort, SCTP_ERROR_RSRC_LOW, 0);
3553 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
3556 /* We are going to ABORT, so we might as well stop
3557 * processing the rest of the chunks in the packet.
3559 sctp_add_cmd_sf(commands, SCTP_CMD_DISCARD_PACKET,SCTP_NULL());
3560 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
3561 SCTP_ERROR(ECONNABORTED));
3562 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
3563 SCTP_PERR(SCTP_ERROR_ASCONF_ACK));
3564 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
3565 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
3566 return SCTP_DISPOSITION_ABORT;
3569 return SCTP_DISPOSITION_DISCARD;
3573 * PR-SCTP Section 3.6 Receiver Side Implementation of PR-SCTP
3575 * When a FORWARD TSN chunk arrives, the data receiver MUST first update
3576 * its cumulative TSN point to the value carried in the FORWARD TSN
3577 * chunk, and then MUST further advance its cumulative TSN point locally
3579 * After the above processing, the data receiver MUST stop reporting any
3580 * missing TSNs earlier than or equal to the new cumulative TSN point.
3582 * Verification Tag: 8.5 Verification Tag [Normal verification]
3584 * The return value is the disposition of the chunk.
3586 sctp_disposition_t sctp_sf_eat_fwd_tsn(const struct sctp_endpoint *ep,
3587 const struct sctp_association *asoc,
3588 const sctp_subtype_t type,
3590 sctp_cmd_seq_t *commands)
3592 struct sctp_chunk *chunk = arg;
3593 struct sctp_fwdtsn_hdr *fwdtsn_hdr;
3597 if (!sctp_vtag_verify(chunk, asoc)) {
3598 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_BAD_TAG,
3600 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3603 /* Make sure that the FORWARD_TSN chunk has valid length. */
3604 if (!sctp_chunk_length_valid(chunk, sizeof(struct sctp_fwdtsn_chunk)))
3605 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3608 fwdtsn_hdr = (struct sctp_fwdtsn_hdr *)chunk->skb->data;
3609 chunk->subh.fwdtsn_hdr = fwdtsn_hdr;
3610 len = ntohs(chunk->chunk_hdr->length);
3611 len -= sizeof(struct sctp_chunkhdr);
3612 skb_pull(chunk->skb, len);
3614 tsn = ntohl(fwdtsn_hdr->new_cum_tsn);
3615 SCTP_DEBUG_PRINTK("%s: TSN 0x%x.\n", __FUNCTION__, tsn);
3617 /* The TSN is too high--silently discard the chunk and count on it
3618 * getting retransmitted later.
3620 if (sctp_tsnmap_check(&asoc->peer.tsn_map, tsn) < 0)
3621 goto discard_noforce;
3623 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_FWDTSN, SCTP_U32(tsn));
3624 if (len > sizeof(struct sctp_fwdtsn_hdr))
3625 sctp_add_cmd_sf(commands, SCTP_CMD_PROCESS_FWDTSN,
3628 /* Count this as receiving DATA. */
3629 if (asoc->autoclose) {
3630 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
3631 SCTP_TO(SCTP_EVENT_TIMEOUT_AUTOCLOSE));
3634 /* FIXME: For now send a SACK, but DATA processing may
3637 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_SACK, SCTP_NOFORCE());
3639 return SCTP_DISPOSITION_CONSUME;
3642 return SCTP_DISPOSITION_DISCARD;
3645 sctp_disposition_t sctp_sf_eat_fwd_tsn_fast(
3646 const struct sctp_endpoint *ep,
3647 const struct sctp_association *asoc,
3648 const sctp_subtype_t type,
3650 sctp_cmd_seq_t *commands)
3652 struct sctp_chunk *chunk = arg;
3653 struct sctp_fwdtsn_hdr *fwdtsn_hdr;
3657 if (!sctp_vtag_verify(chunk, asoc)) {
3658 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_BAD_TAG,
3660 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3663 /* Make sure that the FORWARD_TSN chunk has a valid length. */
3664 if (!sctp_chunk_length_valid(chunk, sizeof(struct sctp_fwdtsn_chunk)))
3665 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3668 fwdtsn_hdr = (struct sctp_fwdtsn_hdr *)chunk->skb->data;
3669 chunk->subh.fwdtsn_hdr = fwdtsn_hdr;
3670 len = ntohs(chunk->chunk_hdr->length);
3671 len -= sizeof(struct sctp_chunkhdr);
3672 skb_pull(chunk->skb, len);
3674 tsn = ntohl(fwdtsn_hdr->new_cum_tsn);
3675 SCTP_DEBUG_PRINTK("%s: TSN 0x%x.\n", __FUNCTION__, tsn);
3677 /* The TSN is too high--silently discard the chunk and count on it
3678 * getting retransmitted later.
3680 if (sctp_tsnmap_check(&asoc->peer.tsn_map, tsn) < 0)
3683 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_FWDTSN, SCTP_U32(tsn));
3684 if (len > sizeof(struct sctp_fwdtsn_hdr))
3685 sctp_add_cmd_sf(commands, SCTP_CMD_PROCESS_FWDTSN,
3688 /* Go a head and force a SACK, since we are shutting down. */
3690 /* Implementor's Guide.
3692 * While in SHUTDOWN-SENT state, the SHUTDOWN sender MUST immediately
3693 * respond to each received packet containing one or more DATA chunk(s)
3694 * with a SACK, a SHUTDOWN chunk, and restart the T2-shutdown timer
3696 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_SHUTDOWN, SCTP_NULL());
3697 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_SACK, SCTP_FORCE());
3698 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
3699 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
3701 return SCTP_DISPOSITION_CONSUME;
3705 * SCTP-AUTH Section 6.3 Receving authenticated chukns
3707 * The receiver MUST use the HMAC algorithm indicated in the HMAC
3708 * Identifier field. If this algorithm was not specified by the
3709 * receiver in the HMAC-ALGO parameter in the INIT or INIT-ACK chunk
3710 * during association setup, the AUTH chunk and all chunks after it MUST
3711 * be discarded and an ERROR chunk SHOULD be sent with the error cause
3712 * defined in Section 4.1.
3714 * If an endpoint with no shared key receives a Shared Key Identifier
3715 * other than 0, it MUST silently discard all authenticated chunks. If
3716 * the endpoint has at least one endpoint pair shared key for the peer,
3717 * it MUST use the key specified by the Shared Key Identifier if a
3718 * key has been configured for that Shared Key Identifier. If no
3719 * endpoint pair shared key has been configured for that Shared Key
3720 * Identifier, all authenticated chunks MUST be silently discarded.
3722 * Verification Tag: 8.5 Verification Tag [Normal verification]
3724 * The return value is the disposition of the chunk.
3726 static sctp_ierror_t sctp_sf_authenticate(const struct sctp_endpoint *ep,
3727 const struct sctp_association *asoc,
3728 const sctp_subtype_t type,
3729 struct sctp_chunk *chunk)
3731 struct sctp_authhdr *auth_hdr;
3732 struct sctp_hmac *hmac;
3733 unsigned int sig_len;
3738 /* Pull in the auth header, so we can do some more verification */
3739 auth_hdr = (struct sctp_authhdr *)chunk->skb->data;
3740 chunk->subh.auth_hdr = auth_hdr;
3741 skb_pull(chunk->skb, sizeof(struct sctp_authhdr));
3743 /* Make sure that we suport the HMAC algorithm from the auth
3746 if (!sctp_auth_asoc_verify_hmac_id(asoc, auth_hdr->hmac_id))
3747 return SCTP_IERROR_AUTH_BAD_HMAC;
3749 /* Make sure that the provided shared key identifier has been
3752 key_id = ntohs(auth_hdr->shkey_id);
3753 if (key_id != asoc->active_key_id && !sctp_auth_get_shkey(asoc, key_id))
3754 return SCTP_IERROR_AUTH_BAD_KEYID;
3757 /* Make sure that the length of the signature matches what
3760 sig_len = ntohs(chunk->chunk_hdr->length) - sizeof(sctp_auth_chunk_t);
3761 hmac = sctp_auth_get_hmac(ntohs(auth_hdr->hmac_id));
3762 if (sig_len != hmac->hmac_len)
3763 return SCTP_IERROR_PROTO_VIOLATION;
3765 /* Now that we've done validation checks, we can compute and
3766 * verify the hmac. The steps involved are:
3767 * 1. Save the digest from the chunk.
3768 * 2. Zero out the digest in the chunk.
3769 * 3. Compute the new digest
3770 * 4. Compare saved and new digests.
3772 digest = auth_hdr->hmac;
3773 skb_pull(chunk->skb, sig_len);
3775 save_digest = kmemdup(digest, sig_len, GFP_ATOMIC);
3779 memset(digest, 0, sig_len);
3781 sctp_auth_calculate_hmac(asoc, chunk->skb,
3782 (struct sctp_auth_chunk *)chunk->chunk_hdr,
3785 /* Discard the packet if the digests do not match */
3786 if (memcmp(save_digest, digest, sig_len)) {
3788 return SCTP_IERROR_BAD_SIG;
3794 return SCTP_IERROR_NO_ERROR;
3796 return SCTP_IERROR_NOMEM;
3799 sctp_disposition_t sctp_sf_eat_auth(const struct sctp_endpoint *ep,
3800 const struct sctp_association *asoc,
3801 const sctp_subtype_t type,
3803 sctp_cmd_seq_t *commands)
3805 struct sctp_authhdr *auth_hdr;
3806 struct sctp_chunk *chunk = arg;
3807 struct sctp_chunk *err_chunk;
3808 sctp_ierror_t error;
3810 if (!sctp_vtag_verify(chunk, asoc)) {
3811 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_BAD_TAG,
3813 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3816 /* Make sure that the AUTH chunk has valid length. */
3817 if (!sctp_chunk_length_valid(chunk, sizeof(struct sctp_auth_chunk)))
3818 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3821 auth_hdr = (struct sctp_authhdr *)chunk->skb->data;
3822 error = sctp_sf_authenticate(ep, asoc, type, chunk);
3824 case SCTP_IERROR_AUTH_BAD_HMAC:
3825 /* Generate the ERROR chunk and discard the rest
3828 err_chunk = sctp_make_op_error(asoc, chunk,
3829 SCTP_ERROR_UNSUP_HMAC,
3833 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
3834 SCTP_CHUNK(err_chunk));
3837 case SCTP_IERROR_AUTH_BAD_KEYID:
3838 case SCTP_IERROR_BAD_SIG:
3839 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3841 case SCTP_IERROR_PROTO_VIOLATION:
3842 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3845 case SCTP_IERROR_NOMEM:
3846 return SCTP_DISPOSITION_NOMEM;
3851 if (asoc->active_key_id != ntohs(auth_hdr->shkey_id)) {
3852 struct sctp_ulpevent *ev;
3854 ev = sctp_ulpevent_make_authkey(asoc, ntohs(auth_hdr->shkey_id),
3855 SCTP_AUTH_NEWKEY, GFP_ATOMIC);
3860 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP,
3864 return SCTP_DISPOSITION_CONSUME;
3868 * Process an unknown chunk.
3870 * Section: 3.2. Also, 2.1 in the implementor's guide.
3872 * Chunk Types are encoded such that the highest-order two bits specify
3873 * the action that must be taken if the processing endpoint does not
3874 * recognize the Chunk Type.
3876 * 00 - Stop processing this SCTP packet and discard it, do not process
3877 * any further chunks within it.
3879 * 01 - Stop processing this SCTP packet and discard it, do not process
3880 * any further chunks within it, and report the unrecognized
3881 * chunk in an 'Unrecognized Chunk Type'.
3883 * 10 - Skip this chunk and continue processing.
3885 * 11 - Skip this chunk and continue processing, but report in an ERROR
3886 * Chunk using the 'Unrecognized Chunk Type' cause of error.
3888 * The return value is the disposition of the chunk.
3890 sctp_disposition_t sctp_sf_unk_chunk(const struct sctp_endpoint *ep,
3891 const struct sctp_association *asoc,
3892 const sctp_subtype_t type,
3894 sctp_cmd_seq_t *commands)
3896 struct sctp_chunk *unk_chunk = arg;
3897 struct sctp_chunk *err_chunk;
3898 sctp_chunkhdr_t *hdr;
3900 SCTP_DEBUG_PRINTK("Processing the unknown chunk id %d.\n", type.chunk);
3902 if (!sctp_vtag_verify(unk_chunk, asoc))
3903 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3905 /* Make sure that the chunk has a valid length.
3906 * Since we don't know the chunk type, we use a general
3907 * chunkhdr structure to make a comparison.
3909 if (!sctp_chunk_length_valid(unk_chunk, sizeof(sctp_chunkhdr_t)))
3910 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3913 switch (type.chunk & SCTP_CID_ACTION_MASK) {
3914 case SCTP_CID_ACTION_DISCARD:
3915 /* Discard the packet. */
3916 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3918 case SCTP_CID_ACTION_DISCARD_ERR:
3919 /* Discard the packet. */
3920 sctp_sf_pdiscard(ep, asoc, type, arg, commands);
3922 /* Generate an ERROR chunk as response. */
3923 hdr = unk_chunk->chunk_hdr;
3924 err_chunk = sctp_make_op_error(asoc, unk_chunk,
3925 SCTP_ERROR_UNKNOWN_CHUNK, hdr,
3926 WORD_ROUND(ntohs(hdr->length)));
3928 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
3929 SCTP_CHUNK(err_chunk));
3931 return SCTP_DISPOSITION_CONSUME;
3933 case SCTP_CID_ACTION_SKIP:
3934 /* Skip the chunk. */
3935 return SCTP_DISPOSITION_DISCARD;
3937 case SCTP_CID_ACTION_SKIP_ERR:
3938 /* Generate an ERROR chunk as response. */
3939 hdr = unk_chunk->chunk_hdr;
3940 err_chunk = sctp_make_op_error(asoc, unk_chunk,
3941 SCTP_ERROR_UNKNOWN_CHUNK, hdr,
3942 WORD_ROUND(ntohs(hdr->length)));
3944 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
3945 SCTP_CHUNK(err_chunk));
3947 /* Skip the chunk. */
3948 return SCTP_DISPOSITION_CONSUME;
3954 return SCTP_DISPOSITION_DISCARD;
3958 * Discard the chunk.
3960 * Section: 0.2, 5.2.3, 5.2.5, 5.2.6, 6.0, 8.4.6, 8.5.1c, 9.2
3961 * [Too numerous to mention...]
3962 * Verification Tag: No verification needed.
3964 * (endpoint, asoc, chunk)
3967 * (asoc, reply_msg, msg_up, timers, counters)
3969 * The return value is the disposition of the chunk.
3971 sctp_disposition_t sctp_sf_discard_chunk(const struct sctp_endpoint *ep,
3972 const struct sctp_association *asoc,
3973 const sctp_subtype_t type,
3975 sctp_cmd_seq_t *commands)
3977 struct sctp_chunk *chunk = arg;
3979 /* Make sure that the chunk has a valid length.
3980 * Since we don't know the chunk type, we use a general
3981 * chunkhdr structure to make a comparison.
3983 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_chunkhdr_t)))
3984 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
3987 SCTP_DEBUG_PRINTK("Chunk %d is discarded\n", type.chunk);
3988 return SCTP_DISPOSITION_DISCARD;
3992 * Discard the whole packet.
3996 * 2) If the OOTB packet contains an ABORT chunk, the receiver MUST
3997 * silently discard the OOTB packet and take no further action.
3999 * Verification Tag: No verification necessary
4002 * (endpoint, asoc, chunk)
4005 * (asoc, reply_msg, msg_up, timers, counters)
4007 * The return value is the disposition of the chunk.
4009 sctp_disposition_t sctp_sf_pdiscard(const struct sctp_endpoint *ep,
4010 const struct sctp_association *asoc,
4011 const sctp_subtype_t type,
4013 sctp_cmd_seq_t *commands)
4015 SCTP_INC_STATS(SCTP_MIB_IN_PKT_DISCARDS);
4016 sctp_add_cmd_sf(commands, SCTP_CMD_DISCARD_PACKET, SCTP_NULL());
4018 return SCTP_DISPOSITION_CONSUME;
4023 * The other end is violating protocol.
4025 * Section: Not specified
4026 * Verification Tag: Not specified
4028 * (endpoint, asoc, chunk)
4031 * (asoc, reply_msg, msg_up, timers, counters)
4033 * We simply tag the chunk as a violation. The state machine will log
4034 * the violation and continue.
4036 sctp_disposition_t sctp_sf_violation(const struct sctp_endpoint *ep,
4037 const struct sctp_association *asoc,
4038 const sctp_subtype_t type,
4040 sctp_cmd_seq_t *commands)
4042 struct sctp_chunk *chunk = arg;
4044 /* Make sure that the chunk has a valid length. */
4045 if (!sctp_chunk_length_valid(chunk, sizeof(sctp_chunkhdr_t)))
4046 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
4049 return SCTP_DISPOSITION_VIOLATION;
4053 * Common function to handle a protocol violation.
4055 static sctp_disposition_t sctp_sf_abort_violation(
4056 const struct sctp_endpoint *ep,
4057 const struct sctp_association *asoc,
4059 sctp_cmd_seq_t *commands,
4060 const __u8 *payload,
4061 const size_t paylen)
4063 struct sctp_packet *packet = NULL;
4064 struct sctp_chunk *chunk = arg;
4065 struct sctp_chunk *abort = NULL;
4067 /* Make the abort chunk. */
4068 abort = sctp_make_abort_violation(asoc, chunk, payload, paylen);
4072 /* SCTP-AUTH, Section 6.3:
4073 * It should be noted that if the receiver wants to tear
4074 * down an association in an authenticated way only, the
4075 * handling of malformed packets should not result in
4076 * tearing down the association.
4078 * This means that if we only want to abort associations
4079 * in an authenticated way (i.e AUTH+ABORT), then we
4080 * can't destory this association just becuase the packet
4083 if (sctp_auth_recv_cid(SCTP_CID_ABORT, asoc))
4087 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(abort));
4088 SCTP_INC_STATS(SCTP_MIB_OUTCTRLCHUNKS);
4090 if (asoc->state <= SCTP_STATE_COOKIE_ECHOED) {
4091 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
4092 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_INIT));
4093 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
4094 SCTP_ERROR(ECONNREFUSED));
4095 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_FAILED,
4096 SCTP_PERR(SCTP_ERROR_PROTO_VIOLATION));
4098 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
4099 SCTP_ERROR(ECONNABORTED));
4100 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
4101 SCTP_PERR(SCTP_ERROR_PROTO_VIOLATION));
4102 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
4105 packet = sctp_ootb_pkt_new(asoc, chunk);
4110 if (sctp_test_T_bit(abort))
4111 packet->vtag = ntohl(chunk->sctp_hdr->vtag);
4113 abort->skb->sk = ep->base.sk;
4115 sctp_packet_append_chunk(packet, abort);
4117 sctp_add_cmd_sf(commands, SCTP_CMD_SEND_PKT,
4118 SCTP_PACKET(packet));
4120 SCTP_INC_STATS(SCTP_MIB_OUTCTRLCHUNKS);
4124 sctp_sf_pdiscard(ep, asoc, SCTP_ST_CHUNK(0), arg, commands);
4126 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
4128 return SCTP_DISPOSITION_ABORT;
4131 sctp_chunk_free(abort);
4133 return SCTP_DISPOSITION_NOMEM;
4137 * Handle a protocol violation when the chunk length is invalid.
4138 * "Invalid" length is identified as smaller then the minimal length a
4139 * given chunk can be. For example, a SACK chunk has invalid length
4140 * if it's length is set to be smaller then the size of sctp_sack_chunk_t.
4142 * We inform the other end by sending an ABORT with a Protocol Violation
4145 * Section: Not specified
4146 * Verification Tag: Nothing to do
4148 * (endpoint, asoc, chunk)
4151 * (reply_msg, msg_up, counters)
4153 * Generate an ABORT chunk and terminate the association.
4155 static sctp_disposition_t sctp_sf_violation_chunklen(
4156 const struct sctp_endpoint *ep,
4157 const struct sctp_association *asoc,
4158 const sctp_subtype_t type,
4160 sctp_cmd_seq_t *commands)
4162 char err_str[]="The following chunk had invalid length:";
4164 return sctp_sf_abort_violation(ep, asoc, arg, commands, err_str,
4169 * Handle a protocol violation when the parameter length is invalid.
4170 * "Invalid" length is identified as smaller then the minimal length a
4171 * given parameter can be.
4173 static sctp_disposition_t sctp_sf_violation_paramlen(
4174 const struct sctp_endpoint *ep,
4175 const struct sctp_association *asoc,
4176 const sctp_subtype_t type,
4178 sctp_cmd_seq_t *commands) {
4179 char err_str[] = "The following parameter had invalid length:";
4181 return sctp_sf_abort_violation(ep, asoc, arg, commands, err_str,
4185 /* Handle a protocol violation when the peer trying to advance the
4186 * cumulative tsn ack to a point beyond the max tsn currently sent.
4188 * We inform the other end by sending an ABORT with a Protocol Violation
4191 static sctp_disposition_t sctp_sf_violation_ctsn(
4192 const struct sctp_endpoint *ep,
4193 const struct sctp_association *asoc,
4194 const sctp_subtype_t type,
4196 sctp_cmd_seq_t *commands)
4198 char err_str[]="The cumulative tsn ack beyond the max tsn currently sent:";
4200 return sctp_sf_abort_violation(ep, asoc, arg, commands, err_str,
4204 /* Handle protocol violation of an invalid chunk bundling. For example,
4205 * when we have an association and we recieve bundled INIT-ACK, or
4206 * SHUDOWN-COMPLETE, our peer is clearly violationg the "MUST NOT bundle"
4207 * statement from the specs. Additinally, there might be an attacker
4208 * on the path and we may not want to continue this communication.
4210 static sctp_disposition_t sctp_sf_violation_chunk(
4211 const struct sctp_endpoint *ep,
4212 const struct sctp_association *asoc,
4213 const sctp_subtype_t type,
4215 sctp_cmd_seq_t *commands)
4217 char err_str[]="The following chunk violates protocol:";
4220 return sctp_sf_violation(ep, asoc, type, arg, commands);
4222 return sctp_sf_abort_violation(ep, asoc, arg, commands, err_str,
4225 /***************************************************************************
4226 * These are the state functions for handling primitive (Section 10) events.
4227 ***************************************************************************/
4229 * sctp_sf_do_prm_asoc
4231 * Section: 10.1 ULP-to-SCTP
4234 * Format: ASSOCIATE(local SCTP instance name, destination transport addr,
4235 * outbound stream count)
4236 * -> association id [,destination transport addr list] [,outbound stream
4239 * This primitive allows the upper layer to initiate an association to a
4240 * specific peer endpoint.
4242 * The peer endpoint shall be specified by one of the transport addresses
4243 * which defines the endpoint (see Section 1.4). If the local SCTP
4244 * instance has not been initialized, the ASSOCIATE is considered an
4246 * [This is not relevant for the kernel implementation since we do all
4247 * initialization at boot time. It we hadn't initialized we wouldn't
4248 * get anywhere near this code.]
4250 * An association id, which is a local handle to the SCTP association,
4251 * will be returned on successful establishment of the association. If
4252 * SCTP is not able to open an SCTP association with the peer endpoint,
4253 * an error is returned.
4254 * [In the kernel implementation, the struct sctp_association needs to
4255 * be created BEFORE causing this primitive to run.]
4257 * Other association parameters may be returned, including the
4258 * complete destination transport addresses of the peer as well as the
4259 * outbound stream count of the local endpoint. One of the transport
4260 * address from the returned destination addresses will be selected by
4261 * the local endpoint as default primary path for sending SCTP packets
4262 * to this peer. The returned "destination transport addr list" can
4263 * be used by the ULP to change the default primary path or to force
4264 * sending a packet to a specific transport address. [All of this
4265 * stuff happens when the INIT ACK arrives. This is a NON-BLOCKING
4268 * Mandatory attributes:
4270 * o local SCTP instance name - obtained from the INITIALIZE operation.
4271 * [This is the argument asoc.]
4272 * o destination transport addr - specified as one of the transport
4273 * addresses of the peer endpoint with which the association is to be
4275 * [This is asoc->peer.active_path.]
4276 * o outbound stream count - the number of outbound streams the ULP
4277 * would like to open towards this peer endpoint.
4278 * [BUG: This is not currently implemented.]
4279 * Optional attributes:
4283 * The return value is a disposition.
4285 sctp_disposition_t sctp_sf_do_prm_asoc(const struct sctp_endpoint *ep,
4286 const struct sctp_association *asoc,
4287 const sctp_subtype_t type,
4289 sctp_cmd_seq_t *commands)
4291 struct sctp_chunk *repl;
4293 /* The comment below says that we enter COOKIE-WAIT AFTER
4294 * sending the INIT, but that doesn't actually work in our
4297 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
4298 SCTP_STATE(SCTP_STATE_COOKIE_WAIT));
4300 /* RFC 2960 5.1 Normal Establishment of an Association
4302 * A) "A" first sends an INIT chunk to "Z". In the INIT, "A"
4303 * must provide its Verification Tag (Tag_A) in the Initiate
4304 * Tag field. Tag_A SHOULD be a random number in the range of
4305 * 1 to 4294967295 (see 5.3.1 for Tag value selection). ...
4308 repl = sctp_make_init(asoc, &asoc->base.bind_addr, GFP_ATOMIC, 0);
4312 /* Cast away the const modifier, as we want to just
4313 * rerun it through as a sideffect.
4315 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_ASOC,
4316 SCTP_ASOC((struct sctp_association *) asoc));
4318 /* Choose transport for INIT. */
4319 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_CHOOSE_TRANSPORT,
4322 /* After sending the INIT, "A" starts the T1-init timer and
4323 * enters the COOKIE-WAIT state.
4325 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_START,
4326 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_INIT));
4327 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(repl));
4328 return SCTP_DISPOSITION_CONSUME;
4331 return SCTP_DISPOSITION_NOMEM;
4335 * Process the SEND primitive.
4337 * Section: 10.1 ULP-to-SCTP
4340 * Format: SEND(association id, buffer address, byte count [,context]
4341 * [,stream id] [,life time] [,destination transport address]
4342 * [,unorder flag] [,no-bundle flag] [,payload protocol-id] )
4345 * This is the main method to send user data via SCTP.
4347 * Mandatory attributes:
4349 * o association id - local handle to the SCTP association
4351 * o buffer address - the location where the user message to be
4352 * transmitted is stored;
4354 * o byte count - The size of the user data in number of bytes;
4356 * Optional attributes:
4358 * o context - an optional 32 bit integer that will be carried in the
4359 * sending failure notification to the ULP if the transportation of
4360 * this User Message fails.
4362 * o stream id - to indicate which stream to send the data on. If not
4363 * specified, stream 0 will be used.
4365 * o life time - specifies the life time of the user data. The user data
4366 * will not be sent by SCTP after the life time expires. This
4367 * parameter can be used to avoid efforts to transmit stale
4368 * user messages. SCTP notifies the ULP if the data cannot be
4369 * initiated to transport (i.e. sent to the destination via SCTP's
4370 * send primitive) within the life time variable. However, the
4371 * user data will be transmitted if SCTP has attempted to transmit a
4372 * chunk before the life time expired.
4374 * o destination transport address - specified as one of the destination
4375 * transport addresses of the peer endpoint to which this packet
4376 * should be sent. Whenever possible, SCTP should use this destination
4377 * transport address for sending the packets, instead of the current
4380 * o unorder flag - this flag, if present, indicates that the user
4381 * would like the data delivered in an unordered fashion to the peer
4382 * (i.e., the U flag is set to 1 on all DATA chunks carrying this
4385 * o no-bundle flag - instructs SCTP not to bundle this user data with
4386 * other outbound DATA chunks. SCTP MAY still bundle even when
4387 * this flag is present, when faced with network congestion.
4389 * o payload protocol-id - A 32 bit unsigned integer that is to be
4390 * passed to the peer indicating the type of payload protocol data
4391 * being transmitted. This value is passed as opaque data by SCTP.
4393 * The return value is the disposition.
4395 sctp_disposition_t sctp_sf_do_prm_send(const struct sctp_endpoint *ep,
4396 const struct sctp_association *asoc,
4397 const sctp_subtype_t type,
4399 sctp_cmd_seq_t *commands)
4401 struct sctp_chunk *chunk = arg;
4403 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(chunk));
4404 return SCTP_DISPOSITION_CONSUME;
4408 * Process the SHUTDOWN primitive.
4413 * Format: SHUTDOWN(association id)
4416 * Gracefully closes an association. Any locally queued user data
4417 * will be delivered to the peer. The association will be terminated only
4418 * after the peer acknowledges all the SCTP packets sent. A success code
4419 * will be returned on successful termination of the association. If
4420 * attempting to terminate the association results in a failure, an error
4421 * code shall be returned.
4423 * Mandatory attributes:
4425 * o association id - local handle to the SCTP association
4427 * Optional attributes:
4431 * The return value is the disposition.
4433 sctp_disposition_t sctp_sf_do_9_2_prm_shutdown(
4434 const struct sctp_endpoint *ep,
4435 const struct sctp_association *asoc,
4436 const sctp_subtype_t type,
4438 sctp_cmd_seq_t *commands)
4442 /* From 9.2 Shutdown of an Association
4443 * Upon receipt of the SHUTDOWN primitive from its upper
4444 * layer, the endpoint enters SHUTDOWN-PENDING state and
4445 * remains there until all outstanding data has been
4446 * acknowledged by its peer. The endpoint accepts no new data
4447 * from its upper layer, but retransmits data to the far end
4448 * if necessary to fill gaps.
4450 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
4451 SCTP_STATE(SCTP_STATE_SHUTDOWN_PENDING));
4453 /* sctpimpguide-05 Section 2.12.2
4454 * The sender of the SHUTDOWN MAY also start an overall guard timer
4455 * 'T5-shutdown-guard' to bound the overall time for shutdown sequence.
4457 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_START,
4458 SCTP_TO(SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD));
4460 disposition = SCTP_DISPOSITION_CONSUME;
4461 if (sctp_outq_is_empty(&asoc->outqueue)) {
4462 disposition = sctp_sf_do_9_2_start_shutdown(ep, asoc, type,
4469 * Process the ABORT primitive.
4474 * Format: Abort(association id [, cause code])
4477 * Ungracefully closes an association. Any locally queued user data
4478 * will be discarded and an ABORT chunk is sent to the peer. A success code
4479 * will be returned on successful abortion of the association. If
4480 * attempting to abort the association results in a failure, an error
4481 * code shall be returned.
4483 * Mandatory attributes:
4485 * o association id - local handle to the SCTP association
4487 * Optional attributes:
4489 * o cause code - reason of the abort to be passed to the peer
4493 * The return value is the disposition.
4495 sctp_disposition_t sctp_sf_do_9_1_prm_abort(
4496 const struct sctp_endpoint *ep,
4497 const struct sctp_association *asoc,
4498 const sctp_subtype_t type,
4500 sctp_cmd_seq_t *commands)
4502 /* From 9.1 Abort of an Association
4503 * Upon receipt of the ABORT primitive from its upper
4504 * layer, the endpoint enters CLOSED state and
4505 * discard all outstanding data has been
4506 * acknowledged by its peer. The endpoint accepts no new data
4507 * from its upper layer, but retransmits data to the far end
4508 * if necessary to fill gaps.
4510 struct sctp_chunk *abort = arg;
4511 sctp_disposition_t retval;
4513 retval = SCTP_DISPOSITION_CONSUME;
4515 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(abort));
4517 /* Even if we can't send the ABORT due to low memory delete the
4518 * TCB. This is a departure from our typical NOMEM handling.
4521 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
4522 SCTP_ERROR(ECONNABORTED));
4523 /* Delete the established association. */
4524 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
4525 SCTP_PERR(SCTP_ERROR_USER_ABORT));
4527 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
4528 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
4533 /* We tried an illegal operation on an association which is closed. */
4534 sctp_disposition_t sctp_sf_error_closed(const struct sctp_endpoint *ep,
4535 const struct sctp_association *asoc,
4536 const sctp_subtype_t type,
4538 sctp_cmd_seq_t *commands)
4540 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_ERROR, SCTP_ERROR(-EINVAL));
4541 return SCTP_DISPOSITION_CONSUME;
4544 /* We tried an illegal operation on an association which is shutting
4547 sctp_disposition_t sctp_sf_error_shutdown(const struct sctp_endpoint *ep,
4548 const struct sctp_association *asoc,
4549 const sctp_subtype_t type,
4551 sctp_cmd_seq_t *commands)
4553 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_ERROR,
4554 SCTP_ERROR(-ESHUTDOWN));
4555 return SCTP_DISPOSITION_CONSUME;
4559 * sctp_cookie_wait_prm_shutdown
4561 * Section: 4 Note: 2
4566 * The RFC does not explicitly address this issue, but is the route through the
4567 * state table when someone issues a shutdown while in COOKIE_WAIT state.
4572 sctp_disposition_t sctp_sf_cookie_wait_prm_shutdown(
4573 const struct sctp_endpoint *ep,
4574 const struct sctp_association *asoc,
4575 const sctp_subtype_t type,
4577 sctp_cmd_seq_t *commands)
4579 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
4580 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_INIT));
4582 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
4583 SCTP_STATE(SCTP_STATE_CLOSED));
4585 SCTP_INC_STATS(SCTP_MIB_SHUTDOWNS);
4587 sctp_add_cmd_sf(commands, SCTP_CMD_DELETE_TCB, SCTP_NULL());
4589 return SCTP_DISPOSITION_DELETE_TCB;
4593 * sctp_cookie_echoed_prm_shutdown
4595 * Section: 4 Note: 2
4600 * The RFC does not explcitly address this issue, but is the route through the
4601 * state table when someone issues a shutdown while in COOKIE_ECHOED state.
4606 sctp_disposition_t sctp_sf_cookie_echoed_prm_shutdown(
4607 const struct sctp_endpoint *ep,
4608 const struct sctp_association *asoc,
4609 const sctp_subtype_t type,
4610 void *arg, sctp_cmd_seq_t *commands)
4612 /* There is a single T1 timer, so we should be able to use
4613 * common function with the COOKIE-WAIT state.
4615 return sctp_sf_cookie_wait_prm_shutdown(ep, asoc, type, arg, commands);
4619 * sctp_sf_cookie_wait_prm_abort
4621 * Section: 4 Note: 2
4626 * The RFC does not explicitly address this issue, but is the route through the
4627 * state table when someone issues an abort while in COOKIE_WAIT state.
4632 sctp_disposition_t sctp_sf_cookie_wait_prm_abort(
4633 const struct sctp_endpoint *ep,
4634 const struct sctp_association *asoc,
4635 const sctp_subtype_t type,
4637 sctp_cmd_seq_t *commands)
4639 struct sctp_chunk *abort = arg;
4640 sctp_disposition_t retval;
4642 /* Stop T1-init timer */
4643 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
4644 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_INIT));
4645 retval = SCTP_DISPOSITION_CONSUME;
4647 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(abort));
4649 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
4650 SCTP_STATE(SCTP_STATE_CLOSED));
4652 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
4654 /* Even if we can't send the ABORT due to low memory delete the
4655 * TCB. This is a departure from our typical NOMEM handling.
4658 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
4659 SCTP_ERROR(ECONNREFUSED));
4660 /* Delete the established association. */
4661 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_FAILED,
4662 SCTP_PERR(SCTP_ERROR_USER_ABORT));
4668 * sctp_sf_cookie_echoed_prm_abort
4670 * Section: 4 Note: 3
4675 * The RFC does not explcitly address this issue, but is the route through the
4676 * state table when someone issues an abort while in COOKIE_ECHOED state.
4681 sctp_disposition_t sctp_sf_cookie_echoed_prm_abort(
4682 const struct sctp_endpoint *ep,
4683 const struct sctp_association *asoc,
4684 const sctp_subtype_t type,
4686 sctp_cmd_seq_t *commands)
4688 /* There is a single T1 timer, so we should be able to use
4689 * common function with the COOKIE-WAIT state.
4691 return sctp_sf_cookie_wait_prm_abort(ep, asoc, type, arg, commands);
4695 * sctp_sf_shutdown_pending_prm_abort
4700 * The RFC does not explicitly address this issue, but is the route through the
4701 * state table when someone issues an abort while in SHUTDOWN-PENDING state.
4706 sctp_disposition_t sctp_sf_shutdown_pending_prm_abort(
4707 const struct sctp_endpoint *ep,
4708 const struct sctp_association *asoc,
4709 const sctp_subtype_t type,
4711 sctp_cmd_seq_t *commands)
4713 /* Stop the T5-shutdown guard timer. */
4714 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
4715 SCTP_TO(SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD));
4717 return sctp_sf_do_9_1_prm_abort(ep, asoc, type, arg, commands);
4721 * sctp_sf_shutdown_sent_prm_abort
4726 * The RFC does not explicitly address this issue, but is the route through the
4727 * state table when someone issues an abort while in SHUTDOWN-SENT state.
4732 sctp_disposition_t sctp_sf_shutdown_sent_prm_abort(
4733 const struct sctp_endpoint *ep,
4734 const struct sctp_association *asoc,
4735 const sctp_subtype_t type,
4737 sctp_cmd_seq_t *commands)
4739 /* Stop the T2-shutdown timer. */
4740 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
4741 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
4743 /* Stop the T5-shutdown guard timer. */
4744 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
4745 SCTP_TO(SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD));
4747 return sctp_sf_do_9_1_prm_abort(ep, asoc, type, arg, commands);
4751 * sctp_sf_cookie_echoed_prm_abort
4756 * The RFC does not explcitly address this issue, but is the route through the
4757 * state table when someone issues an abort while in COOKIE_ECHOED state.
4762 sctp_disposition_t sctp_sf_shutdown_ack_sent_prm_abort(
4763 const struct sctp_endpoint *ep,
4764 const struct sctp_association *asoc,
4765 const sctp_subtype_t type,
4767 sctp_cmd_seq_t *commands)
4769 /* The same T2 timer, so we should be able to use
4770 * common function with the SHUTDOWN-SENT state.
4772 return sctp_sf_shutdown_sent_prm_abort(ep, asoc, type, arg, commands);
4776 * Process the REQUESTHEARTBEAT primitive
4779 * J) Request Heartbeat
4781 * Format: REQUESTHEARTBEAT(association id, destination transport address)
4785 * Instructs the local endpoint to perform a HeartBeat on the specified
4786 * destination transport address of the given association. The returned
4787 * result should indicate whether the transmission of the HEARTBEAT
4788 * chunk to the destination address is successful.
4790 * Mandatory attributes:
4792 * o association id - local handle to the SCTP association
4794 * o destination transport address - the transport address of the
4795 * association on which a heartbeat should be issued.
4797 sctp_disposition_t sctp_sf_do_prm_requestheartbeat(
4798 const struct sctp_endpoint *ep,
4799 const struct sctp_association *asoc,
4800 const sctp_subtype_t type,
4802 sctp_cmd_seq_t *commands)
4804 if (SCTP_DISPOSITION_NOMEM == sctp_sf_heartbeat(ep, asoc, type,
4805 (struct sctp_transport *)arg, commands))
4806 return SCTP_DISPOSITION_NOMEM;
4809 * RFC 2960 (bis), section 8.3
4811 * D) Request an on-demand HEARTBEAT on a specific destination
4812 * transport address of a given association.
4814 * The endpoint should increment the respective error counter of
4815 * the destination transport address each time a HEARTBEAT is sent
4816 * to that address and not acknowledged within one RTO.
4819 sctp_add_cmd_sf(commands, SCTP_CMD_TRANSPORT_RESET,
4820 SCTP_TRANSPORT(arg));
4821 return SCTP_DISPOSITION_CONSUME;
4825 * ADDIP Section 4.1 ASCONF Chunk Procedures
4826 * When an endpoint has an ASCONF signaled change to be sent to the
4827 * remote endpoint it should do A1 to A9
4829 sctp_disposition_t sctp_sf_do_prm_asconf(const struct sctp_endpoint *ep,
4830 const struct sctp_association *asoc,
4831 const sctp_subtype_t type,
4833 sctp_cmd_seq_t *commands)
4835 struct sctp_chunk *chunk = arg;
4837 sctp_add_cmd_sf(commands, SCTP_CMD_SETUP_T4, SCTP_CHUNK(chunk));
4838 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_START,
4839 SCTP_TO(SCTP_EVENT_TIMEOUT_T4_RTO));
4840 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(chunk));
4841 return SCTP_DISPOSITION_CONSUME;
4845 * Ignore the primitive event
4847 * The return value is the disposition of the primitive.
4849 sctp_disposition_t sctp_sf_ignore_primitive(
4850 const struct sctp_endpoint *ep,
4851 const struct sctp_association *asoc,
4852 const sctp_subtype_t type,
4854 sctp_cmd_seq_t *commands)
4856 SCTP_DEBUG_PRINTK("Primitive type %d is ignored.\n", type.primitive);
4857 return SCTP_DISPOSITION_DISCARD;
4860 /***************************************************************************
4861 * These are the state functions for the OTHER events.
4862 ***************************************************************************/
4865 * Start the shutdown negotiation.
4868 * Once all its outstanding data has been acknowledged, the endpoint
4869 * shall send a SHUTDOWN chunk to its peer including in the Cumulative
4870 * TSN Ack field the last sequential TSN it has received from the peer.
4871 * It shall then start the T2-shutdown timer and enter the SHUTDOWN-SENT
4872 * state. If the timer expires, the endpoint must re-send the SHUTDOWN
4873 * with the updated last sequential TSN received from its peer.
4875 * The return value is the disposition.
4877 sctp_disposition_t sctp_sf_do_9_2_start_shutdown(
4878 const struct sctp_endpoint *ep,
4879 const struct sctp_association *asoc,
4880 const sctp_subtype_t type,
4882 sctp_cmd_seq_t *commands)
4884 struct sctp_chunk *reply;
4886 /* Once all its outstanding data has been acknowledged, the
4887 * endpoint shall send a SHUTDOWN chunk to its peer including
4888 * in the Cumulative TSN Ack field the last sequential TSN it
4889 * has received from the peer.
4891 reply = sctp_make_shutdown(asoc, NULL);
4895 /* Set the transport for the SHUTDOWN chunk and the timeout for the
4896 * T2-shutdown timer.
4898 sctp_add_cmd_sf(commands, SCTP_CMD_SETUP_T2, SCTP_CHUNK(reply));
4900 /* It shall then start the T2-shutdown timer */
4901 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_START,
4902 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
4904 if (asoc->autoclose)
4905 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
4906 SCTP_TO(SCTP_EVENT_TIMEOUT_AUTOCLOSE));
4908 /* and enter the SHUTDOWN-SENT state. */
4909 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
4910 SCTP_STATE(SCTP_STATE_SHUTDOWN_SENT));
4912 /* sctp-implguide 2.10 Issues with Heartbeating and failover
4914 * HEARTBEAT ... is discontinued after sending either SHUTDOWN
4917 sctp_add_cmd_sf(commands, SCTP_CMD_HB_TIMERS_STOP, SCTP_NULL());
4919 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(reply));
4921 return SCTP_DISPOSITION_CONSUME;
4924 return SCTP_DISPOSITION_NOMEM;
4928 * Generate a SHUTDOWN ACK now that everything is SACK'd.
4932 * If it has no more outstanding DATA chunks, the SHUTDOWN receiver
4933 * shall send a SHUTDOWN ACK and start a T2-shutdown timer of its own,
4934 * entering the SHUTDOWN-ACK-SENT state. If the timer expires, the
4935 * endpoint must re-send the SHUTDOWN ACK.
4937 * The return value is the disposition.
4939 sctp_disposition_t sctp_sf_do_9_2_shutdown_ack(
4940 const struct sctp_endpoint *ep,
4941 const struct sctp_association *asoc,
4942 const sctp_subtype_t type,
4944 sctp_cmd_seq_t *commands)
4946 struct sctp_chunk *chunk = (struct sctp_chunk *) arg;
4947 struct sctp_chunk *reply;
4949 /* There are 2 ways of getting here:
4950 * 1) called in response to a SHUTDOWN chunk
4951 * 2) called when SCTP_EVENT_NO_PENDING_TSN event is issued.
4953 * For the case (2), the arg parameter is set to NULL. We need
4954 * to check that we have a chunk before accessing it's fields.
4957 if (!sctp_vtag_verify(chunk, asoc))
4958 return sctp_sf_pdiscard(ep, asoc, type, arg, commands);
4960 /* Make sure that the SHUTDOWN chunk has a valid length. */
4961 if (!sctp_chunk_length_valid(chunk, sizeof(struct sctp_shutdown_chunk_t)))
4962 return sctp_sf_violation_chunklen(ep, asoc, type, arg,
4966 /* If it has no more outstanding DATA chunks, the SHUTDOWN receiver
4967 * shall send a SHUTDOWN ACK ...
4969 reply = sctp_make_shutdown_ack(asoc, chunk);
4973 /* Set the transport for the SHUTDOWN ACK chunk and the timeout for
4974 * the T2-shutdown timer.
4976 sctp_add_cmd_sf(commands, SCTP_CMD_SETUP_T2, SCTP_CHUNK(reply));
4978 /* and start/restart a T2-shutdown timer of its own, */
4979 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
4980 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
4982 if (asoc->autoclose)
4983 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
4984 SCTP_TO(SCTP_EVENT_TIMEOUT_AUTOCLOSE));
4986 /* Enter the SHUTDOWN-ACK-SENT state. */
4987 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
4988 SCTP_STATE(SCTP_STATE_SHUTDOWN_ACK_SENT));
4990 /* sctp-implguide 2.10 Issues with Heartbeating and failover
4992 * HEARTBEAT ... is discontinued after sending either SHUTDOWN
4995 sctp_add_cmd_sf(commands, SCTP_CMD_HB_TIMERS_STOP, SCTP_NULL());
4997 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(reply));
4999 return SCTP_DISPOSITION_CONSUME;
5002 return SCTP_DISPOSITION_NOMEM;
5006 * Ignore the event defined as other
5008 * The return value is the disposition of the event.
5010 sctp_disposition_t sctp_sf_ignore_other(const struct sctp_endpoint *ep,
5011 const struct sctp_association *asoc,
5012 const sctp_subtype_t type,
5014 sctp_cmd_seq_t *commands)
5016 SCTP_DEBUG_PRINTK("The event other type %d is ignored\n", type.other);
5017 return SCTP_DISPOSITION_DISCARD;
5020 /************************************************************
5021 * These are the state functions for handling timeout events.
5022 ************************************************************/
5027 * Section: 6.3.3 Handle T3-rtx Expiration
5029 * Whenever the retransmission timer T3-rtx expires for a destination
5030 * address, do the following:
5033 * The return value is the disposition of the chunk.
5035 sctp_disposition_t sctp_sf_do_6_3_3_rtx(const struct sctp_endpoint *ep,
5036 const struct sctp_association *asoc,
5037 const sctp_subtype_t type,
5039 sctp_cmd_seq_t *commands)
5041 struct sctp_transport *transport = arg;
5043 SCTP_INC_STATS(SCTP_MIB_T3_RTX_EXPIREDS);
5045 if (asoc->overall_error_count >= asoc->max_retrans) {
5046 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
5047 SCTP_ERROR(ETIMEDOUT));
5048 /* CMD_ASSOC_FAILED calls CMD_DELETE_TCB. */
5049 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
5050 SCTP_PERR(SCTP_ERROR_NO_ERROR));
5051 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
5052 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
5053 return SCTP_DISPOSITION_DELETE_TCB;
5056 /* E1) For the destination address for which the timer
5057 * expires, adjust its ssthresh with rules defined in Section
5058 * 7.2.3 and set the cwnd <- MTU.
5061 /* E2) For the destination address for which the timer
5062 * expires, set RTO <- RTO * 2 ("back off the timer"). The
5063 * maximum value discussed in rule C7 above (RTO.max) may be
5064 * used to provide an upper bound to this doubling operation.
5067 /* E3) Determine how many of the earliest (i.e., lowest TSN)
5068 * outstanding DATA chunks for the address for which the
5069 * T3-rtx has expired will fit into a single packet, subject
5070 * to the MTU constraint for the path corresponding to the
5071 * destination transport address to which the retransmission
5072 * is being sent (this may be different from the address for
5073 * which the timer expires [see Section 6.4]). Call this
5074 * value K. Bundle and retransmit those K DATA chunks in a
5075 * single packet to the destination endpoint.
5077 * Note: Any DATA chunks that were sent to the address for
5078 * which the T3-rtx timer expired but did not fit in one MTU
5079 * (rule E3 above), should be marked for retransmission and
5080 * sent as soon as cwnd allows (normally when a SACK arrives).
5083 /* Do some failure management (Section 8.2). */
5084 sctp_add_cmd_sf(commands, SCTP_CMD_STRIKE, SCTP_TRANSPORT(transport));
5086 /* NB: Rules E4 and F1 are implicit in R1. */
5087 sctp_add_cmd_sf(commands, SCTP_CMD_RETRAN, SCTP_TRANSPORT(transport));
5089 return SCTP_DISPOSITION_CONSUME;
5093 * Generate delayed SACK on timeout
5095 * Section: 6.2 Acknowledgement on Reception of DATA Chunks
5097 * The guidelines on delayed acknowledgement algorithm specified in
5098 * Section 4.2 of [RFC2581] SHOULD be followed. Specifically, an
5099 * acknowledgement SHOULD be generated for at least every second packet
5100 * (not every second DATA chunk) received, and SHOULD be generated
5101 * within 200 ms of the arrival of any unacknowledged DATA chunk. In
5102 * some situations it may be beneficial for an SCTP transmitter to be
5103 * more conservative than the algorithms detailed in this document
5104 * allow. However, an SCTP transmitter MUST NOT be more aggressive than
5105 * the following algorithms allow.
5107 sctp_disposition_t sctp_sf_do_6_2_sack(const struct sctp_endpoint *ep,
5108 const struct sctp_association *asoc,
5109 const sctp_subtype_t type,
5111 sctp_cmd_seq_t *commands)
5113 SCTP_INC_STATS(SCTP_MIB_DELAY_SACK_EXPIREDS);
5114 sctp_add_cmd_sf(commands, SCTP_CMD_GEN_SACK, SCTP_FORCE());
5115 return SCTP_DISPOSITION_CONSUME;
5119 * sctp_sf_t1_init_timer_expire
5121 * Section: 4 Note: 2
5126 * RFC 2960 Section 4 Notes
5127 * 2) If the T1-init timer expires, the endpoint MUST retransmit INIT
5128 * and re-start the T1-init timer without changing state. This MUST
5129 * be repeated up to 'Max.Init.Retransmits' times. After that, the
5130 * endpoint MUST abort the initialization process and report the
5131 * error to SCTP user.
5137 sctp_disposition_t sctp_sf_t1_init_timer_expire(const struct sctp_endpoint *ep,
5138 const struct sctp_association *asoc,
5139 const sctp_subtype_t type,
5141 sctp_cmd_seq_t *commands)
5143 struct sctp_chunk *repl = NULL;
5144 struct sctp_bind_addr *bp;
5145 int attempts = asoc->init_err_counter + 1;
5147 SCTP_DEBUG_PRINTK("Timer T1 expired (INIT).\n");
5148 SCTP_INC_STATS(SCTP_MIB_T1_INIT_EXPIREDS);
5150 if (attempts <= asoc->max_init_attempts) {
5151 bp = (struct sctp_bind_addr *) &asoc->base.bind_addr;
5152 repl = sctp_make_init(asoc, bp, GFP_ATOMIC, 0);
5154 return SCTP_DISPOSITION_NOMEM;
5156 /* Choose transport for INIT. */
5157 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_CHOOSE_TRANSPORT,
5160 /* Issue a sideeffect to do the needed accounting. */
5161 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_RESTART,
5162 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_INIT));
5164 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(repl));
5166 SCTP_DEBUG_PRINTK("Giving up on INIT, attempts: %d"
5167 " max_init_attempts: %d\n",
5168 attempts, asoc->max_init_attempts);
5169 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
5170 SCTP_ERROR(ETIMEDOUT));
5171 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_FAILED,
5172 SCTP_PERR(SCTP_ERROR_NO_ERROR));
5173 return SCTP_DISPOSITION_DELETE_TCB;
5176 return SCTP_DISPOSITION_CONSUME;
5180 * sctp_sf_t1_cookie_timer_expire
5182 * Section: 4 Note: 2
5187 * RFC 2960 Section 4 Notes
5188 * 3) If the T1-cookie timer expires, the endpoint MUST retransmit
5189 * COOKIE ECHO and re-start the T1-cookie timer without changing
5190 * state. This MUST be repeated up to 'Max.Init.Retransmits' times.
5191 * After that, the endpoint MUST abort the initialization process and
5192 * report the error to SCTP user.
5198 sctp_disposition_t sctp_sf_t1_cookie_timer_expire(const struct sctp_endpoint *ep,
5199 const struct sctp_association *asoc,
5200 const sctp_subtype_t type,
5202 sctp_cmd_seq_t *commands)
5204 struct sctp_chunk *repl = NULL;
5205 int attempts = asoc->init_err_counter + 1;
5207 SCTP_DEBUG_PRINTK("Timer T1 expired (COOKIE-ECHO).\n");
5208 SCTP_INC_STATS(SCTP_MIB_T1_COOKIE_EXPIREDS);
5210 if (attempts <= asoc->max_init_attempts) {
5211 repl = sctp_make_cookie_echo(asoc, NULL);
5213 return SCTP_DISPOSITION_NOMEM;
5215 /* Issue a sideeffect to do the needed accounting. */
5216 sctp_add_cmd_sf(commands, SCTP_CMD_COOKIEECHO_RESTART,
5217 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_COOKIE));
5219 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(repl));
5221 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
5222 SCTP_ERROR(ETIMEDOUT));
5223 sctp_add_cmd_sf(commands, SCTP_CMD_INIT_FAILED,
5224 SCTP_PERR(SCTP_ERROR_NO_ERROR));
5225 return SCTP_DISPOSITION_DELETE_TCB;
5228 return SCTP_DISPOSITION_CONSUME;
5231 /* RFC2960 9.2 If the timer expires, the endpoint must re-send the SHUTDOWN
5232 * with the updated last sequential TSN received from its peer.
5234 * An endpoint should limit the number of retransmissions of the
5235 * SHUTDOWN chunk to the protocol parameter 'Association.Max.Retrans'.
5236 * If this threshold is exceeded the endpoint should destroy the TCB and
5237 * MUST report the peer endpoint unreachable to the upper layer (and
5238 * thus the association enters the CLOSED state). The reception of any
5239 * packet from its peer (i.e. as the peer sends all of its queued DATA
5240 * chunks) should clear the endpoint's retransmission count and restart
5241 * the T2-Shutdown timer, giving its peer ample opportunity to transmit
5242 * all of its queued DATA chunks that have not yet been sent.
5244 sctp_disposition_t sctp_sf_t2_timer_expire(const struct sctp_endpoint *ep,
5245 const struct sctp_association *asoc,
5246 const sctp_subtype_t type,
5248 sctp_cmd_seq_t *commands)
5250 struct sctp_chunk *reply = NULL;
5252 SCTP_DEBUG_PRINTK("Timer T2 expired.\n");
5253 SCTP_INC_STATS(SCTP_MIB_T2_SHUTDOWN_EXPIREDS);
5255 if (asoc->overall_error_count >= asoc->max_retrans) {
5256 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
5257 SCTP_ERROR(ETIMEDOUT));
5258 /* Note: CMD_ASSOC_FAILED calls CMD_DELETE_TCB. */
5259 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
5260 SCTP_PERR(SCTP_ERROR_NO_ERROR));
5261 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
5262 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
5263 return SCTP_DISPOSITION_DELETE_TCB;
5266 switch (asoc->state) {
5267 case SCTP_STATE_SHUTDOWN_SENT:
5268 reply = sctp_make_shutdown(asoc, NULL);
5271 case SCTP_STATE_SHUTDOWN_ACK_SENT:
5272 reply = sctp_make_shutdown_ack(asoc, NULL);
5283 /* Do some failure management (Section 8.2). */
5284 sctp_add_cmd_sf(commands, SCTP_CMD_STRIKE,
5285 SCTP_TRANSPORT(asoc->shutdown_last_sent_to));
5287 /* Set the transport for the SHUTDOWN/ACK chunk and the timeout for
5288 * the T2-shutdown timer.
5290 sctp_add_cmd_sf(commands, SCTP_CMD_SETUP_T2, SCTP_CHUNK(reply));
5292 /* Restart the T2-shutdown timer. */
5293 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
5294 SCTP_TO(SCTP_EVENT_TIMEOUT_T2_SHUTDOWN));
5295 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(reply));
5296 return SCTP_DISPOSITION_CONSUME;
5299 return SCTP_DISPOSITION_NOMEM;
5303 * ADDIP Section 4.1 ASCONF CHunk Procedures
5304 * If the T4 RTO timer expires the endpoint should do B1 to B5
5306 sctp_disposition_t sctp_sf_t4_timer_expire(
5307 const struct sctp_endpoint *ep,
5308 const struct sctp_association *asoc,
5309 const sctp_subtype_t type,
5311 sctp_cmd_seq_t *commands)
5313 struct sctp_chunk *chunk = asoc->addip_last_asconf;
5314 struct sctp_transport *transport = chunk->transport;
5316 SCTP_INC_STATS(SCTP_MIB_T4_RTO_EXPIREDS);
5318 /* ADDIP 4.1 B1) Increment the error counters and perform path failure
5319 * detection on the appropriate destination address as defined in
5320 * RFC2960 [5] section 8.1 and 8.2.
5322 sctp_add_cmd_sf(commands, SCTP_CMD_STRIKE, SCTP_TRANSPORT(transport));
5324 /* Reconfig T4 timer and transport. */
5325 sctp_add_cmd_sf(commands, SCTP_CMD_SETUP_T4, SCTP_CHUNK(chunk));
5327 /* ADDIP 4.1 B2) Increment the association error counters and perform
5328 * endpoint failure detection on the association as defined in
5329 * RFC2960 [5] section 8.1 and 8.2.
5330 * association error counter is incremented in SCTP_CMD_STRIKE.
5332 if (asoc->overall_error_count >= asoc->max_retrans) {
5333 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
5334 SCTP_TO(SCTP_EVENT_TIMEOUT_T4_RTO));
5335 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
5336 SCTP_ERROR(ETIMEDOUT));
5337 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
5338 SCTP_PERR(SCTP_ERROR_NO_ERROR));
5339 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
5340 SCTP_INC_STATS(SCTP_MIB_CURRESTAB);
5341 return SCTP_DISPOSITION_ABORT;
5344 /* ADDIP 4.1 B3) Back-off the destination address RTO value to which
5345 * the ASCONF chunk was sent by doubling the RTO timer value.
5346 * This is done in SCTP_CMD_STRIKE.
5349 /* ADDIP 4.1 B4) Re-transmit the ASCONF Chunk last sent and if possible
5350 * choose an alternate destination address (please refer to RFC2960
5351 * [5] section 6.4.1). An endpoint MUST NOT add new parameters to this
5352 * chunk, it MUST be the same (including its serial number) as the last
5355 sctp_chunk_hold(asoc->addip_last_asconf);
5356 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
5357 SCTP_CHUNK(asoc->addip_last_asconf));
5359 /* ADDIP 4.1 B5) Restart the T-4 RTO timer. Note that if a different
5360 * destination is selected, then the RTO used will be that of the new
5361 * destination address.
5363 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
5364 SCTP_TO(SCTP_EVENT_TIMEOUT_T4_RTO));
5366 return SCTP_DISPOSITION_CONSUME;
5369 /* sctpimpguide-05 Section 2.12.2
5370 * The sender of the SHUTDOWN MAY also start an overall guard timer
5371 * 'T5-shutdown-guard' to bound the overall time for shutdown sequence.
5372 * At the expiration of this timer the sender SHOULD abort the association
5373 * by sending an ABORT chunk.
5375 sctp_disposition_t sctp_sf_t5_timer_expire(const struct sctp_endpoint *ep,
5376 const struct sctp_association *asoc,
5377 const sctp_subtype_t type,
5379 sctp_cmd_seq_t *commands)
5381 struct sctp_chunk *reply = NULL;
5383 SCTP_DEBUG_PRINTK("Timer T5 expired.\n");
5384 SCTP_INC_STATS(SCTP_MIB_T5_SHUTDOWN_GUARD_EXPIREDS);
5386 reply = sctp_make_abort(asoc, NULL, 0);
5390 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(reply));
5391 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
5392 SCTP_ERROR(ETIMEDOUT));
5393 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
5394 SCTP_PERR(SCTP_ERROR_NO_ERROR));
5396 return SCTP_DISPOSITION_DELETE_TCB;
5398 return SCTP_DISPOSITION_NOMEM;
5401 /* Handle expiration of AUTOCLOSE timer. When the autoclose timer expires,
5402 * the association is automatically closed by starting the shutdown process.
5403 * The work that needs to be done is same as when SHUTDOWN is initiated by
5404 * the user. So this routine looks same as sctp_sf_do_9_2_prm_shutdown().
5406 sctp_disposition_t sctp_sf_autoclose_timer_expire(
5407 const struct sctp_endpoint *ep,
5408 const struct sctp_association *asoc,
5409 const sctp_subtype_t type,
5411 sctp_cmd_seq_t *commands)
5415 SCTP_INC_STATS(SCTP_MIB_AUTOCLOSE_EXPIREDS);
5417 /* From 9.2 Shutdown of an Association
5418 * Upon receipt of the SHUTDOWN primitive from its upper
5419 * layer, the endpoint enters SHUTDOWN-PENDING state and
5420 * remains there until all outstanding data has been
5421 * acknowledged by its peer. The endpoint accepts no new data
5422 * from its upper layer, but retransmits data to the far end
5423 * if necessary to fill gaps.
5425 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
5426 SCTP_STATE(SCTP_STATE_SHUTDOWN_PENDING));
5428 /* sctpimpguide-05 Section 2.12.2
5429 * The sender of the SHUTDOWN MAY also start an overall guard timer
5430 * 'T5-shutdown-guard' to bound the overall time for shutdown sequence.
5432 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_START,
5433 SCTP_TO(SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD));
5434 disposition = SCTP_DISPOSITION_CONSUME;
5435 if (sctp_outq_is_empty(&asoc->outqueue)) {
5436 disposition = sctp_sf_do_9_2_start_shutdown(ep, asoc, type,
5442 /*****************************************************************************
5443 * These are sa state functions which could apply to all types of events.
5444 ****************************************************************************/
5447 * This table entry is not implemented.
5450 * (endpoint, asoc, chunk)
5452 * The return value is the disposition of the chunk.
5454 sctp_disposition_t sctp_sf_not_impl(const struct sctp_endpoint *ep,
5455 const struct sctp_association *asoc,
5456 const sctp_subtype_t type,
5458 sctp_cmd_seq_t *commands)
5460 return SCTP_DISPOSITION_NOT_IMPL;
5464 * This table entry represents a bug.
5467 * (endpoint, asoc, chunk)
5469 * The return value is the disposition of the chunk.
5471 sctp_disposition_t sctp_sf_bug(const struct sctp_endpoint *ep,
5472 const struct sctp_association *asoc,
5473 const sctp_subtype_t type,
5475 sctp_cmd_seq_t *commands)
5477 return SCTP_DISPOSITION_BUG;
5481 * This table entry represents the firing of a timer in the wrong state.
5482 * Since timer deletion cannot be guaranteed a timer 'may' end up firing
5483 * when the association is in the wrong state. This event should
5484 * be ignored, so as to prevent any rearming of the timer.
5487 * (endpoint, asoc, chunk)
5489 * The return value is the disposition of the chunk.
5491 sctp_disposition_t sctp_sf_timer_ignore(const struct sctp_endpoint *ep,
5492 const struct sctp_association *asoc,
5493 const sctp_subtype_t type,
5495 sctp_cmd_seq_t *commands)
5497 SCTP_DEBUG_PRINTK("Timer %d ignored.\n", type.chunk);
5498 return SCTP_DISPOSITION_CONSUME;
5501 /********************************************************************
5502 * 2nd Level Abstractions
5503 ********************************************************************/
5505 /* Pull the SACK chunk based on the SACK header. */
5506 static struct sctp_sackhdr *sctp_sm_pull_sack(struct sctp_chunk *chunk)
5508 struct sctp_sackhdr *sack;
5513 /* Protect ourselves from reading too far into
5514 * the skb from a bogus sender.
5516 sack = (struct sctp_sackhdr *) chunk->skb->data;
5518 num_blocks = ntohs(sack->num_gap_ack_blocks);
5519 num_dup_tsns = ntohs(sack->num_dup_tsns);
5520 len = sizeof(struct sctp_sackhdr);
5521 len += (num_blocks + num_dup_tsns) * sizeof(__u32);
5522 if (len > chunk->skb->len)
5525 skb_pull(chunk->skb, len);
5530 /* Create an ABORT packet to be sent as a response, with the specified
5533 static struct sctp_packet *sctp_abort_pkt_new(const struct sctp_endpoint *ep,
5534 const struct sctp_association *asoc,
5535 struct sctp_chunk *chunk,
5536 const void *payload,
5539 struct sctp_packet *packet;
5540 struct sctp_chunk *abort;
5542 packet = sctp_ootb_pkt_new(asoc, chunk);
5546 * The T bit will be set if the asoc is NULL.
5548 abort = sctp_make_abort(asoc, chunk, paylen);
5550 sctp_ootb_pkt_free(packet);
5554 /* Reflect vtag if T-Bit is set */
5555 if (sctp_test_T_bit(abort))
5556 packet->vtag = ntohl(chunk->sctp_hdr->vtag);
5558 /* Add specified error causes, i.e., payload, to the
5561 sctp_addto_chunk(abort, paylen, payload);
5563 /* Set the skb to the belonging sock for accounting. */
5564 abort->skb->sk = ep->base.sk;
5566 sctp_packet_append_chunk(packet, abort);
5573 /* Allocate a packet for responding in the OOTB conditions. */
5574 static struct sctp_packet *sctp_ootb_pkt_new(const struct sctp_association *asoc,
5575 const struct sctp_chunk *chunk)
5577 struct sctp_packet *packet;
5578 struct sctp_transport *transport;
5583 /* Get the source and destination port from the inbound packet. */
5584 sport = ntohs(chunk->sctp_hdr->dest);
5585 dport = ntohs(chunk->sctp_hdr->source);
5587 /* The V-tag is going to be the same as the inbound packet if no
5588 * association exists, otherwise, use the peer's vtag.
5591 /* Special case the INIT-ACK as there is no peer's vtag
5594 switch(chunk->chunk_hdr->type) {
5595 case SCTP_CID_INIT_ACK:
5597 sctp_initack_chunk_t *initack;
5599 initack = (sctp_initack_chunk_t *)chunk->chunk_hdr;
5600 vtag = ntohl(initack->init_hdr.init_tag);
5604 vtag = asoc->peer.i.init_tag;
5608 /* Special case the INIT and stale COOKIE_ECHO as there is no
5611 switch(chunk->chunk_hdr->type) {
5614 sctp_init_chunk_t *init;
5616 init = (sctp_init_chunk_t *)chunk->chunk_hdr;
5617 vtag = ntohl(init->init_hdr.init_tag);
5621 vtag = ntohl(chunk->sctp_hdr->vtag);
5626 /* Make a transport for the bucket, Eliza... */
5627 transport = sctp_transport_new(sctp_source(chunk), GFP_ATOMIC);
5631 /* Cache a route for the transport with the chunk's destination as
5632 * the source address.
5634 sctp_transport_route(transport, (union sctp_addr *)&chunk->dest,
5635 sctp_sk(sctp_get_ctl_sock()));
5637 packet = sctp_packet_init(&transport->packet, transport, sport, dport);
5638 packet = sctp_packet_config(packet, vtag, 0);
5646 /* Free the packet allocated earlier for responding in the OOTB condition. */
5647 void sctp_ootb_pkt_free(struct sctp_packet *packet)
5649 sctp_transport_free(packet->transport);
5652 /* Send a stale cookie error when a invalid COOKIE ECHO chunk is found */
5653 static void sctp_send_stale_cookie_err(const struct sctp_endpoint *ep,
5654 const struct sctp_association *asoc,
5655 const struct sctp_chunk *chunk,
5656 sctp_cmd_seq_t *commands,
5657 struct sctp_chunk *err_chunk)
5659 struct sctp_packet *packet;
5662 packet = sctp_ootb_pkt_new(asoc, chunk);
5664 struct sctp_signed_cookie *cookie;
5666 /* Override the OOTB vtag from the cookie. */
5667 cookie = chunk->subh.cookie_hdr;
5668 packet->vtag = cookie->c.peer_vtag;
5670 /* Set the skb to the belonging sock for accounting. */
5671 err_chunk->skb->sk = ep->base.sk;
5672 sctp_packet_append_chunk(packet, err_chunk);
5673 sctp_add_cmd_sf(commands, SCTP_CMD_SEND_PKT,
5674 SCTP_PACKET(packet));
5675 SCTP_INC_STATS(SCTP_MIB_OUTCTRLCHUNKS);
5677 sctp_chunk_free (err_chunk);
5682 /* Process a data chunk */
5683 static int sctp_eat_data(const struct sctp_association *asoc,
5684 struct sctp_chunk *chunk,
5685 sctp_cmd_seq_t *commands)
5687 sctp_datahdr_t *data_hdr;
5688 struct sctp_chunk *err;
5690 sctp_verb_t deliver;
5693 struct sctp_tsnmap *map = (struct sctp_tsnmap *)&asoc->peer.tsn_map;
5694 struct sock *sk = asoc->base.sk;
5696 data_hdr = chunk->subh.data_hdr = (sctp_datahdr_t *)chunk->skb->data;
5697 skb_pull(chunk->skb, sizeof(sctp_datahdr_t));
5699 tsn = ntohl(data_hdr->tsn);
5700 SCTP_DEBUG_PRINTK("eat_data: TSN 0x%x.\n", tsn);
5702 /* ASSERT: Now skb->data is really the user data. */
5704 /* Process ECN based congestion.
5706 * Since the chunk structure is reused for all chunks within
5707 * a packet, we use ecn_ce_done to track if we've already
5708 * done CE processing for this packet.
5710 * We need to do ECN processing even if we plan to discard the
5714 if (!chunk->ecn_ce_done) {
5716 chunk->ecn_ce_done = 1;
5718 af = sctp_get_af_specific(
5719 ipver2af(ip_hdr(chunk->skb)->version));
5721 if (af && af->is_ce(chunk->skb) && asoc->peer.ecn_capable) {
5722 /* Do real work as sideffect. */
5723 sctp_add_cmd_sf(commands, SCTP_CMD_ECN_CE,
5728 tmp = sctp_tsnmap_check(&asoc->peer.tsn_map, tsn);
5730 /* The TSN is too high--silently discard the chunk and
5731 * count on it getting retransmitted later.
5733 return SCTP_IERROR_HIGH_TSN;
5734 } else if (tmp > 0) {
5735 /* This is a duplicate. Record it. */
5736 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_DUP, SCTP_U32(tsn));
5737 return SCTP_IERROR_DUP_TSN;
5740 /* This is a new TSN. */
5742 /* Discard if there is no room in the receive window.
5743 * Actually, allow a little bit of overflow (up to a MTU).
5745 datalen = ntohs(chunk->chunk_hdr->length);
5746 datalen -= sizeof(sctp_data_chunk_t);
5748 deliver = SCTP_CMD_CHUNK_ULP;
5750 /* Think about partial delivery. */
5751 if ((datalen >= asoc->rwnd) && (!asoc->ulpq.pd_mode)) {
5753 /* Even if we don't accept this chunk there is
5756 sctp_add_cmd_sf(commands, SCTP_CMD_PART_DELIVER, SCTP_NULL());
5759 /* Spill over rwnd a little bit. Note: While allowed, this spill over
5760 * seems a bit troublesome in that frag_point varies based on
5761 * PMTU. In cases, such as loopback, this might be a rather
5764 if ((!chunk->data_accepted) && (!asoc->rwnd || asoc->rwnd_over ||
5765 (datalen > asoc->rwnd + asoc->frag_point))) {
5767 /* If this is the next TSN, consider reneging to make
5768 * room. Note: Playing nice with a confused sender. A
5769 * malicious sender can still eat up all our buffer
5770 * space and in the future we may want to detect and
5771 * do more drastic reneging.
5773 if (sctp_tsnmap_has_gap(map) &&
5774 (sctp_tsnmap_get_ctsn(map) + 1) == tsn) {
5775 SCTP_DEBUG_PRINTK("Reneging for tsn:%u\n", tsn);
5776 deliver = SCTP_CMD_RENEGE;
5778 SCTP_DEBUG_PRINTK("Discard tsn: %u len: %Zd, "
5779 "rwnd: %d\n", tsn, datalen,
5781 return SCTP_IERROR_IGNORE_TSN;
5786 * Also try to renege to limit our memory usage in the event that
5787 * we are under memory pressure
5788 * If we can't renege, don't worry about it, the sk_stream_rmem_schedule
5789 * in sctp_ulpevent_make_rcvmsg will drop the frame if we grow our
5790 * memory usage too much
5792 if (*sk->sk_prot_creator->memory_pressure) {
5793 if (sctp_tsnmap_has_gap(map) &&
5794 (sctp_tsnmap_get_ctsn(map) + 1) == tsn) {
5795 SCTP_DEBUG_PRINTK("Under Pressure! Reneging for tsn:%u\n", tsn);
5796 deliver = SCTP_CMD_RENEGE;
5801 * Section 3.3.10.9 No User Data (9)
5805 * No User Data: This error cause is returned to the originator of a
5806 * DATA chunk if a received DATA chunk has no user data.
5808 if (unlikely(0 == datalen)) {
5809 err = sctp_make_abort_no_data(asoc, chunk, tsn);
5811 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
5814 /* We are going to ABORT, so we might as well stop
5815 * processing the rest of the chunks in the packet.
5817 sctp_add_cmd_sf(commands, SCTP_CMD_DISCARD_PACKET,SCTP_NULL());
5818 sctp_add_cmd_sf(commands, SCTP_CMD_SET_SK_ERR,
5819 SCTP_ERROR(ECONNABORTED));
5820 sctp_add_cmd_sf(commands, SCTP_CMD_ASSOC_FAILED,
5821 SCTP_PERR(SCTP_ERROR_NO_DATA));
5822 SCTP_INC_STATS(SCTP_MIB_ABORTEDS);
5823 SCTP_DEC_STATS(SCTP_MIB_CURRESTAB);
5824 return SCTP_IERROR_NO_DATA;
5827 /* If definately accepting the DATA chunk, record its TSN, otherwise
5828 * wait for renege processing.
5830 if (SCTP_CMD_CHUNK_ULP == deliver)
5831 sctp_add_cmd_sf(commands, SCTP_CMD_REPORT_TSN, SCTP_U32(tsn));
5833 chunk->data_accepted = 1;
5835 /* Note: Some chunks may get overcounted (if we drop) or overcounted
5836 * if we renege and the chunk arrives again.
5838 if (chunk->chunk_hdr->flags & SCTP_DATA_UNORDERED)
5839 SCTP_INC_STATS(SCTP_MIB_INUNORDERCHUNKS);
5841 SCTP_INC_STATS(SCTP_MIB_INORDERCHUNKS);
5843 /* RFC 2960 6.5 Stream Identifier and Stream Sequence Number
5845 * If an endpoint receive a DATA chunk with an invalid stream
5846 * identifier, it shall acknowledge the reception of the DATA chunk
5847 * following the normal procedure, immediately send an ERROR chunk
5848 * with cause set to "Invalid Stream Identifier" (See Section 3.3.10)
5849 * and discard the DATA chunk.
5851 if (ntohs(data_hdr->stream) >= asoc->c.sinit_max_instreams) {
5852 err = sctp_make_op_error(asoc, chunk, SCTP_ERROR_INV_STRM,
5854 sizeof(data_hdr->stream));
5856 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
5858 return SCTP_IERROR_BAD_STREAM;
5861 /* Send the data up to the user. Note: Schedule the
5862 * SCTP_CMD_CHUNK_ULP cmd before the SCTP_CMD_GEN_SACK, as the SACK
5863 * chunk needs the updated rwnd.
5865 sctp_add_cmd_sf(commands, deliver, SCTP_CHUNK(chunk));
5867 return SCTP_IERROR_NO_ERROR;