1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* SCTP kernel implementation
3 * (C) Copyright IBM Corp. 2001, 2003
4 * Copyright (c) Cisco 1999,2000
5 * Copyright (c) Motorola 1999,2000,2001
6 * Copyright (c) La Monte H.P. Yarroll 2001
8 * This file is part of the SCTP kernel implementation.
10 * A collection class to handle the storage of transport addresses.
12 * Please send any bug reports or fixes you make to the
14 * lksctp developers <linux-sctp@vger.kernel.org>
16 * Written or modified by:
17 * La Monte H.P. Yarroll <piggy@acm.org>
18 * Karl Knutson <karl@athena.chicago.il.us>
19 * Jon Grimm <jgrimm@us.ibm.com>
20 * Daisy Chang <daisyc@us.ibm.com>
23 #include <linux/types.h>
24 #include <linux/slab.h>
28 #include <net/if_inet6.h>
29 #include <net/sctp/sctp.h>
30 #include <net/sctp/sm.h>
32 /* Forward declarations for internal helpers. */
33 static int sctp_copy_one_addr(struct net
*net
, struct sctp_bind_addr
*dest
,
34 union sctp_addr
*addr
, enum sctp_scope scope
,
35 gfp_t gfp
, int flags
);
36 static void sctp_bind_addr_clean(struct sctp_bind_addr
*);
38 /* First Level Abstractions. */
40 /* Copy 'src' to 'dest' taking 'scope' into account. Omit addresses
41 * in 'src' which have a broader scope than 'scope'.
43 int sctp_bind_addr_copy(struct net
*net
, struct sctp_bind_addr
*dest
,
44 const struct sctp_bind_addr
*src
,
45 enum sctp_scope scope
, gfp_t gfp
,
48 struct sctp_sockaddr_entry
*addr
;
51 /* All addresses share the same port. */
52 dest
->port
= src
->port
;
54 /* Extract the addresses which are relevant for this scope. */
55 list_for_each_entry(addr
, &src
->address_list
, list
) {
56 error
= sctp_copy_one_addr(net
, dest
, &addr
->a
, scope
,
62 /* If there are no addresses matching the scope and
63 * this is global scope, try to get a link scope address, with
64 * the assumption that we must be sitting behind a NAT.
66 if (list_empty(&dest
->address_list
) && (SCTP_SCOPE_GLOBAL
== scope
)) {
67 list_for_each_entry(addr
, &src
->address_list
, list
) {
68 error
= sctp_copy_one_addr(net
, dest
, &addr
->a
,
78 sctp_bind_addr_clean(dest
);
83 /* Exactly duplicate the address lists. This is necessary when doing
84 * peer-offs and accepts. We don't want to put all the current system
85 * addresses into the endpoint. That's useless. But we do want duplicat
86 * the list of bound addresses that the older endpoint used.
88 int sctp_bind_addr_dup(struct sctp_bind_addr
*dest
,
89 const struct sctp_bind_addr
*src
,
92 struct sctp_sockaddr_entry
*addr
;
95 /* All addresses share the same port. */
96 dest
->port
= src
->port
;
98 list_for_each_entry(addr
, &src
->address_list
, list
) {
99 error
= sctp_add_bind_addr(dest
, &addr
->a
, sizeof(addr
->a
),
108 /* Initialize the SCTP_bind_addr structure for either an endpoint or
111 void sctp_bind_addr_init(struct sctp_bind_addr
*bp
, __u16 port
)
113 INIT_LIST_HEAD(&bp
->address_list
);
117 /* Dispose of the address list. */
118 static void sctp_bind_addr_clean(struct sctp_bind_addr
*bp
)
120 struct sctp_sockaddr_entry
*addr
, *temp
;
122 /* Empty the bind address list. */
123 list_for_each_entry_safe(addr
, temp
, &bp
->address_list
, list
) {
124 list_del_rcu(&addr
->list
);
125 kfree_rcu(addr
, rcu
);
126 SCTP_DBG_OBJCNT_DEC(addr
);
130 /* Dispose of an SCTP_bind_addr structure */
131 void sctp_bind_addr_free(struct sctp_bind_addr
*bp
)
133 /* Empty the bind address list. */
134 sctp_bind_addr_clean(bp
);
137 /* Add an address to the bind address list in the SCTP_bind_addr structure. */
138 int sctp_add_bind_addr(struct sctp_bind_addr
*bp
, union sctp_addr
*new,
139 int new_size
, __u8 addr_state
, gfp_t gfp
)
141 struct sctp_sockaddr_entry
*addr
;
143 /* Add the address to the bind address list. */
144 addr
= kzalloc(sizeof(*addr
), gfp
);
148 memcpy(&addr
->a
, new, min_t(size_t, sizeof(*new), new_size
));
150 /* Fix up the port if it has not yet been set.
151 * Both v4 and v6 have the port at the same offset.
153 if (!addr
->a
.v4
.sin_port
)
154 addr
->a
.v4
.sin_port
= htons(bp
->port
);
156 addr
->state
= addr_state
;
159 INIT_LIST_HEAD(&addr
->list
);
161 /* We always hold a socket lock when calling this function,
162 * and that acts as a writer synchronizing lock.
164 list_add_tail_rcu(&addr
->list
, &bp
->address_list
);
165 SCTP_DBG_OBJCNT_INC(addr
);
170 /* Delete an address from the bind address list in the SCTP_bind_addr
173 int sctp_del_bind_addr(struct sctp_bind_addr
*bp
, union sctp_addr
*del_addr
)
175 struct sctp_sockaddr_entry
*addr
, *temp
;
178 /* We hold the socket lock when calling this function,
179 * and that acts as a writer synchronizing lock.
181 list_for_each_entry_safe(addr
, temp
, &bp
->address_list
, list
) {
182 if (sctp_cmp_addr_exact(&addr
->a
, del_addr
)) {
183 /* Found the exact match. */
186 list_del_rcu(&addr
->list
);
192 kfree_rcu(addr
, rcu
);
193 SCTP_DBG_OBJCNT_DEC(addr
);
200 /* Create a network byte-order representation of all the addresses
201 * formated as SCTP parameters.
203 * The second argument is the return value for the length.
205 union sctp_params
sctp_bind_addrs_to_raw(const struct sctp_bind_addr
*bp
,
209 union sctp_params addrparms
;
210 union sctp_params retval
;
212 union sctp_addr_param rawaddr
;
214 struct sctp_sockaddr_entry
*addr
;
215 struct list_head
*pos
;
221 /* Allocate enough memory at once. */
222 list_for_each(pos
, &bp
->address_list
) {
223 len
+= sizeof(union sctp_addr_param
);
226 /* Don't even bother embedding an address if there
229 if (len
== sizeof(union sctp_addr_param
)) {
234 retval
.v
= kmalloc(len
, gfp
);
240 list_for_each_entry(addr
, &bp
->address_list
, list
) {
241 af
= sctp_get_af_specific(addr
->a
.v4
.sin_family
);
242 len
= af
->to_addr_param(&addr
->a
, &rawaddr
);
243 memcpy(addrparms
.v
, &rawaddr
, len
);
245 addrparms_len
+= len
;
249 *addrs_len
= addrparms_len
;
254 * Create an address list out of the raw address list format (IPv4 and IPv6
255 * address parameters).
257 int sctp_raw_to_bind_addrs(struct sctp_bind_addr
*bp
, __u8
*raw_addr_list
,
258 int addrs_len
, __u16 port
, gfp_t gfp
)
260 union sctp_addr_param
*rawaddr
;
261 struct sctp_paramhdr
*param
;
262 union sctp_addr addr
;
267 /* Convert the raw address to standard address format */
269 param
= (struct sctp_paramhdr
*)raw_addr_list
;
270 rawaddr
= (union sctp_addr_param
*)raw_addr_list
;
272 af
= sctp_get_af_specific(param_type2af(param
->type
));
275 sctp_bind_addr_clean(bp
);
279 af
->from_addr_param(&addr
, rawaddr
, htons(port
), 0);
280 if (sctp_bind_addr_state(bp
, &addr
) != -1)
282 retval
= sctp_add_bind_addr(bp
, &addr
, sizeof(addr
),
285 /* Can't finish building the list, clean up. */
286 sctp_bind_addr_clean(bp
);
291 len
= ntohs(param
->length
);
293 raw_addr_list
+= len
;
299 /********************************************************************
300 * 2nd Level Abstractions
301 ********************************************************************/
303 /* Does this contain a specified address? Allow wildcarding. */
304 int sctp_bind_addr_match(struct sctp_bind_addr
*bp
,
305 const union sctp_addr
*addr
,
306 struct sctp_sock
*opt
)
308 struct sctp_sockaddr_entry
*laddr
;
312 list_for_each_entry_rcu(laddr
, &bp
->address_list
, list
) {
315 if (opt
->pf
->cmp_addr(&laddr
->a
, addr
, opt
)) {
325 int sctp_bind_addrs_check(struct sctp_sock
*sp
,
326 struct sctp_sock
*sp2
, int cnt2
)
328 struct sctp_bind_addr
*bp2
= &sp2
->ep
->base
.bind_addr
;
329 struct sctp_bind_addr
*bp
= &sp
->ep
->base
.bind_addr
;
330 struct sctp_sockaddr_entry
*laddr
, *laddr2
;
335 list_for_each_entry_rcu(laddr
, &bp
->address_list
, list
) {
336 list_for_each_entry_rcu(laddr2
, &bp2
->address_list
, list
) {
337 if (sp
->pf
->af
->cmp_addr(&laddr
->a
, &laddr2
->a
) &&
338 laddr
->valid
&& laddr2
->valid
) {
350 return (cnt
== cnt2
) ? 0 : (exist
? -EEXIST
: 1);
353 /* Does the address 'addr' conflict with any addresses in
356 int sctp_bind_addr_conflict(struct sctp_bind_addr
*bp
,
357 const union sctp_addr
*addr
,
358 struct sctp_sock
*bp_sp
,
359 struct sctp_sock
*addr_sp
)
361 struct sctp_sockaddr_entry
*laddr
;
363 struct sctp_sock
*sp
;
365 /* Pick the IPv6 socket as the basis of comparison
366 * since it's usually a superset of the IPv4.
367 * If there is no IPv6 socket, then default to bind_addr.
369 if (sctp_opt2sk(bp_sp
)->sk_family
== AF_INET6
)
371 else if (sctp_opt2sk(addr_sp
)->sk_family
== AF_INET6
)
377 list_for_each_entry_rcu(laddr
, &bp
->address_list
, list
) {
381 conflict
= sp
->pf
->cmp_addr(&laddr
->a
, addr
, sp
);
390 /* Get the state of the entry in the bind_addr_list */
391 int sctp_bind_addr_state(const struct sctp_bind_addr
*bp
,
392 const union sctp_addr
*addr
)
394 struct sctp_sockaddr_entry
*laddr
;
397 af
= sctp_get_af_specific(addr
->sa
.sa_family
);
401 list_for_each_entry_rcu(laddr
, &bp
->address_list
, list
) {
404 if (af
->cmp_addr(&laddr
->a
, addr
))
411 /* Find the first address in the bind address list that is not present in
412 * the addrs packed array.
414 union sctp_addr
*sctp_find_unmatch_addr(struct sctp_bind_addr
*bp
,
415 const union sctp_addr
*addrs
,
417 struct sctp_sock
*opt
)
419 struct sctp_sockaddr_entry
*laddr
;
420 union sctp_addr
*addr
;
425 /* This is only called sctp_send_asconf_del_ip() and we hold
426 * the socket lock in that code patch, so that address list
429 list_for_each_entry(laddr
, &bp
->address_list
, list
) {
430 addr_buf
= (union sctp_addr
*)addrs
;
431 for (i
= 0; i
< addrcnt
; i
++) {
433 af
= sctp_get_af_specific(addr
->v4
.sin_family
);
437 if (opt
->pf
->cmp_addr(&laddr
->a
, addr
, opt
))
440 addr_buf
+= af
->sockaddr_len
;
449 /* Copy out addresses from the global local address list. */
450 static int sctp_copy_one_addr(struct net
*net
, struct sctp_bind_addr
*dest
,
451 union sctp_addr
*addr
, enum sctp_scope scope
,
452 gfp_t gfp
, int flags
)
456 if (sctp_is_any(NULL
, addr
)) {
457 error
= sctp_copy_local_addr_list(net
, dest
, scope
, gfp
, flags
);
458 } else if (sctp_in_scope(net
, addr
, scope
)) {
459 /* Now that the address is in scope, check to see if
460 * the address type is supported by local sock as
461 * well as the remote peer.
463 if ((((AF_INET
== addr
->sa
.sa_family
) &&
464 (flags
& SCTP_ADDR4_ALLOWED
) &&
465 (flags
& SCTP_ADDR4_PEERSUPP
))) ||
466 (((AF_INET6
== addr
->sa
.sa_family
) &&
467 (flags
& SCTP_ADDR6_ALLOWED
) &&
468 (flags
& SCTP_ADDR6_PEERSUPP
))))
469 error
= sctp_add_bind_addr(dest
, addr
, sizeof(*addr
),
476 /* Is this a wildcard address? */
477 int sctp_is_any(struct sock
*sk
, const union sctp_addr
*addr
)
479 unsigned short fam
= 0;
482 /* Try to get the right address family */
483 if (addr
->sa
.sa_family
!= AF_UNSPEC
)
484 fam
= addr
->sa
.sa_family
;
488 af
= sctp_get_af_specific(fam
);
492 return af
->is_any(addr
);
495 /* Is 'addr' valid for 'scope'? */
496 int sctp_in_scope(struct net
*net
, const union sctp_addr
*addr
,
497 enum sctp_scope scope
)
499 enum sctp_scope addr_scope
= sctp_scope(addr
);
501 /* The unusable SCTP addresses will not be considered with
502 * any defined scopes.
504 if (SCTP_SCOPE_UNUSABLE
== addr_scope
)
507 * For INIT and INIT-ACK address list, let L be the level of
508 * requested destination address, sender and receiver
509 * SHOULD include all of its addresses with level greater
510 * than or equal to L.
512 * Address scoping can be selectively controlled via sysctl
515 switch (net
->sctp
.scope_policy
) {
516 case SCTP_SCOPE_POLICY_DISABLE
:
518 case SCTP_SCOPE_POLICY_ENABLE
:
519 if (addr_scope
<= scope
)
522 case SCTP_SCOPE_POLICY_PRIVATE
:
523 if (addr_scope
<= scope
|| SCTP_SCOPE_PRIVATE
== addr_scope
)
526 case SCTP_SCOPE_POLICY_LINK
:
527 if (addr_scope
<= scope
|| SCTP_SCOPE_LINK
== addr_scope
)
537 int sctp_is_ep_boundall(struct sock
*sk
)
539 struct sctp_bind_addr
*bp
;
540 struct sctp_sockaddr_entry
*addr
;
542 bp
= &sctp_sk(sk
)->ep
->base
.bind_addr
;
543 if (sctp_list_single_entry(&bp
->address_list
)) {
544 addr
= list_entry(bp
->address_list
.next
,
545 struct sctp_sockaddr_entry
, list
);
546 if (sctp_is_any(sk
, &addr
->a
))
552 /********************************************************************
553 * 3rd Level Abstractions
554 ********************************************************************/
556 /* What is the scope of 'addr'? */
557 enum sctp_scope
sctp_scope(const union sctp_addr
*addr
)
561 af
= sctp_get_af_specific(addr
->sa
.sa_family
);
563 return SCTP_SCOPE_UNUSABLE
;
565 return af
->scope((union sctp_addr
*)addr
);