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