2 * NetLabel Domain Hash Table
4 * This file manages the domain hash table that NetLabel uses to determine
5 * which network labeling protocol to use for a given domain. The NetLabel
6 * system manages static and dynamic label mappings for network protocols such
9 * Author: Paul Moore <paul.moore@hp.com>
14 * (c) Copyright Hewlett-Packard Development Company, L.P., 2006, 2008
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
24 * the GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
32 #include <linux/types.h>
33 #include <linux/rculist.h>
34 #include <linux/skbuff.h>
35 #include <linux/spinlock.h>
36 #include <linux/string.h>
37 #include <linux/audit.h>
38 #include <net/netlabel.h>
39 #include <net/cipso_ipv4.h>
42 #include "netlabel_mgmt.h"
43 #include "netlabel_addrlist.h"
44 #include "netlabel_domainhash.h"
45 #include "netlabel_user.h"
47 struct netlbl_domhsh_tbl {
48 struct list_head *tbl;
52 /* Domain hash table */
53 /* XXX - updates should be so rare that having one spinlock for the entire
54 * hash table should be okay */
55 static DEFINE_SPINLOCK(netlbl_domhsh_lock);
56 static struct netlbl_domhsh_tbl *netlbl_domhsh = NULL;
57 static struct netlbl_dom_map *netlbl_domhsh_def = NULL;
60 * Domain Hash Table Helper Functions
64 * netlbl_domhsh_free_entry - Frees a domain hash table entry
65 * @entry: the entry's RCU field
68 * This function is designed to be used as a callback to the call_rcu()
69 * function so that the memory allocated to a hash table entry can be released
73 static void netlbl_domhsh_free_entry(struct rcu_head *entry)
75 struct netlbl_dom_map *ptr;
76 struct netlbl_af4list *iter4;
77 struct netlbl_af4list *tmp4;
78 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
79 struct netlbl_af6list *iter6;
80 struct netlbl_af6list *tmp6;
83 ptr = container_of(entry, struct netlbl_dom_map, rcu);
84 if (ptr->type == NETLBL_NLTYPE_ADDRSELECT) {
85 netlbl_af4list_foreach_safe(iter4, tmp4,
86 &ptr->type_def.addrsel->list4) {
87 netlbl_af4list_remove_entry(iter4);
88 kfree(netlbl_domhsh_addr4_entry(iter4));
90 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
91 netlbl_af6list_foreach_safe(iter6, tmp6,
92 &ptr->type_def.addrsel->list6) {
93 netlbl_af6list_remove_entry(iter6);
94 kfree(netlbl_domhsh_addr6_entry(iter6));
103 * netlbl_domhsh_hash - Hashing function for the domain hash table
104 * @domain: the domain name to hash
107 * This is the hashing function for the domain hash table, it returns the
108 * correct bucket number for the domain. The caller is responsibile for
109 * calling the rcu_read_[un]lock() functions.
112 static u32 netlbl_domhsh_hash(const char *key)
118 /* This is taken (with slight modification) from
119 * security/selinux/ss/symtab.c:symhash() */
121 for (iter = 0, val = 0, len = strlen(key); iter < len; iter++)
122 val = (val << 4 | (val >> (8 * sizeof(u32) - 4))) ^ key[iter];
123 return val & (rcu_dereference(netlbl_domhsh)->size - 1);
127 * netlbl_domhsh_search - Search for a domain entry
128 * @domain: the domain
131 * Searches the domain hash table and returns a pointer to the hash table
132 * entry if found, otherwise NULL is returned. The caller is responsibile for
133 * the rcu hash table locks (i.e. the caller much call rcu_read_[un]lock()).
136 static struct netlbl_dom_map *netlbl_domhsh_search(const char *domain)
139 struct list_head *bkt_list;
140 struct netlbl_dom_map *iter;
142 if (domain != NULL) {
143 bkt = netlbl_domhsh_hash(domain);
144 bkt_list = &rcu_dereference(netlbl_domhsh)->tbl[bkt];
145 list_for_each_entry_rcu(iter, bkt_list, list)
146 if (iter->valid && strcmp(iter->domain, domain) == 0)
154 * netlbl_domhsh_search_def - Search for a domain entry
155 * @domain: the domain
156 * @def: return default if no match is found
159 * Searches the domain hash table and returns a pointer to the hash table
160 * entry if an exact match is found, if an exact match is not present in the
161 * hash table then the default entry is returned if valid otherwise NULL is
162 * returned. The caller is responsibile for the rcu hash table locks
163 * (i.e. the caller much call rcu_read_[un]lock()).
166 static struct netlbl_dom_map *netlbl_domhsh_search_def(const char *domain)
168 struct netlbl_dom_map *entry;
170 entry = netlbl_domhsh_search(domain);
172 entry = rcu_dereference(netlbl_domhsh_def);
173 if (entry != NULL && !entry->valid)
181 * netlbl_domhsh_audit_add - Generate an audit entry for an add event
182 * @entry: the entry being added
183 * @addr4: the IPv4 address information
184 * @addr6: the IPv6 address information
185 * @result: the result code
186 * @audit_info: NetLabel audit information
189 * Generate an audit record for adding a new NetLabel/LSM mapping entry with
190 * the given information. Caller is responsibile for holding the necessary
194 static void netlbl_domhsh_audit_add(struct netlbl_dom_map *entry,
195 struct netlbl_af4list *addr4,
196 struct netlbl_af6list *addr6,
198 struct netlbl_audit *audit_info)
200 struct audit_buffer *audit_buf;
201 struct cipso_v4_doi *cipsov4 = NULL;
204 audit_buf = netlbl_audit_start_common(AUDIT_MAC_MAP_ADD, audit_info);
205 if (audit_buf != NULL) {
206 audit_log_format(audit_buf, " nlbl_domain=%s",
207 entry->domain ? entry->domain : "(default)");
209 struct netlbl_domaddr4_map *map4;
210 map4 = netlbl_domhsh_addr4_entry(addr4);
212 cipsov4 = map4->type_def.cipsov4;
213 netlbl_af4list_audit_addr(audit_buf, 0, NULL,
214 addr4->addr, addr4->mask);
215 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
216 } else if (addr6 != NULL) {
217 struct netlbl_domaddr6_map *map6;
218 map6 = netlbl_domhsh_addr6_entry(addr6);
220 netlbl_af6list_audit_addr(audit_buf, 0, NULL,
221 &addr6->addr, &addr6->mask);
225 cipsov4 = entry->type_def.cipsov4;
228 case NETLBL_NLTYPE_UNLABELED:
229 audit_log_format(audit_buf, " nlbl_protocol=unlbl");
231 case NETLBL_NLTYPE_CIPSOV4:
232 BUG_ON(cipsov4 == NULL);
233 audit_log_format(audit_buf,
234 " nlbl_protocol=cipsov4 cipso_doi=%u",
238 audit_log_format(audit_buf, " res=%u", result == 0 ? 1 : 0);
239 audit_log_end(audit_buf);
244 * Domain Hash Table Functions
248 * netlbl_domhsh_init - Init for the domain hash
249 * @size: the number of bits to use for the hash buckets
252 * Initializes the domain hash table, should be called only by
253 * netlbl_user_init() during initialization. Returns zero on success, non-zero
257 int __init netlbl_domhsh_init(u32 size)
260 struct netlbl_domhsh_tbl *hsh_tbl;
265 hsh_tbl = kmalloc(sizeof(*hsh_tbl), GFP_KERNEL);
268 hsh_tbl->size = 1 << size;
269 hsh_tbl->tbl = kcalloc(hsh_tbl->size,
270 sizeof(struct list_head),
272 if (hsh_tbl->tbl == NULL) {
276 for (iter = 0; iter < hsh_tbl->size; iter++)
277 INIT_LIST_HEAD(&hsh_tbl->tbl[iter]);
279 spin_lock(&netlbl_domhsh_lock);
280 rcu_assign_pointer(netlbl_domhsh, hsh_tbl);
281 spin_unlock(&netlbl_domhsh_lock);
287 * netlbl_domhsh_add - Adds a entry to the domain hash table
288 * @entry: the entry to add
289 * @audit_info: NetLabel audit information
292 * Adds a new entry to the domain hash table and handles any updates to the
293 * lower level protocol handler (i.e. CIPSO). Returns zero on success,
294 * negative on failure.
297 int netlbl_domhsh_add(struct netlbl_dom_map *entry,
298 struct netlbl_audit *audit_info)
301 struct netlbl_dom_map *entry_old;
302 struct netlbl_af4list *iter4;
303 struct netlbl_af4list *tmp4;
304 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
305 struct netlbl_af6list *iter6;
306 struct netlbl_af6list *tmp6;
311 spin_lock(&netlbl_domhsh_lock);
312 if (entry->domain != NULL)
313 entry_old = netlbl_domhsh_search(entry->domain);
315 entry_old = netlbl_domhsh_search_def(entry->domain);
316 if (entry_old == NULL) {
318 INIT_RCU_HEAD(&entry->rcu);
320 if (entry->domain != NULL) {
321 u32 bkt = netlbl_domhsh_hash(entry->domain);
322 list_add_tail_rcu(&entry->list,
323 &rcu_dereference(netlbl_domhsh)->tbl[bkt]);
325 INIT_LIST_HEAD(&entry->list);
326 rcu_assign_pointer(netlbl_domhsh_def, entry);
329 if (entry->type == NETLBL_NLTYPE_ADDRSELECT) {
330 netlbl_af4list_foreach_rcu(iter4,
331 &entry->type_def.addrsel->list4)
332 netlbl_domhsh_audit_add(entry, iter4, NULL,
333 ret_val, audit_info);
334 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
335 netlbl_af6list_foreach_rcu(iter6,
336 &entry->type_def.addrsel->list6)
337 netlbl_domhsh_audit_add(entry, NULL, iter6,
338 ret_val, audit_info);
341 netlbl_domhsh_audit_add(entry, NULL, NULL,
342 ret_val, audit_info);
343 } else if (entry_old->type == NETLBL_NLTYPE_ADDRSELECT &&
344 entry->type == NETLBL_NLTYPE_ADDRSELECT) {
345 struct list_head *old_list4;
346 struct list_head *old_list6;
348 old_list4 = &entry_old->type_def.addrsel->list4;
349 old_list6 = &entry_old->type_def.addrsel->list6;
351 /* we only allow the addition of address selectors if all of
352 * the selectors do not exist in the existing domain map */
353 netlbl_af4list_foreach_rcu(iter4,
354 &entry->type_def.addrsel->list4)
355 if (netlbl_af4list_search_exact(iter4->addr,
361 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
362 netlbl_af6list_foreach_rcu(iter6,
363 &entry->type_def.addrsel->list6)
364 if (netlbl_af6list_search_exact(&iter6->addr,
372 netlbl_af4list_foreach_safe(iter4, tmp4,
373 &entry->type_def.addrsel->list4) {
374 netlbl_af4list_remove_entry(iter4);
376 ret_val = netlbl_af4list_add(iter4, old_list4);
377 netlbl_domhsh_audit_add(entry_old, iter4, NULL,
378 ret_val, audit_info);
382 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
383 netlbl_af6list_foreach_safe(iter6, tmp6,
384 &entry->type_def.addrsel->list6) {
385 netlbl_af6list_remove_entry(iter6);
387 ret_val = netlbl_af6list_add(iter6, old_list6);
388 netlbl_domhsh_audit_add(entry_old, NULL, iter6,
389 ret_val, audit_info);
398 spin_unlock(&netlbl_domhsh_lock);
404 * netlbl_domhsh_add_default - Adds the default entry to the domain hash table
405 * @entry: the entry to add
406 * @audit_info: NetLabel audit information
409 * Adds a new default entry to the domain hash table and handles any updates
410 * to the lower level protocol handler (i.e. CIPSO). Returns zero on success,
411 * negative on failure.
414 int netlbl_domhsh_add_default(struct netlbl_dom_map *entry,
415 struct netlbl_audit *audit_info)
417 return netlbl_domhsh_add(entry, audit_info);
421 * netlbl_domhsh_remove_entry - Removes a given entry from the domain table
422 * @entry: the entry to remove
423 * @audit_info: NetLabel audit information
426 * Removes an entry from the domain hash table and handles any updates to the
427 * lower level protocol handler (i.e. CIPSO). Caller is responsible for
428 * ensuring that the RCU read lock is held. Returns zero on success, negative
432 int netlbl_domhsh_remove_entry(struct netlbl_dom_map *entry,
433 struct netlbl_audit *audit_info)
436 struct audit_buffer *audit_buf;
441 spin_lock(&netlbl_domhsh_lock);
444 if (entry != rcu_dereference(netlbl_domhsh_def))
445 list_del_rcu(&entry->list);
447 rcu_assign_pointer(netlbl_domhsh_def, NULL);
450 spin_unlock(&netlbl_domhsh_lock);
452 audit_buf = netlbl_audit_start_common(AUDIT_MAC_MAP_DEL, audit_info);
453 if (audit_buf != NULL) {
454 audit_log_format(audit_buf,
455 " nlbl_domain=%s res=%u",
456 entry->domain ? entry->domain : "(default)",
457 ret_val == 0 ? 1 : 0);
458 audit_log_end(audit_buf);
462 struct netlbl_af4list *iter4;
463 struct netlbl_domaddr4_map *map4;
465 switch (entry->type) {
466 case NETLBL_NLTYPE_ADDRSELECT:
467 netlbl_af4list_foreach_rcu(iter4,
468 &entry->type_def.addrsel->list4) {
469 map4 = netlbl_domhsh_addr4_entry(iter4);
470 cipso_v4_doi_putdef(map4->type_def.cipsov4);
472 /* no need to check the IPv6 list since we currently
473 * support only unlabeled protocols for IPv6 */
475 case NETLBL_NLTYPE_CIPSOV4:
476 cipso_v4_doi_putdef(entry->type_def.cipsov4);
479 call_rcu(&entry->rcu, netlbl_domhsh_free_entry);
486 * netlbl_domhsh_remove - Removes an entry from the domain hash table
487 * @domain: the domain to remove
488 * @audit_info: NetLabel audit information
491 * Removes an entry from the domain hash table and handles any updates to the
492 * lower level protocol handler (i.e. CIPSO). Returns zero on success,
493 * negative on failure.
496 int netlbl_domhsh_remove(const char *domain, struct netlbl_audit *audit_info)
499 struct netlbl_dom_map *entry;
503 entry = netlbl_domhsh_search(domain);
505 entry = netlbl_domhsh_search_def(domain);
506 ret_val = netlbl_domhsh_remove_entry(entry, audit_info);
513 * netlbl_domhsh_remove_default - Removes the default entry from the table
514 * @audit_info: NetLabel audit information
517 * Removes/resets the default entry for the domain hash table and handles any
518 * updates to the lower level protocol handler (i.e. CIPSO). Returns zero on
519 * success, non-zero on failure.
522 int netlbl_domhsh_remove_default(struct netlbl_audit *audit_info)
524 return netlbl_domhsh_remove(NULL, audit_info);
528 * netlbl_domhsh_getentry - Get an entry from the domain hash table
529 * @domain: the domain name to search for
532 * Look through the domain hash table searching for an entry to match @domain,
533 * return a pointer to a copy of the entry or NULL. The caller is responsibile
534 * for ensuring that rcu_read_[un]lock() is called.
537 struct netlbl_dom_map *netlbl_domhsh_getentry(const char *domain)
539 return netlbl_domhsh_search_def(domain);
543 * netlbl_domhsh_getentry_af4 - Get an entry from the domain hash table
544 * @domain: the domain name to search for
545 * @addr: the IP address to search for
548 * Look through the domain hash table searching for an entry to match @domain
549 * and @addr, return a pointer to a copy of the entry or NULL. The caller is
550 * responsible for ensuring that rcu_read_[un]lock() is called.
553 struct netlbl_domaddr4_map *netlbl_domhsh_getentry_af4(const char *domain,
556 struct netlbl_dom_map *dom_iter;
557 struct netlbl_af4list *addr_iter;
559 dom_iter = netlbl_domhsh_search_def(domain);
560 if (dom_iter == NULL)
562 if (dom_iter->type != NETLBL_NLTYPE_ADDRSELECT)
565 addr_iter = netlbl_af4list_search(addr,
566 &dom_iter->type_def.addrsel->list4);
567 if (addr_iter == NULL)
570 return netlbl_domhsh_addr4_entry(addr_iter);
573 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
575 * netlbl_domhsh_getentry_af6 - Get an entry from the domain hash table
576 * @domain: the domain name to search for
577 * @addr: the IP address to search for
580 * Look through the domain hash table searching for an entry to match @domain
581 * and @addr, return a pointer to a copy of the entry or NULL. The caller is
582 * responsible for ensuring that rcu_read_[un]lock() is called.
585 struct netlbl_domaddr6_map *netlbl_domhsh_getentry_af6(const char *domain,
586 const struct in6_addr *addr)
588 struct netlbl_dom_map *dom_iter;
589 struct netlbl_af6list *addr_iter;
591 dom_iter = netlbl_domhsh_search_def(domain);
592 if (dom_iter == NULL)
594 if (dom_iter->type != NETLBL_NLTYPE_ADDRSELECT)
597 addr_iter = netlbl_af6list_search(addr,
598 &dom_iter->type_def.addrsel->list6);
599 if (addr_iter == NULL)
602 return netlbl_domhsh_addr6_entry(addr_iter);
607 * netlbl_domhsh_walk - Iterate through the domain mapping hash table
608 * @skip_bkt: the number of buckets to skip at the start
609 * @skip_chain: the number of entries to skip in the first iterated bucket
610 * @callback: callback for each entry
611 * @cb_arg: argument for the callback function
614 * Interate over the domain mapping hash table, skipping the first @skip_bkt
615 * buckets and @skip_chain entries. For each entry in the table call
616 * @callback, if @callback returns a negative value stop 'walking' through the
617 * table and return. Updates the values in @skip_bkt and @skip_chain on
618 * return. Returns zero on succcess, negative values on failure.
621 int netlbl_domhsh_walk(u32 *skip_bkt,
623 int (*callback) (struct netlbl_dom_map *entry, void *arg),
626 int ret_val = -ENOENT;
628 struct list_head *iter_list;
629 struct netlbl_dom_map *iter_entry;
633 for (iter_bkt = *skip_bkt;
634 iter_bkt < rcu_dereference(netlbl_domhsh)->size;
635 iter_bkt++, chain_cnt = 0) {
636 iter_list = &rcu_dereference(netlbl_domhsh)->tbl[iter_bkt];
637 list_for_each_entry_rcu(iter_entry, iter_list, list)
638 if (iter_entry->valid) {
639 if (chain_cnt++ < *skip_chain)
641 ret_val = callback(iter_entry, cb_arg);
651 *skip_bkt = iter_bkt;
652 *skip_chain = chain_cnt;