4 * The NetLabel system manages static and dynamic label mappings for network
5 * protocols such as CIPSO and RIPSO.
7 * Author: Paul Moore <paul.moore@hp.com>
12 * (c) Copyright Hewlett-Packard Development Company, L.P., 2006
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, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
33 #include <linux/types.h>
34 #include <linux/net.h>
35 #include <linux/skbuff.h>
36 #include <net/netlink.h>
37 #include <asm/atomic.h>
40 * NetLabel - A management interface for maintaining network packet label
41 * mapping tables for explicit packet labling protocols.
43 * Network protocols such as CIPSO and RIPSO require a label translation layer
44 * to convert the label on the packet into something meaningful on the host
45 * machine. In the current Linux implementation these mapping tables live
46 * inside the kernel; NetLabel provides a mechanism for user space applications
47 * to manage these mapping tables.
49 * NetLabel makes use of the Generic NETLINK mechanism as a transport layer to
50 * send messages between kernel and user space. The general format of a
51 * NetLabel message is shown below:
53 * +-----------------+-------------------+--------- --- -- -
54 * | struct nlmsghdr | struct genlmsghdr | payload
55 * +-----------------+-------------------+--------- --- -- -
57 * The 'nlmsghdr' and 'genlmsghdr' structs should be dealt with like normal.
58 * The payload is dependent on the subsystem specified in the
59 * 'nlmsghdr->nlmsg_type' and should be defined below, supporting functions
60 * should be defined in the corresponding net/netlabel/netlabel_<subsys>.h|c
61 * file. All of the fields in the NetLabel payload are NETLINK attributes, see
62 * the include/net/netlink.h file for more information on NETLINK attributes.
67 * NetLabel NETLINK protocol
70 #define NETLBL_PROTO_VERSION 1
72 /* NetLabel NETLINK types/families */
73 #define NETLBL_NLTYPE_NONE 0
74 #define NETLBL_NLTYPE_MGMT 1
75 #define NETLBL_NLTYPE_MGMT_NAME "NLBL_MGMT"
76 #define NETLBL_NLTYPE_RIPSO 2
77 #define NETLBL_NLTYPE_RIPSO_NAME "NLBL_RIPSO"
78 #define NETLBL_NLTYPE_CIPSOV4 3
79 #define NETLBL_NLTYPE_CIPSOV4_NAME "NLBL_CIPSOv4"
80 #define NETLBL_NLTYPE_CIPSOV6 4
81 #define NETLBL_NLTYPE_CIPSOV6_NAME "NLBL_CIPSOv6"
82 #define NETLBL_NLTYPE_UNLABELED 5
83 #define NETLBL_NLTYPE_UNLABELED_NAME "NLBL_UNLBL"
86 * NetLabel - Kernel API for accessing the network packet label mappings.
88 * The following functions are provided for use by other kernel modules,
89 * specifically kernel LSM modules, to provide a consistent, transparent API
90 * for dealing with explicit packet labeling protocols such as CIPSO and
91 * RIPSO. The functions defined here are implemented in the
92 * net/netlabel/netlabel_kapi.c file.
96 /* NetLabel audit information */
102 /* Domain mapping definition struct */
103 struct netlbl_dom_map;
105 /* Domain mapping operations */
106 int netlbl_domhsh_remove(const char *domain, struct netlbl_audit *audit_info);
108 /* LSM security attributes */
109 struct netlbl_lsm_cache {
111 void (*free) (const void *data);
114 /* The catmap bitmap field MUST be a power of two in length and large
115 * enough to hold at least 240 bits. Special care (i.e. check the code!)
116 * should be used when changing these values as the LSM implementation
117 * probably has functions which rely on the sizes of these types to speed
119 #define NETLBL_CATMAP_MAPTYPE u64
120 #define NETLBL_CATMAP_MAPCNT 4
121 #define NETLBL_CATMAP_MAPSIZE (sizeof(NETLBL_CATMAP_MAPTYPE) * 8)
122 #define NETLBL_CATMAP_SIZE (NETLBL_CATMAP_MAPSIZE * \
123 NETLBL_CATMAP_MAPCNT)
124 #define NETLBL_CATMAP_BIT (NETLBL_CATMAP_MAPTYPE)0x01
125 struct netlbl_lsm_secattr_catmap {
127 NETLBL_CATMAP_MAPTYPE bitmap[NETLBL_CATMAP_MAPCNT];
128 struct netlbl_lsm_secattr_catmap *next;
130 #define NETLBL_SECATTR_NONE 0x00000000
131 #define NETLBL_SECATTR_DOMAIN 0x00000001
132 #define NETLBL_SECATTR_CACHE 0x00000002
133 #define NETLBL_SECATTR_MLS_LVL 0x00000004
134 #define NETLBL_SECATTR_MLS_CAT 0x00000008
135 struct netlbl_lsm_secattr {
141 struct netlbl_lsm_secattr_catmap *mls_cat;
143 struct netlbl_lsm_cache *cache;
147 * LSM security attribute operations
152 * netlbl_secattr_cache_alloc - Allocate and initialize a secattr cache
153 * @flags: the memory allocation flags
156 * Allocate and initialize a netlbl_lsm_cache structure. Returns a pointer
157 * on success, NULL on failure.
160 static inline struct netlbl_lsm_cache *netlbl_secattr_cache_alloc(gfp_t flags)
162 struct netlbl_lsm_cache *cache;
164 cache = kzalloc(sizeof(*cache), flags);
166 atomic_set(&cache->refcount, 1);
171 * netlbl_secattr_cache_free - Frees a netlbl_lsm_cache struct
172 * @cache: the struct to free
175 * Frees @secattr including all of the internal buffers.
178 static inline void netlbl_secattr_cache_free(struct netlbl_lsm_cache *cache)
180 if (!atomic_dec_and_test(&cache->refcount))
184 cache->free(cache->data);
189 * netlbl_secattr_catmap_alloc - Allocate a LSM secattr catmap
190 * @flags: memory allocation flags
193 * Allocate memory for a LSM secattr catmap, returns a pointer on success, NULL
197 static inline struct netlbl_lsm_secattr_catmap *netlbl_secattr_catmap_alloc(
200 return kzalloc(sizeof(struct netlbl_lsm_secattr_catmap), flags);
204 * netlbl_secattr_catmap_free - Free a LSM secattr catmap
205 * @catmap: the category bitmap
208 * Free a LSM secattr catmap.
211 static inline void netlbl_secattr_catmap_free(
212 struct netlbl_lsm_secattr_catmap *catmap)
214 struct netlbl_lsm_secattr_catmap *iter;
218 catmap = catmap->next;
224 * netlbl_secattr_init - Initialize a netlbl_lsm_secattr struct
225 * @secattr: the struct to initialize
228 * Initialize an already allocated netlbl_lsm_secattr struct.
231 static inline void netlbl_secattr_init(struct netlbl_lsm_secattr *secattr)
234 secattr->domain = NULL;
235 secattr->mls_cat = NULL;
236 secattr->cache = NULL;
240 * netlbl_secattr_destroy - Clears a netlbl_lsm_secattr struct
241 * @secattr: the struct to clear
244 * Destroys the @secattr struct, including freeing all of the internal buffers.
245 * The struct must be reset with a call to netlbl_secattr_init() before reuse.
248 static inline void netlbl_secattr_destroy(struct netlbl_lsm_secattr *secattr)
251 netlbl_secattr_cache_free(secattr->cache);
252 kfree(secattr->domain);
253 if (secattr->mls_cat)
254 netlbl_secattr_catmap_free(secattr->mls_cat);
258 * netlbl_secattr_alloc - Allocate and initialize a netlbl_lsm_secattr struct
259 * @flags: the memory allocation flags
262 * Allocate and initialize a netlbl_lsm_secattr struct. Returns a valid
263 * pointer on success, or NULL on failure.
266 static inline struct netlbl_lsm_secattr *netlbl_secattr_alloc(gfp_t flags)
268 return kzalloc(sizeof(struct netlbl_lsm_secattr), flags);
272 * netlbl_secattr_free - Frees a netlbl_lsm_secattr struct
273 * @secattr: the struct to free
276 * Frees @secattr including all of the internal buffers.
279 static inline void netlbl_secattr_free(struct netlbl_lsm_secattr *secattr)
281 netlbl_secattr_destroy(secattr);
285 #ifdef CONFIG_NETLABEL
286 int netlbl_secattr_catmap_walk(struct netlbl_lsm_secattr_catmap *catmap,
288 int netlbl_secattr_catmap_walk_rng(struct netlbl_lsm_secattr_catmap *catmap,
290 int netlbl_secattr_catmap_setbit(struct netlbl_lsm_secattr_catmap *catmap,
293 int netlbl_secattr_catmap_setrng(struct netlbl_lsm_secattr_catmap *catmap,
298 static inline int netlbl_secattr_catmap_walk(
299 struct netlbl_lsm_secattr_catmap *catmap,
305 static inline int netlbl_secattr_catmap_walk_rng(
306 struct netlbl_lsm_secattr_catmap *catmap,
312 static inline int netlbl_secattr_catmap_setbit(
313 struct netlbl_lsm_secattr_catmap *catmap,
320 static inline int netlbl_secattr_catmap_setrng(
321 struct netlbl_lsm_secattr_catmap *catmap,
331 * LSM protocol operations
334 #ifdef CONFIG_NETLABEL
335 int netlbl_socket_setattr(const struct socket *sock,
336 const struct netlbl_lsm_secattr *secattr);
337 int netlbl_sock_getattr(struct sock *sk,
338 struct netlbl_lsm_secattr *secattr);
339 int netlbl_socket_getattr(const struct socket *sock,
340 struct netlbl_lsm_secattr *secattr);
341 int netlbl_skbuff_getattr(const struct sk_buff *skb,
342 struct netlbl_lsm_secattr *secattr);
343 void netlbl_skbuff_err(struct sk_buff *skb, int error);
345 static inline int netlbl_socket_setattr(const struct socket *sock,
346 const struct netlbl_lsm_secattr *secattr)
351 static inline int netlbl_sock_getattr(struct sock *sk,
352 struct netlbl_lsm_secattr *secattr)
357 static inline int netlbl_socket_getattr(const struct socket *sock,
358 struct netlbl_lsm_secattr *secattr)
363 static inline int netlbl_skbuff_getattr(const struct sk_buff *skb,
364 struct netlbl_lsm_secattr *secattr)
369 static inline void netlbl_skbuff_err(struct sk_buff *skb, int error)
373 #endif /* CONFIG_NETLABEL */
376 * LSM label mapping cache operations
379 #ifdef CONFIG_NETLABEL
380 void netlbl_cache_invalidate(void);
381 int netlbl_cache_add(const struct sk_buff *skb,
382 const struct netlbl_lsm_secattr *secattr);
384 static inline void netlbl_cache_invalidate(void)
389 static inline int netlbl_cache_add(const struct sk_buff *skb,
390 const struct netlbl_lsm_secattr *secattr)
394 #endif /* CONFIG_NETLABEL */
396 #endif /* _NETLABEL_H */