xref: /linux/include/net/xfrm.h (revision 2b8232ce512105e28453f301d1510de8363bccd1)
1 #ifndef _NET_XFRM_H
2 #define _NET_XFRM_H
3 
4 #include <linux/compiler.h>
5 #include <linux/xfrm.h>
6 #include <linux/spinlock.h>
7 #include <linux/list.h>
8 #include <linux/skbuff.h>
9 #include <linux/socket.h>
10 #include <linux/pfkeyv2.h>
11 #include <linux/ipsec.h>
12 #include <linux/in6.h>
13 #include <linux/mutex.h>
14 #include <linux/audit.h>
15 
16 #include <net/sock.h>
17 #include <net/dst.h>
18 #include <net/ip.h>
19 #include <net/route.h>
20 #include <net/ipv6.h>
21 #include <net/ip6_fib.h>
22 
23 #define XFRM_PROTO_ESP		50
24 #define XFRM_PROTO_AH		51
25 #define XFRM_PROTO_COMP		108
26 #define XFRM_PROTO_IPIP		4
27 #define XFRM_PROTO_IPV6		41
28 #define XFRM_PROTO_ROUTING	IPPROTO_ROUTING
29 #define XFRM_PROTO_DSTOPTS	IPPROTO_DSTOPTS
30 
31 #define XFRM_ALIGN8(len)	(((len) + 7) & ~7)
32 #define MODULE_ALIAS_XFRM_MODE(family, encap) \
33 	MODULE_ALIAS("xfrm-mode-" __stringify(family) "-" __stringify(encap))
34 #define MODULE_ALIAS_XFRM_TYPE(family, proto) \
35 	MODULE_ALIAS("xfrm-type-" __stringify(family) "-" __stringify(proto))
36 
37 extern struct sock *xfrm_nl;
38 extern u32 sysctl_xfrm_aevent_etime;
39 extern u32 sysctl_xfrm_aevent_rseqth;
40 
41 extern struct mutex xfrm_cfg_mutex;
42 
43 /* Organization of SPD aka "XFRM rules"
44    ------------------------------------
45 
46    Basic objects:
47    - policy rule, struct xfrm_policy (=SPD entry)
48    - bundle of transformations, struct dst_entry == struct xfrm_dst (=SA bundle)
49    - instance of a transformer, struct xfrm_state (=SA)
50    - template to clone xfrm_state, struct xfrm_tmpl
51 
52    SPD is plain linear list of xfrm_policy rules, ordered by priority.
53    (To be compatible with existing pfkeyv2 implementations,
54    many rules with priority of 0x7fffffff are allowed to exist and
55    such rules are ordered in an unpredictable way, thanks to bsd folks.)
56 
57    Lookup is plain linear search until the first match with selector.
58 
59    If "action" is "block", then we prohibit the flow, otherwise:
60    if "xfrms_nr" is zero, the flow passes untransformed. Otherwise,
61    policy entry has list of up to XFRM_MAX_DEPTH transformations,
62    described by templates xfrm_tmpl. Each template is resolved
63    to a complete xfrm_state (see below) and we pack bundle of transformations
64    to a dst_entry returned to requestor.
65 
66    dst -. xfrm  .-> xfrm_state #1
67     |---. child .-> dst -. xfrm .-> xfrm_state #2
68                      |---. child .-> dst -. xfrm .-> xfrm_state #3
69                                       |---. child .-> NULL
70 
71    Bundles are cached at xrfm_policy struct (field ->bundles).
72 
73 
74    Resolution of xrfm_tmpl
75    -----------------------
76    Template contains:
77    1. ->mode		Mode: transport or tunnel
78    2. ->id.proto	Protocol: AH/ESP/IPCOMP
79    3. ->id.daddr	Remote tunnel endpoint, ignored for transport mode.
80       Q: allow to resolve security gateway?
81    4. ->id.spi          If not zero, static SPI.
82    5. ->saddr		Local tunnel endpoint, ignored for transport mode.
83    6. ->algos		List of allowed algos. Plain bitmask now.
84       Q: ealgos, aalgos, calgos. What a mess...
85    7. ->share		Sharing mode.
86       Q: how to implement private sharing mode? To add struct sock* to
87       flow id?
88 
89    Having this template we search through SAD searching for entries
90    with appropriate mode/proto/algo, permitted by selector.
91    If no appropriate entry found, it is requested from key manager.
92 
93    PROBLEMS:
94    Q: How to find all the bundles referring to a physical path for
95       PMTU discovery? Seems, dst should contain list of all parents...
96       and enter to infinite locking hierarchy disaster.
97       No! It is easier, we will not search for them, let them find us.
98       We add genid to each dst plus pointer to genid of raw IP route,
99       pmtu disc will update pmtu on raw IP route and increase its genid.
100       dst_check() will see this for top level and trigger resyncing
101       metrics. Plus, it will be made via sk->sk_dst_cache. Solved.
102  */
103 
104 /* Full description of state of transformer. */
105 struct xfrm_state
106 {
107 	/* Note: bydst is re-used during gc */
108 	struct hlist_node	bydst;
109 	struct hlist_node	bysrc;
110 	struct hlist_node	byspi;
111 
112 	atomic_t		refcnt;
113 	spinlock_t		lock;
114 
115 	struct xfrm_id		id;
116 	struct xfrm_selector	sel;
117 
118 	u32			genid;
119 
120 	/* Key manger bits */
121 	struct {
122 		u8		state;
123 		u8		dying;
124 		u32		seq;
125 	} km;
126 
127 	/* Parameters of this state. */
128 	struct {
129 		u32		reqid;
130 		u8		mode;
131 		u8		replay_window;
132 		u8		aalgo, ealgo, calgo;
133 		u8		flags;
134 		u16		family;
135 		xfrm_address_t	saddr;
136 		int		header_len;
137 		int		trailer_len;
138 	} props;
139 
140 	struct xfrm_lifetime_cfg lft;
141 
142 	/* Data for transformer */
143 	struct xfrm_algo	*aalg;
144 	struct xfrm_algo	*ealg;
145 	struct xfrm_algo	*calg;
146 
147 	/* Data for encapsulator */
148 	struct xfrm_encap_tmpl	*encap;
149 
150 	/* Data for care-of address */
151 	xfrm_address_t	*coaddr;
152 
153 	/* IPComp needs an IPIP tunnel for handling uncompressed packets */
154 	struct xfrm_state	*tunnel;
155 
156 	/* If a tunnel, number of users + 1 */
157 	atomic_t		tunnel_users;
158 
159 	/* State for replay detection */
160 	struct xfrm_replay_state replay;
161 
162 	/* Replay detection state at the time we sent the last notification */
163 	struct xfrm_replay_state preplay;
164 
165 	/* internal flag that only holds state for delayed aevent at the
166 	 * moment
167 	*/
168 	u32			xflags;
169 
170 	/* Replay detection notification settings */
171 	u32			replay_maxage;
172 	u32			replay_maxdiff;
173 
174 	/* Replay detection notification timer */
175 	struct timer_list	rtimer;
176 
177 	/* Statistics */
178 	struct xfrm_stats	stats;
179 
180 	struct xfrm_lifetime_cur curlft;
181 	struct timer_list	timer;
182 
183 	/* Last used time */
184 	u64			lastused;
185 
186 	/* Reference to data common to all the instances of this
187 	 * transformer. */
188 	struct xfrm_type	*type;
189 	struct xfrm_mode	*mode;
190 
191 	/* Security context */
192 	struct xfrm_sec_ctx	*security;
193 
194 	/* Private data of this transformer, format is opaque,
195 	 * interpreted by xfrm_type methods. */
196 	void			*data;
197 };
198 
199 /* xflags - make enum if more show up */
200 #define XFRM_TIME_DEFER	1
201 
202 enum {
203 	XFRM_STATE_VOID,
204 	XFRM_STATE_ACQ,
205 	XFRM_STATE_VALID,
206 	XFRM_STATE_ERROR,
207 	XFRM_STATE_EXPIRED,
208 	XFRM_STATE_DEAD
209 };
210 
211 /* callback structure passed from either netlink or pfkey */
212 struct km_event
213 {
214 	union {
215 		u32 hard;
216 		u32 proto;
217 		u32 byid;
218 		u32 aevent;
219 		u32 type;
220 	} data;
221 
222 	u32	seq;
223 	u32	pid;
224 	u32	event;
225 };
226 
227 struct xfrm_type;
228 struct xfrm_dst;
229 struct xfrm_policy_afinfo {
230 	unsigned short		family;
231 	struct xfrm_type	*type_map[IPPROTO_MAX];
232 	struct xfrm_mode	*mode_map[XFRM_MODE_MAX];
233 	struct dst_ops		*dst_ops;
234 	void			(*garbage_collect)(void);
235 	int			(*dst_lookup)(struct xfrm_dst **dst, struct flowi *fl);
236 	int			(*get_saddr)(xfrm_address_t *saddr, xfrm_address_t *daddr);
237 	struct dst_entry	*(*find_bundle)(struct flowi *fl, struct xfrm_policy *policy);
238 	int			(*bundle_create)(struct xfrm_policy *policy,
239 						 struct xfrm_state **xfrm,
240 						 int nx,
241 						 struct flowi *fl,
242 						 struct dst_entry **dst_p);
243 	void			(*decode_session)(struct sk_buff *skb,
244 						  struct flowi *fl);
245 };
246 
247 extern int xfrm_policy_register_afinfo(struct xfrm_policy_afinfo *afinfo);
248 extern int xfrm_policy_unregister_afinfo(struct xfrm_policy_afinfo *afinfo);
249 extern void km_policy_notify(struct xfrm_policy *xp, int dir, struct km_event *c);
250 extern void km_state_notify(struct xfrm_state *x, struct km_event *c);
251 
252 struct xfrm_tmpl;
253 extern int km_query(struct xfrm_state *x, struct xfrm_tmpl *t, struct xfrm_policy *pol);
254 extern void km_state_expired(struct xfrm_state *x, int hard, u32 pid);
255 extern int __xfrm_state_delete(struct xfrm_state *x);
256 
257 struct xfrm_state_afinfo {
258 	unsigned short		family;
259 	int			(*init_flags)(struct xfrm_state *x);
260 	void			(*init_tempsel)(struct xfrm_state *x, struct flowi *fl,
261 						struct xfrm_tmpl *tmpl,
262 						xfrm_address_t *daddr, xfrm_address_t *saddr);
263 	int			(*tmpl_sort)(struct xfrm_tmpl **dst, struct xfrm_tmpl **src, int n);
264 	int			(*state_sort)(struct xfrm_state **dst, struct xfrm_state **src, int n);
265 	int			(*output)(struct sk_buff *skb);
266 };
267 
268 extern int xfrm_state_register_afinfo(struct xfrm_state_afinfo *afinfo);
269 extern int xfrm_state_unregister_afinfo(struct xfrm_state_afinfo *afinfo);
270 extern struct xfrm_state_afinfo *xfrm_state_get_afinfo(unsigned short family);
271 extern void xfrm_state_put_afinfo(struct xfrm_state_afinfo *afinfo);
272 
273 extern void xfrm_state_delete_tunnel(struct xfrm_state *x);
274 
275 struct xfrm_type
276 {
277 	char			*description;
278 	struct module		*owner;
279 	__u8			proto;
280 	__u8			flags;
281 #define XFRM_TYPE_NON_FRAGMENT	1
282 #define XFRM_TYPE_REPLAY_PROT	2
283 
284 	int			(*init_state)(struct xfrm_state *x);
285 	void			(*destructor)(struct xfrm_state *);
286 	int			(*input)(struct xfrm_state *, struct sk_buff *skb);
287 	int			(*output)(struct xfrm_state *, struct sk_buff *pskb);
288 	int			(*reject)(struct xfrm_state *, struct sk_buff *, struct flowi *);
289 	int			(*hdr_offset)(struct xfrm_state *, struct sk_buff *, u8 **);
290 	xfrm_address_t		*(*local_addr)(struct xfrm_state *, xfrm_address_t *);
291 	xfrm_address_t		*(*remote_addr)(struct xfrm_state *, xfrm_address_t *);
292 	/* Estimate maximal size of result of transformation of a dgram */
293 	u32			(*get_mtu)(struct xfrm_state *, int size);
294 };
295 
296 extern int xfrm_register_type(struct xfrm_type *type, unsigned short family);
297 extern int xfrm_unregister_type(struct xfrm_type *type, unsigned short family);
298 extern struct xfrm_type *xfrm_get_type(u8 proto, unsigned short family);
299 extern void xfrm_put_type(struct xfrm_type *type);
300 
301 struct xfrm_mode {
302 	int (*input)(struct xfrm_state *x, struct sk_buff *skb);
303 
304 	/*
305 	 * Add encapsulation header.
306 	 *
307 	 * On exit, the transport header will be set to the start of the
308 	 * encapsulation header to be filled in by x->type->output and
309 	 * the mac header will be set to the nextheader (protocol for
310 	 * IPv4) field of the extension header directly preceding the
311 	 * encapsulation header, or in its absence, that of the top IP
312 	 * header.  The value of the network header will always point
313 	 * to the top IP header while skb->data will point to the payload.
314 	 */
315 	int (*output)(struct xfrm_state *x,struct sk_buff *skb);
316 
317 	struct module *owner;
318 	unsigned int encap;
319 };
320 
321 extern int xfrm_register_mode(struct xfrm_mode *mode, int family);
322 extern int xfrm_unregister_mode(struct xfrm_mode *mode, int family);
323 extern struct xfrm_mode *xfrm_get_mode(unsigned int encap, int family);
324 extern void xfrm_put_mode(struct xfrm_mode *mode);
325 
326 struct xfrm_tmpl
327 {
328 /* id in template is interpreted as:
329  * daddr - destination of tunnel, may be zero for transport mode.
330  * spi   - zero to acquire spi. Not zero if spi is static, then
331  *	   daddr must be fixed too.
332  * proto - AH/ESP/IPCOMP
333  */
334 	struct xfrm_id		id;
335 
336 /* Source address of tunnel. Ignored, if it is not a tunnel. */
337 	xfrm_address_t		saddr;
338 
339 	unsigned short		encap_family;
340 
341 	__u32			reqid;
342 
343 /* Mode: transport, tunnel etc. */
344 	__u8			mode;
345 
346 /* Sharing mode: unique, this session only, this user only etc. */
347 	__u8			share;
348 
349 /* May skip this transfomration if no SA is found */
350 	__u8			optional;
351 
352 /* Bit mask of algos allowed for acquisition */
353 	__u32			aalgos;
354 	__u32			ealgos;
355 	__u32			calgos;
356 };
357 
358 #define XFRM_MAX_DEPTH		6
359 
360 struct xfrm_policy
361 {
362 	struct xfrm_policy	*next;
363 	struct hlist_node	bydst;
364 	struct hlist_node	byidx;
365 
366 	/* This lock only affects elements except for entry. */
367 	rwlock_t		lock;
368 	atomic_t		refcnt;
369 	struct timer_list	timer;
370 
371 	u32			priority;
372 	u32			index;
373 	struct xfrm_selector	selector;
374 	struct xfrm_lifetime_cfg lft;
375 	struct xfrm_lifetime_cur curlft;
376 	struct dst_entry       *bundles;
377 	u16			family;
378 	u8			type;
379 	u8			action;
380 	u8			flags;
381 	u8			dead;
382 	u8			xfrm_nr;
383 	/* XXX 1 byte hole, try to pack */
384 	struct xfrm_sec_ctx	*security;
385 	struct xfrm_tmpl       	xfrm_vec[XFRM_MAX_DEPTH];
386 };
387 
388 struct xfrm_migrate {
389 	xfrm_address_t		old_daddr;
390 	xfrm_address_t		old_saddr;
391 	xfrm_address_t		new_daddr;
392 	xfrm_address_t		new_saddr;
393 	u8			proto;
394 	u8			mode;
395 	u16			reserved;
396 	u32			reqid;
397 	u16			old_family;
398 	u16			new_family;
399 };
400 
401 #define XFRM_KM_TIMEOUT                30
402 /* which seqno */
403 #define XFRM_REPLAY_SEQ		1
404 #define XFRM_REPLAY_OSEQ	2
405 #define XFRM_REPLAY_SEQ_MASK	3
406 /* what happened */
407 #define XFRM_REPLAY_UPDATE	XFRM_AE_CR
408 #define XFRM_REPLAY_TIMEOUT	XFRM_AE_CE
409 
410 /* default aevent timeout in units of 100ms */
411 #define XFRM_AE_ETIME			10
412 /* Async Event timer multiplier */
413 #define XFRM_AE_ETH_M			10
414 /* default seq threshold size */
415 #define XFRM_AE_SEQT_SIZE		2
416 
417 struct xfrm_mgr
418 {
419 	struct list_head	list;
420 	char			*id;
421 	int			(*notify)(struct xfrm_state *x, struct km_event *c);
422 	int			(*acquire)(struct xfrm_state *x, struct xfrm_tmpl *, struct xfrm_policy *xp, int dir);
423 	struct xfrm_policy	*(*compile_policy)(struct sock *sk, int opt, u8 *data, int len, int *dir);
424 	int			(*new_mapping)(struct xfrm_state *x, xfrm_address_t *ipaddr, __be16 sport);
425 	int			(*notify_policy)(struct xfrm_policy *x, int dir, struct km_event *c);
426 	int			(*report)(u8 proto, struct xfrm_selector *sel, xfrm_address_t *addr);
427 	int			(*migrate)(struct xfrm_selector *sel, u8 dir, u8 type, struct xfrm_migrate *m, int num_bundles);
428 };
429 
430 extern int xfrm_register_km(struct xfrm_mgr *km);
431 extern int xfrm_unregister_km(struct xfrm_mgr *km);
432 
433 extern unsigned int xfrm_policy_count[XFRM_POLICY_MAX*2];
434 
435 /*
436  * This structure is used for the duration where packets are being
437  * transformed by IPsec.  As soon as the packet leaves IPsec the
438  * area beyond the generic IP part may be overwritten.
439  */
440 struct xfrm_skb_cb {
441 	union {
442 		struct inet_skb_parm h4;
443 		struct inet6_skb_parm h6;
444         } header;
445 
446         /* Sequence number for replay protection. */
447         u64 seq;
448 };
449 
450 #define XFRM_SKB_CB(__skb) ((struct xfrm_skb_cb *)&((__skb)->cb[0]))
451 
452 /* Audit Information */
453 struct xfrm_audit
454 {
455 	u32	loginuid;
456 	u32	secid;
457 };
458 
459 #ifdef CONFIG_AUDITSYSCALL
460 static inline struct audit_buffer *xfrm_audit_start(u32 auid, u32 sid)
461 {
462 	struct audit_buffer *audit_buf = NULL;
463 	char *secctx;
464 	u32 secctx_len;
465 
466 	audit_buf = audit_log_start(current->audit_context, GFP_ATOMIC,
467 			      AUDIT_MAC_IPSEC_EVENT);
468 	if (audit_buf == NULL)
469 		return NULL;
470 
471 	audit_log_format(audit_buf, "auid=%u", auid);
472 
473 	if (sid != 0 &&
474 	    security_secid_to_secctx(sid, &secctx, &secctx_len) == 0) {
475 		audit_log_format(audit_buf, " subj=%s", secctx);
476 		security_release_secctx(secctx, secctx_len);
477 	} else
478 		audit_log_task_context(audit_buf);
479 	return audit_buf;
480 }
481 
482 extern void xfrm_audit_policy_add(struct xfrm_policy *xp, int result,
483 				  u32 auid, u32 sid);
484 extern void xfrm_audit_policy_delete(struct xfrm_policy *xp, int result,
485 				  u32 auid, u32 sid);
486 extern void xfrm_audit_state_add(struct xfrm_state *x, int result,
487 				 u32 auid, u32 sid);
488 extern void xfrm_audit_state_delete(struct xfrm_state *x, int result,
489 				    u32 auid, u32 sid);
490 #else
491 #define xfrm_audit_policy_add(x, r, a, s)	do { ; } while (0)
492 #define xfrm_audit_policy_delete(x, r, a, s)	do { ; } while (0)
493 #define xfrm_audit_state_add(x, r, a, s)	do { ; } while (0)
494 #define xfrm_audit_state_delete(x, r, a, s)	do { ; } while (0)
495 #endif /* CONFIG_AUDITSYSCALL */
496 
497 static inline void xfrm_pol_hold(struct xfrm_policy *policy)
498 {
499 	if (likely(policy != NULL))
500 		atomic_inc(&policy->refcnt);
501 }
502 
503 extern void __xfrm_policy_destroy(struct xfrm_policy *policy);
504 
505 static inline void xfrm_pol_put(struct xfrm_policy *policy)
506 {
507 	if (atomic_dec_and_test(&policy->refcnt))
508 		__xfrm_policy_destroy(policy);
509 }
510 
511 #ifdef CONFIG_XFRM_SUB_POLICY
512 static inline void xfrm_pols_put(struct xfrm_policy **pols, int npols)
513 {
514 	int i;
515 	for (i = npols - 1; i >= 0; --i)
516 		xfrm_pol_put(pols[i]);
517 }
518 #else
519 static inline void xfrm_pols_put(struct xfrm_policy **pols, int npols)
520 {
521 	xfrm_pol_put(pols[0]);
522 }
523 #endif
524 
525 extern void __xfrm_state_destroy(struct xfrm_state *);
526 
527 static inline void __xfrm_state_put(struct xfrm_state *x)
528 {
529 	atomic_dec(&x->refcnt);
530 }
531 
532 static inline void xfrm_state_put(struct xfrm_state *x)
533 {
534 	if (atomic_dec_and_test(&x->refcnt))
535 		__xfrm_state_destroy(x);
536 }
537 
538 static inline void xfrm_state_hold(struct xfrm_state *x)
539 {
540 	atomic_inc(&x->refcnt);
541 }
542 
543 static __inline__ int addr_match(void *token1, void *token2, int prefixlen)
544 {
545 	__be32 *a1 = token1;
546 	__be32 *a2 = token2;
547 	int pdw;
548 	int pbi;
549 
550 	pdw = prefixlen >> 5;	  /* num of whole __u32 in prefix */
551 	pbi = prefixlen &  0x1f;  /* num of bits in incomplete u32 in prefix */
552 
553 	if (pdw)
554 		if (memcmp(a1, a2, pdw << 2))
555 			return 0;
556 
557 	if (pbi) {
558 		__be32 mask;
559 
560 		mask = htonl((0xffffffff) << (32 - pbi));
561 
562 		if ((a1[pdw] ^ a2[pdw]) & mask)
563 			return 0;
564 	}
565 
566 	return 1;
567 }
568 
569 static __inline__
570 __be16 xfrm_flowi_sport(struct flowi *fl)
571 {
572 	__be16 port;
573 	switch(fl->proto) {
574 	case IPPROTO_TCP:
575 	case IPPROTO_UDP:
576 	case IPPROTO_UDPLITE:
577 	case IPPROTO_SCTP:
578 		port = fl->fl_ip_sport;
579 		break;
580 	case IPPROTO_ICMP:
581 	case IPPROTO_ICMPV6:
582 		port = htons(fl->fl_icmp_type);
583 		break;
584 	case IPPROTO_MH:
585 		port = htons(fl->fl_mh_type);
586 		break;
587 	default:
588 		port = 0;	/*XXX*/
589 	}
590 	return port;
591 }
592 
593 static __inline__
594 __be16 xfrm_flowi_dport(struct flowi *fl)
595 {
596 	__be16 port;
597 	switch(fl->proto) {
598 	case IPPROTO_TCP:
599 	case IPPROTO_UDP:
600 	case IPPROTO_UDPLITE:
601 	case IPPROTO_SCTP:
602 		port = fl->fl_ip_dport;
603 		break;
604 	case IPPROTO_ICMP:
605 	case IPPROTO_ICMPV6:
606 		port = htons(fl->fl_icmp_code);
607 		break;
608 	default:
609 		port = 0;	/*XXX*/
610 	}
611 	return port;
612 }
613 
614 extern int xfrm_selector_match(struct xfrm_selector *sel, struct flowi *fl,
615 			       unsigned short family);
616 
617 #ifdef CONFIG_SECURITY_NETWORK_XFRM
618 /*	If neither has a context --> match
619  * 	Otherwise, both must have a context and the sids, doi, alg must match
620  */
621 static inline int xfrm_sec_ctx_match(struct xfrm_sec_ctx *s1, struct xfrm_sec_ctx *s2)
622 {
623 	return ((!s1 && !s2) ||
624 		(s1 && s2 &&
625 		 (s1->ctx_sid == s2->ctx_sid) &&
626 		 (s1->ctx_doi == s2->ctx_doi) &&
627 		 (s1->ctx_alg == s2->ctx_alg)));
628 }
629 #else
630 static inline int xfrm_sec_ctx_match(struct xfrm_sec_ctx *s1, struct xfrm_sec_ctx *s2)
631 {
632 	return 1;
633 }
634 #endif
635 
636 /* A struct encoding bundle of transformations to apply to some set of flow.
637  *
638  * dst->child points to the next element of bundle.
639  * dst->xfrm  points to an instanse of transformer.
640  *
641  * Due to unfortunate limitations of current routing cache, which we
642  * have no time to fix, it mirrors struct rtable and bound to the same
643  * routing key, including saddr,daddr. However, we can have many of
644  * bundles differing by session id. All the bundles grow from a parent
645  * policy rule.
646  */
647 struct xfrm_dst
648 {
649 	union {
650 		struct dst_entry	dst;
651 		struct rtable		rt;
652 		struct rt6_info		rt6;
653 	} u;
654 	struct dst_entry *route;
655 #ifdef CONFIG_XFRM_SUB_POLICY
656 	struct flowi *origin;
657 	struct xfrm_selector *partner;
658 #endif
659 	u32 genid;
660 	u32 route_mtu_cached;
661 	u32 child_mtu_cached;
662 	u32 route_cookie;
663 	u32 path_cookie;
664 };
665 
666 static inline void xfrm_dst_destroy(struct xfrm_dst *xdst)
667 {
668 	dst_release(xdst->route);
669 	if (likely(xdst->u.dst.xfrm))
670 		xfrm_state_put(xdst->u.dst.xfrm);
671 #ifdef CONFIG_XFRM_SUB_POLICY
672 	kfree(xdst->origin);
673 	xdst->origin = NULL;
674 	kfree(xdst->partner);
675 	xdst->partner = NULL;
676 #endif
677 }
678 
679 extern void xfrm_dst_ifdown(struct dst_entry *dst, struct net_device *dev);
680 
681 struct sec_path
682 {
683 	atomic_t		refcnt;
684 	int			len;
685 	struct xfrm_state	*xvec[XFRM_MAX_DEPTH];
686 };
687 
688 static inline struct sec_path *
689 secpath_get(struct sec_path *sp)
690 {
691 	if (sp)
692 		atomic_inc(&sp->refcnt);
693 	return sp;
694 }
695 
696 extern void __secpath_destroy(struct sec_path *sp);
697 
698 static inline void
699 secpath_put(struct sec_path *sp)
700 {
701 	if (sp && atomic_dec_and_test(&sp->refcnt))
702 		__secpath_destroy(sp);
703 }
704 
705 extern struct sec_path *secpath_dup(struct sec_path *src);
706 
707 static inline void
708 secpath_reset(struct sk_buff *skb)
709 {
710 #ifdef CONFIG_XFRM
711 	secpath_put(skb->sp);
712 	skb->sp = NULL;
713 #endif
714 }
715 
716 static inline int
717 xfrm_addr_any(xfrm_address_t *addr, unsigned short family)
718 {
719 	switch (family) {
720 	case AF_INET:
721 		return addr->a4 == 0;
722 	case AF_INET6:
723 		return ipv6_addr_any((struct in6_addr *)&addr->a6);
724 	}
725 	return 0;
726 }
727 
728 static inline int
729 __xfrm4_state_addr_cmp(struct xfrm_tmpl *tmpl, struct xfrm_state *x)
730 {
731 	return	(tmpl->saddr.a4 &&
732 		 tmpl->saddr.a4 != x->props.saddr.a4);
733 }
734 
735 static inline int
736 __xfrm6_state_addr_cmp(struct xfrm_tmpl *tmpl, struct xfrm_state *x)
737 {
738 	return	(!ipv6_addr_any((struct in6_addr*)&tmpl->saddr) &&
739 		 ipv6_addr_cmp((struct in6_addr *)&tmpl->saddr, (struct in6_addr*)&x->props.saddr));
740 }
741 
742 static inline int
743 xfrm_state_addr_cmp(struct xfrm_tmpl *tmpl, struct xfrm_state *x, unsigned short family)
744 {
745 	switch (family) {
746 	case AF_INET:
747 		return __xfrm4_state_addr_cmp(tmpl, x);
748 	case AF_INET6:
749 		return __xfrm6_state_addr_cmp(tmpl, x);
750 	}
751 	return !0;
752 }
753 
754 #ifdef CONFIG_XFRM
755 
756 extern int __xfrm_policy_check(struct sock *, int dir, struct sk_buff *skb, unsigned short family);
757 
758 static inline int xfrm_policy_check(struct sock *sk, int dir, struct sk_buff *skb, unsigned short family)
759 {
760 	if (sk && sk->sk_policy[XFRM_POLICY_IN])
761 		return __xfrm_policy_check(sk, dir, skb, family);
762 
763 	return	(!xfrm_policy_count[dir] && !skb->sp) ||
764 		(skb->dst->flags & DST_NOPOLICY) ||
765 		__xfrm_policy_check(sk, dir, skb, family);
766 }
767 
768 static inline int xfrm4_policy_check(struct sock *sk, int dir, struct sk_buff *skb)
769 {
770 	return xfrm_policy_check(sk, dir, skb, AF_INET);
771 }
772 
773 static inline int xfrm6_policy_check(struct sock *sk, int dir, struct sk_buff *skb)
774 {
775 	return xfrm_policy_check(sk, dir, skb, AF_INET6);
776 }
777 
778 extern int xfrm_decode_session(struct sk_buff *skb, struct flowi *fl, unsigned short family);
779 extern int __xfrm_route_forward(struct sk_buff *skb, unsigned short family);
780 
781 static inline int xfrm_route_forward(struct sk_buff *skb, unsigned short family)
782 {
783 	return	!xfrm_policy_count[XFRM_POLICY_OUT] ||
784 		(skb->dst->flags & DST_NOXFRM) ||
785 		__xfrm_route_forward(skb, family);
786 }
787 
788 static inline int xfrm4_route_forward(struct sk_buff *skb)
789 {
790 	return xfrm_route_forward(skb, AF_INET);
791 }
792 
793 static inline int xfrm6_route_forward(struct sk_buff *skb)
794 {
795 	return xfrm_route_forward(skb, AF_INET6);
796 }
797 
798 extern int __xfrm_sk_clone_policy(struct sock *sk);
799 
800 static inline int xfrm_sk_clone_policy(struct sock *sk)
801 {
802 	if (unlikely(sk->sk_policy[0] || sk->sk_policy[1]))
803 		return __xfrm_sk_clone_policy(sk);
804 	return 0;
805 }
806 
807 extern int xfrm_policy_delete(struct xfrm_policy *pol, int dir);
808 
809 static inline void xfrm_sk_free_policy(struct sock *sk)
810 {
811 	if (unlikely(sk->sk_policy[0] != NULL)) {
812 		xfrm_policy_delete(sk->sk_policy[0], XFRM_POLICY_MAX);
813 		sk->sk_policy[0] = NULL;
814 	}
815 	if (unlikely(sk->sk_policy[1] != NULL)) {
816 		xfrm_policy_delete(sk->sk_policy[1], XFRM_POLICY_MAX+1);
817 		sk->sk_policy[1] = NULL;
818 	}
819 }
820 
821 #else
822 
823 static inline void xfrm_sk_free_policy(struct sock *sk) {}
824 static inline int xfrm_sk_clone_policy(struct sock *sk) { return 0; }
825 static inline int xfrm6_route_forward(struct sk_buff *skb) { return 1; }
826 static inline int xfrm4_route_forward(struct sk_buff *skb) { return 1; }
827 static inline int xfrm6_policy_check(struct sock *sk, int dir, struct sk_buff *skb)
828 {
829 	return 1;
830 }
831 static inline int xfrm4_policy_check(struct sock *sk, int dir, struct sk_buff *skb)
832 {
833 	return 1;
834 }
835 static inline int xfrm_policy_check(struct sock *sk, int dir, struct sk_buff *skb, unsigned short family)
836 {
837 	return 1;
838 }
839 #endif
840 
841 static __inline__
842 xfrm_address_t *xfrm_flowi_daddr(struct flowi *fl, unsigned short family)
843 {
844 	switch (family){
845 	case AF_INET:
846 		return (xfrm_address_t *)&fl->fl4_dst;
847 	case AF_INET6:
848 		return (xfrm_address_t *)&fl->fl6_dst;
849 	}
850 	return NULL;
851 }
852 
853 static __inline__
854 xfrm_address_t *xfrm_flowi_saddr(struct flowi *fl, unsigned short family)
855 {
856 	switch (family){
857 	case AF_INET:
858 		return (xfrm_address_t *)&fl->fl4_src;
859 	case AF_INET6:
860 		return (xfrm_address_t *)&fl->fl6_src;
861 	}
862 	return NULL;
863 }
864 
865 static __inline__ int
866 __xfrm4_state_addr_check(struct xfrm_state *x,
867 			 xfrm_address_t *daddr, xfrm_address_t *saddr)
868 {
869 	if (daddr->a4 == x->id.daddr.a4 &&
870 	    (saddr->a4 == x->props.saddr.a4 || !saddr->a4 || !x->props.saddr.a4))
871 		return 1;
872 	return 0;
873 }
874 
875 static __inline__ int
876 __xfrm6_state_addr_check(struct xfrm_state *x,
877 			 xfrm_address_t *daddr, xfrm_address_t *saddr)
878 {
879 	if (!ipv6_addr_cmp((struct in6_addr *)daddr, (struct in6_addr *)&x->id.daddr) &&
880 	    (!ipv6_addr_cmp((struct in6_addr *)saddr, (struct in6_addr *)&x->props.saddr)||
881 	     ipv6_addr_any((struct in6_addr *)saddr) ||
882 	     ipv6_addr_any((struct in6_addr *)&x->props.saddr)))
883 		return 1;
884 	return 0;
885 }
886 
887 static __inline__ int
888 xfrm_state_addr_check(struct xfrm_state *x,
889 		      xfrm_address_t *daddr, xfrm_address_t *saddr,
890 		      unsigned short family)
891 {
892 	switch (family) {
893 	case AF_INET:
894 		return __xfrm4_state_addr_check(x, daddr, saddr);
895 	case AF_INET6:
896 		return __xfrm6_state_addr_check(x, daddr, saddr);
897 	}
898 	return 0;
899 }
900 
901 static __inline__ int
902 xfrm_state_addr_flow_check(struct xfrm_state *x, struct flowi *fl,
903 			   unsigned short family)
904 {
905 	switch (family) {
906 	case AF_INET:
907 		return __xfrm4_state_addr_check(x,
908 						(xfrm_address_t *)&fl->fl4_dst,
909 						(xfrm_address_t *)&fl->fl4_src);
910 	case AF_INET6:
911 		return __xfrm6_state_addr_check(x,
912 						(xfrm_address_t *)&fl->fl6_dst,
913 						(xfrm_address_t *)&fl->fl6_src);
914 	}
915 	return 0;
916 }
917 
918 static inline int xfrm_state_kern(struct xfrm_state *x)
919 {
920 	return atomic_read(&x->tunnel_users);
921 }
922 
923 static inline int xfrm_id_proto_match(u8 proto, u8 userproto)
924 {
925 	return (!userproto || proto == userproto ||
926 		(userproto == IPSEC_PROTO_ANY && (proto == IPPROTO_AH ||
927 						  proto == IPPROTO_ESP ||
928 						  proto == IPPROTO_COMP)));
929 }
930 
931 /*
932  * xfrm algorithm information
933  */
934 struct xfrm_algo_auth_info {
935 	u16 icv_truncbits;
936 	u16 icv_fullbits;
937 };
938 
939 struct xfrm_algo_encr_info {
940 	u16 blockbits;
941 	u16 defkeybits;
942 };
943 
944 struct xfrm_algo_comp_info {
945 	u16 threshold;
946 };
947 
948 struct xfrm_algo_desc {
949 	char *name;
950 	char *compat;
951 	u8 available:1;
952 	union {
953 		struct xfrm_algo_auth_info auth;
954 		struct xfrm_algo_encr_info encr;
955 		struct xfrm_algo_comp_info comp;
956 	} uinfo;
957 	struct sadb_alg desc;
958 };
959 
960 /* XFRM tunnel handlers.  */
961 struct xfrm_tunnel {
962 	int (*handler)(struct sk_buff *skb);
963 	int (*err_handler)(struct sk_buff *skb, __u32 info);
964 
965 	struct xfrm_tunnel *next;
966 	int priority;
967 };
968 
969 struct xfrm6_tunnel {
970 	int (*handler)(struct sk_buff *skb);
971 	int (*err_handler)(struct sk_buff *skb, struct inet6_skb_parm *opt,
972 			   int type, int code, int offset, __be32 info);
973 	struct xfrm6_tunnel *next;
974 	int priority;
975 };
976 
977 extern void xfrm_init(void);
978 extern void xfrm4_init(void);
979 extern void xfrm6_init(void);
980 extern void xfrm6_fini(void);
981 extern void xfrm_state_init(void);
982 extern void xfrm4_state_init(void);
983 extern void xfrm6_state_init(void);
984 extern void xfrm6_state_fini(void);
985 
986 extern int xfrm_state_walk(u8 proto, int (*func)(struct xfrm_state *, int, void*), void *);
987 extern struct xfrm_state *xfrm_state_alloc(void);
988 extern struct xfrm_state *xfrm_state_find(xfrm_address_t *daddr, xfrm_address_t *saddr,
989 					  struct flowi *fl, struct xfrm_tmpl *tmpl,
990 					  struct xfrm_policy *pol, int *err,
991 					  unsigned short family);
992 extern struct xfrm_state * xfrm_stateonly_find(xfrm_address_t *daddr,
993 					       xfrm_address_t *saddr,
994 					       unsigned short family,
995 					       u8 mode, u8 proto, u32 reqid);
996 extern int xfrm_state_check_expire(struct xfrm_state *x);
997 extern void xfrm_state_insert(struct xfrm_state *x);
998 extern int xfrm_state_add(struct xfrm_state *x);
999 extern int xfrm_state_update(struct xfrm_state *x);
1000 extern struct xfrm_state *xfrm_state_lookup(xfrm_address_t *daddr, __be32 spi, u8 proto, unsigned short family);
1001 extern struct xfrm_state *xfrm_state_lookup_byaddr(xfrm_address_t *daddr, xfrm_address_t *saddr, u8 proto, unsigned short family);
1002 #ifdef CONFIG_XFRM_SUB_POLICY
1003 extern int xfrm_tmpl_sort(struct xfrm_tmpl **dst, struct xfrm_tmpl **src,
1004 			  int n, unsigned short family);
1005 extern int xfrm_state_sort(struct xfrm_state **dst, struct xfrm_state **src,
1006 			   int n, unsigned short family);
1007 #else
1008 static inline int xfrm_tmpl_sort(struct xfrm_tmpl **dst, struct xfrm_tmpl **src,
1009 				 int n, unsigned short family)
1010 {
1011 	return -ENOSYS;
1012 }
1013 
1014 static inline int xfrm_state_sort(struct xfrm_state **dst, struct xfrm_state **src,
1015 				  int n, unsigned short family)
1016 {
1017 	return -ENOSYS;
1018 }
1019 #endif
1020 
1021 struct xfrmk_sadinfo {
1022 	u32 sadhcnt; /* current hash bkts */
1023 	u32 sadhmcnt; /* max allowed hash bkts */
1024 	u32 sadcnt; /* current running count */
1025 };
1026 
1027 struct xfrmk_spdinfo {
1028 	u32 incnt;
1029 	u32 outcnt;
1030 	u32 fwdcnt;
1031 	u32 inscnt;
1032 	u32 outscnt;
1033 	u32 fwdscnt;
1034 	u32 spdhcnt;
1035 	u32 spdhmcnt;
1036 };
1037 
1038 extern struct xfrm_state *xfrm_find_acq_byseq(u32 seq);
1039 extern int xfrm_state_delete(struct xfrm_state *x);
1040 extern int xfrm_state_flush(u8 proto, struct xfrm_audit *audit_info);
1041 extern void xfrm_sad_getinfo(struct xfrmk_sadinfo *si);
1042 extern void xfrm_spd_getinfo(struct xfrmk_spdinfo *si);
1043 extern int xfrm_replay_check(struct xfrm_state *x, __be32 seq);
1044 extern void xfrm_replay_advance(struct xfrm_state *x, __be32 seq);
1045 extern void xfrm_replay_notify(struct xfrm_state *x, int event);
1046 extern int xfrm_state_mtu(struct xfrm_state *x, int mtu);
1047 extern int xfrm_init_state(struct xfrm_state *x);
1048 extern int xfrm_output(struct sk_buff *skb);
1049 extern int xfrm4_rcv(struct sk_buff *skb);
1050 extern int xfrm4_output(struct sk_buff *skb);
1051 extern int xfrm4_tunnel_register(struct xfrm_tunnel *handler, unsigned short family);
1052 extern int xfrm4_tunnel_deregister(struct xfrm_tunnel *handler, unsigned short family);
1053 extern int xfrm6_rcv_spi(struct sk_buff *skb, __be32 spi);
1054 extern int xfrm6_rcv(struct sk_buff **pskb);
1055 extern int xfrm6_input_addr(struct sk_buff *skb, xfrm_address_t *daddr,
1056 			    xfrm_address_t *saddr, u8 proto);
1057 extern int xfrm6_tunnel_register(struct xfrm6_tunnel *handler, unsigned short family);
1058 extern int xfrm6_tunnel_deregister(struct xfrm6_tunnel *handler, unsigned short family);
1059 extern __be32 xfrm6_tunnel_alloc_spi(xfrm_address_t *saddr);
1060 extern void xfrm6_tunnel_free_spi(xfrm_address_t *saddr);
1061 extern __be32 xfrm6_tunnel_spi_lookup(xfrm_address_t *saddr);
1062 extern int xfrm6_output(struct sk_buff *skb);
1063 extern int xfrm6_find_1stfragopt(struct xfrm_state *x, struct sk_buff *skb,
1064 				 u8 **prevhdr);
1065 
1066 #ifdef CONFIG_XFRM
1067 extern int xfrm4_udp_encap_rcv(struct sock *sk, struct sk_buff *skb);
1068 extern int xfrm_user_policy(struct sock *sk, int optname, u8 __user *optval, int optlen);
1069 extern int xfrm_dst_lookup(struct xfrm_dst **dst, struct flowi *fl, unsigned short family);
1070 #else
1071 static inline int xfrm_user_policy(struct sock *sk, int optname, u8 __user *optval, int optlen)
1072 {
1073  	return -ENOPROTOOPT;
1074 }
1075 
1076 static inline int xfrm4_udp_encap_rcv(struct sock *sk, struct sk_buff *skb)
1077 {
1078  	/* should not happen */
1079  	kfree_skb(skb);
1080 	return 0;
1081 }
1082 
1083 static inline int xfrm_dst_lookup(struct xfrm_dst **dst, struct flowi *fl, unsigned short family)
1084 {
1085 	return -EINVAL;
1086 }
1087 #endif
1088 
1089 struct xfrm_policy *xfrm_policy_alloc(gfp_t gfp);
1090 extern int xfrm_policy_walk(u8 type, int (*func)(struct xfrm_policy *, int, int, void*), void *);
1091 int xfrm_policy_insert(int dir, struct xfrm_policy *policy, int excl);
1092 struct xfrm_policy *xfrm_policy_bysel_ctx(u8 type, int dir,
1093 					  struct xfrm_selector *sel,
1094 					  struct xfrm_sec_ctx *ctx, int delete,
1095 					  int *err);
1096 struct xfrm_policy *xfrm_policy_byid(u8, int dir, u32 id, int delete, int *err);
1097 int xfrm_policy_flush(u8 type, struct xfrm_audit *audit_info);
1098 u32 xfrm_get_acqseq(void);
1099 extern int xfrm_alloc_spi(struct xfrm_state *x, u32 minspi, u32 maxspi);
1100 struct xfrm_state * xfrm_find_acq(u8 mode, u32 reqid, u8 proto,
1101 				  xfrm_address_t *daddr, xfrm_address_t *saddr,
1102 				  int create, unsigned short family);
1103 extern int xfrm_policy_flush(u8 type, struct xfrm_audit *audit_info);
1104 extern int xfrm_sk_policy_insert(struct sock *sk, int dir, struct xfrm_policy *pol);
1105 extern int xfrm_bundle_ok(struct xfrm_policy *pol, struct xfrm_dst *xdst,
1106 			  struct flowi *fl, int family, int strict);
1107 extern void xfrm_init_pmtu(struct dst_entry *dst);
1108 
1109 #ifdef CONFIG_XFRM_MIGRATE
1110 extern int km_migrate(struct xfrm_selector *sel, u8 dir, u8 type,
1111 		      struct xfrm_migrate *m, int num_bundles);
1112 extern struct xfrm_state * xfrm_migrate_state_find(struct xfrm_migrate *m);
1113 extern struct xfrm_state * xfrm_state_migrate(struct xfrm_state *x,
1114 					      struct xfrm_migrate *m);
1115 extern int xfrm_migrate(struct xfrm_selector *sel, u8 dir, u8 type,
1116 			struct xfrm_migrate *m, int num_bundles);
1117 #endif
1118 
1119 extern wait_queue_head_t km_waitq;
1120 extern int km_new_mapping(struct xfrm_state *x, xfrm_address_t *ipaddr, __be16 sport);
1121 extern void km_policy_expired(struct xfrm_policy *pol, int dir, int hard, u32 pid);
1122 extern int km_report(u8 proto, struct xfrm_selector *sel, xfrm_address_t *addr);
1123 
1124 extern void xfrm_input_init(void);
1125 extern int xfrm_parse_spi(struct sk_buff *skb, u8 nexthdr, __be32 *spi, __be32 *seq);
1126 
1127 extern void xfrm_probe_algs(void);
1128 extern int xfrm_count_auth_supported(void);
1129 extern int xfrm_count_enc_supported(void);
1130 extern struct xfrm_algo_desc *xfrm_aalg_get_byidx(unsigned int idx);
1131 extern struct xfrm_algo_desc *xfrm_ealg_get_byidx(unsigned int idx);
1132 extern struct xfrm_algo_desc *xfrm_aalg_get_byid(int alg_id);
1133 extern struct xfrm_algo_desc *xfrm_ealg_get_byid(int alg_id);
1134 extern struct xfrm_algo_desc *xfrm_calg_get_byid(int alg_id);
1135 extern struct xfrm_algo_desc *xfrm_aalg_get_byname(char *name, int probe);
1136 extern struct xfrm_algo_desc *xfrm_ealg_get_byname(char *name, int probe);
1137 extern struct xfrm_algo_desc *xfrm_calg_get_byname(char *name, int probe);
1138 
1139 struct hash_desc;
1140 struct scatterlist;
1141 typedef int (icv_update_fn_t)(struct hash_desc *, struct scatterlist *,
1142 			      unsigned int);
1143 
1144 extern int skb_icv_walk(const struct sk_buff *skb, struct hash_desc *tfm,
1145 			int offset, int len, icv_update_fn_t icv_update);
1146 
1147 static inline int xfrm_addr_cmp(xfrm_address_t *a, xfrm_address_t *b,
1148 				int family)
1149 {
1150 	switch (family) {
1151 	default:
1152 	case AF_INET:
1153 		return (__force __u32)a->a4 - (__force __u32)b->a4;
1154 	case AF_INET6:
1155 		return ipv6_addr_cmp((struct in6_addr *)a,
1156 				     (struct in6_addr *)b);
1157 	}
1158 }
1159 
1160 static inline int xfrm_policy_id2dir(u32 index)
1161 {
1162 	return index & 7;
1163 }
1164 
1165 static inline int xfrm_aevent_is_on(void)
1166 {
1167 	struct sock *nlsk;
1168 	int ret = 0;
1169 
1170 	rcu_read_lock();
1171 	nlsk = rcu_dereference(xfrm_nl);
1172 	if (nlsk)
1173 		ret = netlink_has_listeners(nlsk, XFRMNLGRP_AEVENTS);
1174 	rcu_read_unlock();
1175 	return ret;
1176 }
1177 
1178 #ifdef CONFIG_XFRM_MIGRATE
1179 static inline struct xfrm_algo *xfrm_algo_clone(struct xfrm_algo *orig)
1180 {
1181 	return (struct xfrm_algo *)kmemdup(orig, sizeof(*orig) + orig->alg_key_len, GFP_KERNEL);
1182 }
1183 
1184 static inline void xfrm_states_put(struct xfrm_state **states, int n)
1185 {
1186 	int i;
1187 	for (i = 0; i < n; i++)
1188 		xfrm_state_put(*(states + i));
1189 }
1190 
1191 static inline void xfrm_states_delete(struct xfrm_state **states, int n)
1192 {
1193 	int i;
1194 	for (i = 0; i < n; i++)
1195 		xfrm_state_delete(*(states + i));
1196 }
1197 #endif
1198 
1199 #endif	/* _NET_XFRM_H */
1200