sys/netproto/ipsec/keysock.c

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