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