net/sctp/endpointola.c

   1 /* SCTP kernel implementation
   2  * Copyright (c) 1999-2000 Cisco, Inc.
   3  * Copyright (c) 1999-2001 Motorola, Inc.
   4  * Copyright (c) 2001-2002 International Business Machines, Corp.
   5  * Copyright (c) 2001 Intel Corp.
   6  * Copyright (c) 2001 Nokia, Inc.
   7  * Copyright (c) 2001 La Monte H.P. Yarroll
   8  *
   9  * This file is part of the SCTP kernel implementation
  10  *
  11  * This abstraction represents an SCTP endpoint.
  12  *
  13  * The SCTP implementation is free software;
  14  * you can redistribute it and/or modify it under the terms of
  15  * the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2, or (at your option)
  17  * any later version.
  18  *
  19  * The SCTP implementation is distributed in the hope that it
  20  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  21  *                 ************************
  22  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  23  * See the GNU General Public License for more details.
  24  *
  25  * You should have received a copy of the GNU General Public License
  26  * along with GNU CC; see the file COPYING.  If not, see
  27  * <http://www.gnu.org/licenses/>.
  28  *
  29  * Please send any bug reports or fixes you make to the
  30  * email address(es):
  31  *    lksctp developers <linux-sctp@vger.kernel.org>
  32  *
  33  * Written or modified by:
  34  *    La Monte H.P. Yarroll <piggy@acm.org>
  35  *    Karl Knutson <karl@athena.chicago.il.us>
  36  *    Jon Grimm <jgrimm@austin.ibm.com>
  37  *    Daisy Chang <daisyc@us.ibm.com>
  38  *    Dajiang Zhang <dajiang.zhang@nokia.com>
  39  */
  40
  41 #include <linux/types.h>
  42 #include <linux/slab.h>
  43 #include <linux/in.h>
  44 #include <linux/random.h>       /* get_random_bytes() */
  45 #include <net/sock.h>
  46 #include <net/ipv6.h>
  47 #include <net/sctp/sctp.h>
  48 #include <net/sctp/sm.h>
  49
  50 /* Forward declarations for internal helpers. */
  51 static void sctp_endpoint_bh_rcv(struct work_struct *work);
  52
  53 /*
  54  * Initialize the base fields of the endpoint structure.
  55  */
  56 static struct sctp_endpoint *sctp_endpoint_init(struct sctp_endpoint *ep,
  57                                                 struct sock *sk,
  58                                                 gfp_t gfp)
  59 {
  60         struct net *net = sock_net(sk);
  61         struct sctp_hmac_algo_param *auth_hmacs = NULL;
  62         struct sctp_chunks_param *auth_chunks = NULL;
  63         struct sctp_shared_key *null_key;
  64         int err;
  65
  66         ep->digest = kzalloc(SCTP_SIGNATURE_SIZE, gfp);
  67         if (!ep->digest)
  68                 return NULL;
  69
  70         ep->auth_enable = net->sctp.auth_enable;
  71         if (ep->auth_enable) {
  72                 /* Allocate space for HMACS and CHUNKS authentication
  73                  * variables.  There are arrays that we encode directly
  74                  * into parameters to make the rest of the operations easier.
  75                  */
  76                 auth_hmacs = kzalloc(sizeof(*auth_hmacs) +
  77                                      sizeof(__u16) * SCTP_AUTH_NUM_HMACS, gfp);
  78                 if (!auth_hmacs)
  79                         goto nomem;
  80
  81                 auth_chunks = kzalloc(sizeof(*auth_chunks) +
  82                                       SCTP_NUM_CHUNK_TYPES, gfp);
  83                 if (!auth_chunks)
  84                         goto nomem;
  85
  86                 /* Initialize the HMACS parameter.
  87                  * SCTP-AUTH: Section 3.3
  88                  *    Every endpoint supporting SCTP chunk authentication MUST
  89                  *    support the HMAC based on the SHA-1 algorithm.
  90                  */
  91                 auth_hmacs->param_hdr.type = SCTP_PARAM_HMAC_ALGO;
  92                 auth_hmacs->param_hdr.length =
  93                                         htons(sizeof(struct sctp_paramhdr) + 2);
  94                 auth_hmacs->hmac_ids[0] = htons(SCTP_AUTH_HMAC_ID_SHA1);
  95
  96                 /* Initialize the CHUNKS parameter */
  97                 auth_chunks->param_hdr.type = SCTP_PARAM_CHUNKS;
  98                 auth_chunks->param_hdr.length =
  99                                         htons(sizeof(struct sctp_paramhdr));
 100
 101                 /* If the Add-IP functionality is enabled, we must
 102                  * authenticate, ASCONF and ASCONF-ACK chunks
 103                  */
 104                 if (net->sctp.addip_enable) {
 105                         auth_chunks->chunks[0] = SCTP_CID_ASCONF;
 106                         auth_chunks->chunks[1] = SCTP_CID_ASCONF_ACK;
 107                         auth_chunks->param_hdr.length =
 108                                         htons(sizeof(struct sctp_paramhdr) + 2);
 109                 }
 110         }
 111
 112         /* Initialize the base structure. */
 113         /* What type of endpoint are we?  */
 114         ep->base.type = SCTP_EP_TYPE_SOCKET;
 115
 116         /* Initialize the basic object fields. */
 117         refcount_set(&ep->base.refcnt, 1);
 118         ep->base.dead = false;
 119
 120         /* Create an input queue.  */
 121         sctp_inq_init(&ep->base.inqueue);
 122
 123         /* Set its top-half handler */
 124         sctp_inq_set_th_handler(&ep->base.inqueue, sctp_endpoint_bh_rcv);
 125
 126         /* Initialize the bind addr area */
 127         sctp_bind_addr_init(&ep->base.bind_addr, 0);
 128
 129         /* Create the lists of associations.  */
 130         INIT_LIST_HEAD(&ep->asocs);
 131
 132         /* Use SCTP specific send buffer space queues.  */
 133         ep->sndbuf_policy = net->sctp.sndbuf_policy;
 134
 135         sk->sk_data_ready = sctp_data_ready;
 136         sk->sk_write_space = sctp_write_space;
 137         sock_set_flag(sk, SOCK_USE_WRITE_QUEUE);
 138
 139         /* Get the receive buffer policy for this endpoint */
 140         ep->rcvbuf_policy = net->sctp.rcvbuf_policy;
 141
 142         /* Initialize the secret key used with cookie. */
 143         get_random_bytes(ep->secret_key, sizeof(ep->secret_key));
 144
 145         /* SCTP-AUTH extensions*/
 146         INIT_LIST_HEAD(&ep->endpoint_shared_keys);
 147         null_key = sctp_auth_shkey_create(0, gfp);
 148         if (!null_key)
 149                 goto nomem;
 150
 151         list_add(&null_key->key_list, &ep->endpoint_shared_keys);
 152
 153         /* Allocate and initialize transorms arrays for supported HMACs. */
 154         err = sctp_auth_init_hmacs(ep, gfp);
 155         if (err)
 156                 goto nomem_hmacs;
 157
 158         /* Add the null key to the endpoint shared keys list and
 159          * set the hmcas and chunks pointers.
 160          */
 161         ep->auth_hmacs_list = auth_hmacs;
 162         ep->auth_chunk_list = auth_chunks;
 163         ep->prsctp_enable = net->sctp.prsctp_enable;
 164         ep->reconf_enable = net->sctp.reconf_enable;
 165
 166         /* Remember who we are attached to.  */
 167         ep->base.sk = sk;
 168         ep->base.net = sock_net(sk);
 169         sock_hold(ep->base.sk);
 170
 171         return ep;
 172
 173 nomem_hmacs:
 174         sctp_auth_destroy_keys(&ep->endpoint_shared_keys);
 175 nomem:
 176         /* Free all allocations */
 177         kfree(auth_hmacs);
 178         kfree(auth_chunks);
 179         kfree(ep->digest);
 180         return NULL;
 181
 182 }
 183
 184 /* Create a sctp_endpoint with all that boring stuff initialized.
 185  * Returns NULL if there isn't enough memory.
 186  */
 187 struct sctp_endpoint *sctp_endpoint_new(struct sock *sk, gfp_t gfp)
 188 {
 189         struct sctp_endpoint *ep;
 190
 191         /* Build a local endpoint. */
 192         ep = kzalloc(sizeof(*ep), gfp);
 193         if (!ep)
 194                 goto fail;
 195
 196         if (!sctp_endpoint_init(ep, sk, gfp))
 197                 goto fail_init;
 198
 199         SCTP_DBG_OBJCNT_INC(ep);
 200         return ep;
 201
 202 fail_init:
 203         kfree(ep);
 204 fail:
 205         return NULL;
 206 }
 207
 208 /* Add an association to an endpoint.  */
 209 void sctp_endpoint_add_asoc(struct sctp_endpoint *ep,
 210                             struct sctp_association *asoc)
 211 {
 212         struct sock *sk = ep->base.sk;
 213
 214         /* If this is a temporary association, don't bother
 215          * since we'll be removing it shortly and don't
 216          * want anyone to find it anyway.
 217          */
 218         if (asoc->temp)
 219                 return;
 220
 221         /* Now just add it to our list of asocs */
 222         list_add_tail(&asoc->asocs, &ep->asocs);
 223
 224         /* Increment the backlog value for a TCP-style listening socket. */
 225         if (sctp_style(sk, TCP) && sctp_sstate(sk, LISTENING))
 226                 sk->sk_ack_backlog++;
 227 }
 228
 229 /* Free the endpoint structure.  Delay cleanup until
 230  * all users have released their reference count on this structure.
 231  */
 232 void sctp_endpoint_free(struct sctp_endpoint *ep)
 233 {
 234         ep->base.dead = true;
 235
 236         ep->base.sk->sk_state = SCTP_SS_CLOSED;
 237
 238         /* Unlink this endpoint, so we can't find it again! */
 239         sctp_unhash_endpoint(ep);
 240
 241         sctp_endpoint_put(ep);
 242 }
 243
 244 /* Final destructor for endpoint.  */
 245 static void sctp_endpoint_destroy_rcu(struct rcu_head *head)
 246 {
 247         struct sctp_endpoint *ep = container_of(head, struct sctp_endpoint, rcu);
 248         struct sock *sk = ep->base.sk;
 249
 250         sctp_sk(sk)->ep = NULL;
 251         sock_put(sk);
 252
 253         kfree(ep);
 254         SCTP_DBG_OBJCNT_DEC(ep);
 255 }
 256
 257 static void sctp_endpoint_destroy(struct sctp_endpoint *ep)
 258 {
 259         struct sock *sk;
 260
 261         if (unlikely(!ep->base.dead)) {
 262                 WARN(1, "Attempt to destroy undead endpoint %p!\n", ep);
 263                 return;
 264         }
 265
 266         /* Free the digest buffer */
 267         kfree(ep->digest);
 268
 269         /* SCTP-AUTH: Free up AUTH releated data such as shared keys
 270          * chunks and hmacs arrays that were allocated
 271          */
 272         sctp_auth_destroy_keys(&ep->endpoint_shared_keys);
 273         kfree(ep->auth_hmacs_list);
 274         kfree(ep->auth_chunk_list);
 275
 276         /* AUTH - Free any allocated HMAC transform containers */
 277         sctp_auth_destroy_hmacs(ep->auth_hmacs);
 278
 279         /* Cleanup. */
 280         sctp_inq_free(&ep->base.inqueue);
 281         sctp_bind_addr_free(&ep->base.bind_addr);
 282
 283         memset(ep->secret_key, 0, sizeof(ep->secret_key));
 284
 285         sk = ep->base.sk;
 286         /* Remove and free the port */
 287         if (sctp_sk(sk)->bind_hash)
 288                 sctp_put_port(sk);
 289
 290         call_rcu(&ep->rcu, sctp_endpoint_destroy_rcu);
 291 }
 292
 293 /* Hold a reference to an endpoint. */
 294 int sctp_endpoint_hold(struct sctp_endpoint *ep)
 295 {
 296         return refcount_inc_not_zero(&ep->base.refcnt);
 297 }
 298
 299 /* Release a reference to an endpoint and clean up if there are
 300  * no more references.
 301  */
 302 void sctp_endpoint_put(struct sctp_endpoint *ep)
 303 {
 304         if (refcount_dec_and_test(&ep->base.refcnt))
 305                 sctp_endpoint_destroy(ep);
 306 }
 307
 308 /* Is this the endpoint we are looking for?  */
 309 struct sctp_endpoint *sctp_endpoint_is_match(struct sctp_endpoint *ep,
 310                                                struct net *net,
 311                                                const union sctp_addr *laddr)
 312 {
 313         struct sctp_endpoint *retval = NULL;
 314
 315         if ((htons(ep->base.bind_addr.port) == laddr->v4.sin_port) &&
 316             net_eq(sock_net(ep->base.sk), net)) {
 317                 if (sctp_bind_addr_match(&ep->base.bind_addr, laddr,
 318                                          sctp_sk(ep->base.sk)))
 319                         retval = ep;
 320         }
 321
 322         return retval;
 323 }
 324
 325 /* Find the association that goes with this chunk.
 326  * We lookup the transport from hashtable at first, then get association
 327  * through t->assoc.
 328  */
 329 struct sctp_association *sctp_endpoint_lookup_assoc(
 330         const struct sctp_endpoint *ep,
 331         const union sctp_addr *paddr,
 332         struct sctp_transport **transport)
 333 {
 334         struct sctp_association *asoc = NULL;
 335         struct sctp_transport *t;
 336
 337         *transport = NULL;
 338
 339         /* If the local port is not set, there can't be any associations
 340          * on this endpoint.
 341          */
 342         if (!ep->base.bind_addr.port)
 343                 return NULL;
 344
 345         rcu_read_lock();
 346         t = sctp_epaddr_lookup_transport(ep, paddr);
 347         if (!t)
 348                 goto out;
 349
 350         *transport = t;
 351         asoc = t->asoc;
 352 out:
 353         rcu_read_unlock();
 354         return asoc;
 355 }
 356
 357 /* Look for any peeled off association from the endpoint that matches the
 358  * given peer address.
 359  */
 360 int sctp_endpoint_is_peeled_off(struct sctp_endpoint *ep,
 361                                 const union sctp_addr *paddr)
 362 {
 363         struct sctp_sockaddr_entry *addr;
 364         struct sctp_bind_addr *bp;
 365         struct net *net = sock_net(ep->base.sk);
 366
 367         bp = &ep->base.bind_addr;
 368         /* This function is called with the socket lock held,
 369          * so the address_list can not change.
 370          */
 371         list_for_each_entry(addr, &bp->address_list, list) {
 372                 if (sctp_has_association(net, &addr->a, paddr))
 373                         return 1;
 374         }
 375
 376         return 0;
 377 }
 378
 379 /* Do delayed input processing.  This is scheduled by sctp_rcv().
 380  * This may be called on BH or task time.
 381  */
 382 static void sctp_endpoint_bh_rcv(struct work_struct *work)
 383 {
 384         struct sctp_endpoint *ep =
 385                 container_of(work, struct sctp_endpoint,
 386                              base.inqueue.immediate);
 387         struct sctp_association *asoc;
 388         struct sock *sk;
 389         struct net *net;
 390         struct sctp_transport *transport;
 391         struct sctp_chunk *chunk;
 392         struct sctp_inq *inqueue;
 393         union sctp_subtype subtype;
 394         enum sctp_state state;
 395         int error = 0;
 396         int first_time = 1;     /* is this the first time through the loop */
 397
 398         if (ep->base.dead)
 399                 return;
 400
 401         asoc = NULL;
 402         inqueue = &ep->base.inqueue;
 403         sk = ep->base.sk;
 404         net = sock_net(sk);
 405
 406         while (NULL != (chunk = sctp_inq_pop(inqueue))) {
 407                 subtype = SCTP_ST_CHUNK(chunk->chunk_hdr->type);
 408
 409                 /* If the first chunk in the packet is AUTH, do special
 410                  * processing specified in Section 6.3 of SCTP-AUTH spec
 411                  */
 412                 if (first_time && (subtype.chunk == SCTP_CID_AUTH)) {
 413                         struct sctp_chunkhdr *next_hdr;
 414
 415                         next_hdr = sctp_inq_peek(inqueue);
 416                         if (!next_hdr)
 417                                 goto normal;
 418
 419                         /* If the next chunk is COOKIE-ECHO, skip the AUTH
 420                          * chunk while saving a pointer to it so we can do
 421                          * Authentication later (during cookie-echo
 422                          * processing).
 423                          */
 424                         if (next_hdr->type == SCTP_CID_COOKIE_ECHO) {
 425                                 chunk->auth_chunk = skb_clone(chunk->skb,
 426                                                                 GFP_ATOMIC);
 427                                 chunk->auth = 1;
 428                                 continue;
 429                         }
 430                 }
 431 normal:
 432                 /* We might have grown an association since last we
 433                  * looked, so try again.
 434                  *
 435                  * This happens when we've just processed our
 436                  * COOKIE-ECHO chunk.
 437                  */
 438                 if (NULL == chunk->asoc) {
 439                         asoc = sctp_endpoint_lookup_assoc(ep,
 440                                                           sctp_source(chunk),
 441                                                           &transport);
 442                         chunk->asoc = asoc;
 443                         chunk->transport = transport;
 444                 }
 445
 446                 state = asoc ? asoc->state : SCTP_STATE_CLOSED;
 447                 if (sctp_auth_recv_cid(subtype.chunk, asoc) && !chunk->auth)
 448                         continue;
 449
 450                 /* Remember where the last DATA chunk came from so we
 451                  * know where to send the SACK.
 452                  */
 453                 if (asoc && sctp_chunk_is_data(chunk))
 454                         asoc->peer.last_data_from = chunk->transport;
 455                 else {
 456                         SCTP_INC_STATS(sock_net(ep->base.sk), SCTP_MIB_INCTRLCHUNKS);
 457                         if (asoc)
 458                                 asoc->stats.ictrlchunks++;
 459                 }
 460
 461                 if (chunk->transport)
 462                         chunk->transport->last_time_heard = ktime_get();
 463
 464                 error = sctp_do_sm(net, SCTP_EVENT_T_CHUNK, subtype, state,
 465                                    ep, asoc, chunk, GFP_ATOMIC);
 466
 467                 if (error && chunk)
 468                         chunk->pdiscard = 1;
 469
 470                 /* Check to see if the endpoint is freed in response to
 471                  * the incoming chunk. If so, get out of the while loop.
 472                  */
 473                 if (!sctp_sk(sk)->ep)
 474                         break;
 475
 476                 if (first_time)
 477                         first_time = 0;
 478         }
 479 }