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 /*      $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/malloc.h>
  43 #include <sys/mbuf.h>
  44 #include <sys/protosw.h>
  45 #include <sys/signalvar.h>
  46 #include <sys/socket.h>
  47 #include <sys/socketvar.h>
  48 #include <sys/sysctl.h>
  49 #include <sys/systm.h>
  50 #include <sys/thread2.h>
  51
  52 #include <net/raw_cb.h>
  53 #include <net/route.h>
  54
  55 #include <net/pfkeyv2.h>
  56 #include <netproto/ipsec/key.h>
  57 #include <netproto/ipsec/keysock.h>
  58 #include <netproto/ipsec/key_debug.h>
  59
  60 #include <machine/stdarg.h>
  61
  62 typedef int     pr_output_t (struct mbuf *, struct socket *);
  63
  64 struct key_cb {
  65         int key_count;
  66         int any_count;
  67 };
  68 static struct key_cb key_cb;
  69
  70 static struct sockaddr key_dst = { 2, PF_KEY, };
  71 static struct sockaddr key_src = { 2, PF_KEY, };
  72
  73 static int key_sendup0 (struct rawcb *, struct mbuf *, int);
  74
  75 struct pfkeystat pfkeystat;
  76
  77 /*
  78  * key_output()
  79  */
  80 int
  81 key_output(struct mbuf *m, struct socket *so, ...)
  82 {
  83         struct sadb_msg *msg;
  84         int len, error = 0;
  85
  86
  87         if (m == 0)
  88                 panic("key_output: NULL pointer was passed.\n");
  89
  90         pfkeystat.out_total++;
  91         pfkeystat.out_bytes += m->m_pkthdr.len;
  92
  93         len = m->m_pkthdr.len;
  94         if (len < sizeof(struct sadb_msg)) {
  95                 pfkeystat.out_tooshort++;
  96                 error = EINVAL;
  97                 goto end;
  98         }
  99
 100         if (m->m_len < sizeof(struct sadb_msg)) {
 101                 if ((m = m_pullup(m, sizeof(struct sadb_msg))) == 0) {
 102                         pfkeystat.out_nomem++;
 103                         error = ENOBUFS;
 104                         goto end;
 105                 }
 106         }
 107
 108         if ((m->m_flags & M_PKTHDR) == 0)
 109                 panic("key_output: not M_PKTHDR ??");
 110
 111         KEYDEBUG(KEYDEBUG_KEY_DUMP, kdebug_mbuf(m));
 112
 113         msg = mtod(m, struct sadb_msg *);
 114         pfkeystat.out_msgtype[msg->sadb_msg_type]++;
 115         if (len != PFKEY_UNUNIT64(msg->sadb_msg_len)) {
 116                 pfkeystat.out_invlen++;
 117                 error = EINVAL;
 118                 goto end;
 119         }
 120
 121         /*XXX giant lock*/
 122         crit_enter();
 123         error = key_parse(m, so);
 124         m = NULL;
 125         crit_exit();
 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(struct rawcb *rp, struct mbuf *m, int promisc)
 137 {
 138         int error;
 139
 140         if (promisc) {
 141                 struct sadb_msg *pmsg;
 142
 143                 M_PREPEND(m, sizeof(struct sadb_msg), MB_DONTWAIT);
 144                 if (m && m->m_len < sizeof(struct sadb_msg))
 145                         m = m_pullup(m, sizeof(struct sadb_msg));
 146                 if (!m) {
 147                         pfkeystat.in_nomem++;
 148                         m_freem(m);
 149                         return ENOBUFS;
 150                 }
 151                 m->m_pkthdr.len += sizeof(*pmsg);
 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.in_msgtype[pmsg->sadb_msg_type]++;
 161         }
 162
 163         if (!ssb_appendaddr(&rp->rcb_socket->so_rcv, (struct sockaddr *)&key_src,
 164             m, NULL)) {
 165                 pfkeystat.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 /*
 175  * XXX this interface should be obsoleted.
 176  *
 177  * Parameters:
 178  *      target: target of the resulting message
 179  */
 180 int
 181 key_sendup(struct socket *so, struct sadb_msg *msg, u_int len, int target)
 182 {
 183         struct mbuf *m, *n, *mprev;
 184         int tlen;
 185
 186         /* sanity check */
 187         if (so == 0 || msg == 0)
 188                 panic("key_sendup: NULL pointer was passed.\n");
 189
 190         KEYDEBUG(KEYDEBUG_KEY_DUMP,
 191                 kprintf("key_sendup: \n");
 192                 kdebug_sadb(msg));
 193
 194         /*
 195          * we increment statistics here, just in case we have ENOBUFS
 196          * in this function.
 197          */
 198         pfkeystat.in_total++;
 199         pfkeystat.in_bytes += len;
 200         pfkeystat.in_msgtype[msg->sadb_msg_type]++;
 201
 202         /*
 203          * Get mbuf chain whenever possible (not clusters),
 204          * to save socket buffer.  We'll be generating many SADB_ACQUIRE
 205          * messages to listening key sockets.  If we simply allocate clusters,
 206          * ssb_appendaddr() will raise ENOBUFS due to too little ssb_space().
 207          * ssb_space() computes # of actual data bytes AND mbuf region.
 208          *
 209          * TODO: SADB_ACQUIRE filters should be implemented.
 210          */
 211         tlen = len;
 212         m = mprev = NULL;
 213         while (tlen > 0) {
 214                 int nsize;
 215
 216                 n = m_getl(tlen, MB_DONTWAIT, MT_DATA,
 217                            (tlen == len) ? M_PKTHDR : 0, &nsize);
 218                 if (n == NULL) {
 219                         m_freem(m);
 220                         pfkeystat.in_nomem++;
 221                         return ENOBUFS;
 222                 }
 223                 n->m_len = (tlen < n->m_len) ? tlen : nsize;
 224
 225                 if (m == NULL)
 226                         m = mprev = n;
 227                 else {
 228                         mprev->m_next = n;
 229                         mprev = n;
 230                 }
 231                 tlen -= n->m_len;
 232         }
 233         m->m_pkthdr.len = len;
 234         m_copyback(m, 0, len, (caddr_t)msg);
 235
 236         /* avoid duplicated statistics */
 237         pfkeystat.in_total--;
 238         pfkeystat.in_bytes -= len;
 239         pfkeystat.in_msgtype[msg->sadb_msg_type]--;
 240
 241         return key_sendup_mbuf(so, m, target);
 242 }
 243
 244 /* so can be NULL if target != KEY_SENDUP_ONE */
 245 int
 246 key_sendup_mbuf(struct socket *so, struct mbuf *m, int target)
 247 {
 248         struct mbuf *n;
 249         struct keycb *kp;
 250         int sendup;
 251         struct rawcb *rp;
 252         int error = 0;
 253
 254         if (m == NULL)
 255                 panic("key_sendup_mbuf: NULL pointer was passed.\n");
 256         if (so == NULL && target == KEY_SENDUP_ONE)
 257                 panic("key_sendup_mbuf: NULL pointer was passed.\n");
 258
 259         pfkeystat.in_total++;
 260         pfkeystat.in_bytes += m->m_pkthdr.len;
 261         if (m->m_len < sizeof(struct sadb_msg)) {
 262 #if 1
 263                 m = m_pullup(m, sizeof(struct sadb_msg));
 264                 if (m == NULL) {
 265                         pfkeystat.in_nomem++;
 266                         return ENOBUFS;
 267                 }
 268 #else
 269                 /* don't bother pulling it up just for stats */
 270 #endif
 271         }
 272         if (m->m_len >= sizeof(struct sadb_msg)) {
 273                 struct sadb_msg *msg;
 274                 msg = mtod(m, struct sadb_msg *);
 275                 pfkeystat.in_msgtype[msg->sadb_msg_type]++;
 276         }
 277
 278         LIST_FOREACH(rp, &rawcb_list, list)
 279         {
 280                 if (rp->rcb_proto.sp_family != PF_KEY)
 281                         continue;
 282                 if (rp->rcb_proto.sp_protocol
 283                  && rp->rcb_proto.sp_protocol != PF_KEY_V2) {
 284                         continue;
 285                 }
 286
 287                 kp = (struct keycb *)rp;
 288
 289                 /*
 290                  * If you are in promiscuous mode, and when you get broadcasted
 291                  * reply, you'll get two PF_KEY messages.
 292                  * (based on pf_key@inner.net message on 14 Oct 1998)
 293                  */
 294                 if (((struct keycb *)rp)->kp_promisc) {
 295                         if ((n = m_copy(m, 0, (int)M_COPYALL)) != NULL) {
 296                                 key_sendup0(rp, n, 1);
 297                                 n = NULL;
 298                         }
 299                 }
 300
 301                 /* the exact target will be processed later */
 302                 if (so && sotorawcb(so) == rp)
 303                         continue;
 304
 305                 sendup = 0;
 306                 switch (target) {
 307                 case KEY_SENDUP_ONE:
 308                         /* the statement has no effect */
 309                         if (so && sotorawcb(so) == rp)
 310                                 sendup++;
 311                         break;
 312                 case KEY_SENDUP_ALL:
 313                         sendup++;
 314                         break;
 315                 case KEY_SENDUP_REGISTERED:
 316                         if (kp->kp_registered)
 317                                 sendup++;
 318                         break;
 319                 }
 320                 pfkeystat.in_msgtarget[target]++;
 321
 322                 if (!sendup)
 323                         continue;
 324
 325                 if ((n = m_copy(m, 0, (int)M_COPYALL)) == NULL) {
 326                         m_freem(m);
 327                         pfkeystat.in_nomem++;
 328                         return ENOBUFS;
 329                 }
 330
 331                 if ((error = key_sendup0(rp, n, 0)) != 0) {
 332                         m_freem(m);
 333                         return error;
 334                 }
 335
 336                 n = NULL;
 337         }
 338
 339         if (so) {
 340                 error = key_sendup0(sotorawcb(so), m, 0);
 341                 m = NULL;
 342         } else {
 343                 error = 0;
 344                 m_freem(m);
 345         }
 346         return error;
 347 }
 348
 349 /*
 350  * key_abort()
 351  * derived from net/rtsock.c:rts_abort()
 352  */
 353 static int
 354 key_abort(struct socket *so)
 355 {
 356         int error;
 357
 358         error = raw_usrreqs.pru_abort(so);
 359
 360         return error;
 361 }
 362
 363 /*
 364  * key_attach()
 365  * derived from net/rtsock.c:rts_attach()
 366  */
 367 static int
 368 key_attach(struct socket *so, int proto, struct pru_attach_info *ai)
 369 {
 370         struct keycb *kp;
 371         int error;
 372
 373         if (sotorawcb(so) != 0)
 374                 return EISCONN; /* XXX panic? */
 375         kp = (struct keycb *)kmalloc(sizeof *kp, M_PCB, M_WAITOK|M_ZERO); /* XXX */
 376
 377         /*
 378          * The critical section is necessary to block protocols from sending
 379          * error notifications (like RTM_REDIRECT or RTM_LOSING) while
 380          * this PCB is extant but incompletely initialized.
 381          * Probably we should try to do more of this work beforehand and
 382          * eliminate the spl.
 383          */
 384         crit_enter();
 385         so->so_pcb = (caddr_t)kp;
 386         error = raw_usrreqs.pru_attach(so, proto, ai);
 387         kp = (struct keycb *)sotorawcb(so);
 388         if (error) {
 389                 kfree(kp, M_PCB);
 390                 so->so_pcb = (caddr_t) 0;
 391                 crit_exit();
 392                 return error;
 393         }
 394
 395         kp->kp_promisc = kp->kp_registered = 0;
 396
 397         if (kp->kp_raw.rcb_proto.sp_protocol == PF_KEY) /* XXX: AF_KEY */
 398                 key_cb.key_count++;
 399         key_cb.any_count++;
 400         kp->kp_raw.rcb_laddr = &key_src;
 401         kp->kp_raw.rcb_faddr = &key_dst;
 402         soisconnected(so);
 403         so->so_options |= SO_USELOOPBACK;
 404
 405         crit_exit();
 406         return 0;
 407 }
 408
 409 /*
 410  * key_bind()
 411  * derived from net/rtsock.c:rts_bind()
 412  */
 413 static int
 414 key_bind(struct socket *so, struct sockaddr *nam, struct thread *td)
 415 {
 416         int error;
 417         crit_enter();
 418         error = raw_usrreqs.pru_bind(so, nam, td); /* xxx just EINVAL */
 419         crit_exit();
 420         return error;
 421 }
 422
 423 /*
 424  * key_connect()
 425  * derived from net/rtsock.c:rts_connect()
 426  */
 427 static int
 428 key_connect(struct socket *so, struct sockaddr *nam, struct thread *td)
 429 {
 430         int error;
 431         crit_enter();
 432         error = raw_usrreqs.pru_connect(so, nam, td); /* XXX just EINVAL */
 433         crit_exit();
 434         return error;
 435 }
 436
 437 /*
 438  * key_detach()
 439  * derived from net/rtsock.c:rts_detach()
 440  */
 441 static int
 442 key_detach(struct socket *so)
 443 {
 444         struct keycb *kp = (struct keycb *)sotorawcb(so);
 445         int error;
 446
 447         crit_enter();
 448         if (kp != 0) {
 449                 if (kp->kp_raw.rcb_proto.sp_protocol
 450                     == PF_KEY) /* XXX: AF_KEY */
 451                         key_cb.key_count--;
 452                 key_cb.any_count--;
 453
 454                 key_freereg(so);
 455         }
 456         error = raw_usrreqs.pru_detach(so);
 457         crit_exit();
 458         return error;
 459 }
 460
 461 /*
 462  * key_disconnect()
 463  * derived from net/rtsock.c:key_disconnect()
 464  */
 465 static int
 466 key_disconnect(struct socket *so)
 467 {
 468         int error;
 469         crit_enter();
 470         error = raw_usrreqs.pru_disconnect(so);
 471         crit_exit();
 472         return error;
 473 }
 474
 475 /*
 476  * key_peeraddr()
 477  * derived from net/rtsock.c:rts_peeraddr()
 478  */
 479 static int
 480 key_peeraddr(struct socket *so, struct sockaddr **nam)
 481 {
 482         int error;
 483         crit_enter();
 484         error = raw_usrreqs.pru_peeraddr(so, nam);
 485         crit_exit();
 486         return error;
 487 }
 488
 489 /*
 490  * key_send()
 491  * derived from net/rtsock.c:rts_send()
 492  */
 493 static int
 494 key_send(struct socket *so, int flags, struct mbuf *m, struct sockaddr *nam,
 495          struct mbuf *control, struct thread *td)
 496 {
 497         int error;
 498         crit_enter();
 499         error = raw_usrreqs.pru_send(so, flags, m, nam, control, td);
 500         crit_exit();
 501         return error;
 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         int error;
 512         crit_enter();
 513         error = raw_usrreqs.pru_shutdown(so);
 514         crit_exit();
 515         return error;
 516 }
 517
 518 /*
 519  * key_sockaddr()
 520  * derived from net/rtsock.c:rts_sockaddr()
 521  */
 522 static int
 523 key_sockaddr(struct socket *so, struct sockaddr **nam)
 524 {
 525         int error;
 526         crit_enter();
 527         error = raw_usrreqs.pru_sockaddr(so, nam);
 528         crit_exit();
 529         return error;
 530 }
 531
 532 struct pr_usrreqs key_usrreqs = {
 533         .pru_abort = key_abort,
 534         .pru_accept = pru_accept_notsupp,
 535         .pru_attach = key_attach,
 536         .pru_bind = key_bind,
 537         .pru_connect = key_connect,
 538         .pru_connect2 = pru_connect2_notsupp,
 539         .pru_control = pru_control_notsupp,
 540         .pru_detach = key_detach,
 541         .pru_disconnect = key_disconnect,
 542         .pru_listen = pru_listen_notsupp,
 543         .pru_peeraddr = key_peeraddr,
 544         .pru_rcvd = pru_rcvd_notsupp,
 545         .pru_rcvoob = pru_rcvoob_notsupp,
 546         .pru_send = key_send,
 547         .pru_sense = pru_sense_null,
 548         .pru_shutdown = key_shutdown,
 549         .pru_sockaddr = key_sockaddr,
 550         .pru_sosend = sosend,
 551         .pru_soreceive = soreceive
 552 };
 553
 554 /* sysctl */
 555 SYSCTL_NODE(_net, PF_KEY, key, CTLFLAG_RW, 0, "Key Family");
 556
 557 /*
 558  * Definitions of protocols supported in the KEY domain.
 559  */
 560
 561 extern struct domain keydomain;
 562
 563 struct protosw keysw[] = {
 564 { SOCK_RAW,     &keydomain,     PF_KEY_V2,      PR_ATOMIC|PR_ADDR,
 565   0,            key_output,     raw_ctlinput,   0,
 566   cpu0_soport,  cpu0_ctlport,
 567   raw_init,     0,              0,              0,
 568   &key_usrreqs
 569 }
 570 };
 571
 572 static void
 573 key_init0(void)
 574 {
 575         bzero((caddr_t)&key_cb, sizeof(key_cb));
 576         key_init();
 577 }
 578
 579 struct domain keydomain = {
 580         PF_KEY, "key", key_init0, NULL, NULL,
 581         keysw, &keysw[NELEM(keysw)],
 582 };
 583
 584 DOMAIN_SET(key);