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