cc8047d1f5055ff09af7c8abd324543a30c29b9f
[linux-2.6.git] / net / netlabel / netlabel_kapi.c
1 /*
2  * NetLabel Kernel API
3  *
4  * This file defines the kernel API for the NetLabel system.  The NetLabel
5  * system manages static and dynamic label mappings for network protocols such
6  * as CIPSO and RIPSO.
7  *
8  * Author: Paul Moore <paul.moore@hp.com>
9  *
10  */
11
12 /*
13  * (c) Copyright Hewlett-Packard Development Company, L.P., 2006
14  *
15  * This program is free software;  you can redistribute it and/or modify
16  * it under the terms of the GNU General Public License as published by
17  * the Free Software Foundation; either version 2 of the License, or
18  * (at your option) any later version.
19  *
20  * This program is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY;  without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
23  * the GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License
26  * along with this program;  if not, write to the Free Software
27  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28  *
29  */
30
31 #include <linux/init.h>
32 #include <linux/types.h>
33 #include <linux/audit.h>
34 #include <net/ip.h>
35 #include <net/netlabel.h>
36 #include <net/cipso_ipv4.h>
37 #include <asm/bug.h>
38 #include <asm/atomic.h>
39
40 #include "netlabel_domainhash.h"
41 #include "netlabel_unlabeled.h"
42 #include "netlabel_cipso_v4.h"
43 #include "netlabel_user.h"
44 #include "netlabel_mgmt.h"
45
46 /*
47  * Configuration Functions
48  */
49
50 /**
51  * netlbl_cfg_map_del - Remove a NetLabel/LSM domain mapping
52  * @domain: the domain mapping to remove
53  * @audit_info: NetLabel audit information
54  *
55  * Description:
56  * Removes a NetLabel/LSM domain mapping.  A @domain value of NULL causes the
57  * default domain mapping to be removed.  Returns zero on success, negative
58  * values on failure.
59  *
60  */
61 int netlbl_cfg_map_del(const char *domain, struct netlbl_audit *audit_info)
62 {
63         return netlbl_domhsh_remove(domain, audit_info);
64 }
65
66 /**
67  * netlbl_cfg_unlbl_add_map - Add an unlabeled NetLabel/LSM domain mapping
68  * @domain: the domain mapping to add
69  * @audit_info: NetLabel audit information
70  *
71  * Description:
72  * Adds a new unlabeled NetLabel/LSM domain mapping.  A @domain value of NULL
73  * causes a new default domain mapping to be added.  Returns zero on success,
74  * negative values on failure.
75  *
76  */
77 int netlbl_cfg_unlbl_add_map(const char *domain,
78                              struct netlbl_audit *audit_info)
79 {
80         int ret_val = -ENOMEM;
81         struct netlbl_dom_map *entry;
82
83         entry = kzalloc(sizeof(*entry), GFP_ATOMIC);
84         if (entry == NULL)
85                 return -ENOMEM;
86         if (domain != NULL) {
87                 entry->domain = kstrdup(domain, GFP_ATOMIC);
88                 if (entry->domain == NULL)
89                         goto cfg_unlbl_add_map_failure;
90         }
91         entry->type = NETLBL_NLTYPE_UNLABELED;
92
93         ret_val = netlbl_domhsh_add(entry, audit_info);
94         if (ret_val != 0)
95                 goto cfg_unlbl_add_map_failure;
96
97         return 0;
98
99 cfg_unlbl_add_map_failure:
100         if (entry != NULL)
101                 kfree(entry->domain);
102         kfree(entry);
103         return ret_val;
104 }
105
106 /**
107  * netlbl_cfg_cipsov4_add_map - Add a new CIPSOv4 DOI definition and mapping
108  * @doi_def: the DOI definition
109  * @domain: the domain mapping to add
110  * @audit_info: NetLabel audit information
111  *
112  * Description:
113  * Add a new CIPSOv4 DOI definition and NetLabel/LSM domain mapping for this
114  * new DOI definition to the NetLabel subsystem.  A @domain value of NULL adds
115  * a new default domain mapping.  Returns zero on success, negative values on
116  * failure.
117  *
118  */
119 int netlbl_cfg_cipsov4_add_map(struct cipso_v4_doi *doi_def,
120                                const char *domain,
121                                struct netlbl_audit *audit_info)
122 {
123         int ret_val = -ENOMEM;
124         u32 doi;
125         u32 doi_type;
126         struct netlbl_dom_map *entry;
127         const char *type_str;
128         struct audit_buffer *audit_buf;
129
130         doi = doi_def->doi;
131         doi_type = doi_def->type;
132
133         entry = kzalloc(sizeof(*entry), GFP_ATOMIC);
134         if (entry == NULL)
135                 return -ENOMEM;
136         if (domain != NULL) {
137                 entry->domain = kstrdup(domain, GFP_ATOMIC);
138                 if (entry->domain == NULL)
139                         goto cfg_cipsov4_add_map_failure;
140         }
141
142         ret_val = cipso_v4_doi_add(doi_def);
143         if (ret_val != 0)
144                 goto cfg_cipsov4_add_map_failure_remove_doi;
145         entry->type = NETLBL_NLTYPE_CIPSOV4;
146         entry->type_def.cipsov4 = cipso_v4_doi_getdef(doi);
147         if (entry->type_def.cipsov4 == NULL) {
148                 ret_val = -ENOENT;
149                 goto cfg_cipsov4_add_map_failure_remove_doi;
150         }
151         ret_val = netlbl_domhsh_add(entry, audit_info);
152         if (ret_val != 0)
153                 goto cfg_cipsov4_add_map_failure_release_doi;
154
155 cfg_cipsov4_add_map_return:
156         audit_buf = netlbl_audit_start_common(AUDIT_MAC_CIPSOV4_ADD,
157                                               audit_info);
158         if (audit_buf != NULL) {
159                 switch (doi_type) {
160                 case CIPSO_V4_MAP_STD:
161                         type_str = "std";
162                         break;
163                 case CIPSO_V4_MAP_PASS:
164                         type_str = "pass";
165                         break;
166                 default:
167                         type_str = "(unknown)";
168                 }
169                 audit_log_format(audit_buf,
170                                  " cipso_doi=%u cipso_type=%s res=%u",
171                                  doi, type_str, ret_val == 0 ? 1 : 0);
172                 audit_log_end(audit_buf);
173         }
174
175         return ret_val;
176
177 cfg_cipsov4_add_map_failure_release_doi:
178         cipso_v4_doi_putdef(doi_def);
179 cfg_cipsov4_add_map_failure_remove_doi:
180         cipso_v4_doi_remove(doi, audit_info);
181 cfg_cipsov4_add_map_failure:
182         if (entry != NULL)
183                 kfree(entry->domain);
184         kfree(entry);
185         goto cfg_cipsov4_add_map_return;
186 }
187
188 /*
189  * Security Attribute Functions
190  */
191
192 /**
193  * netlbl_secattr_catmap_walk - Walk a LSM secattr catmap looking for a bit
194  * @catmap: the category bitmap
195  * @offset: the offset to start searching at, in bits
196  *
197  * Description:
198  * This function walks a LSM secattr category bitmap starting at @offset and
199  * returns the spot of the first set bit or -ENOENT if no bits are set.
200  *
201  */
202 int netlbl_secattr_catmap_walk(struct netlbl_lsm_secattr_catmap *catmap,
203                                u32 offset)
204 {
205         struct netlbl_lsm_secattr_catmap *iter = catmap;
206         u32 node_idx;
207         u32 node_bit;
208         NETLBL_CATMAP_MAPTYPE bitmap;
209
210         if (offset > iter->startbit) {
211                 while (offset >= (iter->startbit + NETLBL_CATMAP_SIZE)) {
212                         iter = iter->next;
213                         if (iter == NULL)
214                                 return -ENOENT;
215                 }
216                 node_idx = (offset - iter->startbit) / NETLBL_CATMAP_MAPSIZE;
217                 node_bit = offset - iter->startbit -
218                            (NETLBL_CATMAP_MAPSIZE * node_idx);
219         } else {
220                 node_idx = 0;
221                 node_bit = 0;
222         }
223         bitmap = iter->bitmap[node_idx] >> node_bit;
224
225         for (;;) {
226                 if (bitmap != 0) {
227                         while ((bitmap & NETLBL_CATMAP_BIT) == 0) {
228                                 bitmap >>= 1;
229                                 node_bit++;
230                         }
231                         return iter->startbit +
232                                 (NETLBL_CATMAP_MAPSIZE * node_idx) + node_bit;
233                 }
234                 if (++node_idx >= NETLBL_CATMAP_MAPCNT) {
235                         if (iter->next != NULL) {
236                                 iter = iter->next;
237                                 node_idx = 0;
238                         } else
239                                 return -ENOENT;
240                 }
241                 bitmap = iter->bitmap[node_idx];
242                 node_bit = 0;
243         }
244
245         return -ENOENT;
246 }
247
248 /**
249  * netlbl_secattr_catmap_walk_rng - Find the end of a string of set bits
250  * @catmap: the category bitmap
251  * @offset: the offset to start searching at, in bits
252  *
253  * Description:
254  * This function walks a LSM secattr category bitmap starting at @offset and
255  * returns the spot of the first cleared bit or -ENOENT if the offset is past
256  * the end of the bitmap.
257  *
258  */
259 int netlbl_secattr_catmap_walk_rng(struct netlbl_lsm_secattr_catmap *catmap,
260                                    u32 offset)
261 {
262         struct netlbl_lsm_secattr_catmap *iter = catmap;
263         u32 node_idx;
264         u32 node_bit;
265         NETLBL_CATMAP_MAPTYPE bitmask;
266         NETLBL_CATMAP_MAPTYPE bitmap;
267
268         if (offset > iter->startbit) {
269                 while (offset >= (iter->startbit + NETLBL_CATMAP_SIZE)) {
270                         iter = iter->next;
271                         if (iter == NULL)
272                                 return -ENOENT;
273                 }
274                 node_idx = (offset - iter->startbit) / NETLBL_CATMAP_MAPSIZE;
275                 node_bit = offset - iter->startbit -
276                            (NETLBL_CATMAP_MAPSIZE * node_idx);
277         } else {
278                 node_idx = 0;
279                 node_bit = 0;
280         }
281         bitmask = NETLBL_CATMAP_BIT << node_bit;
282
283         for (;;) {
284                 bitmap = iter->bitmap[node_idx];
285                 while (bitmask != 0 && (bitmap & bitmask) != 0) {
286                         bitmask <<= 1;
287                         node_bit++;
288                 }
289
290                 if (bitmask != 0)
291                         return iter->startbit +
292                                 (NETLBL_CATMAP_MAPSIZE * node_idx) +
293                                 node_bit - 1;
294                 else if (++node_idx >= NETLBL_CATMAP_MAPCNT) {
295                         if (iter->next == NULL)
296                                 return iter->startbit + NETLBL_CATMAP_SIZE - 1;
297                         iter = iter->next;
298                         node_idx = 0;
299                 }
300                 bitmask = NETLBL_CATMAP_BIT;
301                 node_bit = 0;
302         }
303
304         return -ENOENT;
305 }
306
307 /**
308  * netlbl_secattr_catmap_setbit - Set a bit in a LSM secattr catmap
309  * @catmap: the category bitmap
310  * @bit: the bit to set
311  * @flags: memory allocation flags
312  *
313  * Description:
314  * Set the bit specified by @bit in @catmap.  Returns zero on success,
315  * negative values on failure.
316  *
317  */
318 int netlbl_secattr_catmap_setbit(struct netlbl_lsm_secattr_catmap *catmap,
319                                  u32 bit,
320                                  gfp_t flags)
321 {
322         struct netlbl_lsm_secattr_catmap *iter = catmap;
323         u32 node_bit;
324         u32 node_idx;
325
326         while (iter->next != NULL &&
327                bit >= (iter->startbit + NETLBL_CATMAP_SIZE))
328                 iter = iter->next;
329         if (bit >= (iter->startbit + NETLBL_CATMAP_SIZE)) {
330                 iter->next = netlbl_secattr_catmap_alloc(flags);
331                 if (iter->next == NULL)
332                         return -ENOMEM;
333                 iter = iter->next;
334                 iter->startbit = bit & ~(NETLBL_CATMAP_SIZE - 1);
335         }
336
337         /* gcc always rounds to zero when doing integer division */
338         node_idx = (bit - iter->startbit) / NETLBL_CATMAP_MAPSIZE;
339         node_bit = bit - iter->startbit - (NETLBL_CATMAP_MAPSIZE * node_idx);
340         iter->bitmap[node_idx] |= NETLBL_CATMAP_BIT << node_bit;
341
342         return 0;
343 }
344
345 /**
346  * netlbl_secattr_catmap_setrng - Set a range of bits in a LSM secattr catmap
347  * @catmap: the category bitmap
348  * @start: the starting bit
349  * @end: the last bit in the string
350  * @flags: memory allocation flags
351  *
352  * Description:
353  * Set a range of bits, starting at @start and ending with @end.  Returns zero
354  * on success, negative values on failure.
355  *
356  */
357 int netlbl_secattr_catmap_setrng(struct netlbl_lsm_secattr_catmap *catmap,
358                                  u32 start,
359                                  u32 end,
360                                  gfp_t flags)
361 {
362         int ret_val = 0;
363         struct netlbl_lsm_secattr_catmap *iter = catmap;
364         u32 iter_max_spot;
365         u32 spot;
366
367         /* XXX - This could probably be made a bit faster by combining writes
368          * to the catmap instead of setting a single bit each time, but for
369          * right now skipping to the start of the range in the catmap should
370          * be a nice improvement over calling the individual setbit function
371          * repeatedly from a loop. */
372
373         while (iter->next != NULL &&
374                start >= (iter->startbit + NETLBL_CATMAP_SIZE))
375                 iter = iter->next;
376         iter_max_spot = iter->startbit + NETLBL_CATMAP_SIZE;
377
378         for (spot = start; spot <= end && ret_val == 0; spot++) {
379                 if (spot >= iter_max_spot && iter->next != NULL) {
380                         iter = iter->next;
381                         iter_max_spot = iter->startbit + NETLBL_CATMAP_SIZE;
382                 }
383                 ret_val = netlbl_secattr_catmap_setbit(iter, spot, GFP_ATOMIC);
384         }
385
386         return ret_val;
387 }
388
389 /*
390  * LSM Functions
391  */
392
393 /**
394  * netlbl_enabled - Determine if the NetLabel subsystem is enabled
395  *
396  * Description:
397  * The LSM can use this function to determine if it should use NetLabel
398  * security attributes in it's enforcement mechanism.  Currently, NetLabel is
399  * considered to be enabled when it's configuration contains a valid setup for
400  * at least one labeled protocol (i.e. NetLabel can understand incoming
401  * labeled packets of at least one type); otherwise NetLabel is considered to
402  * be disabled.
403  *
404  */
405 int netlbl_enabled(void)
406 {
407         /* At some point we probably want to expose this mechanism to the user
408          * as well so that admins can toggle NetLabel regardless of the
409          * configuration */
410         return (atomic_read(&netlabel_mgmt_protocount) > 0);
411 }
412
413 /**
414  * netlbl_socket_setattr - Label a socket using the correct protocol
415  * @sk: the socket to label
416  * @secattr: the security attributes
417  *
418  * Description:
419  * Attach the correct label to the given socket using the security attributes
420  * specified in @secattr.  This function requires exclusive access to @sk,
421  * which means it either needs to be in the process of being created or locked.
422  * Returns zero on success, -EDESTADDRREQ if the domain is configured to use
423  * network address selectors (can't blindly label the socket), and negative
424  * values on all other failures.
425  *
426  */
427 int netlbl_sock_setattr(struct sock *sk,
428                         const struct netlbl_lsm_secattr *secattr)
429 {
430         int ret_val = -ENOENT;
431         struct netlbl_dom_map *dom_entry;
432
433         rcu_read_lock();
434         dom_entry = netlbl_domhsh_getentry(secattr->domain);
435         if (dom_entry == NULL)
436                 goto socket_setattr_return;
437         switch (dom_entry->type) {
438         case NETLBL_NLTYPE_ADDRSELECT:
439                 ret_val = -EDESTADDRREQ;
440                 break;
441         case NETLBL_NLTYPE_CIPSOV4:
442                 ret_val = cipso_v4_sock_setattr(sk,
443                                                 dom_entry->type_def.cipsov4,
444                                                 secattr);
445                 break;
446         case NETLBL_NLTYPE_UNLABELED:
447                 ret_val = 0;
448                 break;
449         default:
450                 ret_val = -ENOENT;
451         }
452
453 socket_setattr_return:
454         rcu_read_unlock();
455         return ret_val;
456 }
457
458 /**
459  * netlbl_sock_getattr - Determine the security attributes of a sock
460  * @sk: the sock
461  * @secattr: the security attributes
462  *
463  * Description:
464  * Examines the given sock to see if any NetLabel style labeling has been
465  * applied to the sock, if so it parses the socket label and returns the
466  * security attributes in @secattr.  Returns zero on success, negative values
467  * on failure.
468  *
469  */
470 int netlbl_sock_getattr(struct sock *sk, struct netlbl_lsm_secattr *secattr)
471 {
472         return cipso_v4_sock_getattr(sk, secattr);
473 }
474
475 /**
476  * netlbl_skbuff_setattr - Label a packet using the correct protocol
477  * @skb: the packet
478  * @family: protocol family
479  * @secattr: the security attributes
480  *
481  * Description:
482  * Attach the correct label to the given packet using the security attributes
483  * specified in @secattr.  Returns zero on success, negative values on failure.
484  *
485  */
486 int netlbl_skbuff_setattr(struct sk_buff *skb,
487                           u16 family,
488                           const struct netlbl_lsm_secattr *secattr)
489 {
490         int ret_val;
491         struct iphdr *hdr4;
492         struct netlbl_domaddr4_map *af4_entry;
493
494         rcu_read_lock();
495         switch (family) {
496         case AF_INET:
497                 hdr4 = ip_hdr(skb);
498                 af4_entry = netlbl_domhsh_getentry_af4(secattr->domain,
499                                                        hdr4->daddr);
500                 if (af4_entry == NULL) {
501                         ret_val = -ENOENT;
502                         goto skbuff_setattr_return;
503                 }
504                 switch (af4_entry->type) {
505                 case NETLBL_NLTYPE_CIPSOV4:
506                         ret_val = cipso_v4_skbuff_setattr(skb,
507                                                    af4_entry->type_def.cipsov4,
508                                                    secattr);
509                         break;
510                 case NETLBL_NLTYPE_UNLABELED:
511                         /* just delete the protocols we support for right now
512                          * but we could remove other protocols if needed */
513                         ret_val = cipso_v4_skbuff_delattr(skb);
514                         break;
515                 default:
516                         ret_val = -ENOENT;
517                 }
518                 break;
519 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
520         case AF_INET6:
521                 /* since we don't support any IPv6 labeling protocols right
522                  * now we can optimize everything away until we do */
523                 ret_val = 0;
524                 break;
525 #endif /* IPv6 */
526         default:
527                 ret_val = 0;
528         }
529
530 skbuff_setattr_return:
531         rcu_read_unlock();
532         return ret_val;
533 }
534
535 /**
536  * netlbl_skbuff_getattr - Determine the security attributes of a packet
537  * @skb: the packet
538  * @family: protocol family
539  * @secattr: the security attributes
540  *
541  * Description:
542  * Examines the given packet to see if a recognized form of packet labeling
543  * is present, if so it parses the packet label and returns the security
544  * attributes in @secattr.  Returns zero on success, negative values on
545  * failure.
546  *
547  */
548 int netlbl_skbuff_getattr(const struct sk_buff *skb,
549                           u16 family,
550                           struct netlbl_lsm_secattr *secattr)
551 {
552         if (CIPSO_V4_OPTEXIST(skb) &&
553             cipso_v4_skbuff_getattr(skb, secattr) == 0)
554                 return 0;
555
556         return netlbl_unlabel_getattr(skb, family, secattr);
557 }
558
559 /**
560  * netlbl_skbuff_err - Handle a LSM error on a sk_buff
561  * @skb: the packet
562  * @error: the error code
563  * @gateway: true if host is acting as a gateway, false otherwise
564  *
565  * Description:
566  * Deal with a LSM problem when handling the packet in @skb, typically this is
567  * a permission denied problem (-EACCES).  The correct action is determined
568  * according to the packet's labeling protocol.
569  *
570  */
571 void netlbl_skbuff_err(struct sk_buff *skb, int error, int gateway)
572 {
573         if (CIPSO_V4_OPTEXIST(skb))
574                 cipso_v4_error(skb, error, gateway);
575 }
576
577 /**
578  * netlbl_cache_invalidate - Invalidate all of the NetLabel protocol caches
579  *
580  * Description:
581  * For all of the NetLabel protocols that support some form of label mapping
582  * cache, invalidate the cache.  Returns zero on success, negative values on
583  * error.
584  *
585  */
586 void netlbl_cache_invalidate(void)
587 {
588         cipso_v4_cache_invalidate();
589 }
590
591 /**
592  * netlbl_cache_add - Add an entry to a NetLabel protocol cache
593  * @skb: the packet
594  * @secattr: the packet's security attributes
595  *
596  * Description:
597  * Add the LSM security attributes for the given packet to the underlying
598  * NetLabel protocol's label mapping cache.  Returns zero on success, negative
599  * values on error.
600  *
601  */
602 int netlbl_cache_add(const struct sk_buff *skb,
603                      const struct netlbl_lsm_secattr *secattr)
604 {
605         if ((secattr->flags & NETLBL_SECATTR_CACHE) == 0)
606                 return -ENOMSG;
607
608         if (CIPSO_V4_OPTEXIST(skb))
609                 return cipso_v4_cache_add(skb, secattr);
610
611         return -ENOMSG;
612 }
613
614 /*
615  * Setup Functions
616  */
617
618 /**
619  * netlbl_init - Initialize NetLabel
620  *
621  * Description:
622  * Perform the required NetLabel initialization before first use.
623  *
624  */
625 static int __init netlbl_init(void)
626 {
627         int ret_val;
628
629         printk(KERN_INFO "NetLabel: Initializing\n");
630         printk(KERN_INFO "NetLabel:  domain hash size = %u\n",
631                (1 << NETLBL_DOMHSH_BITSIZE));
632         printk(KERN_INFO "NetLabel:  protocols ="
633                " UNLABELED"
634                " CIPSOv4"
635                "\n");
636
637         ret_val = netlbl_domhsh_init(NETLBL_DOMHSH_BITSIZE);
638         if (ret_val != 0)
639                 goto init_failure;
640
641         ret_val = netlbl_unlabel_init(NETLBL_UNLHSH_BITSIZE);
642         if (ret_val != 0)
643                 goto init_failure;
644
645         ret_val = netlbl_netlink_init();
646         if (ret_val != 0)
647                 goto init_failure;
648
649         ret_val = netlbl_unlabel_defconf();
650         if (ret_val != 0)
651                 goto init_failure;
652         printk(KERN_INFO "NetLabel:  unlabeled traffic allowed by default\n");
653
654         return 0;
655
656 init_failure:
657         panic("NetLabel: failed to initialize properly (%d)\n", ret_val);
658 }
659
660 subsys_initcall(netlbl_init);