netlabel: Add support for querying a CALIPSO DOI.
[deliverable/linux.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@paul-moore.com>
8 *
9 */
10
11 /*
12 * (c) Copyright Hewlett-Packard Development Company, L.P., 2006, 2008
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, see <http://www.gnu.org/licenses/>.
26 *
27 */
28
29 #ifndef _NETLABEL_H
30 #define _NETLABEL_H
31
32 #include <linux/types.h>
33 #include <linux/slab.h>
34 #include <linux/net.h>
35 #include <linux/skbuff.h>
36 #include <linux/in.h>
37 #include <linux/in6.h>
38 #include <net/netlink.h>
39 #include <net/request_sock.h>
40 #include <linux/atomic.h>
41
42 struct cipso_v4_doi;
43 struct calipso_doi;
44
45 /*
46 * NetLabel - A management interface for maintaining network packet label
47 * mapping tables for explicit packet labling protocols.
48 *
49 * Network protocols such as CIPSO and RIPSO require a label translation layer
50 * to convert the label on the packet into something meaningful on the host
51 * machine. In the current Linux implementation these mapping tables live
52 * inside the kernel; NetLabel provides a mechanism for user space applications
53 * to manage these mapping tables.
54 *
55 * NetLabel makes use of the Generic NETLINK mechanism as a transport layer to
56 * send messages between kernel and user space. The general format of a
57 * NetLabel message is shown below:
58 *
59 * +-----------------+-------------------+--------- --- -- -
60 * | struct nlmsghdr | struct genlmsghdr | payload
61 * +-----------------+-------------------+--------- --- -- -
62 *
63 * The 'nlmsghdr' and 'genlmsghdr' structs should be dealt with like normal.
64 * The payload is dependent on the subsystem specified in the
65 * 'nlmsghdr->nlmsg_type' and should be defined below, supporting functions
66 * should be defined in the corresponding net/netlabel/netlabel_<subsys>.h|c
67 * file. All of the fields in the NetLabel payload are NETLINK attributes, see
68 * the include/net/netlink.h file for more information on NETLINK attributes.
69 *
70 */
71
72 /*
73 * NetLabel NETLINK protocol
74 */
75
76 /* NetLabel NETLINK protocol version
77 * 1: initial version
78 * 2: added static labels for unlabeled connections
79 * 3: network selectors added to the NetLabel/LSM domain mapping and the
80 * CIPSO_V4_MAP_LOCAL CIPSO mapping was added
81 */
82 #define NETLBL_PROTO_VERSION 3
83
84 /* NetLabel NETLINK types/families */
85 #define NETLBL_NLTYPE_NONE 0
86 #define NETLBL_NLTYPE_MGMT 1
87 #define NETLBL_NLTYPE_MGMT_NAME "NLBL_MGMT"
88 #define NETLBL_NLTYPE_RIPSO 2
89 #define NETLBL_NLTYPE_RIPSO_NAME "NLBL_RIPSO"
90 #define NETLBL_NLTYPE_CIPSOV4 3
91 #define NETLBL_NLTYPE_CIPSOV4_NAME "NLBL_CIPSOv4"
92 #define NETLBL_NLTYPE_CIPSOV6 4
93 #define NETLBL_NLTYPE_CIPSOV6_NAME "NLBL_CIPSOv6"
94 #define NETLBL_NLTYPE_UNLABELED 5
95 #define NETLBL_NLTYPE_UNLABELED_NAME "NLBL_UNLBL"
96 #define NETLBL_NLTYPE_ADDRSELECT 6
97 #define NETLBL_NLTYPE_ADDRSELECT_NAME "NLBL_ADRSEL"
98 #define NETLBL_NLTYPE_CALIPSO 7
99 #define NETLBL_NLTYPE_CALIPSO_NAME "NLBL_CALIPSO"
100
101 /*
102 * NetLabel - Kernel API for accessing the network packet label mappings.
103 *
104 * The following functions are provided for use by other kernel modules,
105 * specifically kernel LSM modules, to provide a consistent, transparent API
106 * for dealing with explicit packet labeling protocols such as CIPSO and
107 * RIPSO. The functions defined here are implemented in the
108 * net/netlabel/netlabel_kapi.c file.
109 *
110 */
111
112 /* NetLabel audit information */
113 struct netlbl_audit {
114 u32 secid;
115 kuid_t loginuid;
116 unsigned int sessionid;
117 };
118
119 /*
120 * LSM security attributes
121 */
122
123 /**
124 * struct netlbl_lsm_cache - NetLabel LSM security attribute cache
125 * @refcount: atomic reference counter
126 * @free: LSM supplied function to free the cache data
127 * @data: LSM supplied cache data
128 *
129 * Description:
130 * This structure is provided for LSMs which wish to make use of the NetLabel
131 * caching mechanism to store LSM specific data/attributes in the NetLabel
132 * cache. If the LSM has to perform a lot of translation from the NetLabel
133 * security attributes into it's own internal representation then the cache
134 * mechanism can provide a way to eliminate some or all of that translation
135 * overhead on a cache hit.
136 *
137 */
138 struct netlbl_lsm_cache {
139 atomic_t refcount;
140 void (*free) (const void *data);
141 void *data;
142 };
143
144 /**
145 * struct netlbl_lsm_catmap - NetLabel LSM secattr category bitmap
146 * @startbit: the value of the lowest order bit in the bitmap
147 * @bitmap: the category bitmap
148 * @next: pointer to the next bitmap "node" or NULL
149 *
150 * Description:
151 * This structure is used to represent category bitmaps. Due to the large
152 * number of categories supported by most labeling protocols it is not
153 * practical to transfer a full bitmap internally so NetLabel adopts a sparse
154 * bitmap structure modeled after SELinux's ebitmap structure.
155 * The catmap bitmap field MUST be a power of two in length and large
156 * enough to hold at least 240 bits. Special care (i.e. check the code!)
157 * should be used when changing these values as the LSM implementation
158 * probably has functions which rely on the sizes of these types to speed
159 * processing.
160 *
161 */
162 #define NETLBL_CATMAP_MAPTYPE u64
163 #define NETLBL_CATMAP_MAPCNT 4
164 #define NETLBL_CATMAP_MAPSIZE (sizeof(NETLBL_CATMAP_MAPTYPE) * 8)
165 #define NETLBL_CATMAP_SIZE (NETLBL_CATMAP_MAPSIZE * \
166 NETLBL_CATMAP_MAPCNT)
167 #define NETLBL_CATMAP_BIT (NETLBL_CATMAP_MAPTYPE)0x01
168 struct netlbl_lsm_catmap {
169 u32 startbit;
170 NETLBL_CATMAP_MAPTYPE bitmap[NETLBL_CATMAP_MAPCNT];
171 struct netlbl_lsm_catmap *next;
172 };
173
174 /**
175 * struct netlbl_lsm_secattr - NetLabel LSM security attributes
176 * @flags: indicate structure attributes, see NETLBL_SECATTR_*
177 * @type: indicate the NLTYPE of the attributes
178 * @domain: the NetLabel LSM domain
179 * @cache: NetLabel LSM specific cache
180 * @attr.mls: MLS sensitivity label
181 * @attr.mls.cat: MLS category bitmap
182 * @attr.mls.lvl: MLS sensitivity level
183 * @attr.secid: LSM specific secid token
184 *
185 * Description:
186 * This structure is used to pass security attributes between NetLabel and the
187 * LSM modules. The flags field is used to specify which fields within the
188 * struct are valid and valid values can be created by bitwise OR'ing the
189 * NETLBL_SECATTR_* defines. The domain field is typically set by the LSM to
190 * specify domain specific configuration settings and is not usually used by
191 * NetLabel itself when returning security attributes to the LSM.
192 *
193 */
194 struct netlbl_lsm_secattr {
195 u32 flags;
196 /* bitmap values for 'flags' */
197 #define NETLBL_SECATTR_NONE 0x00000000
198 #define NETLBL_SECATTR_DOMAIN 0x00000001
199 #define NETLBL_SECATTR_DOMAIN_CPY (NETLBL_SECATTR_DOMAIN | \
200 NETLBL_SECATTR_FREE_DOMAIN)
201 #define NETLBL_SECATTR_CACHE 0x00000002
202 #define NETLBL_SECATTR_MLS_LVL 0x00000004
203 #define NETLBL_SECATTR_MLS_CAT 0x00000008
204 #define NETLBL_SECATTR_SECID 0x00000010
205 /* bitmap meta-values for 'flags' */
206 #define NETLBL_SECATTR_FREE_DOMAIN 0x01000000
207 #define NETLBL_SECATTR_CACHEABLE (NETLBL_SECATTR_MLS_LVL | \
208 NETLBL_SECATTR_MLS_CAT | \
209 NETLBL_SECATTR_SECID)
210 u32 type;
211 char *domain;
212 struct netlbl_lsm_cache *cache;
213 struct {
214 struct {
215 struct netlbl_lsm_catmap *cat;
216 u32 lvl;
217 } mls;
218 u32 secid;
219 } attr;
220 };
221
222 /**
223 * struct netlbl_calipso_ops - NetLabel CALIPSO operations
224 * @doi_add: add a CALIPSO DOI
225 * @doi_free: free a CALIPSO DOI
226 * @doi_getdef: returns a reference to a DOI
227 * @doi_putdef: releases a reference of a DOI
228 *
229 * Description:
230 * This structure is filled out by the CALIPSO engine and passed
231 * to the NetLabel core via a call to netlbl_calipso_ops_register().
232 * It enables the CALIPSO engine (and hence IPv6) to be compiled
233 * as a module.
234 */
235 struct netlbl_calipso_ops {
236 int (*doi_add)(struct calipso_doi *doi_def,
237 struct netlbl_audit *audit_info);
238 void (*doi_free)(struct calipso_doi *doi_def);
239 struct calipso_doi *(*doi_getdef)(u32 doi);
240 void (*doi_putdef)(struct calipso_doi *doi_def);
241 };
242
243 /*
244 * LSM security attribute operations (inline)
245 */
246
247 /**
248 * netlbl_secattr_cache_alloc - Allocate and initialize a secattr cache
249 * @flags: the memory allocation flags
250 *
251 * Description:
252 * Allocate and initialize a netlbl_lsm_cache structure. Returns a pointer
253 * on success, NULL on failure.
254 *
255 */
256 static inline struct netlbl_lsm_cache *netlbl_secattr_cache_alloc(gfp_t flags)
257 {
258 struct netlbl_lsm_cache *cache;
259
260 cache = kzalloc(sizeof(*cache), flags);
261 if (cache)
262 atomic_set(&cache->refcount, 1);
263 return cache;
264 }
265
266 /**
267 * netlbl_secattr_cache_free - Frees a netlbl_lsm_cache struct
268 * @cache: the struct to free
269 *
270 * Description:
271 * Frees @secattr including all of the internal buffers.
272 *
273 */
274 static inline void netlbl_secattr_cache_free(struct netlbl_lsm_cache *cache)
275 {
276 if (!atomic_dec_and_test(&cache->refcount))
277 return;
278
279 if (cache->free)
280 cache->free(cache->data);
281 kfree(cache);
282 }
283
284 /**
285 * netlbl_catmap_alloc - Allocate a LSM secattr catmap
286 * @flags: memory allocation flags
287 *
288 * Description:
289 * Allocate memory for a LSM secattr catmap, returns a pointer on success, NULL
290 * on failure.
291 *
292 */
293 static inline struct netlbl_lsm_catmap *netlbl_catmap_alloc(gfp_t flags)
294 {
295 return kzalloc(sizeof(struct netlbl_lsm_catmap), flags);
296 }
297
298 /**
299 * netlbl_catmap_free - Free a LSM secattr catmap
300 * @catmap: the category bitmap
301 *
302 * Description:
303 * Free a LSM secattr catmap.
304 *
305 */
306 static inline void netlbl_catmap_free(struct netlbl_lsm_catmap *catmap)
307 {
308 struct netlbl_lsm_catmap *iter;
309
310 while (catmap) {
311 iter = catmap;
312 catmap = catmap->next;
313 kfree(iter);
314 }
315 }
316
317 /**
318 * netlbl_secattr_init - Initialize a netlbl_lsm_secattr struct
319 * @secattr: the struct to initialize
320 *
321 * Description:
322 * Initialize an already allocated netlbl_lsm_secattr struct.
323 *
324 */
325 static inline void netlbl_secattr_init(struct netlbl_lsm_secattr *secattr)
326 {
327 memset(secattr, 0, sizeof(*secattr));
328 }
329
330 /**
331 * netlbl_secattr_destroy - Clears a netlbl_lsm_secattr struct
332 * @secattr: the struct to clear
333 *
334 * Description:
335 * Destroys the @secattr struct, including freeing all of the internal buffers.
336 * The struct must be reset with a call to netlbl_secattr_init() before reuse.
337 *
338 */
339 static inline void netlbl_secattr_destroy(struct netlbl_lsm_secattr *secattr)
340 {
341 if (secattr->flags & NETLBL_SECATTR_FREE_DOMAIN)
342 kfree(secattr->domain);
343 if (secattr->flags & NETLBL_SECATTR_CACHE)
344 netlbl_secattr_cache_free(secattr->cache);
345 if (secattr->flags & NETLBL_SECATTR_MLS_CAT)
346 netlbl_catmap_free(secattr->attr.mls.cat);
347 }
348
349 /**
350 * netlbl_secattr_alloc - Allocate and initialize a netlbl_lsm_secattr struct
351 * @flags: the memory allocation flags
352 *
353 * Description:
354 * Allocate and initialize a netlbl_lsm_secattr struct. Returns a valid
355 * pointer on success, or NULL on failure.
356 *
357 */
358 static inline struct netlbl_lsm_secattr *netlbl_secattr_alloc(gfp_t flags)
359 {
360 return kzalloc(sizeof(struct netlbl_lsm_secattr), flags);
361 }
362
363 /**
364 * netlbl_secattr_free - Frees a netlbl_lsm_secattr struct
365 * @secattr: the struct to free
366 *
367 * Description:
368 * Frees @secattr including all of the internal buffers.
369 *
370 */
371 static inline void netlbl_secattr_free(struct netlbl_lsm_secattr *secattr)
372 {
373 netlbl_secattr_destroy(secattr);
374 kfree(secattr);
375 }
376
377 #ifdef CONFIG_NETLABEL
378 /*
379 * LSM configuration operations
380 */
381 int netlbl_cfg_map_del(const char *domain,
382 u16 family,
383 const void *addr,
384 const void *mask,
385 struct netlbl_audit *audit_info);
386 int netlbl_cfg_unlbl_map_add(const char *domain,
387 u16 family,
388 const void *addr,
389 const void *mask,
390 struct netlbl_audit *audit_info);
391 int netlbl_cfg_unlbl_static_add(struct net *net,
392 const char *dev_name,
393 const void *addr,
394 const void *mask,
395 u16 family,
396 u32 secid,
397 struct netlbl_audit *audit_info);
398 int netlbl_cfg_unlbl_static_del(struct net *net,
399 const char *dev_name,
400 const void *addr,
401 const void *mask,
402 u16 family,
403 struct netlbl_audit *audit_info);
404 int netlbl_cfg_cipsov4_add(struct cipso_v4_doi *doi_def,
405 struct netlbl_audit *audit_info);
406 void netlbl_cfg_cipsov4_del(u32 doi, struct netlbl_audit *audit_info);
407 int netlbl_cfg_cipsov4_map_add(u32 doi,
408 const char *domain,
409 const struct in_addr *addr,
410 const struct in_addr *mask,
411 struct netlbl_audit *audit_info);
412 /*
413 * LSM security attribute operations
414 */
415 int netlbl_catmap_walk(struct netlbl_lsm_catmap *catmap, u32 offset);
416 int netlbl_catmap_walkrng(struct netlbl_lsm_catmap *catmap, u32 offset);
417 int netlbl_catmap_getlong(struct netlbl_lsm_catmap *catmap,
418 u32 *offset,
419 unsigned long *bitmap);
420 int netlbl_catmap_setbit(struct netlbl_lsm_catmap **catmap,
421 u32 bit,
422 gfp_t flags);
423 int netlbl_catmap_setrng(struct netlbl_lsm_catmap **catmap,
424 u32 start,
425 u32 end,
426 gfp_t flags);
427 int netlbl_catmap_setlong(struct netlbl_lsm_catmap **catmap,
428 u32 offset,
429 unsigned long bitmap,
430 gfp_t flags);
431
432 /*
433 * LSM protocol operations (NetLabel LSM/kernel API)
434 */
435 int netlbl_enabled(void);
436 int netlbl_sock_setattr(struct sock *sk,
437 u16 family,
438 const struct netlbl_lsm_secattr *secattr);
439 void netlbl_sock_delattr(struct sock *sk);
440 int netlbl_sock_getattr(struct sock *sk,
441 struct netlbl_lsm_secattr *secattr);
442 int netlbl_conn_setattr(struct sock *sk,
443 struct sockaddr *addr,
444 const struct netlbl_lsm_secattr *secattr);
445 int netlbl_req_setattr(struct request_sock *req,
446 const struct netlbl_lsm_secattr *secattr);
447 void netlbl_req_delattr(struct request_sock *req);
448 int netlbl_skbuff_setattr(struct sk_buff *skb,
449 u16 family,
450 const struct netlbl_lsm_secattr *secattr);
451 int netlbl_skbuff_getattr(const struct sk_buff *skb,
452 u16 family,
453 struct netlbl_lsm_secattr *secattr);
454 void netlbl_skbuff_err(struct sk_buff *skb, int error, int gateway);
455
456 /*
457 * LSM label mapping cache operations
458 */
459 void netlbl_cache_invalidate(void);
460 int netlbl_cache_add(const struct sk_buff *skb,
461 const struct netlbl_lsm_secattr *secattr);
462
463 /*
464 * Protocol engine operations
465 */
466 struct audit_buffer *netlbl_audit_start(int type,
467 struct netlbl_audit *audit_info);
468 #else
469 static inline int netlbl_cfg_map_del(const char *domain,
470 u16 family,
471 const void *addr,
472 const void *mask,
473 struct netlbl_audit *audit_info)
474 {
475 return -ENOSYS;
476 }
477 static inline int netlbl_cfg_unlbl_map_add(const char *domain,
478 u16 family,
479 void *addr,
480 void *mask,
481 struct netlbl_audit *audit_info)
482 {
483 return -ENOSYS;
484 }
485 static inline int netlbl_cfg_unlbl_static_add(struct net *net,
486 const char *dev_name,
487 const void *addr,
488 const void *mask,
489 u16 family,
490 u32 secid,
491 struct netlbl_audit *audit_info)
492 {
493 return -ENOSYS;
494 }
495 static inline int netlbl_cfg_unlbl_static_del(struct net *net,
496 const char *dev_name,
497 const void *addr,
498 const void *mask,
499 u16 family,
500 struct netlbl_audit *audit_info)
501 {
502 return -ENOSYS;
503 }
504 static inline int netlbl_cfg_cipsov4_add(struct cipso_v4_doi *doi_def,
505 struct netlbl_audit *audit_info)
506 {
507 return -ENOSYS;
508 }
509 static inline void netlbl_cfg_cipsov4_del(u32 doi,
510 struct netlbl_audit *audit_info)
511 {
512 return;
513 }
514 static inline int netlbl_cfg_cipsov4_map_add(u32 doi,
515 const char *domain,
516 const struct in_addr *addr,
517 const struct in_addr *mask,
518 struct netlbl_audit *audit_info)
519 {
520 return -ENOSYS;
521 }
522 static inline int netlbl_catmap_walk(struct netlbl_lsm_catmap *catmap,
523 u32 offset)
524 {
525 return -ENOENT;
526 }
527 static inline int netlbl_catmap_walkrng(struct netlbl_lsm_catmap *catmap,
528 u32 offset)
529 {
530 return -ENOENT;
531 }
532 static inline int netlbl_catmap_getlong(struct netlbl_lsm_catmap *catmap,
533 u32 *offset,
534 unsigned long *bitmap)
535 {
536 return 0;
537 }
538 static inline int netlbl_catmap_setbit(struct netlbl_lsm_catmap **catmap,
539 u32 bit,
540 gfp_t flags)
541 {
542 return 0;
543 }
544 static inline int netlbl_catmap_setrng(struct netlbl_lsm_catmap **catmap,
545 u32 start,
546 u32 end,
547 gfp_t flags)
548 {
549 return 0;
550 }
551 static inline int netlbl_catmap_setlong(struct netlbl_lsm_catmap **catmap,
552 u32 offset,
553 unsigned long bitmap,
554 gfp_t flags)
555 {
556 return 0;
557 }
558 static inline int netlbl_enabled(void)
559 {
560 return 0;
561 }
562 static inline int netlbl_sock_setattr(struct sock *sk,
563 u16 family,
564 const struct netlbl_lsm_secattr *secattr)
565 {
566 return -ENOSYS;
567 }
568 static inline void netlbl_sock_delattr(struct sock *sk)
569 {
570 }
571 static inline int netlbl_sock_getattr(struct sock *sk,
572 struct netlbl_lsm_secattr *secattr)
573 {
574 return -ENOSYS;
575 }
576 static inline int netlbl_conn_setattr(struct sock *sk,
577 struct sockaddr *addr,
578 const struct netlbl_lsm_secattr *secattr)
579 {
580 return -ENOSYS;
581 }
582 static inline int netlbl_req_setattr(struct request_sock *req,
583 const struct netlbl_lsm_secattr *secattr)
584 {
585 return -ENOSYS;
586 }
587 static inline void netlbl_req_delattr(struct request_sock *req)
588 {
589 return;
590 }
591 static inline int netlbl_skbuff_setattr(struct sk_buff *skb,
592 u16 family,
593 const struct netlbl_lsm_secattr *secattr)
594 {
595 return -ENOSYS;
596 }
597 static inline int netlbl_skbuff_getattr(const struct sk_buff *skb,
598 u16 family,
599 struct netlbl_lsm_secattr *secattr)
600 {
601 return -ENOSYS;
602 }
603 static inline void netlbl_skbuff_err(struct sk_buff *skb,
604 int error,
605 int gateway)
606 {
607 return;
608 }
609 static inline void netlbl_cache_invalidate(void)
610 {
611 return;
612 }
613 static inline int netlbl_cache_add(const struct sk_buff *skb,
614 const struct netlbl_lsm_secattr *secattr)
615 {
616 return 0;
617 }
618 static inline struct audit_buffer *netlbl_audit_start(int type,
619 struct netlbl_audit *audit_info)
620 {
621 return NULL;
622 }
623 #endif /* CONFIG_NETLABEL */
624
625 const struct netlbl_calipso_ops *
626 netlbl_calipso_ops_register(const struct netlbl_calipso_ops *ops);
627
628 #endif /* _NETLABEL_H */
This page took 0.059658 seconds and 6 git commands to generate.