xref: /openbsd/sys/netinet/in_pcb.h (revision db3296cf)
1 /*	$OpenBSD: in_pcb.h,v 1.45 2003/06/02 23:28:14 millert Exp $	*/
2 /*	$NetBSD: in_pcb.h,v 1.14 1996/02/13 23:42:00 christos 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 /*
34  * Copyright (c) 1982, 1986, 1990, 1993
35  *	The Regents of the University of California.  All rights reserved.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
40  * 1. Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions and the following disclaimer.
42  * 2. Redistributions in binary form must reproduce the above copyright
43  *    notice, this list of conditions and the following disclaimer in the
44  *    documentation and/or other materials provided with the distribution.
45  * 3. Neither the name of the University nor the names of its contributors
46  *    may be used to endorse or promote products derived from this software
47  *    without specific prior written permission.
48  *
49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59  * SUCH DAMAGE.
60  *
61  *	@(#)in_pcb.h	8.1 (Berkeley) 6/10/93
62  */
63 
64 #ifndef _NETINET_IN_PCB_H_
65 #define _NETINET_IN_PCB_H_
66 
67 #include <sys/queue.h>
68 #include <netinet/ip6.h>
69 #include <netinet6/ip6_var.h>
70 #include <netinet/icmp6.h>
71 #include <netinet/ip_ipsp.h>
72 
73 union inpaddru {
74 	struct in6_addr iau_addr6;
75 	struct {
76 		uint8_t pad[12];
77 		struct in_addr inaddr;	/* easier transition */
78 	} iau_a4u;
79 };
80 
81 /*
82  * Common structure pcb for internet protocol implementation.
83  * Here are stored pointers to local and foreign host table
84  * entries, local and foreign socket numbers, and pointers
85  * up (to a socket structure) and down (to a protocol-specific)
86  * control block.
87  */
88 struct inpcb {
89 	LIST_ENTRY(inpcb) inp_hash;
90 	CIRCLEQ_ENTRY(inpcb) inp_queue;
91 	struct	  inpcbtable *inp_table;
92 	union	  inpaddru inp_faddru;		/* Foreign address. */
93 	union	  inpaddru inp_laddru;		/* Local address. */
94 #define	inp_faddr	inp_faddru.iau_a4u.inaddr
95 #define	inp_faddr6	inp_faddru.iau_addr6
96 #define	inp_laddr	inp_laddru.iau_a4u.inaddr
97 #define	inp_laddr6	inp_laddru.iau_addr6
98 	u_int16_t inp_fport;		/* foreign port */
99 	u_int16_t inp_lport;		/* local port */
100 	struct	  socket *inp_socket;	/* back pointer to socket */
101 	caddr_t	  inp_ppcb;		/* pointer to per-protocol pcb */
102 	union {				/* Route (notice increased size). */
103 		struct route ru_route;
104 		struct route_in6 ru_route6;
105 	} inp_ru;
106 #define	inp_route	inp_ru.ru_route
107 #define	inp_route6	inp_ru.ru_route6
108 	int	  inp_flags;		/* generic IP/datagram flags */
109 	union {				/* Header prototype. */
110 		struct ip hu_ip;
111 		struct ip6_hdr hu_ipv6;
112 	} inp_hu;
113 #define	inp_ip		inp_hu.hu_ip
114 #define	inp_ipv6	inp_hu.hu_ipv6
115 	struct	  mbuf *inp_options;	/* IP options */
116 	struct ip6_pktopts *inp_outputopts6; /* IP6 options for outgoing packets */
117 	int inp_hops;
118 	union {
119 		struct ip_moptions *mou_mo;    /* IPv4 multicast options */
120 		struct ip6_moptions *mou_mo6; /* IPv6 multicast options */
121 	} inp_mou;
122 #define inp_moptions inp_mou.mou_mo
123 #define inp_moptions6 inp_mou.mou_mo6
124 	u_char	  inp_seclevel[4];
125 #define SL_AUTH           0             /* Authentication level */
126 #define SL_ESP_TRANS      1             /* ESP transport level */
127 #define SL_ESP_NETWORK    2             /* ESP network (encapsulation) level */
128 #define SL_IPCOMP         3             /* Compression level */
129 	u_int8_t  inp_secrequire:4,     /* Condensed State from above */
130 	          inp_secresult:4;	/* Result from Key Management */
131 #define SR_FAILED         1             /* Negotiation failed permanently */
132 #define SR_SUCCESS        2             /* SA successfully established */
133 #define SR_WAIT           3             /* Waiting for SA */
134 	TAILQ_ENTRY(inpcb) inp_tdb_in_next, inp_tdb_out_next;
135 	struct tdb     *inp_tdb_in, *inp_tdb_out;
136 	struct ipsec_policy *inp_ipo;
137 	struct ipsec_ref *inp_ipsec_remotecred;
138 	struct ipsec_ref *inp_ipsec_remoteauth;
139 #define	inp_flowinfo	inp_hu.hu_ipv6.ip6_flow
140 
141 	int	in6p_cksum;
142 #ifndef _KERNEL
143 #define inp_csumoffset	in6p_cksum
144 #endif
145 	struct	icmp6_filter *inp_icmp6filt;
146 };
147 
148 struct inpcbtable {
149 	CIRCLEQ_HEAD(, inpcb) inpt_queue;
150 	LIST_HEAD(inpcbhead, inpcb) *inpt_hashtbl;
151 	u_long	  inpt_hash;
152 	u_int16_t inpt_lastport;
153 };
154 
155 /* flags in inp_flags: */
156 #define	INP_RECVOPTS	0x001	/* receive incoming IP options */
157 #define	INP_RECVRETOPTS	0x002	/* receive IP options for reply */
158 #define	INP_RECVDSTADDR	0x004	/* receive IP dst address */
159 
160 #define	INP_RXDSTOPTS	INP_RECVOPTS
161 #define	INP_RXHOPOPTS	INP_RECVRETOPTS
162 #define	INP_RXINFO	INP_RECVDSTADDR
163 #define	INP_RXSRCRT	0x010
164 #define	INP_HOPLIMIT	0x020
165 
166 #define	INP_CONTROLOPTS	(INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR| \
167 	    INP_RXSRCRT|INP_HOPLIMIT)
168 
169 #define	INP_HDRINCL	0x008	/* user supplies entire IP header */
170 #define	INP_HIGHPORT	0x010	/* user wants "high" port binding */
171 #define	INP_LOWPORT	0x020	/* user wants "low" port binding */
172 
173 /*
174  * These flags' values should be determined by either the transport
175  * protocol at PRU_BIND, PRU_LISTEN, PRU_CONNECT, etc, or by in_pcb*().
176  */
177 #define	INP_IPV6	0x100	/* sotopf(inp->inp_socket) == PF_INET6 */
178 
179 #if 1	/*KAME*/
180 /*
181  * Flags in in6p_flags
182  * We define KAME's original flags in higher 16 bits as much as possible
183  * for compatibility with *bsd*s.
184  * XXX: Should IN6P_HIGHPORT and IN6P_LOWPORT be moved as well?
185  */
186 #define IN6P_RECVOPTS		INP_RECVOPTS	/* recv incoming IP6 options */
187 #define IN6P_RECVRETOPTS	INP_RECVRETOPTS /* recv IP6 options for reply */
188 #define IN6P_RECVDSTADDR	INP_RECVDSTADDR /* recv IP6 dst address */
189 #define IN6P_HIGHPORT		INP_HIGHPORT	/* user wants "high" port */
190 #define IN6P_LOWPORT		INP_LOWPORT	/* user wants "low" port */
191 #define IN6P_PKTINFO		0x010000 /* receive IP6 dst and I/F */
192 #define IN6P_HOPLIMIT		0x020000 /* receive hoplimit */
193 #define IN6P_HOPOPTS		0x040000 /* receive hop-by-hop options */
194 #define IN6P_DSTOPTS		0x080000 /* receive dst options after rthdr */
195 #define IN6P_RTHDR		0x100000 /* receive routing header */
196 #define IN6P_RTHDRDSTOPTS	0x200000 /* receive dstoptions before rthdr */
197 
198 #define IN6P_ANONPORT		0x4000000 /* port chosen for user */
199 #define IN6P_FAITH		0x8000000 /* accept FAITH'ed connections */
200 
201 #define IN6P_CONTROLOPTS	(IN6P_PKTINFO|IN6P_HOPLIMIT|IN6P_HOPOPTS|\
202 				 IN6P_DSTOPTS|IN6P_RTHDR|IN6P_RTHDRDSTOPTS)
203 #endif
204 
205 #define	INPLOOKUP_WILDCARD	1
206 #define	INPLOOKUP_SETLOCAL	2
207 #define	INPLOOKUP_IPV6		4
208 
209 #define	sotoinpcb(so)	((struct inpcb *)(so)->so_pcb)
210 
211 /* macros for handling bitmap of ports not to allocate dynamically */
212 #define	DP_MAPBITS	(sizeof(u_int32_t) * NBBY)
213 #define	DP_MAPSIZE	(howmany(IPPORT_RESERVED/2, DP_MAPBITS))
214 #define	DP_SET(m, p)	((m)[((p) - IPPORT_RESERVED/2) / DP_MAPBITS] |= (1 << ((p) % DP_MAPBITS)))
215 #define	DP_CLR(m, p)	((m)[((p) - IPPORT_RESERVED/2) / DP_MAPBITS] &= ~(1 << ((p) % DP_MAPBITS)))
216 #define	DP_ISSET(m, p)	((m)[((p) - IPPORT_RESERVED/2) / DP_MAPBITS] & (1 << ((p) % DP_MAPBITS)))
217 
218 /* default values for baddynamicports [see ip_init()] */
219 #define	DEFBADDYNAMICPORTS_TCP	{ 587, 749, 750, 751, 760, 761, 871, 0 }
220 #define	DEFBADDYNAMICPORTS_UDP	{ 750, 751, 0 }
221 
222 struct baddynamicports {
223 	u_int32_t tcp[DP_MAPSIZE];
224 	u_int32_t udp[DP_MAPSIZE];
225 };
226 
227 #ifdef _KERNEL
228 
229 #define sotopf(so)  (so->so_proto->pr_domain->dom_family)
230 
231 void	 in_losing(struct inpcb *);
232 int	 in_pcballoc(struct socket *, void *);
233 int	 in_pcbbind(void *, struct mbuf *);
234 int	 in_pcbconnect(void *, struct mbuf *);
235 void	 in_pcbdetach(void *);
236 void	 in_pcbdisconnect(void *);
237 struct inpcb *
238 	 in_pcbhashlookup(struct inpcbtable *, struct in_addr,
239 			       u_int, struct in_addr, u_int);
240 #ifdef INET6
241 struct inpcb *
242 	 in6_pcbhashlookup(struct inpcbtable *, struct in6_addr *,
243 			       u_int, struct in6_addr *, u_int);
244 int	 in6_pcbbind(struct inpcb *, struct mbuf *);
245 int	 in6_pcbconnect(struct inpcb *, struct mbuf *);
246 int	 in6_setsockaddr(struct inpcb *, struct mbuf *);
247 int	 in6_setpeeraddr(struct inpcb *, struct mbuf *);
248 #endif /* INET6 */
249 void	 in_pcbinit(struct inpcbtable *, int);
250 struct inpcb *
251 	 in_pcblookup(struct inpcbtable *, void *, u_int, void *,
252 	    u_int, int);
253 void	 in_pcbnotify(struct inpcbtable *, struct sockaddr *,
254 	    u_int, struct in_addr, u_int, int, void (*)(struct inpcb *, int));
255 void	 in_pcbnotifyall(struct inpcbtable *, struct sockaddr *,
256 	    int, void (*)(struct inpcb *, int));
257 void	 in_pcbrehash(struct inpcb *);
258 void	 in_rtchange(struct inpcb *, int);
259 void	 in_setpeeraddr(struct inpcb *, struct mbuf *);
260 void	 in_setsockaddr(struct inpcb *, struct mbuf *);
261 int	 in_baddynamic(u_int16_t, u_int16_t);
262 extern struct sockaddr_in *in_selectsrc(struct sockaddr_in *,
263 	struct route *, int, struct ip_moptions *, int *);
264 struct rtentry *
265 	in_pcbrtentry(struct inpcb *);
266 
267 /* INET6 stuff */
268 int	in6_pcbnotify(struct inpcbtable *, struct sockaddr *,
269 	u_int, struct sockaddr *, u_int, int, void *,
270 	void (*)(struct inpcb *, int));
271 int	in6_selecthlim(struct inpcb *, struct ifnet *);
272 int	in6_pcbsetport(struct in6_addr *, struct inpcb *, struct proc *);
273 #endif /* _KERNEL */
274 #endif /* _NETINET_IN_PCB_H_ */
275