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 $ */
5 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
33 #include "opt_ipsec.h"
35 /* This code has derived from sys/net/rtsock.c on FreeBSD2.2.5 */
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>
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>
52 #include <net/raw_cb.h>
53 #include <net/route.h>
55 #include <net/pfkeyv2.h>
56 #include <netproto/ipsec/key.h>
57 #include <netproto/ipsec/keysock.h>
58 #include <netproto/ipsec/key_debug.h>
60 #include <machine/stdarg.h>
62 typedef int pr_output_t (struct mbuf *, struct socket *);
68 static struct key_cb key_cb;
70 static struct sockaddr key_dst = { 2, PF_KEY, };
71 static struct sockaddr key_src = { 2, PF_KEY, };
73 static int key_sendup0 (struct rawcb *, struct mbuf *, int);
75 struct pfkeystat pfkeystat;
81 key_output(struct mbuf *m, struct socket *so, ...)
88 panic("key_output: NULL pointer was passed.\n");
90 pfkeystat.out_total++;
91 pfkeystat.out_bytes += m->m_pkthdr.len;
93 len = m->m_pkthdr.len;
94 if (len < sizeof(struct sadb_msg)) {
95 pfkeystat.out_tooshort++;
100 if (m->m_len < sizeof(struct sadb_msg)) {
101 if ((m = m_pullup(m, sizeof(struct sadb_msg))) == NULL) {
102 pfkeystat.out_nomem++;
108 if ((m->m_flags & M_PKTHDR) == 0)
109 panic("key_output: not M_PKTHDR ??");
111 KEYDEBUG(KEYDEBUG_KEY_DUMP, kdebug_mbuf(m));
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++;
123 error = key_parse(m, so);
133 * send message to the socket.
136 key_sendup0(struct rawcb *rp, struct mbuf *m, int promisc)
141 struct sadb_msg *pmsg;
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));
147 pfkeystat.in_nomem++;
151 m->m_pkthdr.len += sizeof(*pmsg);
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);
160 pfkeystat.in_msgtype[pmsg->sadb_msg_type]++;
163 if (!ssb_appendaddr(&rp->rcb_socket->so_rcv, (struct sockaddr *)&key_src,
165 pfkeystat.in_nomem++;
170 sorwakeup(rp->rcb_socket);
175 * XXX this interface should be obsoleted.
178 * target: target of the resulting message
181 key_sendup(struct socket *so, struct sadb_msg *msg, u_int len, int target)
183 struct mbuf *m, *n, *mprev;
187 if (so == NULL || msg == NULL)
188 panic("key_sendup: NULL pointer was passed.\n");
190 KEYDEBUG(KEYDEBUG_KEY_DUMP,
191 kprintf("key_sendup: \n");
195 * we increment statistics here, just in case we have ENOBUFS
198 pfkeystat.in_total++;
199 pfkeystat.in_bytes += len;
200 pfkeystat.in_msgtype[msg->sadb_msg_type]++;
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.
209 * TODO: SADB_ACQUIRE filters should be implemented.
216 n = m_getl(tlen, MB_DONTWAIT, MT_DATA,
217 (tlen == len) ? M_PKTHDR : 0, &nsize);
220 pfkeystat.in_nomem++;
223 n->m_len = (tlen < n->m_len) ? tlen : nsize;
233 m->m_pkthdr.len = len;
234 m_copyback(m, 0, len, (caddr_t)msg);
236 /* avoid duplicated statistics */
237 pfkeystat.in_total--;
238 pfkeystat.in_bytes -= len;
239 pfkeystat.in_msgtype[msg->sadb_msg_type]--;
241 return key_sendup_mbuf(so, m, target);
244 /* so can be NULL if target != KEY_SENDUP_ONE */
246 key_sendup_mbuf(struct socket *so, struct mbuf *m, int target)
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");
259 pfkeystat.in_total++;
260 pfkeystat.in_bytes += m->m_pkthdr.len;
261 if (m->m_len < sizeof(struct sadb_msg)) {
263 m = m_pullup(m, sizeof(struct sadb_msg));
265 pfkeystat.in_nomem++;
269 /* don't bother pulling it up just for stats */
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]++;
278 LIST_FOREACH(rp, &rawcb_list, list)
280 if (rp->rcb_proto.sp_family != PF_KEY)
282 if (rp->rcb_proto.sp_protocol
283 && rp->rcb_proto.sp_protocol != PF_KEY_V2) {
287 kp = (struct keycb *)rp;
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)
294 if (((struct keycb *)rp)->kp_promisc) {
295 if ((n = m_copy(m, 0, (int)M_COPYALL)) != NULL) {
296 key_sendup0(rp, n, 1);
301 /* the exact target will be processed later */
302 if (so && sotorawcb(so) == rp)
308 /* the statement has no effect */
309 if (so && sotorawcb(so) == rp)
315 case KEY_SENDUP_REGISTERED:
316 if (kp->kp_registered)
320 pfkeystat.in_msgtarget[target]++;
325 if ((n = m_copy(m, 0, (int)M_COPYALL)) == NULL) {
327 pfkeystat.in_nomem++;
331 if ((error = key_sendup0(rp, n, 0)) != 0) {
340 error = key_sendup0(sotorawcb(so), m, 0);
351 * derived from net/rtsock.c:rts_abort()
354 key_abort(struct socket *so)
358 error = raw_usrreqs.pru_abort(so);
365 * derived from net/rtsock.c:rts_attach()
368 key_attach(struct socket *so, int proto, struct pru_attach_info *ai)
373 if (sotorawcb(so) != 0)
374 return EISCONN; /* XXX panic? */
375 kp = (struct keycb *)kmalloc(sizeof *kp, M_PCB, M_WAITOK|M_ZERO); /* XXX */
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
385 so->so_pcb = (caddr_t)kp;
386 error = raw_usrreqs.pru_attach(so, proto, ai);
387 kp = (struct keycb *)sotorawcb(so);
390 so->so_pcb = (caddr_t) 0;
395 kp->kp_promisc = kp->kp_registered = 0;
397 if (kp->kp_raw.rcb_proto.sp_protocol == PF_KEY) /* XXX: AF_KEY */
400 kp->kp_raw.rcb_laddr = &key_src;
401 kp->kp_raw.rcb_faddr = &key_dst;
403 so->so_options |= SO_USELOOPBACK;
411 * derived from net/rtsock.c:rts_bind()
414 key_bind(struct socket *so, struct sockaddr *nam, struct thread *td)
418 error = raw_usrreqs.pru_bind(so, nam, td); /* xxx just EINVAL */
425 * derived from net/rtsock.c:rts_connect()
428 key_connect(struct socket *so, struct sockaddr *nam, struct thread *td)
432 error = raw_usrreqs.pru_connect(so, nam, td); /* XXX just EINVAL */
439 * derived from net/rtsock.c:rts_detach()
442 key_detach(struct socket *so)
444 struct keycb *kp = (struct keycb *)sotorawcb(so);
449 if (kp->kp_raw.rcb_proto.sp_protocol
450 == PF_KEY) /* XXX: AF_KEY */
456 error = raw_usrreqs.pru_detach(so);
463 * derived from net/rtsock.c:key_disconnect()
466 key_disconnect(struct socket *so)
470 error = raw_usrreqs.pru_disconnect(so);
477 * derived from net/rtsock.c:rts_peeraddr()
480 key_peeraddr(struct socket *so, struct sockaddr **nam)
484 error = raw_usrreqs.pru_peeraddr(so, nam);
491 * derived from net/rtsock.c:rts_send()
494 key_send(struct socket *so, int flags, struct mbuf *m, struct sockaddr *nam,
495 struct mbuf *control, struct thread *td)
499 error = raw_usrreqs.pru_send(so, flags, m, nam, control, td);
506 * derived from net/rtsock.c:rts_shutdown()
509 key_shutdown(struct socket *so)
513 error = raw_usrreqs.pru_shutdown(so);
520 * derived from net/rtsock.c:rts_sockaddr()
523 key_sockaddr(struct socket *so, struct sockaddr **nam)
527 error = raw_usrreqs.pru_sockaddr(so, nam);
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
555 SYSCTL_NODE(_net, PF_KEY, key, CTLFLAG_RW, 0, "Key Family");
558 * Definitions of protocols supported in the KEY domain.
561 extern struct domain keydomain;
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,
575 bzero((caddr_t)&key_cb, sizeof(key_cb));
579 struct domain keydomain = {
580 PF_KEY, "key", key_init0, NULL, NULL,
581 keysw, &keysw[NELEM(keysw)],