[NetLabel]: consolidate the struct socket/sock handling to just struct sock
[linux-2.6.git] / include / net / netlabel.h
1 /*
2  * NetLabel System
3  *
4  * The NetLabel system manages static and dynamic label mappings for network
5  * protocols such as CIPSO and RIPSO.
6  *
7  * Author: Paul Moore <paul.moore@hp.com>
8  *
9  */
10
11 /*
12  * (c) Copyright Hewlett-Packard Development Company, L.P., 2006
13  *
14  * This program is free software;  you can redistribute it and/or modify
15  * it under the terms of the GNU General Public License as published by
16  * the Free Software Foundation; either version 2 of the License, or
17  * (at your option) any later version.
18  *
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY;  without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
22  * the GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program;  if not, write to the Free Software
26  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27  *
28  */
29
30 #ifndef _NETLABEL_H
31 #define _NETLABEL_H
32
33 #include <linux/types.h>
34 #include <linux/net.h>
35 #include <linux/skbuff.h>
36 #include <net/netlink.h>
37 #include <asm/atomic.h>
38
39 /*
40  * NetLabel - A management interface for maintaining network packet label
41  *            mapping tables for explicit packet labling protocols.
42  *
43  * Network protocols such as CIPSO and RIPSO require a label translation layer
44  * to convert the label on the packet into something meaningful on the host
45  * machine.  In the current Linux implementation these mapping tables live
46  * inside the kernel; NetLabel provides a mechanism for user space applications
47  * to manage these mapping tables.
48  *
49  * NetLabel makes use of the Generic NETLINK mechanism as a transport layer to
50  * send messages between kernel and user space.  The general format of a
51  * NetLabel message is shown below:
52  *
53  *  +-----------------+-------------------+--------- --- -- -
54  *  | struct nlmsghdr | struct genlmsghdr | payload
55  *  +-----------------+-------------------+--------- --- -- -
56  *
57  * The 'nlmsghdr' and 'genlmsghdr' structs should be dealt with like normal.
58  * The payload is dependent on the subsystem specified in the
59  * 'nlmsghdr->nlmsg_type' and should be defined below, supporting functions
60  * should be defined in the corresponding net/netlabel/netlabel_<subsys>.h|c
61  * file.  All of the fields in the NetLabel payload are NETLINK attributes, see
62  * the include/net/netlink.h file for more information on NETLINK attributes.
63  *
64  */
65
66 /*
67  * NetLabel NETLINK protocol
68  */
69
70 #define NETLBL_PROTO_VERSION            1
71
72 /* NetLabel NETLINK types/families */
73 #define NETLBL_NLTYPE_NONE              0
74 #define NETLBL_NLTYPE_MGMT              1
75 #define NETLBL_NLTYPE_MGMT_NAME         "NLBL_MGMT"
76 #define NETLBL_NLTYPE_RIPSO             2
77 #define NETLBL_NLTYPE_RIPSO_NAME        "NLBL_RIPSO"
78 #define NETLBL_NLTYPE_CIPSOV4           3
79 #define NETLBL_NLTYPE_CIPSOV4_NAME      "NLBL_CIPSOv4"
80 #define NETLBL_NLTYPE_CIPSOV6           4
81 #define NETLBL_NLTYPE_CIPSOV6_NAME      "NLBL_CIPSOv6"
82 #define NETLBL_NLTYPE_UNLABELED         5
83 #define NETLBL_NLTYPE_UNLABELED_NAME    "NLBL_UNLBL"
84
85 /*
86  * NetLabel - Kernel API for accessing the network packet label mappings.
87  *
88  * The following functions are provided for use by other kernel modules,
89  * specifically kernel LSM modules, to provide a consistent, transparent API
90  * for dealing with explicit packet labeling protocols such as CIPSO and
91  * RIPSO.  The functions defined here are implemented in the
92  * net/netlabel/netlabel_kapi.c file.
93  *
94  */
95
96 /* NetLabel audit information */
97 struct netlbl_audit {
98         u32 secid;
99         uid_t loginuid;
100 };
101
102 /* Domain mapping definition struct */
103 struct netlbl_dom_map;
104
105 /* Domain mapping operations */
106 int netlbl_domhsh_remove(const char *domain, struct netlbl_audit *audit_info);
107
108 /* LSM security attributes */
109 struct netlbl_lsm_cache {
110         atomic_t refcount;
111         void (*free) (const void *data);
112         void *data;
113 };
114 /* The catmap bitmap field MUST be a power of two in length and large
115  * enough to hold at least 240 bits.  Special care (i.e. check the code!)
116  * should be used when changing these values as the LSM implementation
117  * probably has functions which rely on the sizes of these types to speed
118  * processing. */
119 #define NETLBL_CATMAP_MAPTYPE           u64
120 #define NETLBL_CATMAP_MAPCNT            4
121 #define NETLBL_CATMAP_MAPSIZE           (sizeof(NETLBL_CATMAP_MAPTYPE) * 8)
122 #define NETLBL_CATMAP_SIZE              (NETLBL_CATMAP_MAPSIZE * \
123                                          NETLBL_CATMAP_MAPCNT)
124 #define NETLBL_CATMAP_BIT               (NETLBL_CATMAP_MAPTYPE)0x01
125 struct netlbl_lsm_secattr_catmap {
126         u32 startbit;
127         NETLBL_CATMAP_MAPTYPE bitmap[NETLBL_CATMAP_MAPCNT];
128         struct netlbl_lsm_secattr_catmap *next;
129 };
130 #define NETLBL_SECATTR_NONE             0x00000000
131 #define NETLBL_SECATTR_DOMAIN           0x00000001
132 #define NETLBL_SECATTR_CACHE            0x00000002
133 #define NETLBL_SECATTR_MLS_LVL          0x00000004
134 #define NETLBL_SECATTR_MLS_CAT          0x00000008
135 struct netlbl_lsm_secattr {
136         u32 flags;
137
138         char *domain;
139
140         u32 mls_lvl;
141         struct netlbl_lsm_secattr_catmap *mls_cat;
142
143         struct netlbl_lsm_cache *cache;
144 };
145
146 /*
147  * LSM security attribute operations
148  */
149
150
151 /**
152  * netlbl_secattr_cache_alloc - Allocate and initialize a secattr cache
153  * @flags: the memory allocation flags
154  *
155  * Description:
156  * Allocate and initialize a netlbl_lsm_cache structure.  Returns a pointer
157  * on success, NULL on failure.
158  *
159  */
160 static inline struct netlbl_lsm_cache *netlbl_secattr_cache_alloc(gfp_t flags)
161 {
162         struct netlbl_lsm_cache *cache;
163
164         cache = kzalloc(sizeof(*cache), flags);
165         if (cache)
166                 atomic_set(&cache->refcount, 1);
167         return cache;
168 }
169
170 /**
171  * netlbl_secattr_cache_free - Frees a netlbl_lsm_cache struct
172  * @cache: the struct to free
173  *
174  * Description:
175  * Frees @secattr including all of the internal buffers.
176  *
177  */
178 static inline void netlbl_secattr_cache_free(struct netlbl_lsm_cache *cache)
179 {
180         if (!atomic_dec_and_test(&cache->refcount))
181                 return;
182
183         if (cache->free)
184                 cache->free(cache->data);
185         kfree(cache);
186 }
187
188 /**
189  * netlbl_secattr_catmap_alloc - Allocate a LSM secattr catmap
190  * @flags: memory allocation flags
191  *
192  * Description:
193  * Allocate memory for a LSM secattr catmap, returns a pointer on success, NULL
194  * on failure.
195  *
196  */
197 static inline struct netlbl_lsm_secattr_catmap *netlbl_secattr_catmap_alloc(
198                                                                    gfp_t flags)
199 {
200         return kzalloc(sizeof(struct netlbl_lsm_secattr_catmap), flags);
201 }
202
203 /**
204  * netlbl_secattr_catmap_free - Free a LSM secattr catmap
205  * @catmap: the category bitmap
206  *
207  * Description:
208  * Free a LSM secattr catmap.
209  *
210  */
211 static inline void netlbl_secattr_catmap_free(
212                                       struct netlbl_lsm_secattr_catmap *catmap)
213 {
214         struct netlbl_lsm_secattr_catmap *iter;
215
216         do {
217                 iter = catmap;
218                 catmap = catmap->next;
219                 kfree(iter);
220         } while (catmap);
221 }
222
223 /**
224  * netlbl_secattr_init - Initialize a netlbl_lsm_secattr struct
225  * @secattr: the struct to initialize
226  *
227  * Description:
228  * Initialize an already allocated netlbl_lsm_secattr struct.
229  *
230  */
231 static inline void netlbl_secattr_init(struct netlbl_lsm_secattr *secattr)
232 {
233         secattr->flags = 0;
234         secattr->domain = NULL;
235         secattr->mls_cat = NULL;
236         secattr->cache = NULL;
237 }
238
239 /**
240  * netlbl_secattr_destroy - Clears a netlbl_lsm_secattr struct
241  * @secattr: the struct to clear
242  *
243  * Description:
244  * Destroys the @secattr struct, including freeing all of the internal buffers.
245  * The struct must be reset with a call to netlbl_secattr_init() before reuse.
246  *
247  */
248 static inline void netlbl_secattr_destroy(struct netlbl_lsm_secattr *secattr)
249 {
250         if (secattr->cache)
251                 netlbl_secattr_cache_free(secattr->cache);
252         kfree(secattr->domain);
253         if (secattr->mls_cat)
254                 netlbl_secattr_catmap_free(secattr->mls_cat);
255 }
256
257 /**
258  * netlbl_secattr_alloc - Allocate and initialize a netlbl_lsm_secattr struct
259  * @flags: the memory allocation flags
260  *
261  * Description:
262  * Allocate and initialize a netlbl_lsm_secattr struct.  Returns a valid
263  * pointer on success, or NULL on failure.
264  *
265  */
266 static inline struct netlbl_lsm_secattr *netlbl_secattr_alloc(gfp_t flags)
267 {
268         return kzalloc(sizeof(struct netlbl_lsm_secattr), flags);
269 }
270
271 /**
272  * netlbl_secattr_free - Frees a netlbl_lsm_secattr struct
273  * @secattr: the struct to free
274  *
275  * Description:
276  * Frees @secattr including all of the internal buffers.
277  *
278  */
279 static inline void netlbl_secattr_free(struct netlbl_lsm_secattr *secattr)
280 {
281         netlbl_secattr_destroy(secattr);
282         kfree(secattr);
283 }
284
285 #ifdef CONFIG_NETLABEL
286 int netlbl_secattr_catmap_walk(struct netlbl_lsm_secattr_catmap *catmap,
287                                u32 offset);
288 int netlbl_secattr_catmap_walk_rng(struct netlbl_lsm_secattr_catmap *catmap,
289                                    u32 offset);
290 int netlbl_secattr_catmap_setbit(struct netlbl_lsm_secattr_catmap *catmap,
291                                  u32 bit,
292                                  gfp_t flags);
293 int netlbl_secattr_catmap_setrng(struct netlbl_lsm_secattr_catmap *catmap,
294                                  u32 start,
295                                  u32 end,
296                                  gfp_t flags);
297 #else
298 static inline int netlbl_secattr_catmap_walk(
299                                       struct netlbl_lsm_secattr_catmap *catmap,
300                                       u32 offset)
301 {
302         return -ENOENT;
303 }
304
305 static inline int netlbl_secattr_catmap_walk_rng(
306                                       struct netlbl_lsm_secattr_catmap *catmap,
307                                       u32 offset)
308 {
309         return -ENOENT;
310 }
311
312 static inline int netlbl_secattr_catmap_setbit(
313                                       struct netlbl_lsm_secattr_catmap *catmap,
314                                       u32 bit,
315                                       gfp_t flags)
316 {
317         return 0;
318 }
319
320 static inline int netlbl_secattr_catmap_setrng(
321                                       struct netlbl_lsm_secattr_catmap *catmap,
322                                       u32 start,
323                                       u32 end,
324                                       gfp_t flags)
325 {
326         return 0;
327 }
328 #endif
329
330 /*
331  * LSM protocol operations
332  */
333
334 #ifdef CONFIG_NETLABEL
335 int netlbl_sock_setattr(struct sock *sk,
336                         const struct netlbl_lsm_secattr *secattr);
337 int netlbl_sock_getattr(struct sock *sk,
338                         struct netlbl_lsm_secattr *secattr);
339 int netlbl_skbuff_getattr(const struct sk_buff *skb,
340                           struct netlbl_lsm_secattr *secattr);
341 void netlbl_skbuff_err(struct sk_buff *skb, int error);
342 #else
343 static inline int netlbl_sock_setattr(struct sock *sk,
344                                      const struct netlbl_lsm_secattr *secattr)
345 {
346         return -ENOSYS;
347 }
348
349 static inline int netlbl_sock_getattr(struct sock *sk,
350                                       struct netlbl_lsm_secattr *secattr)
351 {
352         return -ENOSYS;
353 }
354
355 static inline int netlbl_skbuff_getattr(const struct sk_buff *skb,
356                                         struct netlbl_lsm_secattr *secattr)
357 {
358         return -ENOSYS;
359 }
360
361 static inline void netlbl_skbuff_err(struct sk_buff *skb, int error)
362 {
363         return;
364 }
365 #endif /* CONFIG_NETLABEL */
366
367 /*
368  * LSM label mapping cache operations
369  */
370
371 #ifdef CONFIG_NETLABEL
372 void netlbl_cache_invalidate(void);
373 int netlbl_cache_add(const struct sk_buff *skb,
374                      const struct netlbl_lsm_secattr *secattr);
375 #else
376 static inline void netlbl_cache_invalidate(void)
377 {
378         return;
379 }
380
381 static inline int netlbl_cache_add(const struct sk_buff *skb,
382                                    const struct netlbl_lsm_secattr *secattr)
383 {
384         return 0;
385 }
386 #endif /* CONFIG_NETLABEL */
387
388 #endif /* _NETLABEL_H */