Loading...
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_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_catmap {
166 u32 startbit;
167 NETLBL_CATMAP_MAPTYPE bitmap[NETLBL_CATMAP_MAPCNT];
168 struct netlbl_lsm_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_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_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_catmap *netlbl_catmap_alloc(gfp_t flags)
270{
271 return kzalloc(sizeof(struct netlbl_lsm_catmap), flags);
272}
273
274/**
275 * netlbl_catmap_free - Free a LSM secattr catmap
276 * @catmap: the category bitmap
277 *
278 * Description:
279 * Free a LSM secattr catmap.
280 *
281 */
282static inline void netlbl_catmap_free(struct netlbl_lsm_catmap *catmap)
283{
284 struct netlbl_lsm_catmap *iter;
285
286 while (catmap) {
287 iter = catmap;
288 catmap = catmap->next;
289 kfree(iter);
290 }
291}
292
293/**
294 * netlbl_secattr_init - Initialize a netlbl_lsm_secattr struct
295 * @secattr: the struct to initialize
296 *
297 * Description:
298 * Initialize an already allocated netlbl_lsm_secattr struct.
299 *
300 */
301static inline void netlbl_secattr_init(struct netlbl_lsm_secattr *secattr)
302{
303 memset(secattr, 0, sizeof(*secattr));
304}
305
306/**
307 * netlbl_secattr_destroy - Clears a netlbl_lsm_secattr struct
308 * @secattr: the struct to clear
309 *
310 * Description:
311 * Destroys the @secattr struct, including freeing all of the internal buffers.
312 * The struct must be reset with a call to netlbl_secattr_init() before reuse.
313 *
314 */
315static inline void netlbl_secattr_destroy(struct netlbl_lsm_secattr *secattr)
316{
317 if (secattr->flags & NETLBL_SECATTR_FREE_DOMAIN)
318 kfree(secattr->domain);
319 if (secattr->flags & NETLBL_SECATTR_CACHE)
320 netlbl_secattr_cache_free(secattr->cache);
321 if (secattr->flags & NETLBL_SECATTR_MLS_CAT)
322 netlbl_catmap_free(secattr->attr.mls.cat);
323}
324
325/**
326 * netlbl_secattr_alloc - Allocate and initialize a netlbl_lsm_secattr struct
327 * @flags: the memory allocation flags
328 *
329 * Description:
330 * Allocate and initialize a netlbl_lsm_secattr struct. Returns a valid
331 * pointer on success, or NULL on failure.
332 *
333 */
334static inline struct netlbl_lsm_secattr *netlbl_secattr_alloc(gfp_t flags)
335{
336 return kzalloc(sizeof(struct netlbl_lsm_secattr), flags);
337}
338
339/**
340 * netlbl_secattr_free - Frees a netlbl_lsm_secattr struct
341 * @secattr: the struct to free
342 *
343 * Description:
344 * Frees @secattr including all of the internal buffers.
345 *
346 */
347static inline void netlbl_secattr_free(struct netlbl_lsm_secattr *secattr)
348{
349 netlbl_secattr_destroy(secattr);
350 kfree(secattr);
351}
352
353#ifdef CONFIG_NETLABEL
354/*
355 * LSM configuration operations
356 */
357int netlbl_cfg_map_del(const char *domain,
358 u16 family,
359 const void *addr,
360 const void *mask,
361 struct netlbl_audit *audit_info);
362int netlbl_cfg_unlbl_map_add(const char *domain,
363 u16 family,
364 const void *addr,
365 const void *mask,
366 struct netlbl_audit *audit_info);
367int netlbl_cfg_unlbl_static_add(struct net *net,
368 const char *dev_name,
369 const void *addr,
370 const void *mask,
371 u16 family,
372 u32 secid,
373 struct netlbl_audit *audit_info);
374int netlbl_cfg_unlbl_static_del(struct net *net,
375 const char *dev_name,
376 const void *addr,
377 const void *mask,
378 u16 family,
379 struct netlbl_audit *audit_info);
380int netlbl_cfg_cipsov4_add(struct cipso_v4_doi *doi_def,
381 struct netlbl_audit *audit_info);
382void netlbl_cfg_cipsov4_del(u32 doi, struct netlbl_audit *audit_info);
383int netlbl_cfg_cipsov4_map_add(u32 doi,
384 const char *domain,
385 const struct in_addr *addr,
386 const struct in_addr *mask,
387 struct netlbl_audit *audit_info);
388/*
389 * LSM security attribute operations
390 */
391int netlbl_catmap_walk(struct netlbl_lsm_catmap *catmap, u32 offset);
392int netlbl_catmap_walkrng(struct netlbl_lsm_catmap *catmap, u32 offset);
393int netlbl_catmap_getlong(struct netlbl_lsm_catmap *catmap,
394 u32 *offset,
395 unsigned long *bitmap);
396int netlbl_catmap_setbit(struct netlbl_lsm_catmap **catmap,
397 u32 bit,
398 gfp_t flags);
399int netlbl_catmap_setrng(struct netlbl_lsm_catmap **catmap,
400 u32 start,
401 u32 end,
402 gfp_t flags);
403int netlbl_catmap_setlong(struct netlbl_lsm_catmap **catmap,
404 u32 offset,
405 unsigned long bitmap,
406 gfp_t flags);
407
408/*
409 * LSM protocol operations (NetLabel LSM/kernel API)
410 */
411int netlbl_enabled(void);
412int netlbl_sock_setattr(struct sock *sk,
413 u16 family,
414 const struct netlbl_lsm_secattr *secattr);
415void netlbl_sock_delattr(struct sock *sk);
416int netlbl_sock_getattr(struct sock *sk,
417 struct netlbl_lsm_secattr *secattr);
418int netlbl_conn_setattr(struct sock *sk,
419 struct sockaddr *addr,
420 const struct netlbl_lsm_secattr *secattr);
421int netlbl_req_setattr(struct request_sock *req,
422 const struct netlbl_lsm_secattr *secattr);
423void netlbl_req_delattr(struct request_sock *req);
424int netlbl_skbuff_setattr(struct sk_buff *skb,
425 u16 family,
426 const struct netlbl_lsm_secattr *secattr);
427int netlbl_skbuff_getattr(const struct sk_buff *skb,
428 u16 family,
429 struct netlbl_lsm_secattr *secattr);
430void netlbl_skbuff_err(struct sk_buff *skb, int error, int gateway);
431
432/*
433 * LSM label mapping cache operations
434 */
435void netlbl_cache_invalidate(void);
436int netlbl_cache_add(const struct sk_buff *skb,
437 const struct netlbl_lsm_secattr *secattr);
438
439/*
440 * Protocol engine operations
441 */
442struct audit_buffer *netlbl_audit_start(int type,
443 struct netlbl_audit *audit_info);
444#else
445static inline int netlbl_cfg_map_del(const char *domain,
446 u16 family,
447 const void *addr,
448 const void *mask,
449 struct netlbl_audit *audit_info)
450{
451 return -ENOSYS;
452}
453static inline int netlbl_cfg_unlbl_map_add(const char *domain,
454 u16 family,
455 void *addr,
456 void *mask,
457 struct netlbl_audit *audit_info)
458{
459 return -ENOSYS;
460}
461static inline int netlbl_cfg_unlbl_static_add(struct net *net,
462 const char *dev_name,
463 const void *addr,
464 const void *mask,
465 u16 family,
466 u32 secid,
467 struct netlbl_audit *audit_info)
468{
469 return -ENOSYS;
470}
471static inline int netlbl_cfg_unlbl_static_del(struct net *net,
472 const char *dev_name,
473 const void *addr,
474 const void *mask,
475 u16 family,
476 struct netlbl_audit *audit_info)
477{
478 return -ENOSYS;
479}
480static inline int netlbl_cfg_cipsov4_add(struct cipso_v4_doi *doi_def,
481 struct netlbl_audit *audit_info)
482{
483 return -ENOSYS;
484}
485static inline void netlbl_cfg_cipsov4_del(u32 doi,
486 struct netlbl_audit *audit_info)
487{
488 return;
489}
490static inline int netlbl_cfg_cipsov4_map_add(u32 doi,
491 const char *domain,
492 const struct in_addr *addr,
493 const struct in_addr *mask,
494 struct netlbl_audit *audit_info)
495{
496 return -ENOSYS;
497}
498static inline int netlbl_catmap_walk(struct netlbl_lsm_catmap *catmap,
499 u32 offset)
500{
501 return -ENOENT;
502}
503static inline int netlbl_catmap_walkrng(struct netlbl_lsm_catmap *catmap,
504 u32 offset)
505{
506 return -ENOENT;
507}
508static inline int netlbl_catmap_getlong(struct netlbl_lsm_catmap *catmap,
509 u32 *offset,
510 unsigned long *bitmap)
511{
512 return 0;
513}
514static inline int netlbl_catmap_setbit(struct netlbl_lsm_catmap **catmap,
515 u32 bit,
516 gfp_t flags)
517{
518 return 0;
519}
520static inline int netlbl_catmap_setrng(struct netlbl_lsm_catmap **catmap,
521 u32 start,
522 u32 end,
523 gfp_t flags)
524{
525 return 0;
526}
527static inline int netlbl_catmap_setlong(struct netlbl_lsm_catmap **catmap,
528 u32 offset,
529 unsigned long bitmap,
530 gfp_t flags)
531{
532 return 0;
533}
534static inline int netlbl_enabled(void)
535{
536 return 0;
537}
538static inline int netlbl_sock_setattr(struct sock *sk,
539 u16 family,
540 const struct netlbl_lsm_secattr *secattr)
541{
542 return -ENOSYS;
543}
544static inline void netlbl_sock_delattr(struct sock *sk)
545{
546}
547static inline int netlbl_sock_getattr(struct sock *sk,
548 struct netlbl_lsm_secattr *secattr)
549{
550 return -ENOSYS;
551}
552static inline int netlbl_conn_setattr(struct sock *sk,
553 struct sockaddr *addr,
554 const struct netlbl_lsm_secattr *secattr)
555{
556 return -ENOSYS;
557}
558static inline int netlbl_req_setattr(struct request_sock *req,
559 const struct netlbl_lsm_secattr *secattr)
560{
561 return -ENOSYS;
562}
563static inline void netlbl_req_delattr(struct request_sock *req)
564{
565 return;
566}
567static inline int netlbl_skbuff_setattr(struct sk_buff *skb,
568 u16 family,
569 const struct netlbl_lsm_secattr *secattr)
570{
571 return -ENOSYS;
572}
573static inline int netlbl_skbuff_getattr(const struct sk_buff *skb,
574 u16 family,
575 struct netlbl_lsm_secattr *secattr)
576{
577 return -ENOSYS;
578}
579static inline void netlbl_skbuff_err(struct sk_buff *skb,
580 int error,
581 int gateway)
582{
583 return;
584}
585static inline void netlbl_cache_invalidate(void)
586{
587 return;
588}
589static inline int netlbl_cache_add(const struct sk_buff *skb,
590 const struct netlbl_lsm_secattr *secattr)
591{
592 return 0;
593}
594static inline struct audit_buffer *netlbl_audit_start(int type,
595 struct netlbl_audit *audit_info)
596{
597 return NULL;
598}
599#endif /* CONFIG_NETLABEL */
600
601#endif /* _NETLABEL_H */
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_MAPCNT 4
149#define NETLBL_CATMAP_MAPSIZE (sizeof(u64) * 8)
150#define NETLBL_CATMAP_SIZE (NETLBL_CATMAP_MAPSIZE * \
151 NETLBL_CATMAP_MAPCNT)
152#define NETLBL_CATMAP_BIT ((u64)0x01)
153struct netlbl_lsm_catmap {
154 u32 startbit;
155 u64 bitmap[NETLBL_CATMAP_MAPCNT];
156 struct netlbl_lsm_catmap *next;
157};
158
159/**
160 * struct netlbl_lsm_secattr - NetLabel LSM security attributes
161 * @flags: indicate structure attributes, see NETLBL_SECATTR_*
162 * @type: indicate the NLTYPE of the attributes
163 * @domain: the NetLabel LSM domain
164 * @cache: NetLabel LSM specific cache
165 * @attr.mls: MLS sensitivity label
166 * @attr.mls.cat: MLS category bitmap
167 * @attr.mls.lvl: MLS sensitivity level
168 * @attr.secid: LSM specific secid token
169 *
170 * Description:
171 * This structure is used to pass security attributes between NetLabel and the
172 * LSM modules. The flags field is used to specify which fields within the
173 * struct are valid and valid values can be created by bitwise OR'ing the
174 * NETLBL_SECATTR_* defines. The domain field is typically set by the LSM to
175 * specify domain specific configuration settings and is not usually used by
176 * NetLabel itself when returning security attributes to the LSM.
177 *
178 */
179struct netlbl_lsm_secattr {
180 u32 flags;
181 /* bitmap values for 'flags' */
182#define NETLBL_SECATTR_NONE 0x00000000
183#define NETLBL_SECATTR_DOMAIN 0x00000001
184#define NETLBL_SECATTR_DOMAIN_CPY (NETLBL_SECATTR_DOMAIN | \
185 NETLBL_SECATTR_FREE_DOMAIN)
186#define NETLBL_SECATTR_CACHE 0x00000002
187#define NETLBL_SECATTR_MLS_LVL 0x00000004
188#define NETLBL_SECATTR_MLS_CAT 0x00000008
189#define NETLBL_SECATTR_SECID 0x00000010
190 /* bitmap meta-values for 'flags' */
191#define NETLBL_SECATTR_FREE_DOMAIN 0x01000000
192#define NETLBL_SECATTR_CACHEABLE (NETLBL_SECATTR_MLS_LVL | \
193 NETLBL_SECATTR_MLS_CAT | \
194 NETLBL_SECATTR_SECID)
195 u32 type;
196 char *domain;
197 struct netlbl_lsm_cache *cache;
198 struct {
199 struct {
200 struct netlbl_lsm_catmap *cat;
201 u32 lvl;
202 } mls;
203 u32 secid;
204 } attr;
205};
206
207/**
208 * struct netlbl_calipso_ops - NetLabel CALIPSO operations
209 * @doi_add: add a CALIPSO DOI
210 * @doi_free: free a CALIPSO DOI
211 * @doi_getdef: returns a reference to a DOI
212 * @doi_putdef: releases a reference of a DOI
213 * @doi_walk: enumerate the DOI list
214 * @sock_getattr: retrieve the socket's attr
215 * @sock_setattr: set the socket's attr
216 * @sock_delattr: remove the socket's attr
217 * @req_setattr: set the req socket's attr
218 * @req_delattr: remove the req socket's attr
219 * @opt_getattr: retrieve attr from memory block
220 * @skbuff_optptr: find option in packet
221 * @skbuff_setattr: set the skbuff's attr
222 * @skbuff_delattr: remove the skbuff's attr
223 * @cache_invalidate: invalidate cache
224 * @cache_add: add cache entry
225 *
226 * Description:
227 * This structure is filled out by the CALIPSO engine and passed
228 * to the NetLabel core via a call to netlbl_calipso_ops_register().
229 * It enables the CALIPSO engine (and hence IPv6) to be compiled
230 * as a module.
231 */
232struct netlbl_calipso_ops {
233 int (*doi_add)(struct calipso_doi *doi_def,
234 struct netlbl_audit *audit_info);
235 void (*doi_free)(struct calipso_doi *doi_def);
236 int (*doi_remove)(u32 doi, struct netlbl_audit *audit_info);
237 struct calipso_doi *(*doi_getdef)(u32 doi);
238 void (*doi_putdef)(struct calipso_doi *doi_def);
239 int (*doi_walk)(u32 *skip_cnt,
240 int (*callback)(struct calipso_doi *doi_def, void *arg),
241 void *cb_arg);
242 int (*sock_getattr)(struct sock *sk,
243 struct netlbl_lsm_secattr *secattr);
244 int (*sock_setattr)(struct sock *sk,
245 const struct calipso_doi *doi_def,
246 const struct netlbl_lsm_secattr *secattr);
247 void (*sock_delattr)(struct sock *sk);
248 int (*req_setattr)(struct request_sock *req,
249 const struct calipso_doi *doi_def,
250 const struct netlbl_lsm_secattr *secattr);
251 void (*req_delattr)(struct request_sock *req);
252 int (*opt_getattr)(const unsigned char *calipso,
253 struct netlbl_lsm_secattr *secattr);
254 unsigned char *(*skbuff_optptr)(const struct sk_buff *skb);
255 int (*skbuff_setattr)(struct sk_buff *skb,
256 const struct calipso_doi *doi_def,
257 const struct netlbl_lsm_secattr *secattr);
258 int (*skbuff_delattr)(struct sk_buff *skb);
259 void (*cache_invalidate)(void);
260 int (*cache_add)(const unsigned char *calipso_ptr,
261 const struct netlbl_lsm_secattr *secattr);
262};
263
264/*
265 * LSM security attribute operations (inline)
266 */
267
268/**
269 * netlbl_secattr_cache_alloc - Allocate and initialize a secattr cache
270 * @flags: the memory allocation flags
271 *
272 * Description:
273 * Allocate and initialize a netlbl_lsm_cache structure. Returns a pointer
274 * on success, NULL on failure.
275 *
276 */
277static inline struct netlbl_lsm_cache *netlbl_secattr_cache_alloc(gfp_t flags)
278{
279 struct netlbl_lsm_cache *cache;
280
281 cache = kzalloc(sizeof(*cache), flags);
282 if (cache)
283 refcount_set(&cache->refcount, 1);
284 return cache;
285}
286
287/**
288 * netlbl_secattr_cache_free - Frees a netlbl_lsm_cache struct
289 * @cache: the struct to free
290 *
291 * Description:
292 * Frees @secattr including all of the internal buffers.
293 *
294 */
295static inline void netlbl_secattr_cache_free(struct netlbl_lsm_cache *cache)
296{
297 if (!refcount_dec_and_test(&cache->refcount))
298 return;
299
300 if (cache->free)
301 cache->free(cache->data);
302 kfree(cache);
303}
304
305/**
306 * netlbl_catmap_alloc - Allocate a LSM secattr catmap
307 * @flags: memory allocation flags
308 *
309 * Description:
310 * Allocate memory for a LSM secattr catmap, returns a pointer on success, NULL
311 * on failure.
312 *
313 */
314static inline struct netlbl_lsm_catmap *netlbl_catmap_alloc(gfp_t flags)
315{
316 return kzalloc(sizeof(struct netlbl_lsm_catmap), flags);
317}
318
319/**
320 * netlbl_catmap_free - Free a LSM secattr catmap
321 * @catmap: the category bitmap
322 *
323 * Description:
324 * Free a LSM secattr catmap.
325 *
326 */
327static inline void netlbl_catmap_free(struct netlbl_lsm_catmap *catmap)
328{
329 struct netlbl_lsm_catmap *iter;
330
331 while (catmap) {
332 iter = catmap;
333 catmap = catmap->next;
334 kfree(iter);
335 }
336}
337
338/**
339 * netlbl_secattr_init - Initialize a netlbl_lsm_secattr struct
340 * @secattr: the struct to initialize
341 *
342 * Description:
343 * Initialize an already allocated netlbl_lsm_secattr struct.
344 *
345 */
346static inline void netlbl_secattr_init(struct netlbl_lsm_secattr *secattr)
347{
348 memset(secattr, 0, sizeof(*secattr));
349}
350
351/**
352 * netlbl_secattr_destroy - Clears a netlbl_lsm_secattr struct
353 * @secattr: the struct to clear
354 *
355 * Description:
356 * Destroys the @secattr struct, including freeing all of the internal buffers.
357 * The struct must be reset with a call to netlbl_secattr_init() before reuse.
358 *
359 */
360static inline void netlbl_secattr_destroy(struct netlbl_lsm_secattr *secattr)
361{
362 if (secattr->flags & NETLBL_SECATTR_FREE_DOMAIN)
363 kfree(secattr->domain);
364 if (secattr->flags & NETLBL_SECATTR_CACHE)
365 netlbl_secattr_cache_free(secattr->cache);
366 if (secattr->flags & NETLBL_SECATTR_MLS_CAT)
367 netlbl_catmap_free(secattr->attr.mls.cat);
368}
369
370/**
371 * netlbl_secattr_alloc - Allocate and initialize a netlbl_lsm_secattr struct
372 * @flags: the memory allocation flags
373 *
374 * Description:
375 * Allocate and initialize a netlbl_lsm_secattr struct. Returns a valid
376 * pointer on success, or NULL on failure.
377 *
378 */
379static inline struct netlbl_lsm_secattr *netlbl_secattr_alloc(gfp_t flags)
380{
381 return kzalloc(sizeof(struct netlbl_lsm_secattr), flags);
382}
383
384/**
385 * netlbl_secattr_free - Frees a netlbl_lsm_secattr struct
386 * @secattr: the struct to free
387 *
388 * Description:
389 * Frees @secattr including all of the internal buffers.
390 *
391 */
392static inline void netlbl_secattr_free(struct netlbl_lsm_secattr *secattr)
393{
394 netlbl_secattr_destroy(secattr);
395 kfree(secattr);
396}
397
398#ifdef CONFIG_NETLABEL
399/*
400 * LSM configuration operations
401 */
402int netlbl_cfg_map_del(const char *domain,
403 u16 family,
404 const void *addr,
405 const void *mask,
406 struct netlbl_audit *audit_info);
407int netlbl_cfg_unlbl_map_add(const char *domain,
408 u16 family,
409 const void *addr,
410 const void *mask,
411 struct netlbl_audit *audit_info);
412int netlbl_cfg_unlbl_static_add(struct net *net,
413 const char *dev_name,
414 const void *addr,
415 const void *mask,
416 u16 family,
417 u32 secid,
418 struct netlbl_audit *audit_info);
419int netlbl_cfg_unlbl_static_del(struct net *net,
420 const char *dev_name,
421 const void *addr,
422 const void *mask,
423 u16 family,
424 struct netlbl_audit *audit_info);
425int netlbl_cfg_cipsov4_add(struct cipso_v4_doi *doi_def,
426 struct netlbl_audit *audit_info);
427void netlbl_cfg_cipsov4_del(u32 doi, struct netlbl_audit *audit_info);
428int netlbl_cfg_cipsov4_map_add(u32 doi,
429 const char *domain,
430 const struct in_addr *addr,
431 const struct in_addr *mask,
432 struct netlbl_audit *audit_info);
433int netlbl_cfg_calipso_add(struct calipso_doi *doi_def,
434 struct netlbl_audit *audit_info);
435void netlbl_cfg_calipso_del(u32 doi, struct netlbl_audit *audit_info);
436int netlbl_cfg_calipso_map_add(u32 doi,
437 const char *domain,
438 const struct in6_addr *addr,
439 const struct in6_addr *mask,
440 struct netlbl_audit *audit_info);
441/*
442 * LSM security attribute operations
443 */
444int netlbl_catmap_walk(struct netlbl_lsm_catmap *catmap, u32 offset);
445int netlbl_catmap_walkrng(struct netlbl_lsm_catmap *catmap, u32 offset);
446int netlbl_catmap_getlong(struct netlbl_lsm_catmap *catmap,
447 u32 *offset,
448 unsigned long *bitmap);
449int netlbl_catmap_setbit(struct netlbl_lsm_catmap **catmap,
450 u32 bit,
451 gfp_t flags);
452int netlbl_catmap_setrng(struct netlbl_lsm_catmap **catmap,
453 u32 start,
454 u32 end,
455 gfp_t flags);
456int netlbl_catmap_setlong(struct netlbl_lsm_catmap **catmap,
457 u32 offset,
458 unsigned long bitmap,
459 gfp_t flags);
460
461/* Bitmap functions
462 */
463int netlbl_bitmap_walk(const unsigned char *bitmap, u32 bitmap_len,
464 u32 offset, u8 state);
465void netlbl_bitmap_setbit(unsigned char *bitmap, u32 bit, u8 state);
466
467/*
468 * LSM protocol operations (NetLabel LSM/kernel API)
469 */
470int netlbl_enabled(void);
471int netlbl_sock_setattr(struct sock *sk,
472 u16 family,
473 const struct netlbl_lsm_secattr *secattr);
474void netlbl_sock_delattr(struct sock *sk);
475int netlbl_sock_getattr(struct sock *sk,
476 struct netlbl_lsm_secattr *secattr);
477int netlbl_conn_setattr(struct sock *sk,
478 struct sockaddr *addr,
479 const struct netlbl_lsm_secattr *secattr);
480int netlbl_req_setattr(struct request_sock *req,
481 const struct netlbl_lsm_secattr *secattr);
482void netlbl_req_delattr(struct request_sock *req);
483int netlbl_skbuff_setattr(struct sk_buff *skb,
484 u16 family,
485 const struct netlbl_lsm_secattr *secattr);
486int netlbl_skbuff_getattr(const struct sk_buff *skb,
487 u16 family,
488 struct netlbl_lsm_secattr *secattr);
489void netlbl_skbuff_err(struct sk_buff *skb, u16 family, int error, int gateway);
490
491/*
492 * LSM label mapping cache operations
493 */
494void netlbl_cache_invalidate(void);
495int netlbl_cache_add(const struct sk_buff *skb, u16 family,
496 const struct netlbl_lsm_secattr *secattr);
497
498/*
499 * Protocol engine operations
500 */
501struct audit_buffer *netlbl_audit_start(int type,
502 struct netlbl_audit *audit_info);
503#else
504static inline int netlbl_cfg_map_del(const char *domain,
505 u16 family,
506 const void *addr,
507 const void *mask,
508 struct netlbl_audit *audit_info)
509{
510 return -ENOSYS;
511}
512static inline int netlbl_cfg_unlbl_map_add(const char *domain,
513 u16 family,
514 void *addr,
515 void *mask,
516 struct netlbl_audit *audit_info)
517{
518 return -ENOSYS;
519}
520static inline int netlbl_cfg_unlbl_static_add(struct net *net,
521 const char *dev_name,
522 const void *addr,
523 const void *mask,
524 u16 family,
525 u32 secid,
526 struct netlbl_audit *audit_info)
527{
528 return -ENOSYS;
529}
530static inline int netlbl_cfg_unlbl_static_del(struct net *net,
531 const char *dev_name,
532 const void *addr,
533 const void *mask,
534 u16 family,
535 struct netlbl_audit *audit_info)
536{
537 return -ENOSYS;
538}
539static inline int netlbl_cfg_cipsov4_add(struct cipso_v4_doi *doi_def,
540 struct netlbl_audit *audit_info)
541{
542 return -ENOSYS;
543}
544static inline void netlbl_cfg_cipsov4_del(u32 doi,
545 struct netlbl_audit *audit_info)
546{
547 return;
548}
549static inline int netlbl_cfg_cipsov4_map_add(u32 doi,
550 const char *domain,
551 const struct in_addr *addr,
552 const struct in_addr *mask,
553 struct netlbl_audit *audit_info)
554{
555 return -ENOSYS;
556}
557static inline int netlbl_cfg_calipso_add(struct calipso_doi *doi_def,
558 struct netlbl_audit *audit_info)
559{
560 return -ENOSYS;
561}
562static inline void netlbl_cfg_calipso_del(u32 doi,
563 struct netlbl_audit *audit_info)
564{
565 return;
566}
567static inline int netlbl_cfg_calipso_map_add(u32 doi,
568 const char *domain,
569 const struct in6_addr *addr,
570 const struct in6_addr *mask,
571 struct netlbl_audit *audit_info)
572{
573 return -ENOSYS;
574}
575static inline int netlbl_catmap_walk(struct netlbl_lsm_catmap *catmap,
576 u32 offset)
577{
578 return -ENOENT;
579}
580static inline int netlbl_catmap_walkrng(struct netlbl_lsm_catmap *catmap,
581 u32 offset)
582{
583 return -ENOENT;
584}
585static inline int netlbl_catmap_getlong(struct netlbl_lsm_catmap *catmap,
586 u32 *offset,
587 unsigned long *bitmap)
588{
589 return 0;
590}
591static inline int netlbl_catmap_setbit(struct netlbl_lsm_catmap **catmap,
592 u32 bit,
593 gfp_t flags)
594{
595 return 0;
596}
597static inline int netlbl_catmap_setrng(struct netlbl_lsm_catmap **catmap,
598 u32 start,
599 u32 end,
600 gfp_t flags)
601{
602 return 0;
603}
604static inline int netlbl_catmap_setlong(struct netlbl_lsm_catmap **catmap,
605 u32 offset,
606 unsigned long bitmap,
607 gfp_t flags)
608{
609 return 0;
610}
611static inline int netlbl_enabled(void)
612{
613 return 0;
614}
615static inline int netlbl_sock_setattr(struct sock *sk,
616 u16 family,
617 const struct netlbl_lsm_secattr *secattr)
618{
619 return -ENOSYS;
620}
621static inline void netlbl_sock_delattr(struct sock *sk)
622{
623}
624static inline int netlbl_sock_getattr(struct sock *sk,
625 struct netlbl_lsm_secattr *secattr)
626{
627 return -ENOSYS;
628}
629static inline int netlbl_conn_setattr(struct sock *sk,
630 struct sockaddr *addr,
631 const struct netlbl_lsm_secattr *secattr)
632{
633 return -ENOSYS;
634}
635static inline int netlbl_req_setattr(struct request_sock *req,
636 const struct netlbl_lsm_secattr *secattr)
637{
638 return -ENOSYS;
639}
640static inline void netlbl_req_delattr(struct request_sock *req)
641{
642 return;
643}
644static inline int netlbl_skbuff_setattr(struct sk_buff *skb,
645 u16 family,
646 const struct netlbl_lsm_secattr *secattr)
647{
648 return -ENOSYS;
649}
650static inline int netlbl_skbuff_getattr(const struct sk_buff *skb,
651 u16 family,
652 struct netlbl_lsm_secattr *secattr)
653{
654 return -ENOSYS;
655}
656static inline void netlbl_skbuff_err(struct sk_buff *skb,
657 int error,
658 int gateway)
659{
660 return;
661}
662static inline void netlbl_cache_invalidate(void)
663{
664 return;
665}
666static inline int netlbl_cache_add(const struct sk_buff *skb, u16 family,
667 const struct netlbl_lsm_secattr *secattr)
668{
669 return 0;
670}
671static inline struct audit_buffer *netlbl_audit_start(int type,
672 struct netlbl_audit *audit_info)
673{
674 return NULL;
675}
676#endif /* CONFIG_NETLABEL */
677
678const struct netlbl_calipso_ops *
679netlbl_calipso_ops_register(const struct netlbl_calipso_ops *ops);
680
681#endif /* _NETLABEL_H */