blob: 83da7e1f0d3db8aeaae7d6e21bdcfe7c3e5d2715 [file] [log] [blame]
Paul Moore11a03f72006-08-03 16:46:20 -07001/*
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.moore@hp.com>
8 *
9 */
10
11/*
12 * (c) Copyright Hewlett-Packard Development Company, L.P., 2006
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, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 *
28 */
29
30#ifndef _NETLABEL_H
31#define _NETLABEL_H
32
33#include <linux/types.h>
Paul Moore7a0e1d62006-08-29 17:56:04 -070034#include <linux/net.h>
Paul Moore11a03f72006-08-03 16:46:20 -070035#include <linux/skbuff.h>
36#include <net/netlink.h>
paul.moore@hp.comffb733c2006-10-04 11:46:31 -040037#include <asm/atomic.h>
Paul Moore11a03f72006-08-03 16:46:20 -070038
39/*
40 * NetLabel - A management interface for maintaining network packet label
41 * mapping tables for explicit packet labling protocols.
42 *
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.
48 *
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:
52 *
53 * +-----------------+-------------------+--------- --- -- -
54 * | struct nlmsghdr | struct genlmsghdr | payload
55 * +-----------------+-------------------+--------- --- -- -
56 *
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
Paul Moorefcd48282006-09-25 15:56:09 -070061 * 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.
Paul Moore11a03f72006-08-03 16:46:20 -070063 *
64 */
65
66/*
67 * NetLabel NETLINK protocol
68 */
69
70#define NETLBL_PROTO_VERSION 1
71
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"
84
Paul Moore11a03f72006-08-03 16:46:20 -070085/*
86 * NetLabel - Kernel API for accessing the network packet label mappings.
87 *
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.
93 *
94 */
95
Paul Moore95d4e6b2006-09-29 17:05:05 -070096/* NetLabel audit information */
97struct netlbl_audit {
98 u32 secid;
99 uid_t loginuid;
100};
101
Paul Moore11a03f72006-08-03 16:46:20 -0700102/* Domain mapping definition struct */
103struct netlbl_dom_map;
104
105/* Domain mapping operations */
Paul Moore95d4e6b2006-09-29 17:05:05 -0700106int netlbl_domhsh_remove(const char *domain, struct netlbl_audit *audit_info);
Paul Moore11a03f72006-08-03 16:46:20 -0700107
108/* LSM security attributes */
109struct netlbl_lsm_cache {
paul.moore@hp.comffb733c2006-10-04 11:46:31 -0400110 atomic_t refcount;
Paul Moore11a03f72006-08-03 16:46:20 -0700111 void (*free) (const void *data);
112 void *data;
113};
Paul Moore02752762006-11-29 13:18:18 -0500114/* 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
118 * processing. */
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
125struct netlbl_lsm_secattr_catmap {
126 u32 startbit;
127 NETLBL_CATMAP_MAPTYPE bitmap[NETLBL_CATMAP_MAPCNT];
128 struct netlbl_lsm_secattr_catmap *next;
129};
Paul Moore701a90b2006-11-17 17:38:46 -0500130#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
Paul Moore11a03f72006-08-03 16:46:20 -0700135struct netlbl_lsm_secattr {
Paul Moore701a90b2006-11-17 17:38:46 -0500136 u32 flags;
137
Paul Moore11a03f72006-08-03 16:46:20 -0700138 char *domain;
139
140 u32 mls_lvl;
Paul Moore02752762006-11-29 13:18:18 -0500141 struct netlbl_lsm_secattr_catmap *mls_cat;
Paul Moore11a03f72006-08-03 16:46:20 -0700142
paul.moore@hp.comffb733c2006-10-04 11:46:31 -0400143 struct netlbl_lsm_cache *cache;
Paul Moore11a03f72006-08-03 16:46:20 -0700144};
145
146/*
147 * LSM security attribute operations
148 */
149
150
151/**
paul.moore@hp.comffb733c2006-10-04 11:46:31 -0400152 * netlbl_secattr_cache_alloc - Allocate and initialize a secattr cache
153 * @flags: the memory allocation flags
154 *
155 * Description:
156 * Allocate and initialize a netlbl_lsm_cache structure. Returns a pointer
157 * on success, NULL on failure.
158 *
159 */
Al Viro645408d2006-10-14 16:50:38 +0100160static inline struct netlbl_lsm_cache *netlbl_secattr_cache_alloc(gfp_t flags)
paul.moore@hp.comffb733c2006-10-04 11:46:31 -0400161{
162 struct netlbl_lsm_cache *cache;
163
164 cache = kzalloc(sizeof(*cache), flags);
165 if (cache)
166 atomic_set(&cache->refcount, 1);
167 return cache;
168}
169
170/**
171 * netlbl_secattr_cache_free - Frees a netlbl_lsm_cache struct
172 * @cache: the struct to free
173 *
174 * Description:
175 * Frees @secattr including all of the internal buffers.
176 *
177 */
178static inline void netlbl_secattr_cache_free(struct netlbl_lsm_cache *cache)
179{
180 if (!atomic_dec_and_test(&cache->refcount))
181 return;
182
183 if (cache->free)
184 cache->free(cache->data);
185 kfree(cache);
186}
187
188/**
Paul Moore02752762006-11-29 13:18:18 -0500189 * netlbl_secattr_catmap_alloc - Allocate a LSM secattr catmap
190 * @flags: memory allocation flags
191 *
192 * Description:
193 * Allocate memory for a LSM secattr catmap, returns a pointer on success, NULL
194 * on failure.
195 *
196 */
197static inline struct netlbl_lsm_secattr_catmap *netlbl_secattr_catmap_alloc(
198 gfp_t flags)
199{
200 return kzalloc(sizeof(struct netlbl_lsm_secattr_catmap), flags);
201}
202
203/**
204 * netlbl_secattr_catmap_free - Free a LSM secattr catmap
205 * @catmap: the category bitmap
206 *
207 * Description:
208 * Free a LSM secattr catmap.
209 *
210 */
211static inline void netlbl_secattr_catmap_free(
212 struct netlbl_lsm_secattr_catmap *catmap)
213{
214 struct netlbl_lsm_secattr_catmap *iter;
215
216 do {
217 iter = catmap;
218 catmap = catmap->next;
219 kfree(iter);
220 } while (catmap);
221}
222
223/**
Paul Moore11a03f72006-08-03 16:46:20 -0700224 * netlbl_secattr_init - Initialize a netlbl_lsm_secattr struct
225 * @secattr: the struct to initialize
226 *
227 * Description:
Paul Moorec6fa82a2006-11-17 17:38:45 -0500228 * Initialize an already allocated netlbl_lsm_secattr struct.
Paul Moore11a03f72006-08-03 16:46:20 -0700229 *
230 */
Paul Moorec6fa82a2006-11-17 17:38:45 -0500231static inline void netlbl_secattr_init(struct netlbl_lsm_secattr *secattr)
Paul Moore11a03f72006-08-03 16:46:20 -0700232{
Paul Moore701a90b2006-11-17 17:38:46 -0500233 secattr->flags = 0;
234 secattr->domain = NULL;
235 secattr->mls_cat = NULL;
236 secattr->cache = NULL;
Paul Moore11a03f72006-08-03 16:46:20 -0700237}
238
239/**
240 * netlbl_secattr_destroy - Clears a netlbl_lsm_secattr struct
241 * @secattr: the struct to clear
Paul Moore11a03f72006-08-03 16:46:20 -0700242 *
243 * Description:
244 * Destroys the @secattr struct, including freeing all of the internal buffers.
paul.moore@hp.comffb733c2006-10-04 11:46:31 -0400245 * The struct must be reset with a call to netlbl_secattr_init() before reuse.
Paul Moore11a03f72006-08-03 16:46:20 -0700246 *
247 */
paul.moore@hp.comffb733c2006-10-04 11:46:31 -0400248static inline void netlbl_secattr_destroy(struct netlbl_lsm_secattr *secattr)
Paul Moore11a03f72006-08-03 16:46:20 -0700249{
paul.moore@hp.comffb733c2006-10-04 11:46:31 -0400250 if (secattr->cache)
251 netlbl_secattr_cache_free(secattr->cache);
Paul Moore11a03f72006-08-03 16:46:20 -0700252 kfree(secattr->domain);
Paul Moore02752762006-11-29 13:18:18 -0500253 if (secattr->mls_cat)
254 netlbl_secattr_catmap_free(secattr->mls_cat);
Paul Moore11a03f72006-08-03 16:46:20 -0700255}
256
257/**
258 * netlbl_secattr_alloc - Allocate and initialize a netlbl_lsm_secattr struct
259 * @flags: the memory allocation flags
260 *
261 * Description:
262 * Allocate and initialize a netlbl_lsm_secattr struct. Returns a valid
263 * pointer on success, or NULL on failure.
264 *
265 */
Paul Moore1f758d92006-11-17 17:38:43 -0500266static inline struct netlbl_lsm_secattr *netlbl_secattr_alloc(gfp_t flags)
Paul Moore11a03f72006-08-03 16:46:20 -0700267{
268 return kzalloc(sizeof(struct netlbl_lsm_secattr), flags);
269}
270
271/**
272 * netlbl_secattr_free - Frees a netlbl_lsm_secattr struct
273 * @secattr: the struct to free
Paul Moore11a03f72006-08-03 16:46:20 -0700274 *
275 * Description:
paul.moore@hp.comffb733c2006-10-04 11:46:31 -0400276 * Frees @secattr including all of the internal buffers.
Paul Moore11a03f72006-08-03 16:46:20 -0700277 *
278 */
paul.moore@hp.comffb733c2006-10-04 11:46:31 -0400279static inline void netlbl_secattr_free(struct netlbl_lsm_secattr *secattr)
Paul Moore11a03f72006-08-03 16:46:20 -0700280{
paul.moore@hp.comffb733c2006-10-04 11:46:31 -0400281 netlbl_secattr_destroy(secattr);
Paul Moore11a03f72006-08-03 16:46:20 -0700282 kfree(secattr);
283}
284
Paul Moore02752762006-11-29 13:18:18 -0500285#ifdef CONFIG_NETLABEL
286int netlbl_secattr_catmap_walk(struct netlbl_lsm_secattr_catmap *catmap,
287 u32 offset);
288int netlbl_secattr_catmap_walk_rng(struct netlbl_lsm_secattr_catmap *catmap,
289 u32 offset);
290int netlbl_secattr_catmap_setbit(struct netlbl_lsm_secattr_catmap *catmap,
291 u32 bit,
292 gfp_t flags);
293int netlbl_secattr_catmap_setrng(struct netlbl_lsm_secattr_catmap *catmap,
294 u32 start,
295 u32 end,
296 gfp_t flags);
297#else
298static inline int netlbl_secattr_catmap_walk(
299 struct netlbl_lsm_secattr_catmap *catmap,
300 u32 offset)
301{
302 return -ENOENT;
303}
304
305static inline int netlbl_secattr_catmap_walk_rng(
306 struct netlbl_lsm_secattr_catmap *catmap,
307 u32 offset)
308{
309 return -ENOENT;
310}
311
312static inline int netlbl_secattr_catmap_setbit(
313 struct netlbl_lsm_secattr_catmap *catmap,
314 u32 bit,
315 gfp_t flags)
316{
317 return 0;
318}
319
320static inline int netlbl_secattr_catmap_setrng(
321 struct netlbl_lsm_secattr_catmap *catmap,
322 u32 start,
323 u32 end,
324 gfp_t flags)
325{
326 return 0;
327}
328#endif
329
Paul Moore11a03f72006-08-03 16:46:20 -0700330/*
331 * LSM protocol operations
332 */
333
334#ifdef CONFIG_NETLABEL
335int netlbl_socket_setattr(const struct socket *sock,
336 const struct netlbl_lsm_secattr *secattr);
Paul Moore14a72f52006-09-25 15:52:01 -0700337int netlbl_sock_getattr(struct sock *sk,
338 struct netlbl_lsm_secattr *secattr);
Paul Moore11a03f72006-08-03 16:46:20 -0700339int netlbl_socket_getattr(const struct socket *sock,
340 struct netlbl_lsm_secattr *secattr);
341int netlbl_skbuff_getattr(const struct sk_buff *skb,
342 struct netlbl_lsm_secattr *secattr);
343void netlbl_skbuff_err(struct sk_buff *skb, int error);
344#else
345static inline int netlbl_socket_setattr(const struct socket *sock,
346 const struct netlbl_lsm_secattr *secattr)
347{
348 return -ENOSYS;
349}
350
Paul Moore14a72f52006-09-25 15:52:01 -0700351static inline int netlbl_sock_getattr(struct sock *sk,
352 struct netlbl_lsm_secattr *secattr)
353{
354 return -ENOSYS;
355}
356
Paul Moore11a03f72006-08-03 16:46:20 -0700357static inline int netlbl_socket_getattr(const struct socket *sock,
358 struct netlbl_lsm_secattr *secattr)
359{
360 return -ENOSYS;
361}
362
363static inline int netlbl_skbuff_getattr(const struct sk_buff *skb,
364 struct netlbl_lsm_secattr *secattr)
365{
366 return -ENOSYS;
367}
368
369static inline void netlbl_skbuff_err(struct sk_buff *skb, int error)
370{
371 return;
372}
373#endif /* CONFIG_NETLABEL */
374
375/*
376 * LSM label mapping cache operations
377 */
378
379#ifdef CONFIG_NETLABEL
380void netlbl_cache_invalidate(void);
381int netlbl_cache_add(const struct sk_buff *skb,
382 const struct netlbl_lsm_secattr *secattr);
383#else
384static inline void netlbl_cache_invalidate(void)
385{
386 return;
387}
388
389static inline int netlbl_cache_add(const struct sk_buff *skb,
390 const struct netlbl_lsm_secattr *secattr)
391{
392 return 0;
393}
394#endif /* CONFIG_NETLABEL */
395
396#endif /* _NETLABEL_H */