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