Commit | Line | Data |
---|---|---|
11a03f78 PM |
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.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> | |
7a0e1d60 | 34 | #include <linux/net.h> |
11a03f78 PM |
35 | #include <linux/skbuff.h> |
36 | #include <net/netlink.h> | |
ffb733c6 | 37 | #include <asm/atomic.h> |
11a03f78 | 38 | |
eda61d32 PM |
39 | struct cipso_v4_doi; |
40 | ||
11a03f78 PM |
41 | /* |
42 | * NetLabel - A management interface for maintaining network packet label | |
43 | * mapping tables for explicit packet labling protocols. | |
44 | * | |
45 | * Network protocols such as CIPSO and RIPSO require a label translation layer | |
46 | * to convert the label on the packet into something meaningful on the host | |
47 | * machine. In the current Linux implementation these mapping tables live | |
48 | * inside the kernel; NetLabel provides a mechanism for user space applications | |
49 | * to manage these mapping tables. | |
50 | * | |
51 | * NetLabel makes use of the Generic NETLINK mechanism as a transport layer to | |
52 | * send messages between kernel and user space. The general format of a | |
53 | * NetLabel message is shown below: | |
54 | * | |
55 | * +-----------------+-------------------+--------- --- -- - | |
56 | * | struct nlmsghdr | struct genlmsghdr | payload | |
57 | * +-----------------+-------------------+--------- --- -- - | |
58 | * | |
59 | * The 'nlmsghdr' and 'genlmsghdr' structs should be dealt with like normal. | |
60 | * The payload is dependent on the subsystem specified in the | |
61 | * 'nlmsghdr->nlmsg_type' and should be defined below, supporting functions | |
62 | * should be defined in the corresponding net/netlabel/netlabel_<subsys>.h|c | |
fcd48280 PM |
63 | * file. All of the fields in the NetLabel payload are NETLINK attributes, see |
64 | * the include/net/netlink.h file for more information on NETLINK attributes. | |
11a03f78 PM |
65 | * |
66 | */ | |
67 | ||
68 | /* | |
69 | * NetLabel NETLINK protocol | |
70 | */ | |
71 | ||
8cc44579 PM |
72 | /* NetLabel NETLINK protocol version |
73 | * 1: initial version | |
74 | * 2: added static labels for unlabeled connections | |
75 | */ | |
76 | #define NETLBL_PROTO_VERSION 2 | |
11a03f78 PM |
77 | |
78 | /* NetLabel NETLINK types/families */ | |
79 | #define NETLBL_NLTYPE_NONE 0 | |
80 | #define NETLBL_NLTYPE_MGMT 1 | |
81 | #define NETLBL_NLTYPE_MGMT_NAME "NLBL_MGMT" | |
82 | #define NETLBL_NLTYPE_RIPSO 2 | |
83 | #define NETLBL_NLTYPE_RIPSO_NAME "NLBL_RIPSO" | |
84 | #define NETLBL_NLTYPE_CIPSOV4 3 | |
85 | #define NETLBL_NLTYPE_CIPSOV4_NAME "NLBL_CIPSOv4" | |
86 | #define NETLBL_NLTYPE_CIPSOV6 4 | |
87 | #define NETLBL_NLTYPE_CIPSOV6_NAME "NLBL_CIPSOv6" | |
88 | #define NETLBL_NLTYPE_UNLABELED 5 | |
89 | #define NETLBL_NLTYPE_UNLABELED_NAME "NLBL_UNLBL" | |
90 | ||
11a03f78 PM |
91 | /* |
92 | * NetLabel - Kernel API for accessing the network packet label mappings. | |
93 | * | |
94 | * The following functions are provided for use by other kernel modules, | |
95 | * specifically kernel LSM modules, to provide a consistent, transparent API | |
96 | * for dealing with explicit packet labeling protocols such as CIPSO and | |
97 | * RIPSO. The functions defined here are implemented in the | |
98 | * net/netlabel/netlabel_kapi.c file. | |
99 | * | |
100 | */ | |
101 | ||
95d4e6be PM |
102 | /* NetLabel audit information */ |
103 | struct netlbl_audit { | |
104 | u32 secid; | |
105 | uid_t loginuid; | |
106 | }; | |
107 | ||
16efd454 PM |
108 | /* |
109 | * LSM security attributes | |
110 | */ | |
111 | ||
112 | /** | |
113 | * struct netlbl_lsm_cache - NetLabel LSM security attribute cache | |
114 | * @refcount: atomic reference counter | |
115 | * @free: LSM supplied function to free the cache data | |
116 | * @data: LSM supplied cache data | |
117 | * | |
118 | * Description: | |
119 | * This structure is provided for LSMs which wish to make use of the NetLabel | |
120 | * caching mechanism to store LSM specific data/attributes in the NetLabel | |
121 | * cache. If the LSM has to perform a lot of translation from the NetLabel | |
122 | * security attributes into it's own internal representation then the cache | |
123 | * mechanism can provide a way to eliminate some or all of that translation | |
124 | * overhead on a cache hit. | |
125 | * | |
126 | */ | |
11a03f78 | 127 | struct netlbl_lsm_cache { |
ffb733c6 | 128 | atomic_t refcount; |
11a03f78 PM |
129 | void (*free) (const void *data); |
130 | void *data; | |
131 | }; | |
16efd454 PM |
132 | |
133 | /** | |
134 | * struct netlbl_lsm_secattr_catmap - NetLabel LSM secattr category bitmap | |
135 | * @startbit: the value of the lowest order bit in the bitmap | |
136 | * @bitmap: the category bitmap | |
137 | * @next: pointer to the next bitmap "node" or NULL | |
138 | * | |
139 | * Description: | |
140 | * This structure is used to represent category bitmaps. Due to the large | |
141 | * number of categories supported by most labeling protocols it is not | |
142 | * practical to transfer a full bitmap internally so NetLabel adopts a sparse | |
143 | * bitmap structure modeled after SELinux's ebitmap structure. | |
144 | * The catmap bitmap field MUST be a power of two in length and large | |
02752760 PM |
145 | * enough to hold at least 240 bits. Special care (i.e. check the code!) |
146 | * should be used when changing these values as the LSM implementation | |
147 | * probably has functions which rely on the sizes of these types to speed | |
16efd454 PM |
148 | * processing. |
149 | * | |
150 | */ | |
02752760 PM |
151 | #define NETLBL_CATMAP_MAPTYPE u64 |
152 | #define NETLBL_CATMAP_MAPCNT 4 | |
153 | #define NETLBL_CATMAP_MAPSIZE (sizeof(NETLBL_CATMAP_MAPTYPE) * 8) | |
154 | #define NETLBL_CATMAP_SIZE (NETLBL_CATMAP_MAPSIZE * \ | |
155 | NETLBL_CATMAP_MAPCNT) | |
156 | #define NETLBL_CATMAP_BIT (NETLBL_CATMAP_MAPTYPE)0x01 | |
157 | struct netlbl_lsm_secattr_catmap { | |
158 | u32 startbit; | |
159 | NETLBL_CATMAP_MAPTYPE bitmap[NETLBL_CATMAP_MAPCNT]; | |
160 | struct netlbl_lsm_secattr_catmap *next; | |
161 | }; | |
16efd454 PM |
162 | |
163 | /** | |
164 | * struct netlbl_lsm_secattr - NetLabel LSM security attributes | |
00447872 | 165 | * @flags: indicate structure attributes, see NETLBL_SECATTR_* |
16efd454 PM |
166 | * @type: indicate the NLTYPE of the attributes |
167 | * @domain: the NetLabel LSM domain | |
168 | * @cache: NetLabel LSM specific cache | |
169 | * @attr.mls: MLS sensitivity label | |
170 | * @attr.mls.cat: MLS category bitmap | |
171 | * @attr.mls.lvl: MLS sensitivity level | |
172 | * @attr.secid: LSM specific secid token | |
173 | * | |
174 | * Description: | |
175 | * This structure is used to pass security attributes between NetLabel and the | |
176 | * LSM modules. The flags field is used to specify which fields within the | |
177 | * struct are valid and valid values can be created by bitwise OR'ing the | |
178 | * NETLBL_SECATTR_* defines. The domain field is typically set by the LSM to | |
179 | * specify domain specific configuration settings and is not usually used by | |
180 | * NetLabel itself when returning security attributes to the LSM. | |
181 | * | |
182 | */ | |
00447872 PM |
183 | struct netlbl_lsm_secattr { |
184 | u32 flags; | |
185 | /* bitmap values for 'flags' */ | |
701a90ba PM |
186 | #define NETLBL_SECATTR_NONE 0x00000000 |
187 | #define NETLBL_SECATTR_DOMAIN 0x00000001 | |
00447872 PM |
188 | #define NETLBL_SECATTR_DOMAIN_CPY (NETLBL_SECATTR_DOMAIN | \ |
189 | NETLBL_SECATTR_FREE_DOMAIN) | |
701a90ba PM |
190 | #define NETLBL_SECATTR_CACHE 0x00000002 |
191 | #define NETLBL_SECATTR_MLS_LVL 0x00000004 | |
192 | #define NETLBL_SECATTR_MLS_CAT 0x00000008 | |
16efd454 | 193 | #define NETLBL_SECATTR_SECID 0x00000010 |
00447872 PM |
194 | /* bitmap meta-values for 'flags' */ |
195 | #define NETLBL_SECATTR_FREE_DOMAIN 0x01000000 | |
9534f71c | 196 | #define NETLBL_SECATTR_CACHEABLE (NETLBL_SECATTR_MLS_LVL | \ |
16efd454 PM |
197 | NETLBL_SECATTR_MLS_CAT | \ |
198 | NETLBL_SECATTR_SECID) | |
16efd454 | 199 | u32 type; |
11a03f78 | 200 | char *domain; |
ffb733c6 | 201 | struct netlbl_lsm_cache *cache; |
16efd454 PM |
202 | union { |
203 | struct { | |
204 | struct netlbl_lsm_secattr_catmap *cat; | |
205 | u32 lvl; | |
206 | } mls; | |
207 | u32 secid; | |
208 | } attr; | |
11a03f78 PM |
209 | }; |
210 | ||
211 | /* | |
23bcdc1a | 212 | * LSM security attribute operations (inline) |
11a03f78 PM |
213 | */ |
214 | ||
ffb733c6 | 215 | /** |
216 | * netlbl_secattr_cache_alloc - Allocate and initialize a secattr cache | |
217 | * @flags: the memory allocation flags | |
218 | * | |
219 | * Description: | |
220 | * Allocate and initialize a netlbl_lsm_cache structure. Returns a pointer | |
221 | * on success, NULL on failure. | |
222 | * | |
223 | */ | |
645408d1 | 224 | static inline struct netlbl_lsm_cache *netlbl_secattr_cache_alloc(gfp_t flags) |
ffb733c6 | 225 | { |
226 | struct netlbl_lsm_cache *cache; | |
227 | ||
228 | cache = kzalloc(sizeof(*cache), flags); | |
229 | if (cache) | |
230 | atomic_set(&cache->refcount, 1); | |
231 | return cache; | |
232 | } | |
233 | ||
234 | /** | |
235 | * netlbl_secattr_cache_free - Frees a netlbl_lsm_cache struct | |
236 | * @cache: the struct to free | |
237 | * | |
238 | * Description: | |
239 | * Frees @secattr including all of the internal buffers. | |
240 | * | |
241 | */ | |
242 | static inline void netlbl_secattr_cache_free(struct netlbl_lsm_cache *cache) | |
243 | { | |
244 | if (!atomic_dec_and_test(&cache->refcount)) | |
245 | return; | |
246 | ||
247 | if (cache->free) | |
248 | cache->free(cache->data); | |
249 | kfree(cache); | |
250 | } | |
251 | ||
02752760 PM |
252 | /** |
253 | * netlbl_secattr_catmap_alloc - Allocate a LSM secattr catmap | |
254 | * @flags: memory allocation flags | |
255 | * | |
256 | * Description: | |
257 | * Allocate memory for a LSM secattr catmap, returns a pointer on success, NULL | |
258 | * on failure. | |
259 | * | |
260 | */ | |
261 | static inline struct netlbl_lsm_secattr_catmap *netlbl_secattr_catmap_alloc( | |
262 | gfp_t flags) | |
263 | { | |
264 | return kzalloc(sizeof(struct netlbl_lsm_secattr_catmap), flags); | |
265 | } | |
266 | ||
267 | /** | |
268 | * netlbl_secattr_catmap_free - Free a LSM secattr catmap | |
269 | * @catmap: the category bitmap | |
270 | * | |
271 | * Description: | |
272 | * Free a LSM secattr catmap. | |
273 | * | |
274 | */ | |
275 | static inline void netlbl_secattr_catmap_free( | |
276 | struct netlbl_lsm_secattr_catmap *catmap) | |
277 | { | |
278 | struct netlbl_lsm_secattr_catmap *iter; | |
279 | ||
280 | do { | |
281 | iter = catmap; | |
282 | catmap = catmap->next; | |
283 | kfree(iter); | |
284 | } while (catmap); | |
285 | } | |
286 | ||
11a03f78 PM |
287 | /** |
288 | * netlbl_secattr_init - Initialize a netlbl_lsm_secattr struct | |
289 | * @secattr: the struct to initialize | |
290 | * | |
291 | * Description: | |
c6fa82a9 | 292 | * Initialize an already allocated netlbl_lsm_secattr struct. |
11a03f78 PM |
293 | * |
294 | */ | |
c6fa82a9 | 295 | static inline void netlbl_secattr_init(struct netlbl_lsm_secattr *secattr) |
11a03f78 | 296 | { |
16efd454 | 297 | memset(secattr, 0, sizeof(*secattr)); |
11a03f78 PM |
298 | } |
299 | ||
300 | /** | |
301 | * netlbl_secattr_destroy - Clears a netlbl_lsm_secattr struct | |
302 | * @secattr: the struct to clear | |
11a03f78 PM |
303 | * |
304 | * Description: | |
305 | * Destroys the @secattr struct, including freeing all of the internal buffers. | |
ffb733c6 | 306 | * The struct must be reset with a call to netlbl_secattr_init() before reuse. |
11a03f78 PM |
307 | * |
308 | */ | |
ffb733c6 | 309 | static inline void netlbl_secattr_destroy(struct netlbl_lsm_secattr *secattr) |
11a03f78 | 310 | { |
00447872 PM |
311 | if (secattr->flags & NETLBL_SECATTR_FREE_DOMAIN) |
312 | kfree(secattr->domain); | |
16efd454 PM |
313 | if (secattr->flags & NETLBL_SECATTR_CACHE) |
314 | netlbl_secattr_cache_free(secattr->cache); | |
315 | if (secattr->flags & NETLBL_SECATTR_MLS_CAT) | |
316 | netlbl_secattr_catmap_free(secattr->attr.mls.cat); | |
11a03f78 PM |
317 | } |
318 | ||
319 | /** | |
320 | * netlbl_secattr_alloc - Allocate and initialize a netlbl_lsm_secattr struct | |
321 | * @flags: the memory allocation flags | |
322 | * | |
323 | * Description: | |
324 | * Allocate and initialize a netlbl_lsm_secattr struct. Returns a valid | |
325 | * pointer on success, or NULL on failure. | |
326 | * | |
327 | */ | |
1f758d93 | 328 | static inline struct netlbl_lsm_secattr *netlbl_secattr_alloc(gfp_t flags) |
11a03f78 PM |
329 | { |
330 | return kzalloc(sizeof(struct netlbl_lsm_secattr), flags); | |
331 | } | |
332 | ||
333 | /** | |
334 | * netlbl_secattr_free - Frees a netlbl_lsm_secattr struct | |
335 | * @secattr: the struct to free | |
11a03f78 PM |
336 | * |
337 | * Description: | |
ffb733c6 | 338 | * Frees @secattr including all of the internal buffers. |
11a03f78 PM |
339 | * |
340 | */ | |
ffb733c6 | 341 | static inline void netlbl_secattr_free(struct netlbl_lsm_secattr *secattr) |
11a03f78 | 342 | { |
ffb733c6 | 343 | netlbl_secattr_destroy(secattr); |
11a03f78 PM |
344 | kfree(secattr); |
345 | } | |
346 | ||
02752760 | 347 | #ifdef CONFIG_NETLABEL |
eda61d32 PM |
348 | /* |
349 | * LSM configuration operations | |
350 | */ | |
351 | int netlbl_cfg_map_del(const char *domain, struct netlbl_audit *audit_info); | |
352 | int netlbl_cfg_unlbl_add_map(const char *domain, | |
353 | struct netlbl_audit *audit_info); | |
354 | int netlbl_cfg_cipsov4_add(struct cipso_v4_doi *doi_def, | |
355 | struct netlbl_audit *audit_info); | |
356 | int netlbl_cfg_cipsov4_add_map(struct cipso_v4_doi *doi_def, | |
357 | const char *domain, | |
358 | struct netlbl_audit *audit_info); | |
359 | int netlbl_cfg_cipsov4_del(u32 doi, struct netlbl_audit *audit_info); | |
360 | ||
23bcdc1a PM |
361 | /* |
362 | * LSM security attribute operations | |
363 | */ | |
02752760 PM |
364 | int netlbl_secattr_catmap_walk(struct netlbl_lsm_secattr_catmap *catmap, |
365 | u32 offset); | |
366 | int netlbl_secattr_catmap_walk_rng(struct netlbl_lsm_secattr_catmap *catmap, | |
367 | u32 offset); | |
368 | int netlbl_secattr_catmap_setbit(struct netlbl_lsm_secattr_catmap *catmap, | |
369 | u32 bit, | |
370 | gfp_t flags); | |
371 | int netlbl_secattr_catmap_setrng(struct netlbl_lsm_secattr_catmap *catmap, | |
372 | u32 start, | |
373 | u32 end, | |
374 | gfp_t flags); | |
23bcdc1a PM |
375 | |
376 | /* | |
16efd454 | 377 | * LSM protocol operations (NetLabel LSM/kernel API) |
23bcdc1a PM |
378 | */ |
379 | int netlbl_enabled(void); | |
380 | int netlbl_sock_setattr(struct sock *sk, | |
381 | const struct netlbl_lsm_secattr *secattr); | |
382 | int netlbl_sock_getattr(struct sock *sk, | |
383 | struct netlbl_lsm_secattr *secattr); | |
384 | int netlbl_skbuff_getattr(const struct sk_buff *skb, | |
75e22910 | 385 | u16 family, |
23bcdc1a PM |
386 | struct netlbl_lsm_secattr *secattr); |
387 | void netlbl_skbuff_err(struct sk_buff *skb, int error); | |
388 | ||
389 | /* | |
390 | * LSM label mapping cache operations | |
391 | */ | |
392 | void netlbl_cache_invalidate(void); | |
393 | int netlbl_cache_add(const struct sk_buff *skb, | |
394 | const struct netlbl_lsm_secattr *secattr); | |
02752760 | 395 | #else |
eda61d32 PM |
396 | static inline int netlbl_cfg_map_del(const char *domain, |
397 | struct netlbl_audit *audit_info) | |
398 | { | |
399 | return -ENOSYS; | |
400 | } | |
401 | static inline int netlbl_cfg_unlbl_add_map(const char *domain, | |
402 | struct netlbl_audit *audit_info) | |
403 | { | |
404 | return -ENOSYS; | |
405 | } | |
406 | static inline int netlbl_cfg_cipsov4_add(struct cipso_v4_doi *doi_def, | |
407 | struct netlbl_audit *audit_info) | |
408 | { | |
409 | return -ENOSYS; | |
410 | } | |
411 | static inline int netlbl_cfg_cipsov4_add_map(struct cipso_v4_doi *doi_def, | |
412 | const char *domain, | |
413 | struct netlbl_audit *audit_info) | |
414 | { | |
415 | return -ENOSYS; | |
416 | } | |
417 | static inline int netlbl_cfg_cipsov4_del(u32 doi, | |
418 | struct netlbl_audit *audit_info) | |
419 | { | |
420 | return -ENOSYS; | |
421 | } | |
02752760 PM |
422 | static inline int netlbl_secattr_catmap_walk( |
423 | struct netlbl_lsm_secattr_catmap *catmap, | |
424 | u32 offset) | |
425 | { | |
426 | return -ENOENT; | |
427 | } | |
02752760 PM |
428 | static inline int netlbl_secattr_catmap_walk_rng( |
429 | struct netlbl_lsm_secattr_catmap *catmap, | |
430 | u32 offset) | |
431 | { | |
432 | return -ENOENT; | |
433 | } | |
02752760 PM |
434 | static inline int netlbl_secattr_catmap_setbit( |
435 | struct netlbl_lsm_secattr_catmap *catmap, | |
436 | u32 bit, | |
437 | gfp_t flags) | |
438 | { | |
439 | return 0; | |
440 | } | |
02752760 PM |
441 | static inline int netlbl_secattr_catmap_setrng( |
442 | struct netlbl_lsm_secattr_catmap *catmap, | |
443 | u32 start, | |
444 | u32 end, | |
445 | gfp_t flags) | |
446 | { | |
447 | return 0; | |
448 | } | |
23bcdc1a PM |
449 | static inline int netlbl_enabled(void) |
450 | { | |
451 | return 0; | |
452 | } | |
ba6ff9f2 | 453 | static inline int netlbl_sock_setattr(struct sock *sk, |
11a03f78 PM |
454 | const struct netlbl_lsm_secattr *secattr) |
455 | { | |
456 | return -ENOSYS; | |
457 | } | |
14a72f53 PM |
458 | static inline int netlbl_sock_getattr(struct sock *sk, |
459 | struct netlbl_lsm_secattr *secattr) | |
460 | { | |
461 | return -ENOSYS; | |
462 | } | |
11a03f78 | 463 | static inline int netlbl_skbuff_getattr(const struct sk_buff *skb, |
75e22910 | 464 | u16 family, |
11a03f78 PM |
465 | struct netlbl_lsm_secattr *secattr) |
466 | { | |
467 | return -ENOSYS; | |
468 | } | |
11a03f78 PM |
469 | static inline void netlbl_skbuff_err(struct sk_buff *skb, int error) |
470 | { | |
471 | return; | |
472 | } | |
11a03f78 PM |
473 | static inline void netlbl_cache_invalidate(void) |
474 | { | |
475 | return; | |
476 | } | |
11a03f78 PM |
477 | static inline int netlbl_cache_add(const struct sk_buff *skb, |
478 | const struct netlbl_lsm_secattr *secattr) | |
479 | { | |
480 | return 0; | |
481 | } | |
482 | #endif /* CONFIG_NETLABEL */ | |
483 | ||
484 | #endif /* _NETLABEL_H */ |