net/sctp/bind_addr.c

   1 /* SCTP kernel implementation
   2  * (C) Copyright IBM Corp. 2001, 2003
   3  * Copyright (c) Cisco 1999,2000
   4  * Copyright (c) Motorola 1999,2000,2001
   5  * Copyright (c) La Monte H.P. Yarroll 2001
   6  *
   7  * This file is part of the SCTP kernel implementation.
   8  *
   9  * A collection class to handle the storage of transport addresses.
  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 address(es):
  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  *    Jon Grimm             <jgrimm@us.ibm.com>
  35  *    Daisy Chang           <daisyc@us.ibm.com>
  36  */
  37
  38 #include <linux/types.h>
  39 #include <linux/slab.h>
  40 #include <linux/in.h>
  41 #include <net/sock.h>
  42 #include <net/ipv6.h>
  43 #include <net/if_inet6.h>
  44 #include <net/sctp/sctp.h>
  45 #include <net/sctp/sm.h>
  46
  47 /* Forward declarations for internal helpers. */
  48 static int sctp_copy_one_addr(struct net *net, struct sctp_bind_addr *dest,
  49                               union sctp_addr *addr, enum sctp_scope scope,
  50                               gfp_t gfp, int flags);
  51 static void sctp_bind_addr_clean(struct sctp_bind_addr *);
  52
  53 /* First Level Abstractions. */
  54
  55 /* Copy 'src' to 'dest' taking 'scope' into account.  Omit addresses
  56  * in 'src' which have a broader scope than 'scope'.
  57  */
  58 int sctp_bind_addr_copy(struct net *net, struct sctp_bind_addr *dest,
  59                         const struct sctp_bind_addr *src,
  60                         enum sctp_scope scope, gfp_t gfp,
  61                         int flags)
  62 {
  63         struct sctp_sockaddr_entry *addr;
  64         int error = 0;
  65
  66         /* All addresses share the same port.  */
  67         dest->port = src->port;
  68
  69         /* Extract the addresses which are relevant for this scope.  */
  70         list_for_each_entry(addr, &src->address_list, list) {
  71                 error = sctp_copy_one_addr(net, dest, &addr->a, scope,
  72                                            gfp, flags);
  73                 if (error < 0)
  74                         goto out;
  75         }
  76
  77         /* If there are no addresses matching the scope and
  78          * this is global scope, try to get a link scope address, with
  79          * the assumption that we must be sitting behind a NAT.
  80          */
  81         if (list_empty(&dest->address_list) && (SCTP_SCOPE_GLOBAL == scope)) {
  82                 list_for_each_entry(addr, &src->address_list, list) {
  83                         error = sctp_copy_one_addr(net, dest, &addr->a,
  84                                                    SCTP_SCOPE_LINK, gfp,
  85                                                    flags);
  86                         if (error < 0)
  87                                 goto out;
  88                 }
  89         }
  90
  91         /* If somehow no addresses were found that can be used with this
  92          * scope, it's an error.
  93          */
  94         if (list_empty(&dest->address_list))
  95                 error = -ENETUNREACH;
  96
  97 out:
  98         if (error)
  99                 sctp_bind_addr_clean(dest);
 100
 101         return error;
 102 }
 103
 104 /* Exactly duplicate the address lists.  This is necessary when doing
 105  * peer-offs and accepts.  We don't want to put all the current system
 106  * addresses into the endpoint.  That's useless.  But we do want duplicat
 107  * the list of bound addresses that the older endpoint used.
 108  */
 109 int sctp_bind_addr_dup(struct sctp_bind_addr *dest,
 110                         const struct sctp_bind_addr *src,
 111                         gfp_t gfp)
 112 {
 113         struct sctp_sockaddr_entry *addr;
 114         int error = 0;
 115
 116         /* All addresses share the same port.  */
 117         dest->port = src->port;
 118
 119         list_for_each_entry(addr, &src->address_list, list) {
 120                 error = sctp_add_bind_addr(dest, &addr->a, sizeof(addr->a),
 121                                            1, gfp);
 122                 if (error < 0)
 123                         break;
 124         }
 125
 126         return error;
 127 }
 128
 129 /* Initialize the SCTP_bind_addr structure for either an endpoint or
 130  * an association.
 131  */
 132 void sctp_bind_addr_init(struct sctp_bind_addr *bp, __u16 port)
 133 {
 134         INIT_LIST_HEAD(&bp->address_list);
 135         bp->port = port;
 136 }
 137
 138 /* Dispose of the address list. */
 139 static void sctp_bind_addr_clean(struct sctp_bind_addr *bp)
 140 {
 141         struct sctp_sockaddr_entry *addr, *temp;
 142
 143         /* Empty the bind address list. */
 144         list_for_each_entry_safe(addr, temp, &bp->address_list, list) {
 145                 list_del_rcu(&addr->list);
 146                 kfree_rcu(addr, rcu);
 147                 SCTP_DBG_OBJCNT_DEC(addr);
 148         }
 149 }
 150
 151 /* Dispose of an SCTP_bind_addr structure  */
 152 void sctp_bind_addr_free(struct sctp_bind_addr *bp)
 153 {
 154         /* Empty the bind address list. */
 155         sctp_bind_addr_clean(bp);
 156 }
 157
 158 /* Add an address to the bind address list in the SCTP_bind_addr structure. */
 159 int sctp_add_bind_addr(struct sctp_bind_addr *bp, union sctp_addr *new,
 160                        int new_size, __u8 addr_state, gfp_t gfp)
 161 {
 162         struct sctp_sockaddr_entry *addr;
 163
 164         /* Add the address to the bind address list.  */
 165         addr = kzalloc(sizeof(*addr), gfp);
 166         if (!addr)
 167                 return -ENOMEM;
 168
 169         memcpy(&addr->a, new, min_t(size_t, sizeof(*new), new_size));
 170
 171         /* Fix up the port if it has not yet been set.
 172          * Both v4 and v6 have the port at the same offset.
 173          */
 174         if (!addr->a.v4.sin_port)
 175                 addr->a.v4.sin_port = htons(bp->port);
 176
 177         addr->state = addr_state;
 178         addr->valid = 1;
 179
 180         INIT_LIST_HEAD(&addr->list);
 181
 182         /* We always hold a socket lock when calling this function,
 183          * and that acts as a writer synchronizing lock.
 184          */
 185         list_add_tail_rcu(&addr->list, &bp->address_list);
 186         SCTP_DBG_OBJCNT_INC(addr);
 187
 188         return 0;
 189 }
 190
 191 /* Delete an address from the bind address list in the SCTP_bind_addr
 192  * structure.
 193  */
 194 int sctp_del_bind_addr(struct sctp_bind_addr *bp, union sctp_addr *del_addr)
 195 {
 196         struct sctp_sockaddr_entry *addr, *temp;
 197         int found = 0;
 198
 199         /* We hold the socket lock when calling this function,
 200          * and that acts as a writer synchronizing lock.
 201          */
 202         list_for_each_entry_safe(addr, temp, &bp->address_list, list) {
 203                 if (sctp_cmp_addr_exact(&addr->a, del_addr)) {
 204                         /* Found the exact match. */
 205                         found = 1;
 206                         addr->valid = 0;
 207                         list_del_rcu(&addr->list);
 208                         break;
 209                 }
 210         }
 211
 212         if (found) {
 213                 kfree_rcu(addr, rcu);
 214                 SCTP_DBG_OBJCNT_DEC(addr);
 215                 return 0;
 216         }
 217
 218         return -EINVAL;
 219 }
 220
 221 /* Create a network byte-order representation of all the addresses
 222  * formated as SCTP parameters.
 223  *
 224  * The second argument is the return value for the length.
 225  */
 226 union sctp_params sctp_bind_addrs_to_raw(const struct sctp_bind_addr *bp,
 227                                          int *addrs_len,
 228                                          gfp_t gfp)
 229 {
 230         union sctp_params addrparms;
 231         union sctp_params retval;
 232         int addrparms_len;
 233         union sctp_addr_param rawaddr;
 234         int len;
 235         struct sctp_sockaddr_entry *addr;
 236         struct list_head *pos;
 237         struct sctp_af *af;
 238
 239         addrparms_len = 0;
 240         len = 0;
 241
 242         /* Allocate enough memory at once. */
 243         list_for_each(pos, &bp->address_list) {
 244                 len += sizeof(union sctp_addr_param);
 245         }
 246
 247         /* Don't even bother embedding an address if there
 248          * is only one.
 249          */
 250         if (len == sizeof(union sctp_addr_param)) {
 251                 retval.v = NULL;
 252                 goto end_raw;
 253         }
 254
 255         retval.v = kmalloc(len, gfp);
 256         if (!retval.v)
 257                 goto end_raw;
 258
 259         addrparms = retval;
 260
 261         list_for_each_entry(addr, &bp->address_list, list) {
 262                 af = sctp_get_af_specific(addr->a.v4.sin_family);
 263                 len = af->to_addr_param(&addr->a, &rawaddr);
 264                 memcpy(addrparms.v, &rawaddr, len);
 265                 addrparms.v += len;
 266                 addrparms_len += len;
 267         }
 268
 269 end_raw:
 270         *addrs_len = addrparms_len;
 271         return retval;
 272 }
 273
 274 /*
 275  * Create an address list out of the raw address list format (IPv4 and IPv6
 276  * address parameters).
 277  */
 278 int sctp_raw_to_bind_addrs(struct sctp_bind_addr *bp, __u8 *raw_addr_list,
 279                            int addrs_len, __u16 port, gfp_t gfp)
 280 {
 281         union sctp_addr_param *rawaddr;
 282         struct sctp_paramhdr *param;
 283         union sctp_addr addr;
 284         int retval = 0;
 285         int len;
 286         struct sctp_af *af;
 287
 288         /* Convert the raw address to standard address format */
 289         while (addrs_len) {
 290                 param = (struct sctp_paramhdr *)raw_addr_list;
 291                 rawaddr = (union sctp_addr_param *)raw_addr_list;
 292
 293                 af = sctp_get_af_specific(param_type2af(param->type));
 294                 if (unlikely(!af) ||
 295                     !af->from_addr_param(&addr, rawaddr, htons(port), 0)) {
 296                         retval = -EINVAL;
 297                         goto out_err;
 298                 }
 299
 300                 if (sctp_bind_addr_state(bp, &addr) != -1)
 301                         goto next;
 302                 retval = sctp_add_bind_addr(bp, &addr, sizeof(addr),
 303                                             SCTP_ADDR_SRC, gfp);
 304                 if (retval)
 305                         /* Can't finish building the list, clean up. */
 306                         goto out_err;
 307
 308 next:
 309                 len = ntohs(param->length);
 310                 addrs_len -= len;
 311                 raw_addr_list += len;
 312         }
 313
 314         return retval;
 315
 316 out_err:
 317         if (retval)
 318                 sctp_bind_addr_clean(bp);
 319
 320         return retval;
 321 }
 322
 323 /********************************************************************
 324  * 2nd Level Abstractions
 325  ********************************************************************/
 326
 327 /* Does this contain a specified address?  Allow wildcarding. */
 328 int sctp_bind_addr_match(struct sctp_bind_addr *bp,
 329                          const union sctp_addr *addr,
 330                          struct sctp_sock *opt)
 331 {
 332         struct sctp_sockaddr_entry *laddr;
 333         int match = 0;
 334
 335         rcu_read_lock();
 336         list_for_each_entry_rcu(laddr, &bp->address_list, list) {
 337                 if (!laddr->valid)
 338                         continue;
 339                 if (opt->pf->cmp_addr(&laddr->a, addr, opt)) {
 340                         match = 1;
 341                         break;
 342                 }
 343         }
 344         rcu_read_unlock();
 345
 346         return match;
 347 }
 348
 349 /* Does the address 'addr' conflict with any addresses in
 350  * the bp.
 351  */
 352 int sctp_bind_addr_conflict(struct sctp_bind_addr *bp,
 353                             const union sctp_addr *addr,
 354                             struct sctp_sock *bp_sp,
 355                             struct sctp_sock *addr_sp)
 356 {
 357         struct sctp_sockaddr_entry *laddr;
 358         int conflict = 0;
 359         struct sctp_sock *sp;
 360
 361         /* Pick the IPv6 socket as the basis of comparison
 362          * since it's usually a superset of the IPv4.
 363          * If there is no IPv6 socket, then default to bind_addr.
 364          */
 365         if (sctp_opt2sk(bp_sp)->sk_family == AF_INET6)
 366                 sp = bp_sp;
 367         else if (sctp_opt2sk(addr_sp)->sk_family == AF_INET6)
 368                 sp = addr_sp;
 369         else
 370                 sp = bp_sp;
 371
 372         rcu_read_lock();
 373         list_for_each_entry_rcu(laddr, &bp->address_list, list) {
 374                 if (!laddr->valid)
 375                         continue;
 376
 377                 conflict = sp->pf->cmp_addr(&laddr->a, addr, sp);
 378                 if (conflict)
 379                         break;
 380         }
 381         rcu_read_unlock();
 382
 383         return conflict;
 384 }
 385
 386 /* Get the state of the entry in the bind_addr_list */
 387 int sctp_bind_addr_state(const struct sctp_bind_addr *bp,
 388                          const union sctp_addr *addr)
 389 {
 390         struct sctp_sockaddr_entry *laddr;
 391         struct sctp_af *af;
 392         int state = -1;
 393
 394         af = sctp_get_af_specific(addr->sa.sa_family);
 395         if (unlikely(!af))
 396                 return state;
 397
 398         rcu_read_lock();
 399         list_for_each_entry_rcu(laddr, &bp->address_list, list) {
 400                 if (!laddr->valid)
 401                         continue;
 402                 if (af->cmp_addr(&laddr->a, addr)) {
 403                         state = laddr->state;
 404                         break;
 405                 }
 406         }
 407         rcu_read_unlock();
 408
 409         return state;
 410 }
 411
 412 /* Find the first address in the bind address list that is not present in
 413  * the addrs packed array.
 414  */
 415 union sctp_addr *sctp_find_unmatch_addr(struct sctp_bind_addr   *bp,
 416                                         const union sctp_addr   *addrs,
 417                                         int                     addrcnt,
 418                                         struct sctp_sock        *opt)
 419 {
 420         struct sctp_sockaddr_entry      *laddr;
 421         union sctp_addr                 *addr;
 422         void                            *addr_buf;
 423         struct sctp_af                  *af;
 424         int                             i;
 425
 426         /* This is only called sctp_send_asconf_del_ip() and we hold
 427          * the socket lock in that code patch, so that address list
 428          * can't change.
 429          */
 430         list_for_each_entry(laddr, &bp->address_list, list) {
 431                 addr_buf = (union sctp_addr *)addrs;
 432                 for (i = 0; i < addrcnt; i++) {
 433                         addr = addr_buf;
 434                         af = sctp_get_af_specific(addr->v4.sin_family);
 435                         if (!af)
 436                                 break;
 437
 438                         if (opt->pf->cmp_addr(&laddr->a, addr, opt))
 439                                 break;
 440
 441                         addr_buf += af->sockaddr_len;
 442                 }
 443                 if (i == addrcnt)
 444                         return &laddr->a;
 445         }
 446
 447         return NULL;
 448 }
 449
 450 /* Copy out addresses from the global local address list. */
 451 static int sctp_copy_one_addr(struct net *net, struct sctp_bind_addr *dest,
 452                               union sctp_addr *addr, enum sctp_scope scope,
 453                               gfp_t gfp, int flags)
 454 {
 455         int error = 0;
 456
 457         if (sctp_is_any(NULL, addr)) {
 458                 error = sctp_copy_local_addr_list(net, dest, scope, gfp, flags);
 459         } else if (sctp_in_scope(net, addr, scope)) {
 460                 /* Now that the address is in scope, check to see if
 461                  * the address type is supported by local sock as
 462                  * well as the remote peer.
 463                  */
 464                 if ((((AF_INET == addr->sa.sa_family) &&
 465                       (flags & SCTP_ADDR4_ALLOWED) &&
 466                       (flags & SCTP_ADDR4_PEERSUPP))) ||
 467                     (((AF_INET6 == addr->sa.sa_family) &&
 468                       (flags & SCTP_ADDR6_ALLOWED) &&
 469                       (flags & SCTP_ADDR6_PEERSUPP))))
 470                         error = sctp_add_bind_addr(dest, addr, sizeof(*addr),
 471                                                    SCTP_ADDR_SRC, gfp);
 472         }
 473
 474         return error;
 475 }
 476
 477 /* Is this a wildcard address?  */
 478 int sctp_is_any(struct sock *sk, const union sctp_addr *addr)
 479 {
 480         unsigned short fam = 0;
 481         struct sctp_af *af;
 482
 483         /* Try to get the right address family */
 484         if (addr->sa.sa_family != AF_UNSPEC)
 485                 fam = addr->sa.sa_family;
 486         else if (sk)
 487                 fam = sk->sk_family;
 488
 489         af = sctp_get_af_specific(fam);
 490         if (!af)
 491                 return 0;
 492
 493         return af->is_any(addr);
 494 }
 495
 496 /* Is 'addr' valid for 'scope'?  */
 497 int sctp_in_scope(struct net *net, const union sctp_addr *addr,
 498                   enum sctp_scope scope)
 499 {
 500         enum sctp_scope addr_scope = sctp_scope(addr);
 501
 502         /* The unusable SCTP addresses will not be considered with
 503          * any defined scopes.
 504          */
 505         if (SCTP_SCOPE_UNUSABLE == addr_scope)
 506                 return 0;
 507         /*
 508          * For INIT and INIT-ACK address list, let L be the level of
 509          * of requested destination address, sender and receiver
 510          * SHOULD include all of its addresses with level greater
 511          * than or equal to L.
 512          *
 513          * Address scoping can be selectively controlled via sysctl
 514          * option
 515          */
 516         switch (net->sctp.scope_policy) {
 517         case SCTP_SCOPE_POLICY_DISABLE:
 518                 return 1;
 519         case SCTP_SCOPE_POLICY_ENABLE:
 520                 if (addr_scope <= scope)
 521                         return 1;
 522                 break;
 523         case SCTP_SCOPE_POLICY_PRIVATE:
 524                 if (addr_scope <= scope || SCTP_SCOPE_PRIVATE == addr_scope)
 525                         return 1;
 526                 break;
 527         case SCTP_SCOPE_POLICY_LINK:
 528                 if (addr_scope <= scope || SCTP_SCOPE_LINK == addr_scope)
 529                         return 1;
 530                 break;
 531         default:
 532                 break;
 533         }
 534
 535         return 0;
 536 }
 537
 538 int sctp_is_ep_boundall(struct sock *sk)
 539 {
 540         struct sctp_bind_addr *bp;
 541         struct sctp_sockaddr_entry *addr;
 542
 543         bp = &sctp_sk(sk)->ep->base.bind_addr;
 544         if (sctp_list_single_entry(&bp->address_list)) {
 545                 addr = list_entry(bp->address_list.next,
 546                                   struct sctp_sockaddr_entry, list);
 547                 if (sctp_is_any(sk, &addr->a))
 548                         return 1;
 549         }
 550         return 0;
 551 }
 552
 553 /********************************************************************
 554  * 3rd Level Abstractions
 555  ********************************************************************/
 556
 557 /* What is the scope of 'addr'?  */
 558 enum sctp_scope sctp_scope(const union sctp_addr *addr)
 559 {
 560         struct sctp_af *af;
 561
 562         af = sctp_get_af_specific(addr->sa.sa_family);
 563         if (!af)
 564                 return SCTP_SCOPE_UNUSABLE;
 565
 566         return af->scope((union sctp_addr *)addr);
 567 }