calipso: Allow request sockets to be relabelled by the lsm.
[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 * @doi_walk: enumerate the DOI list
229 * @sock_getattr: retrieve the socket's attr
230 * @sock_setattr: set the socket's attr
231 * @sock_delattr: remove the socket's attr
232 * @req_setattr: set the req socket's attr
233 * @req_delattr: remove the req socket's attr
234 *
235 * Description:
236 * This structure is filled out by the CALIPSO engine and passed
237 * to the NetLabel core via a call to netlbl_calipso_ops_register().
238 * It enables the CALIPSO engine (and hence IPv6) to be compiled
239 * as a module.
240 */
241 struct netlbl_calipso_ops {
242 int (*doi_add)(struct calipso_doi *doi_def,
243 struct netlbl_audit *audit_info);
244 void (*doi_free)(struct calipso_doi *doi_def);
245 int (*doi_remove)(u32 doi, struct netlbl_audit *audit_info);
246 struct calipso_doi *(*doi_getdef)(u32 doi);
247 void (*doi_putdef)(struct calipso_doi *doi_def);
248 int (*doi_walk)(u32 *skip_cnt,
249 int (*callback)(struct calipso_doi *doi_def, void *arg),
250 void *cb_arg);
251 int (*sock_getattr)(struct sock *sk,
252 struct netlbl_lsm_secattr *secattr);
253 int (*sock_setattr)(struct sock *sk,
254 const struct calipso_doi *doi_def,
255 const struct netlbl_lsm_secattr *secattr);
256 void (*sock_delattr)(struct sock *sk);
257 int (*req_setattr)(struct request_sock *req,
258 const struct calipso_doi *doi_def,
259 const struct netlbl_lsm_secattr *secattr);
260 void (*req_delattr)(struct request_sock *req);
261 };
262
263 /*
264 * LSM security attribute operations (inline)
265 */
266
267 /**
268 * netlbl_secattr_cache_alloc - Allocate and initialize a secattr cache
269 * @flags: the memory allocation flags
270 *
271 * Description:
272 * Allocate and initialize a netlbl_lsm_cache structure. Returns a pointer
273 * on success, NULL on failure.
274 *
275 */
276 static inline struct netlbl_lsm_cache *netlbl_secattr_cache_alloc(gfp_t flags)
277 {
278 struct netlbl_lsm_cache *cache;
279
280 cache = kzalloc(sizeof(*cache), flags);
281 if (cache)
282 atomic_set(&cache->refcount, 1);
283 return cache;
284 }
285
286 /**
287 * netlbl_secattr_cache_free - Frees a netlbl_lsm_cache struct
288 * @cache: the struct to free
289 *
290 * Description:
291 * Frees @secattr including all of the internal buffers.
292 *
293 */
294 static inline void netlbl_secattr_cache_free(struct netlbl_lsm_cache *cache)
295 {
296 if (!atomic_dec_and_test(&cache->refcount))
297 return;
298
299 if (cache->free)
300 cache->free(cache->data);
301 kfree(cache);
302 }
303
304 /**
305 * netlbl_catmap_alloc - Allocate a LSM secattr catmap
306 * @flags: memory allocation flags
307 *
308 * Description:
309 * Allocate memory for a LSM secattr catmap, returns a pointer on success, NULL
310 * on failure.
311 *
312 */
313 static inline struct netlbl_lsm_catmap *netlbl_catmap_alloc(gfp_t flags)
314 {
315 return kzalloc(sizeof(struct netlbl_lsm_catmap), flags);
316 }
317
318 /**
319 * netlbl_catmap_free - Free a LSM secattr catmap
320 * @catmap: the category bitmap
321 *
322 * Description:
323 * Free a LSM secattr catmap.
324 *
325 */
326 static inline void netlbl_catmap_free(struct netlbl_lsm_catmap *catmap)
327 {
328 struct netlbl_lsm_catmap *iter;
329
330 while (catmap) {
331 iter = catmap;
332 catmap = catmap->next;
333 kfree(iter);
334 }
335 }
336
337 /**
338 * netlbl_secattr_init - Initialize a netlbl_lsm_secattr struct
339 * @secattr: the struct to initialize
340 *
341 * Description:
342 * Initialize an already allocated netlbl_lsm_secattr struct.
343 *
344 */
345 static inline void netlbl_secattr_init(struct netlbl_lsm_secattr *secattr)
346 {
347 memset(secattr, 0, sizeof(*secattr));
348 }
349
350 /**
351 * netlbl_secattr_destroy - Clears a netlbl_lsm_secattr struct
352 * @secattr: the struct to clear
353 *
354 * Description:
355 * Destroys the @secattr struct, including freeing all of the internal buffers.
356 * The struct must be reset with a call to netlbl_secattr_init() before reuse.
357 *
358 */
359 static inline void netlbl_secattr_destroy(struct netlbl_lsm_secattr *secattr)
360 {
361 if (secattr->flags & NETLBL_SECATTR_FREE_DOMAIN)
362 kfree(secattr->domain);
363 if (secattr->flags & NETLBL_SECATTR_CACHE)
364 netlbl_secattr_cache_free(secattr->cache);
365 if (secattr->flags & NETLBL_SECATTR_MLS_CAT)
366 netlbl_catmap_free(secattr->attr.mls.cat);
367 }
368
369 /**
370 * netlbl_secattr_alloc - Allocate and initialize a netlbl_lsm_secattr struct
371 * @flags: the memory allocation flags
372 *
373 * Description:
374 * Allocate and initialize a netlbl_lsm_secattr struct. Returns a valid
375 * pointer on success, or NULL on failure.
376 *
377 */
378 static inline struct netlbl_lsm_secattr *netlbl_secattr_alloc(gfp_t flags)
379 {
380 return kzalloc(sizeof(struct netlbl_lsm_secattr), flags);
381 }
382
383 /**
384 * netlbl_secattr_free - Frees a netlbl_lsm_secattr struct
385 * @secattr: the struct to free
386 *
387 * Description:
388 * Frees @secattr including all of the internal buffers.
389 *
390 */
391 static inline void netlbl_secattr_free(struct netlbl_lsm_secattr *secattr)
392 {
393 netlbl_secattr_destroy(secattr);
394 kfree(secattr);
395 }
396
397 #ifdef CONFIG_NETLABEL
398 /*
399 * LSM configuration operations
400 */
401 int netlbl_cfg_map_del(const char *domain,
402 u16 family,
403 const void *addr,
404 const void *mask,
405 struct netlbl_audit *audit_info);
406 int netlbl_cfg_unlbl_map_add(const char *domain,
407 u16 family,
408 const void *addr,
409 const void *mask,
410 struct netlbl_audit *audit_info);
411 int netlbl_cfg_unlbl_static_add(struct net *net,
412 const char *dev_name,
413 const void *addr,
414 const void *mask,
415 u16 family,
416 u32 secid,
417 struct netlbl_audit *audit_info);
418 int netlbl_cfg_unlbl_static_del(struct net *net,
419 const char *dev_name,
420 const void *addr,
421 const void *mask,
422 u16 family,
423 struct netlbl_audit *audit_info);
424 int netlbl_cfg_cipsov4_add(struct cipso_v4_doi *doi_def,
425 struct netlbl_audit *audit_info);
426 void netlbl_cfg_cipsov4_del(u32 doi, struct netlbl_audit *audit_info);
427 int netlbl_cfg_cipsov4_map_add(u32 doi,
428 const char *domain,
429 const struct in_addr *addr,
430 const struct in_addr *mask,
431 struct netlbl_audit *audit_info);
432 /*
433 * LSM security attribute operations
434 */
435 int netlbl_catmap_walk(struct netlbl_lsm_catmap *catmap, u32 offset);
436 int netlbl_catmap_walkrng(struct netlbl_lsm_catmap *catmap, u32 offset);
437 int netlbl_catmap_getlong(struct netlbl_lsm_catmap *catmap,
438 u32 *offset,
439 unsigned long *bitmap);
440 int netlbl_catmap_setbit(struct netlbl_lsm_catmap **catmap,
441 u32 bit,
442 gfp_t flags);
443 int netlbl_catmap_setrng(struct netlbl_lsm_catmap **catmap,
444 u32 start,
445 u32 end,
446 gfp_t flags);
447 int netlbl_catmap_setlong(struct netlbl_lsm_catmap **catmap,
448 u32 offset,
449 unsigned long bitmap,
450 gfp_t flags);
451
452 /* Bitmap functions
453 */
454 int netlbl_bitmap_walk(const unsigned char *bitmap, u32 bitmap_len,
455 u32 offset, u8 state);
456 void netlbl_bitmap_setbit(unsigned char *bitmap, u32 bit, u8 state);
457
458 /*
459 * LSM protocol operations (NetLabel LSM/kernel API)
460 */
461 int netlbl_enabled(void);
462 int netlbl_sock_setattr(struct sock *sk,
463 u16 family,
464 const struct netlbl_lsm_secattr *secattr);
465 void netlbl_sock_delattr(struct sock *sk);
466 int netlbl_sock_getattr(struct sock *sk,
467 struct netlbl_lsm_secattr *secattr);
468 int netlbl_conn_setattr(struct sock *sk,
469 struct sockaddr *addr,
470 const struct netlbl_lsm_secattr *secattr);
471 int netlbl_req_setattr(struct request_sock *req,
472 const struct netlbl_lsm_secattr *secattr);
473 void netlbl_req_delattr(struct request_sock *req);
474 int netlbl_skbuff_setattr(struct sk_buff *skb,
475 u16 family,
476 const struct netlbl_lsm_secattr *secattr);
477 int netlbl_skbuff_getattr(const struct sk_buff *skb,
478 u16 family,
479 struct netlbl_lsm_secattr *secattr);
480 void netlbl_skbuff_err(struct sk_buff *skb, int error, int gateway);
481
482 /*
483 * LSM label mapping cache operations
484 */
485 void netlbl_cache_invalidate(void);
486 int netlbl_cache_add(const struct sk_buff *skb,
487 const struct netlbl_lsm_secattr *secattr);
488
489 /*
490 * Protocol engine operations
491 */
492 struct audit_buffer *netlbl_audit_start(int type,
493 struct netlbl_audit *audit_info);
494 #else
495 static inline int netlbl_cfg_map_del(const char *domain,
496 u16 family,
497 const void *addr,
498 const void *mask,
499 struct netlbl_audit *audit_info)
500 {
501 return -ENOSYS;
502 }
503 static inline int netlbl_cfg_unlbl_map_add(const char *domain,
504 u16 family,
505 void *addr,
506 void *mask,
507 struct netlbl_audit *audit_info)
508 {
509 return -ENOSYS;
510 }
511 static inline int netlbl_cfg_unlbl_static_add(struct net *net,
512 const char *dev_name,
513 const void *addr,
514 const void *mask,
515 u16 family,
516 u32 secid,
517 struct netlbl_audit *audit_info)
518 {
519 return -ENOSYS;
520 }
521 static inline int netlbl_cfg_unlbl_static_del(struct net *net,
522 const char *dev_name,
523 const void *addr,
524 const void *mask,
525 u16 family,
526 struct netlbl_audit *audit_info)
527 {
528 return -ENOSYS;
529 }
530 static inline int netlbl_cfg_cipsov4_add(struct cipso_v4_doi *doi_def,
531 struct netlbl_audit *audit_info)
532 {
533 return -ENOSYS;
534 }
535 static inline void netlbl_cfg_cipsov4_del(u32 doi,
536 struct netlbl_audit *audit_info)
537 {
538 return;
539 }
540 static inline int netlbl_cfg_cipsov4_map_add(u32 doi,
541 const char *domain,
542 const struct in_addr *addr,
543 const struct in_addr *mask,
544 struct netlbl_audit *audit_info)
545 {
546 return -ENOSYS;
547 }
548 static inline int netlbl_catmap_walk(struct netlbl_lsm_catmap *catmap,
549 u32 offset)
550 {
551 return -ENOENT;
552 }
553 static inline int netlbl_catmap_walkrng(struct netlbl_lsm_catmap *catmap,
554 u32 offset)
555 {
556 return -ENOENT;
557 }
558 static inline int netlbl_catmap_getlong(struct netlbl_lsm_catmap *catmap,
559 u32 *offset,
560 unsigned long *bitmap)
561 {
562 return 0;
563 }
564 static inline int netlbl_catmap_setbit(struct netlbl_lsm_catmap **catmap,
565 u32 bit,
566 gfp_t flags)
567 {
568 return 0;
569 }
570 static inline int netlbl_catmap_setrng(struct netlbl_lsm_catmap **catmap,
571 u32 start,
572 u32 end,
573 gfp_t flags)
574 {
575 return 0;
576 }
577 static inline int netlbl_catmap_setlong(struct netlbl_lsm_catmap **catmap,
578 u32 offset,
579 unsigned long bitmap,
580 gfp_t flags)
581 {
582 return 0;
583 }
584 static inline int netlbl_enabled(void)
585 {
586 return 0;
587 }
588 static inline int netlbl_sock_setattr(struct sock *sk,
589 u16 family,
590 const struct netlbl_lsm_secattr *secattr)
591 {
592 return -ENOSYS;
593 }
594 static inline void netlbl_sock_delattr(struct sock *sk)
595 {
596 }
597 static inline int netlbl_sock_getattr(struct sock *sk,
598 struct netlbl_lsm_secattr *secattr)
599 {
600 return -ENOSYS;
601 }
602 static inline int netlbl_conn_setattr(struct sock *sk,
603 struct sockaddr *addr,
604 const struct netlbl_lsm_secattr *secattr)
605 {
606 return -ENOSYS;
607 }
608 static inline int netlbl_req_setattr(struct request_sock *req,
609 const struct netlbl_lsm_secattr *secattr)
610 {
611 return -ENOSYS;
612 }
613 static inline void netlbl_req_delattr(struct request_sock *req)
614 {
615 return;
616 }
617 static inline int netlbl_skbuff_setattr(struct sk_buff *skb,
618 u16 family,
619 const struct netlbl_lsm_secattr *secattr)
620 {
621 return -ENOSYS;
622 }
623 static inline int netlbl_skbuff_getattr(const struct sk_buff *skb,
624 u16 family,
625 struct netlbl_lsm_secattr *secattr)
626 {
627 return -ENOSYS;
628 }
629 static inline void netlbl_skbuff_err(struct sk_buff *skb,
630 int error,
631 int gateway)
632 {
633 return;
634 }
635 static inline void netlbl_cache_invalidate(void)
636 {
637 return;
638 }
639 static inline int netlbl_cache_add(const struct sk_buff *skb,
640 const struct netlbl_lsm_secattr *secattr)
641 {
642 return 0;
643 }
644 static inline struct audit_buffer *netlbl_audit_start(int type,
645 struct netlbl_audit *audit_info)
646 {
647 return NULL;
648 }
649 #endif /* CONFIG_NETLABEL */
650
651 const struct netlbl_calipso_ops *
652 netlbl_calipso_ops_register(const struct netlbl_calipso_ops *ops);
653
654 #endif /* _NETLABEL_H */
This page took 0.046951 seconds and 6 git commands to generate.