1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * CIPSO - Commercial IP Security Option
5 * This is an implementation of the CIPSO 2.2 protocol as specified in
6 * draft-ietf-cipso-ipsecurity-01.txt with additional tag types as found in
7 * FIPS-188. While CIPSO never became a full IETF RFC standard many vendors
8 * have chosen to adopt the protocol and over the years it has become a
9 * de-facto standard for labeled networking.
11 * The CIPSO draft specification can be found in the kernel's Documentation
12 * directory as well as the following URL:
13 * https://tools.ietf.org/id/draft-ietf-cipso-ipsecurity-01.txt
14 * The FIPS-188 specification can be found at the following URL:
15 * https://www.itl.nist.gov/fipspubs/fip188.htm
17 * Author: Paul Moore <paul.moore@hp.com>
21 * (c) Copyright Hewlett-Packard Development Company, L.P., 2006, 2008
24 #include <linux/init.h>
25 #include <linux/types.h>
26 #include <linux/rcupdate.h>
27 #include <linux/list.h>
28 #include <linux/spinlock.h>
29 #include <linux/string.h>
30 #include <linux/jhash.h>
31 #include <linux/audit.h>
32 #include <linux/slab.h>
36 #include <net/netlabel.h>
37 #include <net/cipso_ipv4.h>
38 #include <linux/atomic.h>
39 #include <linux/bug.h>
40 #include <asm/unaligned.h>
42 /* List of available DOI definitions */
43 /* XXX - This currently assumes a minimal number of different DOIs in use,
44 * if in practice there are a lot of different DOIs this list should
45 * probably be turned into a hash table or something similar so we
46 * can do quick lookups. */
47 static DEFINE_SPINLOCK(cipso_v4_doi_list_lock);
48 static LIST_HEAD(cipso_v4_doi_list);
50 /* Label mapping cache */
51 int cipso_v4_cache_enabled = 1;
52 int cipso_v4_cache_bucketsize = 10;
53 #define CIPSO_V4_CACHE_BUCKETBITS 7
54 #define CIPSO_V4_CACHE_BUCKETS (1 << CIPSO_V4_CACHE_BUCKETBITS)
55 #define CIPSO_V4_CACHE_REORDERLIMIT 10
56 struct cipso_v4_map_cache_bkt {
59 struct list_head list;
62 struct cipso_v4_map_cache_entry {
67 struct netlbl_lsm_cache *lsm_data;
70 struct list_head list;
73 static struct cipso_v4_map_cache_bkt *cipso_v4_cache;
75 /* Restricted bitmap (tag #1) flags */
76 int cipso_v4_rbm_optfmt;
77 int cipso_v4_rbm_strictvalid = 1;
83 /* Maximum size of the CIPSO IP option, derived from the fact that the maximum
84 * IPv4 header size is 60 bytes and the base IPv4 header is 20 bytes long. */
85 #define CIPSO_V4_OPT_LEN_MAX 40
87 /* Length of the base CIPSO option, this includes the option type (1 byte), the
88 * option length (1 byte), and the DOI (4 bytes). */
89 #define CIPSO_V4_HDR_LEN 6
91 /* Base length of the restrictive category bitmap tag (tag #1). */
92 #define CIPSO_V4_TAG_RBM_BLEN 4
94 /* Base length of the enumerated category tag (tag #2). */
95 #define CIPSO_V4_TAG_ENUM_BLEN 4
97 /* Base length of the ranged categories bitmap tag (tag #5). */
98 #define CIPSO_V4_TAG_RNG_BLEN 4
99 /* The maximum number of category ranges permitted in the ranged category tag
100 * (tag #5). You may note that the IETF draft states that the maximum number
101 * of category ranges is 7, but if the low end of the last category range is
102 * zero then it is possible to fit 8 category ranges because the zero should
104 #define CIPSO_V4_TAG_RNG_CAT_MAX 8
106 /* Base length of the local tag (non-standard tag).
107 * Tag definition (may change between kernel versions)
110 * +----------+----------+----------+----------+
111 * | 10000000 | 00000110 | 32-bit secid value |
112 * +----------+----------+----------+----------+
113 * | in (host byte order)|
114 * +----------+----------+
117 #define CIPSO_V4_TAG_LOC_BLEN 6
124 * cipso_v4_cache_entry_free - Frees a cache entry
125 * @entry: the entry to free
128 * This function frees the memory associated with a cache entry including the
129 * LSM cache data if there are no longer any users, i.e. reference count == 0.
132 static void cipso_v4_cache_entry_free(struct cipso_v4_map_cache_entry *entry)
135 netlbl_secattr_cache_free(entry->lsm_data);
141 * cipso_v4_map_cache_hash - Hashing function for the CIPSO cache
143 * @key_len: the length of the key in bytes
146 * The CIPSO tag hashing function. Returns a 32-bit hash value.
149 static u32 cipso_v4_map_cache_hash(const unsigned char *key, u32 key_len)
151 return jhash(key, key_len, 0);
155 * Label Mapping Cache Functions
159 * cipso_v4_cache_init - Initialize the CIPSO cache
162 * Initializes the CIPSO label mapping cache, this function should be called
163 * before any of the other functions defined in this file. Returns zero on
164 * success, negative values on error.
167 static int __init cipso_v4_cache_init(void)
171 cipso_v4_cache = kcalloc(CIPSO_V4_CACHE_BUCKETS,
172 sizeof(struct cipso_v4_map_cache_bkt),
177 for (iter = 0; iter < CIPSO_V4_CACHE_BUCKETS; iter++) {
178 spin_lock_init(&cipso_v4_cache[iter].lock);
179 cipso_v4_cache[iter].size = 0;
180 INIT_LIST_HEAD(&cipso_v4_cache[iter].list);
187 * cipso_v4_cache_invalidate - Invalidates the current CIPSO cache
190 * Invalidates and frees any entries in the CIPSO cache.
193 void cipso_v4_cache_invalidate(void)
195 struct cipso_v4_map_cache_entry *entry, *tmp_entry;
198 for (iter = 0; iter < CIPSO_V4_CACHE_BUCKETS; iter++) {
199 spin_lock_bh(&cipso_v4_cache[iter].lock);
200 list_for_each_entry_safe(entry,
202 &cipso_v4_cache[iter].list, list) {
203 list_del(&entry->list);
204 cipso_v4_cache_entry_free(entry);
206 cipso_v4_cache[iter].size = 0;
207 spin_unlock_bh(&cipso_v4_cache[iter].lock);
212 * cipso_v4_cache_check - Check the CIPSO cache for a label mapping
213 * @key: the buffer to check
214 * @key_len: buffer length in bytes
215 * @secattr: the security attribute struct to use
218 * This function checks the cache to see if a label mapping already exists for
219 * the given key. If there is a match then the cache is adjusted and the
220 * @secattr struct is populated with the correct LSM security attributes. The
221 * cache is adjusted in the following manner if the entry is not already the
222 * first in the cache bucket:
224 * 1. The cache entry's activity counter is incremented
225 * 2. The previous (higher ranking) entry's activity counter is decremented
226 * 3. If the difference between the two activity counters is geater than
227 * CIPSO_V4_CACHE_REORDERLIMIT the two entries are swapped
229 * Returns zero on success, -ENOENT for a cache miss, and other negative values
233 static int cipso_v4_cache_check(const unsigned char *key,
235 struct netlbl_lsm_secattr *secattr)
238 struct cipso_v4_map_cache_entry *entry;
239 struct cipso_v4_map_cache_entry *prev_entry = NULL;
242 if (!READ_ONCE(cipso_v4_cache_enabled))
245 hash = cipso_v4_map_cache_hash(key, key_len);
246 bkt = hash & (CIPSO_V4_CACHE_BUCKETS - 1);
247 spin_lock_bh(&cipso_v4_cache[bkt].lock);
248 list_for_each_entry(entry, &cipso_v4_cache[bkt].list, list) {
249 if (entry->hash == hash &&
250 entry->key_len == key_len &&
251 memcmp(entry->key, key, key_len) == 0) {
252 entry->activity += 1;
253 refcount_inc(&entry->lsm_data->refcount);
254 secattr->cache = entry->lsm_data;
255 secattr->flags |= NETLBL_SECATTR_CACHE;
256 secattr->type = NETLBL_NLTYPE_CIPSOV4;
258 spin_unlock_bh(&cipso_v4_cache[bkt].lock);
262 if (prev_entry->activity > 0)
263 prev_entry->activity -= 1;
264 if (entry->activity > prev_entry->activity &&
265 entry->activity - prev_entry->activity >
266 CIPSO_V4_CACHE_REORDERLIMIT) {
267 __list_del(entry->list.prev, entry->list.next);
268 __list_add(&entry->list,
269 prev_entry->list.prev,
273 spin_unlock_bh(&cipso_v4_cache[bkt].lock);
278 spin_unlock_bh(&cipso_v4_cache[bkt].lock);
284 * cipso_v4_cache_add - Add an entry to the CIPSO cache
285 * @cipso_ptr: pointer to CIPSO IP option
286 * @secattr: the packet's security attributes
289 * Add a new entry into the CIPSO label mapping cache. Add the new entry to
290 * head of the cache bucket's list, if the cache bucket is out of room remove
291 * the last entry in the list first. It is important to note that there is
292 * currently no checking for duplicate keys. Returns zero on success,
293 * negative values on failure.
296 int cipso_v4_cache_add(const unsigned char *cipso_ptr,
297 const struct netlbl_lsm_secattr *secattr)
299 int bkt_size = READ_ONCE(cipso_v4_cache_bucketsize);
300 int ret_val = -EPERM;
302 struct cipso_v4_map_cache_entry *entry = NULL;
303 struct cipso_v4_map_cache_entry *old_entry = NULL;
306 if (!READ_ONCE(cipso_v4_cache_enabled) || bkt_size <= 0)
309 cipso_ptr_len = cipso_ptr[1];
311 entry = kzalloc(sizeof(*entry), GFP_ATOMIC);
314 entry->key = kmemdup(cipso_ptr, cipso_ptr_len, GFP_ATOMIC);
317 goto cache_add_failure;
319 entry->key_len = cipso_ptr_len;
320 entry->hash = cipso_v4_map_cache_hash(cipso_ptr, cipso_ptr_len);
321 refcount_inc(&secattr->cache->refcount);
322 entry->lsm_data = secattr->cache;
324 bkt = entry->hash & (CIPSO_V4_CACHE_BUCKETS - 1);
325 spin_lock_bh(&cipso_v4_cache[bkt].lock);
326 if (cipso_v4_cache[bkt].size < bkt_size) {
327 list_add(&entry->list, &cipso_v4_cache[bkt].list);
328 cipso_v4_cache[bkt].size += 1;
330 old_entry = list_entry(cipso_v4_cache[bkt].list.prev,
331 struct cipso_v4_map_cache_entry, list);
332 list_del(&old_entry->list);
333 list_add(&entry->list, &cipso_v4_cache[bkt].list);
334 cipso_v4_cache_entry_free(old_entry);
336 spin_unlock_bh(&cipso_v4_cache[bkt].lock);
342 cipso_v4_cache_entry_free(entry);
351 * cipso_v4_doi_search - Searches for a DOI definition
352 * @doi: the DOI to search for
355 * Search the DOI definition list for a DOI definition with a DOI value that
356 * matches @doi. The caller is responsible for calling rcu_read_[un]lock().
357 * Returns a pointer to the DOI definition on success and NULL on failure.
359 static struct cipso_v4_doi *cipso_v4_doi_search(u32 doi)
361 struct cipso_v4_doi *iter;
363 list_for_each_entry_rcu(iter, &cipso_v4_doi_list, list)
364 if (iter->doi == doi && refcount_read(&iter->refcount))
370 * cipso_v4_doi_add - Add a new DOI to the CIPSO protocol engine
371 * @doi_def: the DOI structure
372 * @audit_info: NetLabel audit information
375 * The caller defines a new DOI for use by the CIPSO engine and calls this
376 * function to add it to the list of acceptable domains. The caller must
377 * ensure that the mapping table specified in @doi_def->map meets all of the
378 * requirements of the mapping type (see cipso_ipv4.h for details). Returns
379 * zero on success and non-zero on failure.
382 int cipso_v4_doi_add(struct cipso_v4_doi *doi_def,
383 struct netlbl_audit *audit_info)
385 int ret_val = -EINVAL;
389 struct audit_buffer *audit_buf;
392 doi_type = doi_def->type;
394 if (doi_def->doi == CIPSO_V4_DOI_UNKNOWN)
396 for (iter = 0; iter < CIPSO_V4_TAG_MAXCNT; iter++) {
397 switch (doi_def->tags[iter]) {
398 case CIPSO_V4_TAG_RBITMAP:
400 case CIPSO_V4_TAG_RANGE:
401 case CIPSO_V4_TAG_ENUM:
402 if (doi_def->type != CIPSO_V4_MAP_PASS)
405 case CIPSO_V4_TAG_LOCAL:
406 if (doi_def->type != CIPSO_V4_MAP_LOCAL)
409 case CIPSO_V4_TAG_INVALID:
418 refcount_set(&doi_def->refcount, 1);
420 spin_lock(&cipso_v4_doi_list_lock);
421 if (cipso_v4_doi_search(doi_def->doi)) {
422 spin_unlock(&cipso_v4_doi_list_lock);
426 list_add_tail_rcu(&doi_def->list, &cipso_v4_doi_list);
427 spin_unlock(&cipso_v4_doi_list_lock);
431 audit_buf = netlbl_audit_start(AUDIT_MAC_CIPSOV4_ADD, audit_info);
433 const char *type_str;
435 case CIPSO_V4_MAP_TRANS:
438 case CIPSO_V4_MAP_PASS:
441 case CIPSO_V4_MAP_LOCAL:
445 type_str = "(unknown)";
447 audit_log_format(audit_buf,
448 " cipso_doi=%u cipso_type=%s res=%u",
449 doi, type_str, ret_val == 0 ? 1 : 0);
450 audit_log_end(audit_buf);
457 * cipso_v4_doi_free - Frees a DOI definition
458 * @doi_def: the DOI definition
461 * This function frees all of the memory associated with a DOI definition.
464 void cipso_v4_doi_free(struct cipso_v4_doi *doi_def)
469 switch (doi_def->type) {
470 case CIPSO_V4_MAP_TRANS:
471 kfree(doi_def->map.std->lvl.cipso);
472 kfree(doi_def->map.std->lvl.local);
473 kfree(doi_def->map.std->cat.cipso);
474 kfree(doi_def->map.std->cat.local);
475 kfree(doi_def->map.std);
482 * cipso_v4_doi_free_rcu - Frees a DOI definition via the RCU pointer
483 * @entry: the entry's RCU field
486 * This function is designed to be used as a callback to the call_rcu()
487 * function so that the memory allocated to the DOI definition can be released
491 static void cipso_v4_doi_free_rcu(struct rcu_head *entry)
493 struct cipso_v4_doi *doi_def;
495 doi_def = container_of(entry, struct cipso_v4_doi, rcu);
496 cipso_v4_doi_free(doi_def);
500 * cipso_v4_doi_remove - Remove an existing DOI from the CIPSO protocol engine
501 * @doi: the DOI value
502 * @audit_info: NetLabel audit information
505 * Removes a DOI definition from the CIPSO engine. The NetLabel routines will
506 * be called to release their own LSM domain mappings as well as our own
507 * domain list. Returns zero on success and negative values on failure.
510 int cipso_v4_doi_remove(u32 doi, struct netlbl_audit *audit_info)
513 struct cipso_v4_doi *doi_def;
514 struct audit_buffer *audit_buf;
516 spin_lock(&cipso_v4_doi_list_lock);
517 doi_def = cipso_v4_doi_search(doi);
519 spin_unlock(&cipso_v4_doi_list_lock);
521 goto doi_remove_return;
523 list_del_rcu(&doi_def->list);
524 spin_unlock(&cipso_v4_doi_list_lock);
526 cipso_v4_doi_putdef(doi_def);
530 audit_buf = netlbl_audit_start(AUDIT_MAC_CIPSOV4_DEL, audit_info);
532 audit_log_format(audit_buf,
533 " cipso_doi=%u res=%u",
534 doi, ret_val == 0 ? 1 : 0);
535 audit_log_end(audit_buf);
542 * cipso_v4_doi_getdef - Returns a reference to a valid DOI definition
543 * @doi: the DOI value
546 * Searches for a valid DOI definition and if one is found it is returned to
547 * the caller. Otherwise NULL is returned. The caller must ensure that
548 * rcu_read_lock() is held while accessing the returned definition and the DOI
549 * definition reference count is decremented when the caller is done.
552 struct cipso_v4_doi *cipso_v4_doi_getdef(u32 doi)
554 struct cipso_v4_doi *doi_def;
557 doi_def = cipso_v4_doi_search(doi);
559 goto doi_getdef_return;
560 if (!refcount_inc_not_zero(&doi_def->refcount))
569 * cipso_v4_doi_putdef - Releases a reference for the given DOI definition
570 * @doi_def: the DOI definition
573 * Releases a DOI definition reference obtained from cipso_v4_doi_getdef().
576 void cipso_v4_doi_putdef(struct cipso_v4_doi *doi_def)
581 if (!refcount_dec_and_test(&doi_def->refcount))
584 cipso_v4_cache_invalidate();
585 call_rcu(&doi_def->rcu, cipso_v4_doi_free_rcu);
589 * cipso_v4_doi_walk - Iterate through the DOI definitions
590 * @skip_cnt: skip past this number of DOI definitions, updated
591 * @callback: callback for each DOI definition
592 * @cb_arg: argument for the callback function
595 * Iterate over the DOI definition list, skipping the first @skip_cnt entries.
596 * For each entry call @callback, if @callback returns a negative value stop
597 * 'walking' through the list and return. Updates the value in @skip_cnt upon
598 * return. Returns zero on success, negative values on failure.
601 int cipso_v4_doi_walk(u32 *skip_cnt,
602 int (*callback) (struct cipso_v4_doi *doi_def, void *arg),
605 int ret_val = -ENOENT;
607 struct cipso_v4_doi *iter_doi;
610 list_for_each_entry_rcu(iter_doi, &cipso_v4_doi_list, list)
611 if (refcount_read(&iter_doi->refcount) > 0) {
612 if (doi_cnt++ < *skip_cnt)
614 ret_val = callback(iter_doi, cb_arg);
617 goto doi_walk_return;
628 * Label Mapping Functions
632 * cipso_v4_map_lvl_valid - Checks to see if the given level is understood
633 * @doi_def: the DOI definition
634 * @level: the level to check
637 * Checks the given level against the given DOI definition and returns a
638 * negative value if the level does not have a valid mapping and a zero value
639 * if the level is defined by the DOI.
642 static int cipso_v4_map_lvl_valid(const struct cipso_v4_doi *doi_def, u8 level)
644 switch (doi_def->type) {
645 case CIPSO_V4_MAP_PASS:
647 case CIPSO_V4_MAP_TRANS:
648 if ((level < doi_def->map.std->lvl.cipso_size) &&
649 (doi_def->map.std->lvl.cipso[level] < CIPSO_V4_INV_LVL))
658 * cipso_v4_map_lvl_hton - Perform a level mapping from the host to the network
659 * @doi_def: the DOI definition
660 * @host_lvl: the host MLS level
661 * @net_lvl: the network/CIPSO MLS level
664 * Perform a label mapping to translate a local MLS level to the correct
665 * CIPSO level using the given DOI definition. Returns zero on success,
666 * negative values otherwise.
669 static int cipso_v4_map_lvl_hton(const struct cipso_v4_doi *doi_def,
673 switch (doi_def->type) {
674 case CIPSO_V4_MAP_PASS:
677 case CIPSO_V4_MAP_TRANS:
678 if (host_lvl < doi_def->map.std->lvl.local_size &&
679 doi_def->map.std->lvl.local[host_lvl] < CIPSO_V4_INV_LVL) {
680 *net_lvl = doi_def->map.std->lvl.local[host_lvl];
690 * cipso_v4_map_lvl_ntoh - Perform a level mapping from the network to the host
691 * @doi_def: the DOI definition
692 * @net_lvl: the network/CIPSO MLS level
693 * @host_lvl: the host MLS level
696 * Perform a label mapping to translate a CIPSO level to the correct local MLS
697 * level using the given DOI definition. Returns zero on success, negative
701 static int cipso_v4_map_lvl_ntoh(const struct cipso_v4_doi *doi_def,
705 struct cipso_v4_std_map_tbl *map_tbl;
707 switch (doi_def->type) {
708 case CIPSO_V4_MAP_PASS:
711 case CIPSO_V4_MAP_TRANS:
712 map_tbl = doi_def->map.std;
713 if (net_lvl < map_tbl->lvl.cipso_size &&
714 map_tbl->lvl.cipso[net_lvl] < CIPSO_V4_INV_LVL) {
715 *host_lvl = doi_def->map.std->lvl.cipso[net_lvl];
725 * cipso_v4_map_cat_rbm_valid - Checks to see if the category bitmap is valid
726 * @doi_def: the DOI definition
727 * @bitmap: category bitmap
728 * @bitmap_len: bitmap length in bytes
731 * Checks the given category bitmap against the given DOI definition and
732 * returns a negative value if any of the categories in the bitmap do not have
733 * a valid mapping and a zero value if all of the categories are valid.
736 static int cipso_v4_map_cat_rbm_valid(const struct cipso_v4_doi *doi_def,
737 const unsigned char *bitmap,
741 u32 bitmap_len_bits = bitmap_len * 8;
745 switch (doi_def->type) {
746 case CIPSO_V4_MAP_PASS:
748 case CIPSO_V4_MAP_TRANS:
749 cipso_cat_size = doi_def->map.std->cat.cipso_size;
750 cipso_array = doi_def->map.std->cat.cipso;
752 cat = netlbl_bitmap_walk(bitmap,
758 if (cat >= cipso_cat_size ||
759 cipso_array[cat] >= CIPSO_V4_INV_CAT)
772 * cipso_v4_map_cat_rbm_hton - Perform a category mapping from host to network
773 * @doi_def: the DOI definition
774 * @secattr: the security attributes
775 * @net_cat: the zero'd out category bitmap in network/CIPSO format
776 * @net_cat_len: the length of the CIPSO bitmap in bytes
779 * Perform a label mapping to translate a local MLS category bitmap to the
780 * correct CIPSO bitmap using the given DOI definition. Returns the minimum
781 * size in bytes of the network bitmap on success, negative values otherwise.
784 static int cipso_v4_map_cat_rbm_hton(const struct cipso_v4_doi *doi_def,
785 const struct netlbl_lsm_secattr *secattr,
786 unsigned char *net_cat,
790 u32 net_spot = CIPSO_V4_INV_CAT;
791 u32 net_spot_max = 0;
792 u32 net_clen_bits = net_cat_len * 8;
793 u32 host_cat_size = 0;
794 u32 *host_cat_array = NULL;
796 if (doi_def->type == CIPSO_V4_MAP_TRANS) {
797 host_cat_size = doi_def->map.std->cat.local_size;
798 host_cat_array = doi_def->map.std->cat.local;
802 host_spot = netlbl_catmap_walk(secattr->attr.mls.cat,
807 switch (doi_def->type) {
808 case CIPSO_V4_MAP_PASS:
809 net_spot = host_spot;
811 case CIPSO_V4_MAP_TRANS:
812 if (host_spot >= host_cat_size)
814 net_spot = host_cat_array[host_spot];
815 if (net_spot >= CIPSO_V4_INV_CAT)
819 if (net_spot >= net_clen_bits)
821 netlbl_bitmap_setbit(net_cat, net_spot, 1);
823 if (net_spot > net_spot_max)
824 net_spot_max = net_spot;
827 if (++net_spot_max % 8)
828 return net_spot_max / 8 + 1;
829 return net_spot_max / 8;
833 * cipso_v4_map_cat_rbm_ntoh - Perform a category mapping from network to host
834 * @doi_def: the DOI definition
835 * @net_cat: the category bitmap in network/CIPSO format
836 * @net_cat_len: the length of the CIPSO bitmap in bytes
837 * @secattr: the security attributes
840 * Perform a label mapping to translate a CIPSO bitmap to the correct local
841 * MLS category bitmap using the given DOI definition. Returns zero on
842 * success, negative values on failure.
845 static int cipso_v4_map_cat_rbm_ntoh(const struct cipso_v4_doi *doi_def,
846 const unsigned char *net_cat,
848 struct netlbl_lsm_secattr *secattr)
852 u32 host_spot = CIPSO_V4_INV_CAT;
853 u32 net_clen_bits = net_cat_len * 8;
854 u32 net_cat_size = 0;
855 u32 *net_cat_array = NULL;
857 if (doi_def->type == CIPSO_V4_MAP_TRANS) {
858 net_cat_size = doi_def->map.std->cat.cipso_size;
859 net_cat_array = doi_def->map.std->cat.cipso;
863 net_spot = netlbl_bitmap_walk(net_cat,
870 switch (doi_def->type) {
871 case CIPSO_V4_MAP_PASS:
872 host_spot = net_spot;
874 case CIPSO_V4_MAP_TRANS:
875 if (net_spot >= net_cat_size)
877 host_spot = net_cat_array[net_spot];
878 if (host_spot >= CIPSO_V4_INV_CAT)
882 ret_val = netlbl_catmap_setbit(&secattr->attr.mls.cat,
893 * cipso_v4_map_cat_enum_valid - Checks to see if the categories are valid
894 * @doi_def: the DOI definition
895 * @enumcat: category list
896 * @enumcat_len: length of the category list in bytes
899 * Checks the given categories against the given DOI definition and returns a
900 * negative value if any of the categories do not have a valid mapping and a
901 * zero value if all of the categories are valid.
904 static int cipso_v4_map_cat_enum_valid(const struct cipso_v4_doi *doi_def,
905 const unsigned char *enumcat,
912 if (doi_def->type != CIPSO_V4_MAP_PASS || enumcat_len & 0x01)
915 for (iter = 0; iter < enumcat_len; iter += 2) {
916 cat = get_unaligned_be16(&enumcat[iter]);
926 * cipso_v4_map_cat_enum_hton - Perform a category mapping from host to network
927 * @doi_def: the DOI definition
928 * @secattr: the security attributes
929 * @net_cat: the zero'd out category list in network/CIPSO format
930 * @net_cat_len: the length of the CIPSO category list in bytes
933 * Perform a label mapping to translate a local MLS category bitmap to the
934 * correct CIPSO category list using the given DOI definition. Returns the
935 * size in bytes of the network category bitmap on success, negative values
939 static int cipso_v4_map_cat_enum_hton(const struct cipso_v4_doi *doi_def,
940 const struct netlbl_lsm_secattr *secattr,
941 unsigned char *net_cat,
948 cat = netlbl_catmap_walk(secattr->attr.mls.cat, cat + 1);
951 if ((cat_iter + 2) > net_cat_len)
954 *((__be16 *)&net_cat[cat_iter]) = htons(cat);
962 * cipso_v4_map_cat_enum_ntoh - Perform a category mapping from network to host
963 * @doi_def: the DOI definition
964 * @net_cat: the category list in network/CIPSO format
965 * @net_cat_len: the length of the CIPSO bitmap in bytes
966 * @secattr: the security attributes
969 * Perform a label mapping to translate a CIPSO category list to the correct
970 * local MLS category bitmap using the given DOI definition. Returns zero on
971 * success, negative values on failure.
974 static int cipso_v4_map_cat_enum_ntoh(const struct cipso_v4_doi *doi_def,
975 const unsigned char *net_cat,
977 struct netlbl_lsm_secattr *secattr)
982 for (iter = 0; iter < net_cat_len; iter += 2) {
983 ret_val = netlbl_catmap_setbit(&secattr->attr.mls.cat,
984 get_unaligned_be16(&net_cat[iter]),
994 * cipso_v4_map_cat_rng_valid - Checks to see if the categories are valid
995 * @doi_def: the DOI definition
996 * @rngcat: category list
997 * @rngcat_len: length of the category list in bytes
1000 * Checks the given categories against the given DOI definition and returns a
1001 * negative value if any of the categories do not have a valid mapping and a
1002 * zero value if all of the categories are valid.
1005 static int cipso_v4_map_cat_rng_valid(const struct cipso_v4_doi *doi_def,
1006 const unsigned char *rngcat,
1011 u32 cat_prev = CIPSO_V4_MAX_REM_CATS + 1;
1014 if (doi_def->type != CIPSO_V4_MAP_PASS || rngcat_len & 0x01)
1017 for (iter = 0; iter < rngcat_len; iter += 4) {
1018 cat_high = get_unaligned_be16(&rngcat[iter]);
1019 if ((iter + 4) <= rngcat_len)
1020 cat_low = get_unaligned_be16(&rngcat[iter + 2]);
1024 if (cat_high > cat_prev)
1034 * cipso_v4_map_cat_rng_hton - Perform a category mapping from host to network
1035 * @doi_def: the DOI definition
1036 * @secattr: the security attributes
1037 * @net_cat: the zero'd out category list in network/CIPSO format
1038 * @net_cat_len: the length of the CIPSO category list in bytes
1041 * Perform a label mapping to translate a local MLS category bitmap to the
1042 * correct CIPSO category list using the given DOI definition. Returns the
1043 * size in bytes of the network category bitmap on success, negative values
1047 static int cipso_v4_map_cat_rng_hton(const struct cipso_v4_doi *doi_def,
1048 const struct netlbl_lsm_secattr *secattr,
1049 unsigned char *net_cat,
1053 u16 array[CIPSO_V4_TAG_RNG_CAT_MAX * 2];
1057 /* make sure we don't overflow the 'array[]' variable */
1059 (CIPSO_V4_OPT_LEN_MAX - CIPSO_V4_HDR_LEN - CIPSO_V4_TAG_RNG_BLEN))
1063 iter = netlbl_catmap_walk(secattr->attr.mls.cat, iter + 1);
1066 cat_size += (iter == 0 ? 0 : sizeof(u16));
1067 if (cat_size > net_cat_len)
1069 array[array_cnt++] = iter;
1071 iter = netlbl_catmap_walkrng(secattr->attr.mls.cat, iter);
1074 cat_size += sizeof(u16);
1075 if (cat_size > net_cat_len)
1077 array[array_cnt++] = iter;
1080 for (iter = 0; array_cnt > 0;) {
1081 *((__be16 *)&net_cat[iter]) = htons(array[--array_cnt]);
1084 if (array[array_cnt] != 0) {
1085 *((__be16 *)&net_cat[iter]) = htons(array[array_cnt]);
1094 * cipso_v4_map_cat_rng_ntoh - Perform a category mapping from network to host
1095 * @doi_def: the DOI definition
1096 * @net_cat: the category list in network/CIPSO format
1097 * @net_cat_len: the length of the CIPSO bitmap in bytes
1098 * @secattr: the security attributes
1101 * Perform a label mapping to translate a CIPSO category list to the correct
1102 * local MLS category bitmap using the given DOI definition. Returns zero on
1103 * success, negative values on failure.
1106 static int cipso_v4_map_cat_rng_ntoh(const struct cipso_v4_doi *doi_def,
1107 const unsigned char *net_cat,
1109 struct netlbl_lsm_secattr *secattr)
1116 for (net_iter = 0; net_iter < net_cat_len; net_iter += 4) {
1117 cat_high = get_unaligned_be16(&net_cat[net_iter]);
1118 if ((net_iter + 4) <= net_cat_len)
1119 cat_low = get_unaligned_be16(&net_cat[net_iter + 2]);
1123 ret_val = netlbl_catmap_setrng(&secattr->attr.mls.cat,
1135 * Protocol Handling Functions
1139 * cipso_v4_gentag_hdr - Generate a CIPSO option header
1140 * @doi_def: the DOI definition
1141 * @len: the total tag length in bytes, not including this header
1142 * @buf: the CIPSO option buffer
1145 * Write a CIPSO header into the beginning of @buffer.
1148 static void cipso_v4_gentag_hdr(const struct cipso_v4_doi *doi_def,
1152 buf[0] = IPOPT_CIPSO;
1153 buf[1] = CIPSO_V4_HDR_LEN + len;
1154 put_unaligned_be32(doi_def->doi, &buf[2]);
1158 * cipso_v4_gentag_rbm - Generate a CIPSO restricted bitmap tag (type #1)
1159 * @doi_def: the DOI definition
1160 * @secattr: the security attributes
1161 * @buffer: the option buffer
1162 * @buffer_len: length of buffer in bytes
1165 * Generate a CIPSO option using the restricted bitmap tag, tag type #1. The
1166 * actual buffer length may be larger than the indicated size due to
1167 * translation between host and network category bitmaps. Returns the size of
1168 * the tag on success, negative values on failure.
1171 static int cipso_v4_gentag_rbm(const struct cipso_v4_doi *doi_def,
1172 const struct netlbl_lsm_secattr *secattr,
1173 unsigned char *buffer,
1180 if ((secattr->flags & NETLBL_SECATTR_MLS_LVL) == 0)
1183 ret_val = cipso_v4_map_lvl_hton(doi_def,
1184 secattr->attr.mls.lvl,
1189 if (secattr->flags & NETLBL_SECATTR_MLS_CAT) {
1190 ret_val = cipso_v4_map_cat_rbm_hton(doi_def,
1197 /* This will send packets using the "optimized" format when
1198 * possible as specified in section 3.4.2.6 of the
1200 if (READ_ONCE(cipso_v4_rbm_optfmt) && ret_val > 0 &&
1204 tag_len = 4 + ret_val;
1208 buffer[0] = CIPSO_V4_TAG_RBITMAP;
1209 buffer[1] = tag_len;
1216 * cipso_v4_parsetag_rbm - Parse a CIPSO restricted bitmap tag
1217 * @doi_def: the DOI definition
1218 * @tag: the CIPSO tag
1219 * @secattr: the security attributes
1222 * Parse a CIPSO restricted bitmap tag (tag type #1) and return the security
1223 * attributes in @secattr. Return zero on success, negatives values on
1227 static int cipso_v4_parsetag_rbm(const struct cipso_v4_doi *doi_def,
1228 const unsigned char *tag,
1229 struct netlbl_lsm_secattr *secattr)
1232 u8 tag_len = tag[1];
1235 ret_val = cipso_v4_map_lvl_ntoh(doi_def, tag[3], &level);
1238 secattr->attr.mls.lvl = level;
1239 secattr->flags |= NETLBL_SECATTR_MLS_LVL;
1242 ret_val = cipso_v4_map_cat_rbm_ntoh(doi_def,
1247 netlbl_catmap_free(secattr->attr.mls.cat);
1251 if (secattr->attr.mls.cat)
1252 secattr->flags |= NETLBL_SECATTR_MLS_CAT;
1259 * cipso_v4_gentag_enum - Generate a CIPSO enumerated tag (type #2)
1260 * @doi_def: the DOI definition
1261 * @secattr: the security attributes
1262 * @buffer: the option buffer
1263 * @buffer_len: length of buffer in bytes
1266 * Generate a CIPSO option using the enumerated tag, tag type #2. Returns the
1267 * size of the tag on success, negative values on failure.
1270 static int cipso_v4_gentag_enum(const struct cipso_v4_doi *doi_def,
1271 const struct netlbl_lsm_secattr *secattr,
1272 unsigned char *buffer,
1279 if (!(secattr->flags & NETLBL_SECATTR_MLS_LVL))
1282 ret_val = cipso_v4_map_lvl_hton(doi_def,
1283 secattr->attr.mls.lvl,
1288 if (secattr->flags & NETLBL_SECATTR_MLS_CAT) {
1289 ret_val = cipso_v4_map_cat_enum_hton(doi_def,
1296 tag_len = 4 + ret_val;
1300 buffer[0] = CIPSO_V4_TAG_ENUM;
1301 buffer[1] = tag_len;
1308 * cipso_v4_parsetag_enum - Parse a CIPSO enumerated tag
1309 * @doi_def: the DOI definition
1310 * @tag: the CIPSO tag
1311 * @secattr: the security attributes
1314 * Parse a CIPSO enumerated tag (tag type #2) and return the security
1315 * attributes in @secattr. Return zero on success, negatives values on
1319 static int cipso_v4_parsetag_enum(const struct cipso_v4_doi *doi_def,
1320 const unsigned char *tag,
1321 struct netlbl_lsm_secattr *secattr)
1324 u8 tag_len = tag[1];
1327 ret_val = cipso_v4_map_lvl_ntoh(doi_def, tag[3], &level);
1330 secattr->attr.mls.lvl = level;
1331 secattr->flags |= NETLBL_SECATTR_MLS_LVL;
1334 ret_val = cipso_v4_map_cat_enum_ntoh(doi_def,
1339 netlbl_catmap_free(secattr->attr.mls.cat);
1343 secattr->flags |= NETLBL_SECATTR_MLS_CAT;
1350 * cipso_v4_gentag_rng - Generate a CIPSO ranged tag (type #5)
1351 * @doi_def: the DOI definition
1352 * @secattr: the security attributes
1353 * @buffer: the option buffer
1354 * @buffer_len: length of buffer in bytes
1357 * Generate a CIPSO option using the ranged tag, tag type #5. Returns the
1358 * size of the tag on success, negative values on failure.
1361 static int cipso_v4_gentag_rng(const struct cipso_v4_doi *doi_def,
1362 const struct netlbl_lsm_secattr *secattr,
1363 unsigned char *buffer,
1370 if (!(secattr->flags & NETLBL_SECATTR_MLS_LVL))
1373 ret_val = cipso_v4_map_lvl_hton(doi_def,
1374 secattr->attr.mls.lvl,
1379 if (secattr->flags & NETLBL_SECATTR_MLS_CAT) {
1380 ret_val = cipso_v4_map_cat_rng_hton(doi_def,
1387 tag_len = 4 + ret_val;
1391 buffer[0] = CIPSO_V4_TAG_RANGE;
1392 buffer[1] = tag_len;
1399 * cipso_v4_parsetag_rng - Parse a CIPSO ranged tag
1400 * @doi_def: the DOI definition
1401 * @tag: the CIPSO tag
1402 * @secattr: the security attributes
1405 * Parse a CIPSO ranged tag (tag type #5) and return the security attributes
1406 * in @secattr. Return zero on success, negatives values on failure.
1409 static int cipso_v4_parsetag_rng(const struct cipso_v4_doi *doi_def,
1410 const unsigned char *tag,
1411 struct netlbl_lsm_secattr *secattr)
1414 u8 tag_len = tag[1];
1417 ret_val = cipso_v4_map_lvl_ntoh(doi_def, tag[3], &level);
1420 secattr->attr.mls.lvl = level;
1421 secattr->flags |= NETLBL_SECATTR_MLS_LVL;
1424 ret_val = cipso_v4_map_cat_rng_ntoh(doi_def,
1429 netlbl_catmap_free(secattr->attr.mls.cat);
1433 if (secattr->attr.mls.cat)
1434 secattr->flags |= NETLBL_SECATTR_MLS_CAT;
1441 * cipso_v4_gentag_loc - Generate a CIPSO local tag (non-standard)
1442 * @doi_def: the DOI definition
1443 * @secattr: the security attributes
1444 * @buffer: the option buffer
1445 * @buffer_len: length of buffer in bytes
1448 * Generate a CIPSO option using the local tag. Returns the size of the tag
1449 * on success, negative values on failure.
1452 static int cipso_v4_gentag_loc(const struct cipso_v4_doi *doi_def,
1453 const struct netlbl_lsm_secattr *secattr,
1454 unsigned char *buffer,
1457 if (!(secattr->flags & NETLBL_SECATTR_SECID))
1460 buffer[0] = CIPSO_V4_TAG_LOCAL;
1461 buffer[1] = CIPSO_V4_TAG_LOC_BLEN;
1462 *(u32 *)&buffer[2] = secattr->attr.secid;
1464 return CIPSO_V4_TAG_LOC_BLEN;
1468 * cipso_v4_parsetag_loc - Parse a CIPSO local tag
1469 * @doi_def: the DOI definition
1470 * @tag: the CIPSO tag
1471 * @secattr: the security attributes
1474 * Parse a CIPSO local tag and return the security attributes in @secattr.
1475 * Return zero on success, negatives values on failure.
1478 static int cipso_v4_parsetag_loc(const struct cipso_v4_doi *doi_def,
1479 const unsigned char *tag,
1480 struct netlbl_lsm_secattr *secattr)
1482 secattr->attr.secid = *(u32 *)&tag[2];
1483 secattr->flags |= NETLBL_SECATTR_SECID;
1489 * cipso_v4_optptr - Find the CIPSO option in the packet
1493 * Parse the packet's IP header looking for a CIPSO option. Returns a pointer
1494 * to the start of the CIPSO option on success, NULL if one is not found.
1497 unsigned char *cipso_v4_optptr(const struct sk_buff *skb)
1499 const struct iphdr *iph = ip_hdr(skb);
1500 unsigned char *optptr = (unsigned char *)&(ip_hdr(skb)[1]);
1504 for (optlen = iph->ihl*4 - sizeof(struct iphdr); optlen > 1; ) {
1505 switch (optptr[0]) {
1514 if (!taglen || taglen > optlen)
1516 if (optptr[0] == IPOPT_CIPSO)
1527 * cipso_v4_validate - Validate a CIPSO option
1529 * @option: the start of the option, on error it is set to point to the error
1532 * This routine is called to validate a CIPSO option, it checks all of the
1533 * fields to ensure that they are at least valid, see the draft snippet below
1534 * for details. If the option is valid then a zero value is returned and
1535 * the value of @option is unchanged. If the option is invalid then a
1536 * non-zero value is returned and @option is adjusted to point to the
1537 * offending portion of the option. From the IETF draft ...
1539 * "If any field within the CIPSO options, such as the DOI identifier, is not
1540 * recognized the IP datagram is discarded and an ICMP 'parameter problem'
1541 * (type 12) is generated and returned. The ICMP code field is set to 'bad
1542 * parameter' (code 0) and the pointer is set to the start of the CIPSO field
1543 * that is unrecognized."
1546 int cipso_v4_validate(const struct sk_buff *skb, unsigned char **option)
1548 unsigned char *opt = *option;
1550 unsigned char opt_iter;
1551 unsigned char err_offset = 0;
1554 struct cipso_v4_doi *doi_def = NULL;
1557 /* caller already checks for length values that are too large */
1561 goto validate_return;
1565 doi_def = cipso_v4_doi_search(get_unaligned_be32(&opt[2]));
1568 goto validate_return_locked;
1571 opt_iter = CIPSO_V4_HDR_LEN;
1572 tag = opt + opt_iter;
1573 while (opt_iter < opt_len) {
1574 for (tag_iter = 0; doi_def->tags[tag_iter] != tag[0];)
1575 if (doi_def->tags[tag_iter] == CIPSO_V4_TAG_INVALID ||
1576 ++tag_iter == CIPSO_V4_TAG_MAXCNT) {
1577 err_offset = opt_iter;
1578 goto validate_return_locked;
1581 if (opt_iter + 1 == opt_len) {
1582 err_offset = opt_iter;
1583 goto validate_return_locked;
1586 if (tag_len > (opt_len - opt_iter)) {
1587 err_offset = opt_iter + 1;
1588 goto validate_return_locked;
1592 case CIPSO_V4_TAG_RBITMAP:
1593 if (tag_len < CIPSO_V4_TAG_RBM_BLEN) {
1594 err_offset = opt_iter + 1;
1595 goto validate_return_locked;
1598 /* We are already going to do all the verification
1599 * necessary at the socket layer so from our point of
1600 * view it is safe to turn these checks off (and less
1601 * work), however, the CIPSO draft says we should do
1602 * all the CIPSO validations here but it doesn't
1603 * really specify _exactly_ what we need to validate
1604 * ... so, just make it a sysctl tunable. */
1605 if (READ_ONCE(cipso_v4_rbm_strictvalid)) {
1606 if (cipso_v4_map_lvl_valid(doi_def,
1608 err_offset = opt_iter + 3;
1609 goto validate_return_locked;
1611 if (tag_len > CIPSO_V4_TAG_RBM_BLEN &&
1612 cipso_v4_map_cat_rbm_valid(doi_def,
1615 err_offset = opt_iter + 4;
1616 goto validate_return_locked;
1620 case CIPSO_V4_TAG_ENUM:
1621 if (tag_len < CIPSO_V4_TAG_ENUM_BLEN) {
1622 err_offset = opt_iter + 1;
1623 goto validate_return_locked;
1626 if (cipso_v4_map_lvl_valid(doi_def,
1628 err_offset = opt_iter + 3;
1629 goto validate_return_locked;
1631 if (tag_len > CIPSO_V4_TAG_ENUM_BLEN &&
1632 cipso_v4_map_cat_enum_valid(doi_def,
1635 err_offset = opt_iter + 4;
1636 goto validate_return_locked;
1639 case CIPSO_V4_TAG_RANGE:
1640 if (tag_len < CIPSO_V4_TAG_RNG_BLEN) {
1641 err_offset = opt_iter + 1;
1642 goto validate_return_locked;
1645 if (cipso_v4_map_lvl_valid(doi_def,
1647 err_offset = opt_iter + 3;
1648 goto validate_return_locked;
1650 if (tag_len > CIPSO_V4_TAG_RNG_BLEN &&
1651 cipso_v4_map_cat_rng_valid(doi_def,
1654 err_offset = opt_iter + 4;
1655 goto validate_return_locked;
1658 case CIPSO_V4_TAG_LOCAL:
1659 /* This is a non-standard tag that we only allow for
1660 * local connections, so if the incoming interface is
1661 * not the loopback device drop the packet. Further,
1662 * there is no legitimate reason for setting this from
1663 * userspace so reject it if skb is NULL. */
1664 if (!skb || !(skb->dev->flags & IFF_LOOPBACK)) {
1665 err_offset = opt_iter;
1666 goto validate_return_locked;
1668 if (tag_len != CIPSO_V4_TAG_LOC_BLEN) {
1669 err_offset = opt_iter + 1;
1670 goto validate_return_locked;
1674 err_offset = opt_iter;
1675 goto validate_return_locked;
1679 opt_iter += tag_len;
1682 validate_return_locked:
1685 *option = opt + err_offset;
1690 * cipso_v4_error - Send the correct response for a bad packet
1692 * @error: the error code
1693 * @gateway: CIPSO gateway flag
1696 * Based on the error code given in @error, send an ICMP error message back to
1697 * the originating host. From the IETF draft ...
1699 * "If the contents of the CIPSO [option] are valid but the security label is
1700 * outside of the configured host or port label range, the datagram is
1701 * discarded and an ICMP 'destination unreachable' (type 3) is generated and
1702 * returned. The code field of the ICMP is set to 'communication with
1703 * destination network administratively prohibited' (code 9) or to
1704 * 'communication with destination host administratively prohibited'
1705 * (code 10). The value of the code is dependent on whether the originator
1706 * of the ICMP message is acting as a CIPSO host or a CIPSO gateway. The
1707 * recipient of the ICMP message MUST be able to handle either value. The
1708 * same procedure is performed if a CIPSO [option] can not be added to an
1709 * IP packet because it is too large to fit in the IP options area."
1711 * "If the error is triggered by receipt of an ICMP message, the message is
1712 * discarded and no response is permitted (consistent with general ICMP
1713 * processing rules)."
1716 void cipso_v4_error(struct sk_buff *skb, int error, u32 gateway)
1718 unsigned char optbuf[sizeof(struct ip_options) + 40];
1719 struct ip_options *opt = (struct ip_options *)optbuf;
1722 if (ip_hdr(skb)->protocol == IPPROTO_ICMP || error != -EACCES)
1726 * We might be called above the IP layer,
1727 * so we can not use icmp_send and IPCB here.
1730 memset(opt, 0, sizeof(struct ip_options));
1731 opt->optlen = ip_hdr(skb)->ihl*4 - sizeof(struct iphdr);
1733 res = __ip_options_compile(dev_net(skb->dev), opt, skb, NULL);
1740 __icmp_send(skb, ICMP_DEST_UNREACH, ICMP_NET_ANO, 0, opt);
1742 __icmp_send(skb, ICMP_DEST_UNREACH, ICMP_HOST_ANO, 0, opt);
1746 * cipso_v4_genopt - Generate a CIPSO option
1747 * @buf: the option buffer
1748 * @buf_len: the size of opt_buf
1749 * @doi_def: the CIPSO DOI to use
1750 * @secattr: the security attributes
1753 * Generate a CIPSO option using the DOI definition and security attributes
1754 * passed to the function. Returns the length of the option on success and
1755 * negative values on failure.
1758 static int cipso_v4_genopt(unsigned char *buf, u32 buf_len,
1759 const struct cipso_v4_doi *doi_def,
1760 const struct netlbl_lsm_secattr *secattr)
1765 if (buf_len <= CIPSO_V4_HDR_LEN)
1768 /* XXX - This code assumes only one tag per CIPSO option which isn't
1769 * really a good assumption to make but since we only support the MAC
1770 * tags right now it is a safe assumption. */
1773 memset(buf, 0, buf_len);
1774 switch (doi_def->tags[iter]) {
1775 case CIPSO_V4_TAG_RBITMAP:
1776 ret_val = cipso_v4_gentag_rbm(doi_def,
1778 &buf[CIPSO_V4_HDR_LEN],
1779 buf_len - CIPSO_V4_HDR_LEN);
1781 case CIPSO_V4_TAG_ENUM:
1782 ret_val = cipso_v4_gentag_enum(doi_def,
1784 &buf[CIPSO_V4_HDR_LEN],
1785 buf_len - CIPSO_V4_HDR_LEN);
1787 case CIPSO_V4_TAG_RANGE:
1788 ret_val = cipso_v4_gentag_rng(doi_def,
1790 &buf[CIPSO_V4_HDR_LEN],
1791 buf_len - CIPSO_V4_HDR_LEN);
1793 case CIPSO_V4_TAG_LOCAL:
1794 ret_val = cipso_v4_gentag_loc(doi_def,
1796 &buf[CIPSO_V4_HDR_LEN],
1797 buf_len - CIPSO_V4_HDR_LEN);
1804 } while (ret_val < 0 &&
1805 iter < CIPSO_V4_TAG_MAXCNT &&
1806 doi_def->tags[iter] != CIPSO_V4_TAG_INVALID);
1809 cipso_v4_gentag_hdr(doi_def, buf, ret_val);
1810 return CIPSO_V4_HDR_LEN + ret_val;
1814 * cipso_v4_sock_setattr - Add a CIPSO option to a socket
1816 * @doi_def: the CIPSO DOI to use
1817 * @secattr: the specific security attributes of the socket
1820 * Set the CIPSO option on the given socket using the DOI definition and
1821 * security attributes passed to the function. This function requires
1822 * exclusive access to @sk, which means it either needs to be in the
1823 * process of being created or locked. Returns zero on success and negative
1824 * values on failure.
1827 int cipso_v4_sock_setattr(struct sock *sk,
1828 const struct cipso_v4_doi *doi_def,
1829 const struct netlbl_lsm_secattr *secattr)
1831 int ret_val = -EPERM;
1832 unsigned char *buf = NULL;
1835 struct ip_options_rcu *old, *opt = NULL;
1836 struct inet_sock *sk_inet;
1837 struct inet_connection_sock *sk_conn;
1839 /* In the case of sock_create_lite(), the sock->sk field is not
1840 * defined yet but it is not a problem as the only users of these
1841 * "lite" PF_INET sockets are functions which do an accept() call
1842 * afterwards so we will label the socket as part of the accept(). */
1846 /* We allocate the maximum CIPSO option size here so we are probably
1847 * being a little wasteful, but it makes our life _much_ easier later
1848 * on and after all we are only talking about 40 bytes. */
1849 buf_len = CIPSO_V4_OPT_LEN_MAX;
1850 buf = kmalloc(buf_len, GFP_ATOMIC);
1853 goto socket_setattr_failure;
1856 ret_val = cipso_v4_genopt(buf, buf_len, doi_def, secattr);
1858 goto socket_setattr_failure;
1861 /* We can't use ip_options_get() directly because it makes a call to
1862 * ip_options_get_alloc() which allocates memory with GFP_KERNEL and
1863 * we won't always have CAP_NET_RAW even though we _always_ want to
1864 * set the IPOPT_CIPSO option. */
1865 opt_len = (buf_len + 3) & ~3;
1866 opt = kzalloc(sizeof(*opt) + opt_len, GFP_ATOMIC);
1869 goto socket_setattr_failure;
1871 memcpy(opt->opt.__data, buf, buf_len);
1872 opt->opt.optlen = opt_len;
1873 opt->opt.cipso = sizeof(struct iphdr);
1877 sk_inet = inet_sk(sk);
1879 old = rcu_dereference_protected(sk_inet->inet_opt,
1880 lockdep_sock_is_held(sk));
1881 if (inet_test_bit(IS_ICSK, sk)) {
1882 sk_conn = inet_csk(sk);
1884 sk_conn->icsk_ext_hdr_len -= old->opt.optlen;
1885 sk_conn->icsk_ext_hdr_len += opt->opt.optlen;
1886 sk_conn->icsk_sync_mss(sk, sk_conn->icsk_pmtu_cookie);
1888 rcu_assign_pointer(sk_inet->inet_opt, opt);
1890 kfree_rcu(old, rcu);
1894 socket_setattr_failure:
1901 * cipso_v4_req_setattr - Add a CIPSO option to a connection request socket
1902 * @req: the connection request socket
1903 * @doi_def: the CIPSO DOI to use
1904 * @secattr: the specific security attributes of the socket
1907 * Set the CIPSO option on the given socket using the DOI definition and
1908 * security attributes passed to the function. Returns zero on success and
1909 * negative values on failure.
1912 int cipso_v4_req_setattr(struct request_sock *req,
1913 const struct cipso_v4_doi *doi_def,
1914 const struct netlbl_lsm_secattr *secattr)
1916 int ret_val = -EPERM;
1917 unsigned char *buf = NULL;
1920 struct ip_options_rcu *opt = NULL;
1921 struct inet_request_sock *req_inet;
1923 /* We allocate the maximum CIPSO option size here so we are probably
1924 * being a little wasteful, but it makes our life _much_ easier later
1925 * on and after all we are only talking about 40 bytes. */
1926 buf_len = CIPSO_V4_OPT_LEN_MAX;
1927 buf = kmalloc(buf_len, GFP_ATOMIC);
1930 goto req_setattr_failure;
1933 ret_val = cipso_v4_genopt(buf, buf_len, doi_def, secattr);
1935 goto req_setattr_failure;
1938 /* We can't use ip_options_get() directly because it makes a call to
1939 * ip_options_get_alloc() which allocates memory with GFP_KERNEL and
1940 * we won't always have CAP_NET_RAW even though we _always_ want to
1941 * set the IPOPT_CIPSO option. */
1942 opt_len = (buf_len + 3) & ~3;
1943 opt = kzalloc(sizeof(*opt) + opt_len, GFP_ATOMIC);
1946 goto req_setattr_failure;
1948 memcpy(opt->opt.__data, buf, buf_len);
1949 opt->opt.optlen = opt_len;
1950 opt->opt.cipso = sizeof(struct iphdr);
1954 req_inet = inet_rsk(req);
1955 opt = xchg((__force struct ip_options_rcu **)&req_inet->ireq_opt, opt);
1957 kfree_rcu(opt, rcu);
1961 req_setattr_failure:
1968 * cipso_v4_delopt - Delete the CIPSO option from a set of IP options
1969 * @opt_ptr: IP option pointer
1972 * Deletes the CIPSO IP option from a set of IP options and makes the necessary
1973 * adjustments to the IP option structure. Returns zero on success, negative
1974 * values on failure.
1977 static int cipso_v4_delopt(struct ip_options_rcu __rcu **opt_ptr)
1979 struct ip_options_rcu *opt = rcu_dereference_protected(*opt_ptr, 1);
1982 if (!opt || opt->opt.cipso == 0)
1984 if (opt->opt.srr || opt->opt.rr || opt->opt.ts || opt->opt.router_alert) {
1987 unsigned char *cipso_ptr;
1991 cipso_off = opt->opt.cipso - sizeof(struct iphdr);
1992 cipso_ptr = &opt->opt.__data[cipso_off];
1993 cipso_len = cipso_ptr[1];
1995 if (opt->opt.srr > opt->opt.cipso)
1996 opt->opt.srr -= cipso_len;
1997 if (opt->opt.rr > opt->opt.cipso)
1998 opt->opt.rr -= cipso_len;
1999 if (opt->opt.ts > opt->opt.cipso)
2000 opt->opt.ts -= cipso_len;
2001 if (opt->opt.router_alert > opt->opt.cipso)
2002 opt->opt.router_alert -= cipso_len;
2005 memmove(cipso_ptr, cipso_ptr + cipso_len,
2006 opt->opt.optlen - cipso_off - cipso_len);
2008 /* determining the new total option length is tricky because of
2009 * the padding necessary, the only thing i can think to do at
2010 * this point is walk the options one-by-one, skipping the
2011 * padding at the end to determine the actual option size and
2012 * from there we can determine the new total option length */
2015 while (iter < opt->opt.optlen)
2016 if (opt->opt.__data[iter] != IPOPT_NOP) {
2017 iter += opt->opt.__data[iter + 1];
2021 hdr_delta = opt->opt.optlen;
2022 opt->opt.optlen = (optlen_new + 3) & ~3;
2023 hdr_delta -= opt->opt.optlen;
2025 /* only the cipso option was present on the socket so we can
2026 * remove the entire option struct */
2028 hdr_delta = opt->opt.optlen;
2029 kfree_rcu(opt, rcu);
2036 * cipso_v4_sock_delattr - Delete the CIPSO option from a socket
2040 * Removes the CIPSO option from a socket, if present.
2043 void cipso_v4_sock_delattr(struct sock *sk)
2045 struct inet_sock *sk_inet;
2048 sk_inet = inet_sk(sk);
2050 hdr_delta = cipso_v4_delopt(&sk_inet->inet_opt);
2051 if (inet_test_bit(IS_ICSK, sk) && hdr_delta > 0) {
2052 struct inet_connection_sock *sk_conn = inet_csk(sk);
2053 sk_conn->icsk_ext_hdr_len -= hdr_delta;
2054 sk_conn->icsk_sync_mss(sk, sk_conn->icsk_pmtu_cookie);
2059 * cipso_v4_req_delattr - Delete the CIPSO option from a request socket
2060 * @req: the request socket
2063 * Removes the CIPSO option from a request socket, if present.
2066 void cipso_v4_req_delattr(struct request_sock *req)
2068 cipso_v4_delopt(&inet_rsk(req)->ireq_opt);
2072 * cipso_v4_getattr - Helper function for the cipso_v4_*_getattr functions
2073 * @cipso: the CIPSO v4 option
2074 * @secattr: the security attributes
2077 * Inspect @cipso and return the security attributes in @secattr. Returns zero
2078 * on success and negative values on failure.
2081 int cipso_v4_getattr(const unsigned char *cipso,
2082 struct netlbl_lsm_secattr *secattr)
2084 int ret_val = -ENOMSG;
2086 struct cipso_v4_doi *doi_def;
2088 if (cipso_v4_cache_check(cipso, cipso[1], secattr) == 0)
2091 doi = get_unaligned_be32(&cipso[2]);
2093 doi_def = cipso_v4_doi_search(doi);
2095 goto getattr_return;
2096 /* XXX - This code assumes only one tag per CIPSO option which isn't
2097 * really a good assumption to make but since we only support the MAC
2098 * tags right now it is a safe assumption. */
2100 case CIPSO_V4_TAG_RBITMAP:
2101 ret_val = cipso_v4_parsetag_rbm(doi_def, &cipso[6], secattr);
2103 case CIPSO_V4_TAG_ENUM:
2104 ret_val = cipso_v4_parsetag_enum(doi_def, &cipso[6], secattr);
2106 case CIPSO_V4_TAG_RANGE:
2107 ret_val = cipso_v4_parsetag_rng(doi_def, &cipso[6], secattr);
2109 case CIPSO_V4_TAG_LOCAL:
2110 ret_val = cipso_v4_parsetag_loc(doi_def, &cipso[6], secattr);
2114 secattr->type = NETLBL_NLTYPE_CIPSOV4;
2122 * cipso_v4_sock_getattr - Get the security attributes from a sock
2124 * @secattr: the security attributes
2127 * Query @sk to see if there is a CIPSO option attached to the sock and if
2128 * there is return the CIPSO security attributes in @secattr. This function
2129 * requires that @sk be locked, or privately held, but it does not do any
2130 * locking itself. Returns zero on success and negative values on failure.
2133 int cipso_v4_sock_getattr(struct sock *sk, struct netlbl_lsm_secattr *secattr)
2135 struct ip_options_rcu *opt;
2139 opt = rcu_dereference(inet_sk(sk)->inet_opt);
2140 if (opt && opt->opt.cipso)
2141 res = cipso_v4_getattr(opt->opt.__data +
2143 sizeof(struct iphdr),
2150 * cipso_v4_skbuff_setattr - Set the CIPSO option on a packet
2152 * @doi_def: the DOI structure
2153 * @secattr: the security attributes
2156 * Set the CIPSO option on the given packet based on the security attributes.
2157 * Returns a pointer to the IP header on success and NULL on failure.
2160 int cipso_v4_skbuff_setattr(struct sk_buff *skb,
2161 const struct cipso_v4_doi *doi_def,
2162 const struct netlbl_lsm_secattr *secattr)
2166 struct ip_options *opt = &IPCB(skb)->opt;
2167 unsigned char buf[CIPSO_V4_OPT_LEN_MAX];
2168 u32 buf_len = CIPSO_V4_OPT_LEN_MAX;
2172 ret_val = cipso_v4_genopt(buf, buf_len, doi_def, secattr);
2176 opt_len = (buf_len + 3) & ~3;
2178 /* we overwrite any existing options to ensure that we have enough
2179 * room for the CIPSO option, the reason is that we _need_ to guarantee
2180 * that the security label is applied to the packet - we do the same
2181 * thing when using the socket options and it hasn't caused a problem,
2182 * if we need to we can always revisit this choice later */
2184 len_delta = opt_len - opt->optlen;
2185 /* if we don't ensure enough headroom we could panic on the skb_push()
2186 * call below so make sure we have enough, we are also "mangling" the
2187 * packet so we should probably do a copy-on-write call anyway */
2188 ret_val = skb_cow(skb, skb_headroom(skb) + len_delta);
2192 if (len_delta > 0) {
2193 /* we assume that the header + opt->optlen have already been
2194 * "pushed" in ip_options_build() or similar */
2196 skb_push(skb, len_delta);
2197 memmove((char *)iph - len_delta, iph, iph->ihl << 2);
2198 skb_reset_network_header(skb);
2200 } else if (len_delta < 0) {
2202 memset(iph + 1, IPOPT_NOP, opt->optlen);
2206 if (opt->optlen > 0)
2207 memset(opt, 0, sizeof(*opt));
2208 opt->optlen = opt_len;
2209 opt->cipso = sizeof(struct iphdr);
2210 opt->is_changed = 1;
2212 /* we have to do the following because we are being called from a
2213 * netfilter hook which means the packet already has had the header
2214 * fields populated and the checksum calculated - yes this means we
2215 * are doing more work than needed but we do it to keep the core
2216 * stack clean and tidy */
2217 memcpy(iph + 1, buf, buf_len);
2218 if (opt_len > buf_len)
2219 memset((char *)(iph + 1) + buf_len, 0, opt_len - buf_len);
2220 if (len_delta != 0) {
2221 iph->ihl = 5 + (opt_len >> 2);
2222 iph_set_totlen(iph, skb->len);
2230 * cipso_v4_skbuff_delattr - Delete any CIPSO options from a packet
2234 * Removes any and all CIPSO options from the given packet. Returns zero on
2235 * success, negative values on failure.
2238 int cipso_v4_skbuff_delattr(struct sk_buff *skb)
2242 struct ip_options *opt = &IPCB(skb)->opt;
2243 unsigned char *cipso_ptr;
2245 if (opt->cipso == 0)
2248 /* since we are changing the packet we should make a copy */
2249 ret_val = skb_cow(skb, skb_headroom(skb));
2253 /* the easiest thing to do is just replace the cipso option with noop
2254 * options since we don't change the size of the packet, although we
2255 * still need to recalculate the checksum */
2258 cipso_ptr = (unsigned char *)iph + opt->cipso;
2259 memset(cipso_ptr, IPOPT_NOOP, cipso_ptr[1]);
2261 opt->is_changed = 1;
2273 * cipso_v4_init - Initialize the CIPSO module
2276 * Initialize the CIPSO module and prepare it for use. Returns zero on success
2277 * and negative values on failure.
2280 static int __init cipso_v4_init(void)
2284 ret_val = cipso_v4_cache_init();
2286 panic("Failed to initialize the CIPSO/IPv4 cache (%d)\n",
2292 subsys_initcall(cipso_v4_init);