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