sys/netipsec/keysock.c

   1 /*      $FreeBSD$       */
   2 /*      $KAME: keysock.c,v 1.25 2001/08/13 20:07:41 itojun Exp $        */
   3
   4 /*-
   5  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. Neither the name of the project nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 #include "opt_ipsec.h"
  34
  35 /* This code has derived from sys/net/rtsock.c on FreeBSD2.2.5 */
  36
  37 #include <sys/types.h>
  38 #include <sys/param.h>
  39 #include <sys/domain.h>
  40 #include <sys/errno.h>
  41 #include <sys/kernel.h>
  42 #include <sys/lock.h>
  43 #include <sys/malloc.h>
  44 #include <sys/mbuf.h>
  45 #include <sys/mutex.h>
  46 #include <sys/priv.h>
  47 #include <sys/protosw.h>
  48 #include <sys/signalvar.h>
  49 #include <sys/socket.h>
  50 #include <sys/socketvar.h>
  51 #include <sys/sysctl.h>
  52 #include <sys/systm.h>
  53
  54 #include <net/if.h>
  55 #include <net/raw_cb.h>
  56 #include <net/vnet.h>
  57
  58 #include <netinet/in.h>
  59
  60 #include <net/pfkeyv2.h>
  61 #include <netipsec/key.h>
  62 #include <netipsec/keysock.h>
  63 #include <netipsec/key_debug.h>
  64 #include <netipsec/ipsec.h>
  65
  66 #include <machine/stdarg.h>
  67
  68 struct key_cb {
  69         int key_count;
  70         int any_count;
  71 };
  72 static VNET_DEFINE(struct key_cb, key_cb);
  73 #define V_key_cb                VNET(key_cb)
  74
  75 static struct sockaddr key_src = { 2, PF_KEY, };
  76
  77 static int key_sendup0 __P((struct rawcb *, struct mbuf *, int));
  78
  79 VNET_PCPUSTAT_DEFINE(struct pfkeystat, pfkeystat);
  80 VNET_PCPUSTAT_SYSINIT(pfkeystat);
  81
  82 #ifdef VIMAGE
  83 VNET_PCPUSTAT_SYSUNINIT(pfkeystat);
  84 #endif /* VIMAGE */
  85
  86 /*
  87  * key_output()
  88  */
  89 int
  90 key_output(struct mbuf *m, struct socket *so)
  91 {
  92         struct sadb_msg *msg;
  93         int len, error = 0;
  94
  95         if (m == 0)
  96                 panic("%s: NULL pointer was passed.\n", __func__);
  97
  98         PFKEYSTAT_INC(out_total);
  99         PFKEYSTAT_ADD(out_bytes, m->m_pkthdr.len);
 100
 101         len = m->m_pkthdr.len;
 102         if (len < sizeof(struct sadb_msg)) {
 103                 PFKEYSTAT_INC(out_tooshort);
 104                 error = EINVAL;
 105                 goto end;
 106         }
 107
 108         if (m->m_len < sizeof(struct sadb_msg)) {
 109                 if ((m = m_pullup(m, sizeof(struct sadb_msg))) == 0) {
 110                         PFKEYSTAT_INC(out_nomem);
 111                         error = ENOBUFS;
 112                         goto end;
 113                 }
 114         }
 115
 116         M_ASSERTPKTHDR(m);
 117
 118         KEYDEBUG(KEYDEBUG_KEY_DUMP, kdebug_mbuf(m));
 119
 120         msg = mtod(m, struct sadb_msg *);
 121         PFKEYSTAT_INC(out_msgtype[msg->sadb_msg_type]);
 122         if (len != PFKEY_UNUNIT64(msg->sadb_msg_len)) {
 123                 PFKEYSTAT_INC(out_invlen);
 124                 error = EINVAL;
 125                 goto end;
 126         }
 127
 128         error = key_parse(m, so);
 129         m = NULL;
 130 end:
 131         if (m)
 132                 m_freem(m);
 133         return error;
 134 }
 135
 136 /*
 137  * send message to the socket.
 138  */
 139 static int
 140 key_sendup0(rp, m, promisc)
 141         struct rawcb *rp;
 142         struct mbuf *m;
 143         int promisc;
 144 {
 145         int error;
 146
 147         if (promisc) {
 148                 struct sadb_msg *pmsg;
 149
 150                 M_PREPEND(m, sizeof(struct sadb_msg), M_NOWAIT);
 151                 if (m == NULL) {
 152                         PFKEYSTAT_INC(in_nomem);
 153                         return (ENOBUFS);
 154                 }
 155                 pmsg = mtod(m, struct sadb_msg *);
 156                 bzero(pmsg, sizeof(*pmsg));
 157                 pmsg->sadb_msg_version = PF_KEY_V2;
 158                 pmsg->sadb_msg_type = SADB_X_PROMISC;
 159                 pmsg->sadb_msg_len = PFKEY_UNIT64(m->m_pkthdr.len);
 160                 /* pid and seq? */
 161
 162                 PFKEYSTAT_INC(in_msgtype[pmsg->sadb_msg_type]);
 163         }
 164
 165         if (!sbappendaddr(&rp->rcb_socket->so_rcv, (struct sockaddr *)&key_src,
 166             m, NULL)) {
 167                 PFKEYSTAT_INC(in_nomem);
 168                 m_freem(m);
 169                 error = ENOBUFS;
 170         } else
 171                 error = 0;
 172         sorwakeup(rp->rcb_socket);
 173         return error;
 174 }
 175
 176 /* XXX this interface should be obsoleted. */
 177 int
 178 key_sendup(so, msg, len, target)
 179         struct socket *so;
 180         struct sadb_msg *msg;
 181         u_int len;
 182         int target;     /*target of the resulting message*/
 183 {
 184         struct mbuf *m, *n, *mprev;
 185         int tlen;
 186
 187         /* sanity check */
 188         if (so == 0 || msg == 0)
 189                 panic("%s: NULL pointer was passed.\n", __func__);
 190
 191         KEYDEBUG(KEYDEBUG_KEY_DUMP,
 192                 printf("%s: \n", __func__);
 193                 kdebug_sadb(msg));
 194
 195         /*
 196          * we increment statistics here, just in case we have ENOBUFS
 197          * in this function.
 198          */
 199         PFKEYSTAT_INC(in_total);
 200         PFKEYSTAT_ADD(in_bytes, len);
 201         PFKEYSTAT_INC(in_msgtype[msg->sadb_msg_type]);
 202
 203         /*
 204          * Get mbuf chain whenever possible (not clusters),
 205          * to save socket buffer.  We'll be generating many SADB_ACQUIRE
 206          * messages to listening key sockets.  If we simply allocate clusters,
 207          * sbappendaddr() will raise ENOBUFS due to too little sbspace().
 208          * sbspace() computes # of actual data bytes AND mbuf region.
 209          *
 210          * TODO: SADB_ACQUIRE filters should be implemented.
 211          */
 212         tlen = len;
 213         m = mprev = NULL;
 214         while (tlen > 0) {
 215                 if (tlen == len) {
 216                         MGETHDR(n, M_NOWAIT, MT_DATA);
 217                         if (n == NULL) {
 218                                 PFKEYSTAT_INC(in_nomem);
 219                                 return ENOBUFS;
 220                         }
 221                         n->m_len = MHLEN;
 222                 } else {
 223                         MGET(n, M_NOWAIT, MT_DATA);
 224                         if (n == NULL) {
 225                                 PFKEYSTAT_INC(in_nomem);
 226                                 return ENOBUFS;
 227                         }
 228                         n->m_len = MLEN;
 229                 }
 230                 if (tlen >= MCLBYTES) { /*XXX better threshold? */
 231                         MCLGET(n, M_NOWAIT);
 232                         if ((n->m_flags & M_EXT) == 0) {
 233                                 m_free(n);
 234                                 m_freem(m);
 235                                 PFKEYSTAT_INC(in_nomem);
 236                                 return ENOBUFS;
 237                         }
 238                         n->m_len = MCLBYTES;
 239                 }
 240
 241                 if (tlen < n->m_len)
 242                         n->m_len = tlen;
 243                 n->m_next = NULL;
 244                 if (m == NULL)
 245                         m = mprev = n;
 246                 else {
 247                         mprev->m_next = n;
 248                         mprev = n;
 249                 }
 250                 tlen -= n->m_len;
 251                 n = NULL;
 252         }
 253         m->m_pkthdr.len = len;
 254         m->m_pkthdr.rcvif = NULL;
 255         m_copyback(m, 0, len, (caddr_t)msg);
 256
 257         /* avoid duplicated statistics */
 258         PFKEYSTAT_ADD(in_total, -1);
 259         PFKEYSTAT_ADD(in_bytes, -len);
 260         PFKEYSTAT_ADD(in_msgtype[msg->sadb_msg_type], -1);
 261
 262         return key_sendup_mbuf(so, m, target);
 263 }
 264
 265 /* so can be NULL if target != KEY_SENDUP_ONE */
 266 int
 267 key_sendup_mbuf(so, m, target)
 268         struct socket *so;
 269         struct mbuf *m;
 270         int target;
 271 {
 272         struct mbuf *n;
 273         struct keycb *kp;
 274         int sendup;
 275         struct rawcb *rp;
 276         int error = 0;
 277
 278         if (m == NULL)
 279                 panic("key_sendup_mbuf: NULL pointer was passed.\n");
 280         if (so == NULL && target == KEY_SENDUP_ONE)
 281                 panic("%s: NULL pointer was passed.\n", __func__);
 282
 283         PFKEYSTAT_INC(in_total);
 284         PFKEYSTAT_ADD(in_bytes, m->m_pkthdr.len);
 285         if (m->m_len < sizeof(struct sadb_msg)) {
 286                 m = m_pullup(m, sizeof(struct sadb_msg));
 287                 if (m == NULL) {
 288                         PFKEYSTAT_INC(in_nomem);
 289                         return ENOBUFS;
 290                 }
 291         }
 292         if (m->m_len >= sizeof(struct sadb_msg)) {
 293                 struct sadb_msg *msg;
 294                 msg = mtod(m, struct sadb_msg *);
 295                 PFKEYSTAT_INC(in_msgtype[msg->sadb_msg_type]);
 296         }
 297         mtx_lock(&rawcb_mtx);
 298         LIST_FOREACH(rp, &V_rawcb_list, list)
 299         {
 300                 if (rp->rcb_proto.sp_family != PF_KEY)
 301                         continue;
 302                 if (rp->rcb_proto.sp_protocol
 303                  && rp->rcb_proto.sp_protocol != PF_KEY_V2) {
 304                         continue;
 305                 }
 306
 307                 kp = (struct keycb *)rp;
 308
 309                 /*
 310                  * If you are in promiscuous mode, and when you get broadcasted
 311                  * reply, you'll get two PF_KEY messages.
 312                  * (based on pf_key@inner.net message on 14 Oct 1998)
 313                  */
 314                 if (((struct keycb *)rp)->kp_promisc) {
 315                         if ((n = m_copy(m, 0, (int)M_COPYALL)) != NULL) {
 316                                 (void)key_sendup0(rp, n, 1);
 317                                 n = NULL;
 318                         }
 319                 }
 320
 321                 /* the exact target will be processed later */
 322                 if (so && sotorawcb(so) == rp)
 323                         continue;
 324
 325                 sendup = 0;
 326                 switch (target) {
 327                 case KEY_SENDUP_ONE:
 328                         /* the statement has no effect */
 329                         if (so && sotorawcb(so) == rp)
 330                                 sendup++;
 331                         break;
 332                 case KEY_SENDUP_ALL:
 333                         sendup++;
 334                         break;
 335                 case KEY_SENDUP_REGISTERED:
 336                         if (kp->kp_registered)
 337                                 sendup++;
 338                         break;
 339                 }
 340                 PFKEYSTAT_INC(in_msgtarget[target]);
 341
 342                 if (!sendup)
 343                         continue;
 344
 345                 if ((n = m_copy(m, 0, (int)M_COPYALL)) == NULL) {
 346                         m_freem(m);
 347                         PFKEYSTAT_INC(in_nomem);
 348                         mtx_unlock(&rawcb_mtx);
 349                         return ENOBUFS;
 350                 }
 351
 352                 if ((error = key_sendup0(rp, n, 0)) != 0) {
 353                         m_freem(m);
 354                         mtx_unlock(&rawcb_mtx);
 355                         return error;
 356                 }
 357
 358                 n = NULL;
 359         }
 360
 361         if (so) {
 362                 error = key_sendup0(sotorawcb(so), m, 0);
 363                 m = NULL;
 364         } else {
 365                 error = 0;
 366                 m_freem(m);
 367         }
 368         mtx_unlock(&rawcb_mtx);
 369         return error;
 370 }
 371
 372 /*
 373  * key_abort()
 374  * derived from net/rtsock.c:rts_abort()
 375  */
 376 static void
 377 key_abort(struct socket *so)
 378 {
 379         raw_usrreqs.pru_abort(so);
 380 }
 381
 382 /*
 383  * key_attach()
 384  * derived from net/rtsock.c:rts_attach()
 385  */
 386 static int
 387 key_attach(struct socket *so, int proto, struct thread *td)
 388 {
 389         struct keycb *kp;
 390         int error;
 391
 392         KASSERT(so->so_pcb == NULL, ("key_attach: so_pcb != NULL"));
 393
 394         if (td != NULL) {
 395                 error = priv_check(td, PRIV_NET_RAW);
 396                 if (error)
 397                         return error;
 398         }
 399
 400         /* XXX */
 401         kp = malloc(sizeof *kp, M_PCB, M_WAITOK | M_ZERO);
 402         if (kp == 0)
 403                 return ENOBUFS;
 404
 405         so->so_pcb = (caddr_t)kp;
 406         error = raw_attach(so, proto);
 407         kp = (struct keycb *)sotorawcb(so);
 408         if (error) {
 409                 free(kp, M_PCB);
 410                 so->so_pcb = (caddr_t) 0;
 411                 return error;
 412         }
 413
 414         kp->kp_promisc = kp->kp_registered = 0;
 415
 416         if (kp->kp_raw.rcb_proto.sp_protocol == PF_KEY) /* XXX: AF_KEY */
 417                 V_key_cb.key_count++;
 418         V_key_cb.any_count++;
 419         soisconnected(so);
 420         so->so_options |= SO_USELOOPBACK;
 421
 422         return 0;
 423 }
 424
 425 /*
 426  * key_bind()
 427  * derived from net/rtsock.c:rts_bind()
 428  */
 429 static int
 430 key_bind(struct socket *so, struct sockaddr *nam, struct thread *td)
 431 {
 432   return EINVAL;
 433 }
 434
 435 /*
 436  * key_close()
 437  * derived from net/rtsock.c:rts_close().
 438  */
 439 static void
 440 key_close(struct socket *so)
 441 {
 442
 443         raw_usrreqs.pru_close(so);
 444 }
 445
 446 /*
 447  * key_connect()
 448  * derived from net/rtsock.c:rts_connect()
 449  */
 450 static int
 451 key_connect(struct socket *so, struct sockaddr *nam, struct thread *td)
 452 {
 453         return EINVAL;
 454 }
 455
 456 /*
 457  * key_detach()
 458  * derived from net/rtsock.c:rts_detach()
 459  */
 460 static void
 461 key_detach(struct socket *so)
 462 {
 463         struct keycb *kp = (struct keycb *)sotorawcb(so);
 464
 465         KASSERT(kp != NULL, ("key_detach: kp == NULL"));
 466         if (kp->kp_raw.rcb_proto.sp_protocol
 467             == PF_KEY) /* XXX: AF_KEY */
 468                 V_key_cb.key_count--;
 469         V_key_cb.any_count--;
 470
 471         key_freereg(so);
 472         raw_usrreqs.pru_detach(so);
 473 }
 474
 475 /*
 476  * key_disconnect()
 477  * derived from net/rtsock.c:key_disconnect()
 478  */
 479 static int
 480 key_disconnect(struct socket *so)
 481 {
 482         return(raw_usrreqs.pru_disconnect(so));
 483 }
 484
 485 /*
 486  * key_peeraddr()
 487  * derived from net/rtsock.c:rts_peeraddr()
 488  */
 489 static int
 490 key_peeraddr(struct socket *so, struct sockaddr **nam)
 491 {
 492         return(raw_usrreqs.pru_peeraddr(so, nam));
 493 }
 494
 495 /*
 496  * key_send()
 497  * derived from net/rtsock.c:rts_send()
 498  */
 499 static int
 500 key_send(struct socket *so, int flags, struct mbuf *m, struct sockaddr *nam,
 501          struct mbuf *control, struct thread *td)
 502 {
 503         return(raw_usrreqs.pru_send(so, flags, m, nam, control, td));
 504 }
 505
 506 /*
 507  * key_shutdown()
 508  * derived from net/rtsock.c:rts_shutdown()
 509  */
 510 static int
 511 key_shutdown(struct socket *so)
 512 {
 513         return(raw_usrreqs.pru_shutdown(so));
 514 }
 515
 516 /*
 517  * key_sockaddr()
 518  * derived from net/rtsock.c:rts_sockaddr()
 519  */
 520 static int
 521 key_sockaddr(struct socket *so, struct sockaddr **nam)
 522 {
 523         return(raw_usrreqs.pru_sockaddr(so, nam));
 524 }
 525
 526 struct pr_usrreqs key_usrreqs = {
 527         .pru_abort =            key_abort,
 528         .pru_attach =           key_attach,
 529         .pru_bind =             key_bind,
 530         .pru_connect =          key_connect,
 531         .pru_detach =           key_detach,
 532         .pru_disconnect =       key_disconnect,
 533         .pru_peeraddr =         key_peeraddr,
 534         .pru_send =             key_send,
 535         .pru_shutdown =         key_shutdown,
 536         .pru_sockaddr =         key_sockaddr,
 537         .pru_close =            key_close,
 538 };
 539
 540 /* sysctl */
 541 SYSCTL_NODE(_net, PF_KEY, key, CTLFLAG_RW, 0, "Key Family");
 542
 543 /*
 544  * Definitions of protocols supported in the KEY domain.
 545  */
 546
 547 extern struct domain keydomain;
 548
 549 struct protosw keysw[] = {
 550 {
 551         .pr_type =              SOCK_RAW,
 552         .pr_domain =            &keydomain,
 553         .pr_protocol =          PF_KEY_V2,
 554         .pr_flags =             PR_ATOMIC|PR_ADDR,
 555         .pr_output =            key_output,
 556         .pr_ctlinput =          raw_ctlinput,
 557         .pr_init =              raw_init,
 558         .pr_usrreqs =           &key_usrreqs
 559 }
 560 };
 561
 562 static void
 563 key_init0(void)
 564 {
 565
 566         bzero((caddr_t)&V_key_cb, sizeof(V_key_cb));
 567         key_init();
 568 }
 569
 570 struct domain keydomain = {
 571         .dom_family =           PF_KEY,
 572         .dom_name =             "key",
 573         .dom_init =             key_init0,
 574 #ifdef VIMAGE
 575         .dom_destroy =          key_destroy,
 576 #endif
 577         .dom_protosw =          keysw,
 578         .dom_protoswNPROTOSW =  &keysw[sizeof(keysw)/sizeof(keysw[0])]
 579 };
 580
 581 VNET_DOMAIN_SET(key);