4 * The NetLabel system manages static and dynamic label mappings for network
5 * protocols such as CIPSO and RIPSO.
7 * Author: Paul Moore <paul@paul-moore.com>
12 * (c) Copyright Hewlett-Packard Development Company, L.P., 2006, 2008
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.
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.
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/>.
32 #include <linux/types.h>
33 #include <linux/slab.h>
34 #include <linux/net.h>
35 #include <linux/skbuff.h>
37 #include <linux/in6.h>
38 #include <net/netlink.h>
39 #include <net/request_sock.h>
40 #include <linux/atomic.h>
46 * NetLabel - A management interface for maintaining network packet label
47 * mapping tables for explicit packet labling protocols.
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.
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:
59 * +-----------------+-------------------+--------- --- -- -
60 * | struct nlmsghdr | struct genlmsghdr | payload
61 * +-----------------+-------------------+--------- --- -- -
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.
73 * NetLabel NETLINK protocol
76 /* NetLabel NETLINK protocol 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
82 #define NETLBL_PROTO_VERSION 3
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"
102 * NetLabel - Kernel API for accessing the network packet label mappings.
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.
112 /* NetLabel audit information */
113 struct netlbl_audit
{
116 unsigned int sessionid
;
120 * LSM security attributes
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
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.
138 struct netlbl_lsm_cache
{
140 void (*free
) (const void *data
);
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
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
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
{
170 NETLBL_CATMAP_MAPTYPE bitmap
[NETLBL_CATMAP_MAPCNT
];
171 struct netlbl_lsm_catmap
*next
;
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
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.
194 struct netlbl_lsm_secattr
{
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)
212 struct netlbl_lsm_cache
*cache
;
215 struct netlbl_lsm_catmap
*cat
;
223 * struct netlbl_calipso_ops - NetLabel CALIPSO operations
224 * @doi_add: add a CALIPSO DOI
225 * @doi_free: free a CALIPSO DOI
226 * @doi_getdef: returns a reference to a DOI
227 * @doi_putdef: releases a reference of a DOI
230 * This structure is filled out by the CALIPSO engine and passed
231 * to the NetLabel core via a call to netlbl_calipso_ops_register().
232 * It enables the CALIPSO engine (and hence IPv6) to be compiled
235 struct netlbl_calipso_ops
{
236 int (*doi_add
)(struct calipso_doi
*doi_def
,
237 struct netlbl_audit
*audit_info
);
238 void (*doi_free
)(struct calipso_doi
*doi_def
);
239 struct calipso_doi
*(*doi_getdef
)(u32 doi
);
240 void (*doi_putdef
)(struct calipso_doi
*doi_def
);
244 * LSM security attribute operations (inline)
248 * netlbl_secattr_cache_alloc - Allocate and initialize a secattr cache
249 * @flags: the memory allocation flags
252 * Allocate and initialize a netlbl_lsm_cache structure. Returns a pointer
253 * on success, NULL on failure.
256 static inline struct netlbl_lsm_cache
*netlbl_secattr_cache_alloc(gfp_t flags
)
258 struct netlbl_lsm_cache
*cache
;
260 cache
= kzalloc(sizeof(*cache
), flags
);
262 atomic_set(&cache
->refcount
, 1);
267 * netlbl_secattr_cache_free - Frees a netlbl_lsm_cache struct
268 * @cache: the struct to free
271 * Frees @secattr including all of the internal buffers.
274 static inline void netlbl_secattr_cache_free(struct netlbl_lsm_cache
*cache
)
276 if (!atomic_dec_and_test(&cache
->refcount
))
280 cache
->free(cache
->data
);
285 * netlbl_catmap_alloc - Allocate a LSM secattr catmap
286 * @flags: memory allocation flags
289 * Allocate memory for a LSM secattr catmap, returns a pointer on success, NULL
293 static inline struct netlbl_lsm_catmap
*netlbl_catmap_alloc(gfp_t flags
)
295 return kzalloc(sizeof(struct netlbl_lsm_catmap
), flags
);
299 * netlbl_catmap_free - Free a LSM secattr catmap
300 * @catmap: the category bitmap
303 * Free a LSM secattr catmap.
306 static inline void netlbl_catmap_free(struct netlbl_lsm_catmap
*catmap
)
308 struct netlbl_lsm_catmap
*iter
;
312 catmap
= catmap
->next
;
318 * netlbl_secattr_init - Initialize a netlbl_lsm_secattr struct
319 * @secattr: the struct to initialize
322 * Initialize an already allocated netlbl_lsm_secattr struct.
325 static inline void netlbl_secattr_init(struct netlbl_lsm_secattr
*secattr
)
327 memset(secattr
, 0, sizeof(*secattr
));
331 * netlbl_secattr_destroy - Clears a netlbl_lsm_secattr struct
332 * @secattr: the struct to clear
335 * Destroys the @secattr struct, including freeing all of the internal buffers.
336 * The struct must be reset with a call to netlbl_secattr_init() before reuse.
339 static inline void netlbl_secattr_destroy(struct netlbl_lsm_secattr
*secattr
)
341 if (secattr
->flags
& NETLBL_SECATTR_FREE_DOMAIN
)
342 kfree(secattr
->domain
);
343 if (secattr
->flags
& NETLBL_SECATTR_CACHE
)
344 netlbl_secattr_cache_free(secattr
->cache
);
345 if (secattr
->flags
& NETLBL_SECATTR_MLS_CAT
)
346 netlbl_catmap_free(secattr
->attr
.mls
.cat
);
350 * netlbl_secattr_alloc - Allocate and initialize a netlbl_lsm_secattr struct
351 * @flags: the memory allocation flags
354 * Allocate and initialize a netlbl_lsm_secattr struct. Returns a valid
355 * pointer on success, or NULL on failure.
358 static inline struct netlbl_lsm_secattr
*netlbl_secattr_alloc(gfp_t flags
)
360 return kzalloc(sizeof(struct netlbl_lsm_secattr
), flags
);
364 * netlbl_secattr_free - Frees a netlbl_lsm_secattr struct
365 * @secattr: the struct to free
368 * Frees @secattr including all of the internal buffers.
371 static inline void netlbl_secattr_free(struct netlbl_lsm_secattr
*secattr
)
373 netlbl_secattr_destroy(secattr
);
377 #ifdef CONFIG_NETLABEL
379 * LSM configuration operations
381 int netlbl_cfg_map_del(const char *domain
,
385 struct netlbl_audit
*audit_info
);
386 int netlbl_cfg_unlbl_map_add(const char *domain
,
390 struct netlbl_audit
*audit_info
);
391 int netlbl_cfg_unlbl_static_add(struct net
*net
,
392 const char *dev_name
,
397 struct netlbl_audit
*audit_info
);
398 int netlbl_cfg_unlbl_static_del(struct net
*net
,
399 const char *dev_name
,
403 struct netlbl_audit
*audit_info
);
404 int netlbl_cfg_cipsov4_add(struct cipso_v4_doi
*doi_def
,
405 struct netlbl_audit
*audit_info
);
406 void netlbl_cfg_cipsov4_del(u32 doi
, struct netlbl_audit
*audit_info
);
407 int netlbl_cfg_cipsov4_map_add(u32 doi
,
409 const struct in_addr
*addr
,
410 const struct in_addr
*mask
,
411 struct netlbl_audit
*audit_info
);
413 * LSM security attribute operations
415 int netlbl_catmap_walk(struct netlbl_lsm_catmap
*catmap
, u32 offset
);
416 int netlbl_catmap_walkrng(struct netlbl_lsm_catmap
*catmap
, u32 offset
);
417 int netlbl_catmap_getlong(struct netlbl_lsm_catmap
*catmap
,
419 unsigned long *bitmap
);
420 int netlbl_catmap_setbit(struct netlbl_lsm_catmap
**catmap
,
423 int netlbl_catmap_setrng(struct netlbl_lsm_catmap
**catmap
,
427 int netlbl_catmap_setlong(struct netlbl_lsm_catmap
**catmap
,
429 unsigned long bitmap
,
433 * LSM protocol operations (NetLabel LSM/kernel API)
435 int netlbl_enabled(void);
436 int netlbl_sock_setattr(struct sock
*sk
,
438 const struct netlbl_lsm_secattr
*secattr
);
439 void netlbl_sock_delattr(struct sock
*sk
);
440 int netlbl_sock_getattr(struct sock
*sk
,
441 struct netlbl_lsm_secattr
*secattr
);
442 int netlbl_conn_setattr(struct sock
*sk
,
443 struct sockaddr
*addr
,
444 const struct netlbl_lsm_secattr
*secattr
);
445 int netlbl_req_setattr(struct request_sock
*req
,
446 const struct netlbl_lsm_secattr
*secattr
);
447 void netlbl_req_delattr(struct request_sock
*req
);
448 int netlbl_skbuff_setattr(struct sk_buff
*skb
,
450 const struct netlbl_lsm_secattr
*secattr
);
451 int netlbl_skbuff_getattr(const struct sk_buff
*skb
,
453 struct netlbl_lsm_secattr
*secattr
);
454 void netlbl_skbuff_err(struct sk_buff
*skb
, int error
, int gateway
);
457 * LSM label mapping cache operations
459 void netlbl_cache_invalidate(void);
460 int netlbl_cache_add(const struct sk_buff
*skb
,
461 const struct netlbl_lsm_secattr
*secattr
);
464 * Protocol engine operations
466 struct audit_buffer
*netlbl_audit_start(int type
,
467 struct netlbl_audit
*audit_info
);
469 static inline int netlbl_cfg_map_del(const char *domain
,
473 struct netlbl_audit
*audit_info
)
477 static inline int netlbl_cfg_unlbl_map_add(const char *domain
,
481 struct netlbl_audit
*audit_info
)
485 static inline int netlbl_cfg_unlbl_static_add(struct net
*net
,
486 const char *dev_name
,
491 struct netlbl_audit
*audit_info
)
495 static inline int netlbl_cfg_unlbl_static_del(struct net
*net
,
496 const char *dev_name
,
500 struct netlbl_audit
*audit_info
)
504 static inline int netlbl_cfg_cipsov4_add(struct cipso_v4_doi
*doi_def
,
505 struct netlbl_audit
*audit_info
)
509 static inline void netlbl_cfg_cipsov4_del(u32 doi
,
510 struct netlbl_audit
*audit_info
)
514 static inline int netlbl_cfg_cipsov4_map_add(u32 doi
,
516 const struct in_addr
*addr
,
517 const struct in_addr
*mask
,
518 struct netlbl_audit
*audit_info
)
522 static inline int netlbl_catmap_walk(struct netlbl_lsm_catmap
*catmap
,
527 static inline int netlbl_catmap_walkrng(struct netlbl_lsm_catmap
*catmap
,
532 static inline int netlbl_catmap_getlong(struct netlbl_lsm_catmap
*catmap
,
534 unsigned long *bitmap
)
538 static inline int netlbl_catmap_setbit(struct netlbl_lsm_catmap
**catmap
,
544 static inline int netlbl_catmap_setrng(struct netlbl_lsm_catmap
**catmap
,
551 static inline int netlbl_catmap_setlong(struct netlbl_lsm_catmap
**catmap
,
553 unsigned long bitmap
,
558 static inline int netlbl_enabled(void)
562 static inline int netlbl_sock_setattr(struct sock
*sk
,
564 const struct netlbl_lsm_secattr
*secattr
)
568 static inline void netlbl_sock_delattr(struct sock
*sk
)
571 static inline int netlbl_sock_getattr(struct sock
*sk
,
572 struct netlbl_lsm_secattr
*secattr
)
576 static inline int netlbl_conn_setattr(struct sock
*sk
,
577 struct sockaddr
*addr
,
578 const struct netlbl_lsm_secattr
*secattr
)
582 static inline int netlbl_req_setattr(struct request_sock
*req
,
583 const struct netlbl_lsm_secattr
*secattr
)
587 static inline void netlbl_req_delattr(struct request_sock
*req
)
591 static inline int netlbl_skbuff_setattr(struct sk_buff
*skb
,
593 const struct netlbl_lsm_secattr
*secattr
)
597 static inline int netlbl_skbuff_getattr(const struct sk_buff
*skb
,
599 struct netlbl_lsm_secattr
*secattr
)
603 static inline void netlbl_skbuff_err(struct sk_buff
*skb
,
609 static inline void netlbl_cache_invalidate(void)
613 static inline int netlbl_cache_add(const struct sk_buff
*skb
,
614 const struct netlbl_lsm_secattr
*secattr
)
618 static inline struct audit_buffer
*netlbl_audit_start(int type
,
619 struct netlbl_audit
*audit_info
)
623 #endif /* CONFIG_NETLABEL */
625 const struct netlbl_calipso_ops
*
626 netlbl_calipso_ops_register(const struct netlbl_calipso_ops
*ops
);
628 #endif /* _NETLABEL_H */