Loading...
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/* SCTP kernel implementation
3 * (C) Copyright IBM Corp. 2001, 2004
4 * Copyright (c) 1999-2000 Cisco, Inc.
5 * Copyright (c) 1999-2001 Motorola, Inc.
6 * Copyright (c) 2001 Intel Corp.
7 *
8 * This file is part of the SCTP kernel implementation
9 *
10 * These are definitions needed by the state machine.
11 *
12 * Please send any bug reports or fixes you make to the
13 * email addresses:
14 * lksctp developers <linux-sctp@vger.kernel.org>
15 *
16 * Written or modified by:
17 * La Monte H.P. Yarroll <piggy@acm.org>
18 * Karl Knutson <karl@athena.chicago.il.us>
19 * Xingang Guo <xingang.guo@intel.com>
20 * Jon Grimm <jgrimm@us.ibm.com>
21 * Dajiang Zhang <dajiang.zhang@nokia.com>
22 * Sridhar Samudrala <sri@us.ibm.com>
23 * Daisy Chang <daisyc@us.ibm.com>
24 * Ardelle Fan <ardelle.fan@intel.com>
25 * Kevin Gao <kevin.gao@intel.com>
26 */
27
28#include <linux/types.h>
29#include <linux/compiler.h>
30#include <linux/slab.h>
31#include <linux/in.h>
32#include <net/sctp/command.h>
33#include <net/sctp/sctp.h>
34
35#ifndef __sctp_sm_h__
36#define __sctp_sm_h__
37
38/*
39 * Possible values for the disposition are:
40 */
41enum sctp_disposition {
42 SCTP_DISPOSITION_DISCARD, /* No further processing. */
43 SCTP_DISPOSITION_CONSUME, /* Process return values normally. */
44 SCTP_DISPOSITION_NOMEM, /* We ran out of memory--recover. */
45 SCTP_DISPOSITION_DELETE_TCB, /* Close the association. */
46 SCTP_DISPOSITION_ABORT, /* Close the association NOW. */
47 SCTP_DISPOSITION_VIOLATION, /* The peer is misbehaving. */
48 SCTP_DISPOSITION_NOT_IMPL, /* This entry is not implemented. */
49 SCTP_DISPOSITION_ERROR, /* This is plain old user error. */
50 SCTP_DISPOSITION_BUG, /* This is a bug. */
51};
52
53typedef enum sctp_disposition (sctp_state_fn_t) (
54 struct net *net,
55 const struct sctp_endpoint *ep,
56 const struct sctp_association *asoc,
57 const union sctp_subtype type,
58 void *arg,
59 struct sctp_cmd_seq *commands);
60typedef void (sctp_timer_event_t) (struct timer_list *);
61struct sctp_sm_table_entry {
62 sctp_state_fn_t *fn;
63 const char *name;
64};
65
66/* A naming convention of "sctp_sf_xxx" applies to all the state functions
67 * currently in use.
68 */
69
70/* Prototypes for generic state functions. */
71sctp_state_fn_t sctp_sf_not_impl;
72sctp_state_fn_t sctp_sf_bug;
73
74/* Prototypes for gener timer state functions. */
75sctp_state_fn_t sctp_sf_timer_ignore;
76
77/* Prototypes for chunk state functions. */
78sctp_state_fn_t sctp_sf_do_9_1_abort;
79sctp_state_fn_t sctp_sf_cookie_wait_abort;
80sctp_state_fn_t sctp_sf_cookie_echoed_abort;
81sctp_state_fn_t sctp_sf_shutdown_pending_abort;
82sctp_state_fn_t sctp_sf_shutdown_sent_abort;
83sctp_state_fn_t sctp_sf_shutdown_ack_sent_abort;
84sctp_state_fn_t sctp_sf_do_5_1B_init;
85sctp_state_fn_t sctp_sf_do_5_1C_ack;
86sctp_state_fn_t sctp_sf_do_5_1D_ce;
87sctp_state_fn_t sctp_sf_do_5_1E_ca;
88sctp_state_fn_t sctp_sf_do_4_C;
89sctp_state_fn_t sctp_sf_eat_data_6_2;
90sctp_state_fn_t sctp_sf_eat_data_fast_4_4;
91sctp_state_fn_t sctp_sf_eat_sack_6_2;
92sctp_state_fn_t sctp_sf_operr_notify;
93sctp_state_fn_t sctp_sf_t1_init_timer_expire;
94sctp_state_fn_t sctp_sf_t1_cookie_timer_expire;
95sctp_state_fn_t sctp_sf_t2_timer_expire;
96sctp_state_fn_t sctp_sf_t4_timer_expire;
97sctp_state_fn_t sctp_sf_t5_timer_expire;
98sctp_state_fn_t sctp_sf_sendbeat_8_3;
99sctp_state_fn_t sctp_sf_beat_8_3;
100sctp_state_fn_t sctp_sf_backbeat_8_3;
101sctp_state_fn_t sctp_sf_do_9_2_final;
102sctp_state_fn_t sctp_sf_do_9_2_shutdown;
103sctp_state_fn_t sctp_sf_do_9_2_shut_ctsn;
104sctp_state_fn_t sctp_sf_do_ecn_cwr;
105sctp_state_fn_t sctp_sf_do_ecne;
106sctp_state_fn_t sctp_sf_ootb;
107sctp_state_fn_t sctp_sf_pdiscard;
108sctp_state_fn_t sctp_sf_violation;
109sctp_state_fn_t sctp_sf_discard_chunk;
110sctp_state_fn_t sctp_sf_do_5_2_1_siminit;
111sctp_state_fn_t sctp_sf_do_5_2_2_dupinit;
112sctp_state_fn_t sctp_sf_do_5_2_3_initack;
113sctp_state_fn_t sctp_sf_do_5_2_4_dupcook;
114sctp_state_fn_t sctp_sf_unk_chunk;
115sctp_state_fn_t sctp_sf_do_8_5_1_E_sa;
116sctp_state_fn_t sctp_sf_cookie_echoed_err;
117sctp_state_fn_t sctp_sf_do_asconf;
118sctp_state_fn_t sctp_sf_do_asconf_ack;
119sctp_state_fn_t sctp_sf_do_reconf;
120sctp_state_fn_t sctp_sf_do_9_2_reshutack;
121sctp_state_fn_t sctp_sf_eat_fwd_tsn;
122sctp_state_fn_t sctp_sf_eat_fwd_tsn_fast;
123sctp_state_fn_t sctp_sf_eat_auth;
124
125/* Prototypes for primitive event state functions. */
126sctp_state_fn_t sctp_sf_do_prm_asoc;
127sctp_state_fn_t sctp_sf_do_prm_send;
128sctp_state_fn_t sctp_sf_do_9_2_prm_shutdown;
129sctp_state_fn_t sctp_sf_cookie_wait_prm_shutdown;
130sctp_state_fn_t sctp_sf_cookie_echoed_prm_shutdown;
131sctp_state_fn_t sctp_sf_do_9_1_prm_abort;
132sctp_state_fn_t sctp_sf_cookie_wait_prm_abort;
133sctp_state_fn_t sctp_sf_cookie_echoed_prm_abort;
134sctp_state_fn_t sctp_sf_shutdown_pending_prm_abort;
135sctp_state_fn_t sctp_sf_shutdown_sent_prm_abort;
136sctp_state_fn_t sctp_sf_shutdown_ack_sent_prm_abort;
137sctp_state_fn_t sctp_sf_error_closed;
138sctp_state_fn_t sctp_sf_error_shutdown;
139sctp_state_fn_t sctp_sf_ignore_primitive;
140sctp_state_fn_t sctp_sf_do_prm_requestheartbeat;
141sctp_state_fn_t sctp_sf_do_prm_asconf;
142sctp_state_fn_t sctp_sf_do_prm_reconf;
143
144/* Prototypes for other event state functions. */
145sctp_state_fn_t sctp_sf_do_no_pending_tsn;
146sctp_state_fn_t sctp_sf_do_9_2_start_shutdown;
147sctp_state_fn_t sctp_sf_do_9_2_shutdown_ack;
148sctp_state_fn_t sctp_sf_ignore_other;
149sctp_state_fn_t sctp_sf_cookie_wait_icmp_abort;
150
151/* Prototypes for timeout event state functions. */
152sctp_state_fn_t sctp_sf_do_6_3_3_rtx;
153sctp_state_fn_t sctp_sf_send_reconf;
154sctp_state_fn_t sctp_sf_do_6_2_sack;
155sctp_state_fn_t sctp_sf_autoclose_timer_expire;
156
157/* Prototypes for utility support functions. */
158__u8 sctp_get_chunk_type(struct sctp_chunk *chunk);
159const struct sctp_sm_table_entry *sctp_sm_lookup_event(
160 struct net *net,
161 enum sctp_event_type event_type,
162 enum sctp_state state,
163 union sctp_subtype event_subtype);
164int sctp_chunk_iif(const struct sctp_chunk *);
165struct sctp_association *sctp_make_temp_asoc(const struct sctp_endpoint *,
166 struct sctp_chunk *,
167 gfp_t gfp);
168__u32 sctp_generate_verification_tag(void);
169void sctp_populate_tie_tags(__u8 *cookie, __u32 curTag, __u32 hisTag);
170
171/* Prototypes for chunk-building functions. */
172struct sctp_chunk *sctp_make_init(const struct sctp_association *asoc,
173 const struct sctp_bind_addr *bp,
174 gfp_t gfp, int vparam_len);
175struct sctp_chunk *sctp_make_init_ack(const struct sctp_association *asoc,
176 const struct sctp_chunk *chunk,
177 const gfp_t gfp, const int unkparam_len);
178struct sctp_chunk *sctp_make_cookie_echo(const struct sctp_association *asoc,
179 const struct sctp_chunk *chunk);
180struct sctp_chunk *sctp_make_cookie_ack(const struct sctp_association *asoc,
181 const struct sctp_chunk *chunk);
182struct sctp_chunk *sctp_make_cwr(const struct sctp_association *asoc,
183 const __u32 lowest_tsn,
184 const struct sctp_chunk *chunk);
185struct sctp_chunk *sctp_make_idata(const struct sctp_association *asoc,
186 __u8 flags, int paylen, gfp_t gfp);
187struct sctp_chunk *sctp_make_ifwdtsn(const struct sctp_association *asoc,
188 __u32 new_cum_tsn, size_t nstreams,
189 struct sctp_ifwdtsn_skip *skiplist);
190struct sctp_chunk *sctp_make_datafrag_empty(const struct sctp_association *asoc,
191 const struct sctp_sndrcvinfo *sinfo,
192 int len, __u8 flags, gfp_t gfp);
193struct sctp_chunk *sctp_make_ecne(const struct sctp_association *asoc,
194 const __u32 lowest_tsn);
195struct sctp_chunk *sctp_make_sack(struct sctp_association *asoc);
196struct sctp_chunk *sctp_make_shutdown(const struct sctp_association *asoc,
197 const struct sctp_chunk *chunk);
198struct sctp_chunk *sctp_make_shutdown_ack(const struct sctp_association *asoc,
199 const struct sctp_chunk *chunk);
200struct sctp_chunk *sctp_make_shutdown_complete(
201 const struct sctp_association *asoc,
202 const struct sctp_chunk *chunk);
203int sctp_init_cause(struct sctp_chunk *chunk, __be16 cause, size_t paylen);
204struct sctp_chunk *sctp_make_abort(const struct sctp_association *asoc,
205 const struct sctp_chunk *chunk,
206 const size_t hint);
207struct sctp_chunk *sctp_make_abort_no_data(const struct sctp_association *asoc,
208 const struct sctp_chunk *chunk,
209 __u32 tsn);
210struct sctp_chunk *sctp_make_abort_user(const struct sctp_association *asoc,
211 struct msghdr *msg, size_t msg_len);
212struct sctp_chunk *sctp_make_abort_violation(
213 const struct sctp_association *asoc,
214 const struct sctp_chunk *chunk,
215 const __u8 *payload,
216 const size_t paylen);
217struct sctp_chunk *sctp_make_violation_paramlen(
218 const struct sctp_association *asoc,
219 const struct sctp_chunk *chunk,
220 struct sctp_paramhdr *param);
221struct sctp_chunk *sctp_make_violation_max_retrans(
222 const struct sctp_association *asoc,
223 const struct sctp_chunk *chunk);
224struct sctp_chunk *sctp_make_heartbeat(const struct sctp_association *asoc,
225 const struct sctp_transport *transport);
226struct sctp_chunk *sctp_make_heartbeat_ack(const struct sctp_association *asoc,
227 const struct sctp_chunk *chunk,
228 const void *payload,
229 const size_t paylen);
230struct sctp_chunk *sctp_make_op_error(const struct sctp_association *asoc,
231 const struct sctp_chunk *chunk,
232 __be16 cause_code, const void *payload,
233 size_t paylen, size_t reserve_tail);
234
235struct sctp_chunk *sctp_make_asconf_update_ip(struct sctp_association *asoc,
236 union sctp_addr *laddr,
237 struct sockaddr *addrs,
238 int addrcnt, __be16 flags);
239struct sctp_chunk *sctp_make_asconf_set_prim(struct sctp_association *asoc,
240 union sctp_addr *addr);
241bool sctp_verify_asconf(const struct sctp_association *asoc,
242 struct sctp_chunk *chunk, bool addr_param_needed,
243 struct sctp_paramhdr **errp);
244struct sctp_chunk *sctp_process_asconf(struct sctp_association *asoc,
245 struct sctp_chunk *asconf);
246int sctp_process_asconf_ack(struct sctp_association *asoc,
247 struct sctp_chunk *asconf_ack);
248struct sctp_chunk *sctp_make_fwdtsn(const struct sctp_association *asoc,
249 __u32 new_cum_tsn, size_t nstreams,
250 struct sctp_fwdtsn_skip *skiplist);
251struct sctp_chunk *sctp_make_auth(const struct sctp_association *asoc,
252 __u16 key_id);
253struct sctp_chunk *sctp_make_strreset_req(const struct sctp_association *asoc,
254 __u16 stream_num, __be16 *stream_list,
255 bool out, bool in);
256struct sctp_chunk *sctp_make_strreset_tsnreq(
257 const struct sctp_association *asoc);
258struct sctp_chunk *sctp_make_strreset_addstrm(
259 const struct sctp_association *asoc,
260 __u16 out, __u16 in);
261struct sctp_chunk *sctp_make_strreset_resp(const struct sctp_association *asoc,
262 __u32 result, __u32 sn);
263struct sctp_chunk *sctp_make_strreset_tsnresp(struct sctp_association *asoc,
264 __u32 result, __u32 sn,
265 __u32 sender_tsn,
266 __u32 receiver_tsn);
267bool sctp_verify_reconf(const struct sctp_association *asoc,
268 struct sctp_chunk *chunk,
269 struct sctp_paramhdr **errp);
270void sctp_chunk_assign_tsn(struct sctp_chunk *chunk);
271void sctp_chunk_assign_ssn(struct sctp_chunk *chunk);
272
273/* Prototypes for stream-processing functions. */
274struct sctp_chunk *sctp_process_strreset_outreq(
275 struct sctp_association *asoc,
276 union sctp_params param,
277 struct sctp_ulpevent **evp);
278struct sctp_chunk *sctp_process_strreset_inreq(
279 struct sctp_association *asoc,
280 union sctp_params param,
281 struct sctp_ulpevent **evp);
282struct sctp_chunk *sctp_process_strreset_tsnreq(
283 struct sctp_association *asoc,
284 union sctp_params param,
285 struct sctp_ulpevent **evp);
286struct sctp_chunk *sctp_process_strreset_addstrm_out(
287 struct sctp_association *asoc,
288 union sctp_params param,
289 struct sctp_ulpevent **evp);
290struct sctp_chunk *sctp_process_strreset_addstrm_in(
291 struct sctp_association *asoc,
292 union sctp_params param,
293 struct sctp_ulpevent **evp);
294struct sctp_chunk *sctp_process_strreset_resp(
295 struct sctp_association *asoc,
296 union sctp_params param,
297 struct sctp_ulpevent **evp);
298
299/* Prototypes for statetable processing. */
300
301int sctp_do_sm(struct net *net, enum sctp_event_type event_type,
302 union sctp_subtype subtype, enum sctp_state state,
303 struct sctp_endpoint *ep, struct sctp_association *asoc,
304 void *event_arg, gfp_t gfp);
305
306/* 2nd level prototypes */
307void sctp_generate_t3_rtx_event(struct timer_list *t);
308void sctp_generate_heartbeat_event(struct timer_list *t);
309void sctp_generate_reconf_event(struct timer_list *t);
310void sctp_generate_proto_unreach_event(struct timer_list *t);
311
312void sctp_ootb_pkt_free(struct sctp_packet *packet);
313
314struct sctp_association *sctp_unpack_cookie(
315 const struct sctp_endpoint *ep,
316 const struct sctp_association *asoc,
317 struct sctp_chunk *chunk,
318 gfp_t gfp, int *err,
319 struct sctp_chunk **err_chk_p);
320
321/* 3rd level prototypes */
322__u32 sctp_generate_tag(const struct sctp_endpoint *ep);
323__u32 sctp_generate_tsn(const struct sctp_endpoint *ep);
324
325/* Extern declarations for major data structures. */
326extern sctp_timer_event_t *sctp_timer_events[SCTP_NUM_TIMEOUT_TYPES];
327
328
329/* Get the size of a DATA chunk payload. */
330static inline __u16 sctp_data_size(struct sctp_chunk *chunk)
331{
332 __u16 size;
333
334 size = ntohs(chunk->chunk_hdr->length);
335 size -= sctp_datachk_len(&chunk->asoc->stream);
336
337 return size;
338}
339
340/* Compare two TSNs */
341#define TSN_lt(a,b) \
342 (typecheck(__u32, a) && \
343 typecheck(__u32, b) && \
344 ((__s32)((a) - (b)) < 0))
345
346#define TSN_lte(a,b) \
347 (typecheck(__u32, a) && \
348 typecheck(__u32, b) && \
349 ((__s32)((a) - (b)) <= 0))
350
351/* Compare two MIDs */
352#define MID_lt(a, b) \
353 (typecheck(__u32, a) && \
354 typecheck(__u32, b) && \
355 ((__s32)((a) - (b)) < 0))
356
357/* Compare two SSNs */
358#define SSN_lt(a,b) \
359 (typecheck(__u16, a) && \
360 typecheck(__u16, b) && \
361 ((__s16)((a) - (b)) < 0))
362
363/* ADDIP 3.1.1 */
364#define ADDIP_SERIAL_gte(a,b) \
365 (typecheck(__u32, a) && \
366 typecheck(__u32, b) && \
367 ((__s32)((b) - (a)) <= 0))
368
369/* Check VTAG of the packet matches the sender's own tag. */
370static inline int
371sctp_vtag_verify(const struct sctp_chunk *chunk,
372 const struct sctp_association *asoc)
373{
374 /* RFC 2960 Sec 8.5 When receiving an SCTP packet, the endpoint
375 * MUST ensure that the value in the Verification Tag field of
376 * the received SCTP packet matches its own Tag. If the received
377 * Verification Tag value does not match the receiver's own
378 * tag value, the receiver shall silently discard the packet...
379 */
380 if (ntohl(chunk->sctp_hdr->vtag) == asoc->c.my_vtag)
381 return 1;
382
383 return 0;
384}
385
386/* Check VTAG of the packet matches the sender's own tag and the T bit is
387 * not set, OR its peer's tag and the T bit is set in the Chunk Flags.
388 */
389static inline int
390sctp_vtag_verify_either(const struct sctp_chunk *chunk,
391 const struct sctp_association *asoc)
392{
393 /* RFC 2960 Section 8.5.1, sctpimpguide Section 2.41
394 *
395 * B) The receiver of a ABORT MUST accept the packet
396 * if the Verification Tag field of the packet matches its own tag
397 * and the T bit is not set
398 * OR
399 * it is set to its peer's tag and the T bit is set in the Chunk
400 * Flags.
401 * Otherwise, the receiver MUST silently discard the packet
402 * and take no further action.
403 *
404 * C) The receiver of a SHUTDOWN COMPLETE shall accept the packet
405 * if the Verification Tag field of the packet matches its own tag
406 * and the T bit is not set
407 * OR
408 * it is set to its peer's tag and the T bit is set in the Chunk
409 * Flags.
410 * Otherwise, the receiver MUST silently discard the packet
411 * and take no further action. An endpoint MUST ignore the
412 * SHUTDOWN COMPLETE if it is not in the SHUTDOWN-ACK-SENT state.
413 */
414 if ((!sctp_test_T_bit(chunk) &&
415 (ntohl(chunk->sctp_hdr->vtag) == asoc->c.my_vtag)) ||
416 (sctp_test_T_bit(chunk) && asoc->c.peer_vtag &&
417 (ntohl(chunk->sctp_hdr->vtag) == asoc->c.peer_vtag))) {
418 return 1;
419 }
420
421 return 0;
422}
423
424#endif /* __sctp_sm_h__ */
1/* SCTP kernel implementation
2 * (C) Copyright IBM Corp. 2001, 2004
3 * Copyright (c) 1999-2000 Cisco, Inc.
4 * Copyright (c) 1999-2001 Motorola, Inc.
5 * Copyright (c) 2001 Intel Corp.
6 *
7 * This file is part of the SCTP kernel implementation
8 *
9 * These are definitions needed by the state machine.
10 *
11 * This SCTP implementation is free software;
12 * you can redistribute it and/or modify it under the terms of
13 * the GNU General Public License as published by
14 * the Free Software Foundation; either version 2, or (at your option)
15 * any later version.
16 *
17 * This SCTP implementation is distributed in the hope that it
18 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
19 * ************************
20 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
21 * See the GNU General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License
24 * along with GNU CC; see the file COPYING. If not, see
25 * <http://www.gnu.org/licenses/>.
26 *
27 * Please send any bug reports or fixes you make to the
28 * email addresses:
29 * lksctp developers <linux-sctp@vger.kernel.org>
30 *
31 * Written or modified by:
32 * La Monte H.P. Yarroll <piggy@acm.org>
33 * Karl Knutson <karl@athena.chicago.il.us>
34 * Xingang Guo <xingang.guo@intel.com>
35 * Jon Grimm <jgrimm@us.ibm.com>
36 * Dajiang Zhang <dajiang.zhang@nokia.com>
37 * Sridhar Samudrala <sri@us.ibm.com>
38 * Daisy Chang <daisyc@us.ibm.com>
39 * Ardelle Fan <ardelle.fan@intel.com>
40 * Kevin Gao <kevin.gao@intel.com>
41 */
42
43#include <linux/types.h>
44#include <linux/compiler.h>
45#include <linux/slab.h>
46#include <linux/in.h>
47#include <net/sctp/command.h>
48#include <net/sctp/sctp.h>
49
50#ifndef __sctp_sm_h__
51#define __sctp_sm_h__
52
53/*
54 * Possible values for the disposition are:
55 */
56typedef enum {
57 SCTP_DISPOSITION_DISCARD, /* No further processing. */
58 SCTP_DISPOSITION_CONSUME, /* Process return values normally. */
59 SCTP_DISPOSITION_NOMEM, /* We ran out of memory--recover. */
60 SCTP_DISPOSITION_DELETE_TCB, /* Close the association. */
61 SCTP_DISPOSITION_ABORT, /* Close the association NOW. */
62 SCTP_DISPOSITION_VIOLATION, /* The peer is misbehaving. */
63 SCTP_DISPOSITION_NOT_IMPL, /* This entry is not implemented. */
64 SCTP_DISPOSITION_ERROR, /* This is plain old user error. */
65 SCTP_DISPOSITION_BUG, /* This is a bug. */
66} sctp_disposition_t;
67
68typedef struct {
69 int name;
70 int action;
71} sctp_sm_command_t;
72
73typedef sctp_disposition_t (sctp_state_fn_t) (struct net *,
74 const struct sctp_endpoint *,
75 const struct sctp_association *,
76 const sctp_subtype_t type,
77 void *arg,
78 sctp_cmd_seq_t *);
79typedef void (sctp_timer_event_t) (unsigned long);
80typedef struct {
81 sctp_state_fn_t *fn;
82 const char *name;
83} sctp_sm_table_entry_t;
84
85/* A naming convention of "sctp_sf_xxx" applies to all the state functions
86 * currently in use.
87 */
88
89/* Prototypes for generic state functions. */
90sctp_state_fn_t sctp_sf_not_impl;
91sctp_state_fn_t sctp_sf_bug;
92
93/* Prototypes for gener timer state functions. */
94sctp_state_fn_t sctp_sf_timer_ignore;
95
96/* Prototypes for chunk state functions. */
97sctp_state_fn_t sctp_sf_do_9_1_abort;
98sctp_state_fn_t sctp_sf_cookie_wait_abort;
99sctp_state_fn_t sctp_sf_cookie_echoed_abort;
100sctp_state_fn_t sctp_sf_shutdown_pending_abort;
101sctp_state_fn_t sctp_sf_shutdown_sent_abort;
102sctp_state_fn_t sctp_sf_shutdown_ack_sent_abort;
103sctp_state_fn_t sctp_sf_do_5_1B_init;
104sctp_state_fn_t sctp_sf_do_5_1C_ack;
105sctp_state_fn_t sctp_sf_do_5_1D_ce;
106sctp_state_fn_t sctp_sf_do_5_1E_ca;
107sctp_state_fn_t sctp_sf_do_4_C;
108sctp_state_fn_t sctp_sf_eat_data_6_2;
109sctp_state_fn_t sctp_sf_eat_data_fast_4_4;
110sctp_state_fn_t sctp_sf_eat_sack_6_2;
111sctp_state_fn_t sctp_sf_operr_notify;
112sctp_state_fn_t sctp_sf_t1_init_timer_expire;
113sctp_state_fn_t sctp_sf_t1_cookie_timer_expire;
114sctp_state_fn_t sctp_sf_t2_timer_expire;
115sctp_state_fn_t sctp_sf_t4_timer_expire;
116sctp_state_fn_t sctp_sf_t5_timer_expire;
117sctp_state_fn_t sctp_sf_sendbeat_8_3;
118sctp_state_fn_t sctp_sf_beat_8_3;
119sctp_state_fn_t sctp_sf_backbeat_8_3;
120sctp_state_fn_t sctp_sf_do_9_2_final;
121sctp_state_fn_t sctp_sf_do_9_2_shutdown;
122sctp_state_fn_t sctp_sf_do_9_2_shut_ctsn;
123sctp_state_fn_t sctp_sf_do_ecn_cwr;
124sctp_state_fn_t sctp_sf_do_ecne;
125sctp_state_fn_t sctp_sf_ootb;
126sctp_state_fn_t sctp_sf_pdiscard;
127sctp_state_fn_t sctp_sf_violation;
128sctp_state_fn_t sctp_sf_discard_chunk;
129sctp_state_fn_t sctp_sf_do_5_2_1_siminit;
130sctp_state_fn_t sctp_sf_do_5_2_2_dupinit;
131sctp_state_fn_t sctp_sf_do_5_2_3_initack;
132sctp_state_fn_t sctp_sf_do_5_2_4_dupcook;
133sctp_state_fn_t sctp_sf_unk_chunk;
134sctp_state_fn_t sctp_sf_do_8_5_1_E_sa;
135sctp_state_fn_t sctp_sf_cookie_echoed_err;
136sctp_state_fn_t sctp_sf_do_asconf;
137sctp_state_fn_t sctp_sf_do_asconf_ack;
138sctp_state_fn_t sctp_sf_do_9_2_reshutack;
139sctp_state_fn_t sctp_sf_eat_fwd_tsn;
140sctp_state_fn_t sctp_sf_eat_fwd_tsn_fast;
141sctp_state_fn_t sctp_sf_eat_auth;
142
143/* Prototypes for primitive event state functions. */
144sctp_state_fn_t sctp_sf_do_prm_asoc;
145sctp_state_fn_t sctp_sf_do_prm_send;
146sctp_state_fn_t sctp_sf_do_9_2_prm_shutdown;
147sctp_state_fn_t sctp_sf_cookie_wait_prm_shutdown;
148sctp_state_fn_t sctp_sf_cookie_echoed_prm_shutdown;
149sctp_state_fn_t sctp_sf_do_9_1_prm_abort;
150sctp_state_fn_t sctp_sf_cookie_wait_prm_abort;
151sctp_state_fn_t sctp_sf_cookie_echoed_prm_abort;
152sctp_state_fn_t sctp_sf_shutdown_pending_prm_abort;
153sctp_state_fn_t sctp_sf_shutdown_sent_prm_abort;
154sctp_state_fn_t sctp_sf_shutdown_ack_sent_prm_abort;
155sctp_state_fn_t sctp_sf_error_closed;
156sctp_state_fn_t sctp_sf_error_shutdown;
157sctp_state_fn_t sctp_sf_ignore_primitive;
158sctp_state_fn_t sctp_sf_do_prm_requestheartbeat;
159sctp_state_fn_t sctp_sf_do_prm_asconf;
160
161/* Prototypes for other event state functions. */
162sctp_state_fn_t sctp_sf_do_no_pending_tsn;
163sctp_state_fn_t sctp_sf_do_9_2_start_shutdown;
164sctp_state_fn_t sctp_sf_do_9_2_shutdown_ack;
165sctp_state_fn_t sctp_sf_ignore_other;
166sctp_state_fn_t sctp_sf_cookie_wait_icmp_abort;
167
168/* Prototypes for timeout event state functions. */
169sctp_state_fn_t sctp_sf_do_6_3_3_rtx;
170sctp_state_fn_t sctp_sf_do_6_2_sack;
171sctp_state_fn_t sctp_sf_autoclose_timer_expire;
172
173/* Prototypes for utility support functions. */
174__u8 sctp_get_chunk_type(struct sctp_chunk *chunk);
175const sctp_sm_table_entry_t *sctp_sm_lookup_event(struct net *,
176 sctp_event_t,
177 sctp_state_t,
178 sctp_subtype_t);
179int sctp_chunk_iif(const struct sctp_chunk *);
180struct sctp_association *sctp_make_temp_asoc(const struct sctp_endpoint *,
181 struct sctp_chunk *,
182 gfp_t gfp);
183__u32 sctp_generate_verification_tag(void);
184void sctp_populate_tie_tags(__u8 *cookie, __u32 curTag, __u32 hisTag);
185
186/* Prototypes for chunk-building functions. */
187struct sctp_chunk *sctp_make_init(const struct sctp_association *,
188 const struct sctp_bind_addr *,
189 gfp_t gfp, int vparam_len);
190struct sctp_chunk *sctp_make_init_ack(const struct sctp_association *,
191 const struct sctp_chunk *,
192 const gfp_t gfp,
193 const int unkparam_len);
194struct sctp_chunk *sctp_make_cookie_echo(const struct sctp_association *,
195 const struct sctp_chunk *);
196struct sctp_chunk *sctp_make_cookie_ack(const struct sctp_association *,
197 const struct sctp_chunk *);
198struct sctp_chunk *sctp_make_cwr(const struct sctp_association *,
199 const __u32 lowest_tsn,
200 const struct sctp_chunk *);
201struct sctp_chunk * sctp_make_datafrag_empty(struct sctp_association *,
202 const struct sctp_sndrcvinfo *sinfo,
203 int len, const __u8 flags,
204 __u16 ssn, gfp_t gfp);
205struct sctp_chunk *sctp_make_ecne(const struct sctp_association *,
206 const __u32);
207struct sctp_chunk *sctp_make_sack(const struct sctp_association *);
208struct sctp_chunk *sctp_make_shutdown(const struct sctp_association *asoc,
209 const struct sctp_chunk *chunk);
210struct sctp_chunk *sctp_make_shutdown_ack(const struct sctp_association *asoc,
211 const struct sctp_chunk *);
212struct sctp_chunk *sctp_make_shutdown_complete(const struct sctp_association *,
213 const struct sctp_chunk *);
214void sctp_init_cause(struct sctp_chunk *, __be16 cause, size_t);
215struct sctp_chunk *sctp_make_abort(const struct sctp_association *,
216 const struct sctp_chunk *,
217 const size_t hint);
218struct sctp_chunk *sctp_make_abort_no_data(const struct sctp_association *,
219 const struct sctp_chunk *,
220 __u32 tsn);
221struct sctp_chunk *sctp_make_abort_user(const struct sctp_association *,
222 struct msghdr *, size_t msg_len);
223struct sctp_chunk *sctp_make_abort_violation(const struct sctp_association *,
224 const struct sctp_chunk *,
225 const __u8 *,
226 const size_t );
227struct sctp_chunk *sctp_make_violation_paramlen(const struct sctp_association *,
228 const struct sctp_chunk *,
229 struct sctp_paramhdr *);
230struct sctp_chunk *sctp_make_violation_max_retrans(const struct sctp_association *,
231 const struct sctp_chunk *);
232struct sctp_chunk *sctp_make_heartbeat(const struct sctp_association *,
233 const struct sctp_transport *);
234struct sctp_chunk *sctp_make_heartbeat_ack(const struct sctp_association *,
235 const struct sctp_chunk *,
236 const void *payload,
237 const size_t paylen);
238struct sctp_chunk *sctp_make_op_error(const struct sctp_association *,
239 const struct sctp_chunk *chunk,
240 __be16 cause_code,
241 const void *payload,
242 size_t paylen,
243 size_t reserve_tail);
244
245struct sctp_chunk *sctp_make_asconf_update_ip(struct sctp_association *,
246 union sctp_addr *,
247 struct sockaddr *,
248 int, __be16);
249struct sctp_chunk *sctp_make_asconf_set_prim(struct sctp_association *asoc,
250 union sctp_addr *addr);
251bool sctp_verify_asconf(const struct sctp_association *asoc,
252 struct sctp_chunk *chunk, bool addr_param_needed,
253 struct sctp_paramhdr **errp);
254struct sctp_chunk *sctp_process_asconf(struct sctp_association *asoc,
255 struct sctp_chunk *asconf);
256int sctp_process_asconf_ack(struct sctp_association *asoc,
257 struct sctp_chunk *asconf_ack);
258struct sctp_chunk *sctp_make_fwdtsn(const struct sctp_association *asoc,
259 __u32 new_cum_tsn, size_t nstreams,
260 struct sctp_fwdtsn_skip *skiplist);
261struct sctp_chunk *sctp_make_auth(const struct sctp_association *asoc);
262
263void sctp_chunk_assign_tsn(struct sctp_chunk *);
264void sctp_chunk_assign_ssn(struct sctp_chunk *);
265
266/* Prototypes for statetable processing. */
267
268int sctp_do_sm(struct net *net, sctp_event_t event_type, sctp_subtype_t subtype,
269 sctp_state_t state,
270 struct sctp_endpoint *,
271 struct sctp_association *asoc,
272 void *event_arg,
273 gfp_t gfp);
274
275/* 2nd level prototypes */
276void sctp_generate_t3_rtx_event(unsigned long peer);
277void sctp_generate_heartbeat_event(unsigned long peer);
278void sctp_generate_proto_unreach_event(unsigned long peer);
279
280void sctp_ootb_pkt_free(struct sctp_packet *);
281
282struct sctp_association *sctp_unpack_cookie(const struct sctp_endpoint *,
283 const struct sctp_association *,
284 struct sctp_chunk *,
285 gfp_t gfp, int *err,
286 struct sctp_chunk **err_chk_p);
287int sctp_addip_addr_config(struct sctp_association *, sctp_param_t,
288 struct sockaddr_storage*, int);
289
290/* 3rd level prototypes */
291__u32 sctp_generate_tag(const struct sctp_endpoint *);
292__u32 sctp_generate_tsn(const struct sctp_endpoint *);
293
294/* Extern declarations for major data structures. */
295extern sctp_timer_event_t *sctp_timer_events[SCTP_NUM_TIMEOUT_TYPES];
296
297
298/* Get the size of a DATA chunk payload. */
299static inline __u16 sctp_data_size(struct sctp_chunk *chunk)
300{
301 __u16 size;
302
303 size = ntohs(chunk->chunk_hdr->length);
304 size -= sizeof(sctp_data_chunk_t);
305
306 return size;
307}
308
309/* Compare two TSNs */
310#define TSN_lt(a,b) \
311 (typecheck(__u32, a) && \
312 typecheck(__u32, b) && \
313 ((__s32)((a) - (b)) < 0))
314
315#define TSN_lte(a,b) \
316 (typecheck(__u32, a) && \
317 typecheck(__u32, b) && \
318 ((__s32)((a) - (b)) <= 0))
319
320/* Compare two SSNs */
321#define SSN_lt(a,b) \
322 (typecheck(__u16, a) && \
323 typecheck(__u16, b) && \
324 ((__s16)((a) - (b)) < 0))
325
326/* ADDIP 3.1.1 */
327#define ADDIP_SERIAL_gte(a,b) \
328 (typecheck(__u32, a) && \
329 typecheck(__u32, b) && \
330 ((__s32)((b) - (a)) <= 0))
331
332/* Check VTAG of the packet matches the sender's own tag. */
333static inline int
334sctp_vtag_verify(const struct sctp_chunk *chunk,
335 const struct sctp_association *asoc)
336{
337 /* RFC 2960 Sec 8.5 When receiving an SCTP packet, the endpoint
338 * MUST ensure that the value in the Verification Tag field of
339 * the received SCTP packet matches its own Tag. If the received
340 * Verification Tag value does not match the receiver's own
341 * tag value, the receiver shall silently discard the packet...
342 */
343 if (ntohl(chunk->sctp_hdr->vtag) == asoc->c.my_vtag)
344 return 1;
345
346 return 0;
347}
348
349/* Check VTAG of the packet matches the sender's own tag and the T bit is
350 * not set, OR its peer's tag and the T bit is set in the Chunk Flags.
351 */
352static inline int
353sctp_vtag_verify_either(const struct sctp_chunk *chunk,
354 const struct sctp_association *asoc)
355{
356 /* RFC 2960 Section 8.5.1, sctpimpguide Section 2.41
357 *
358 * B) The receiver of a ABORT MUST accept the packet
359 * if the Verification Tag field of the packet matches its own tag
360 * and the T bit is not set
361 * OR
362 * it is set to its peer's tag and the T bit is set in the Chunk
363 * Flags.
364 * Otherwise, the receiver MUST silently discard the packet
365 * and take no further action.
366 *
367 * C) The receiver of a SHUTDOWN COMPLETE shall accept the packet
368 * if the Verification Tag field of the packet matches its own tag
369 * and the T bit is not set
370 * OR
371 * it is set to its peer's tag and the T bit is set in the Chunk
372 * Flags.
373 * Otherwise, the receiver MUST silently discard the packet
374 * and take no further action. An endpoint MUST ignore the
375 * SHUTDOWN COMPLETE if it is not in the SHUTDOWN-ACK-SENT state.
376 */
377 if ((!sctp_test_T_bit(chunk) &&
378 (ntohl(chunk->sctp_hdr->vtag) == asoc->c.my_vtag)) ||
379 (sctp_test_T_bit(chunk) && asoc->c.peer_vtag &&
380 (ntohl(chunk->sctp_hdr->vtag) == asoc->c.peer_vtag))) {
381 return 1;
382 }
383
384 return 0;
385}
386
387#endif /* __sctp_sm_h__ */