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 * http://tools.ietf.org/id/draft-ietf-cipso-ipsecurity-01.txt
14 * The FIPS-188 specification can be found at the following URL:
15 * http://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
= 0;
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. Returns zero on
191 * success and negative values on failure.
194 void cipso_v4_cache_invalidate(void)
196 struct cipso_v4_map_cache_entry
*entry
, *tmp_entry
;
199 for (iter
= 0; iter
< CIPSO_V4_CACHE_BUCKETS
; iter
++) {
200 spin_lock_bh(&cipso_v4_cache
[iter
].lock
);
201 list_for_each_entry_safe(entry
,
203 &cipso_v4_cache
[iter
].list
, list
) {
204 list_del(&entry
->list
);
205 cipso_v4_cache_entry_free(entry
);
207 cipso_v4_cache
[iter
].size
= 0;
208 spin_unlock_bh(&cipso_v4_cache
[iter
].lock
);
213 * cipso_v4_cache_check - Check the CIPSO cache for a label mapping
214 * @key: the buffer to check
215 * @key_len: buffer length in bytes
216 * @secattr: the security attribute struct to use
219 * This function checks the cache to see if a label mapping already exists for
220 * the given key. If there is a match then the cache is adjusted and the
221 * @secattr struct is populated with the correct LSM security attributes. The
222 * cache is adjusted in the following manner if the entry is not already the
223 * first in the cache bucket:
225 * 1. The cache entry's activity counter is incremented
226 * 2. The previous (higher ranking) entry's activity counter is decremented
227 * 3. If the difference between the two activity counters is geater than
228 * CIPSO_V4_CACHE_REORDERLIMIT the two entries are swapped
230 * Returns zero on success, -ENOENT for a cache miss, and other negative values
234 static int cipso_v4_cache_check(const unsigned char *key
,
236 struct netlbl_lsm_secattr
*secattr
)
239 struct cipso_v4_map_cache_entry
*entry
;
240 struct cipso_v4_map_cache_entry
*prev_entry
= NULL
;
243 if (!cipso_v4_cache_enabled
)
246 hash
= cipso_v4_map_cache_hash(key
, key_len
);
247 bkt
= hash
& (CIPSO_V4_CACHE_BUCKETS
- 1);
248 spin_lock_bh(&cipso_v4_cache
[bkt
].lock
);
249 list_for_each_entry(entry
, &cipso_v4_cache
[bkt
].list
, list
) {
250 if (entry
->hash
== hash
&&
251 entry
->key_len
== key_len
&&
252 memcmp(entry
->key
, key
, key_len
) == 0) {
253 entry
->activity
+= 1;
254 refcount_inc(&entry
->lsm_data
->refcount
);
255 secattr
->cache
= entry
->lsm_data
;
256 secattr
->flags
|= NETLBL_SECATTR_CACHE
;
257 secattr
->type
= NETLBL_NLTYPE_CIPSOV4
;
259 spin_unlock_bh(&cipso_v4_cache
[bkt
].lock
);
263 if (prev_entry
->activity
> 0)
264 prev_entry
->activity
-= 1;
265 if (entry
->activity
> prev_entry
->activity
&&
266 entry
->activity
- prev_entry
->activity
>
267 CIPSO_V4_CACHE_REORDERLIMIT
) {
268 __list_del(entry
->list
.prev
, entry
->list
.next
);
269 __list_add(&entry
->list
,
270 prev_entry
->list
.prev
,
274 spin_unlock_bh(&cipso_v4_cache
[bkt
].lock
);
279 spin_unlock_bh(&cipso_v4_cache
[bkt
].lock
);
285 * cipso_v4_cache_add - Add an entry to the CIPSO cache
287 * @secattr: the packet's security attributes
290 * Add a new entry into the CIPSO label mapping cache. Add the new entry to
291 * head of the cache bucket's list, if the cache bucket is out of room remove
292 * the last entry in the list first. It is important to note that there is
293 * currently no checking for duplicate keys. Returns zero on success,
294 * negative values on failure.
297 int cipso_v4_cache_add(const unsigned char *cipso_ptr
,
298 const struct netlbl_lsm_secattr
*secattr
)
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 (!cipso_v4_cache_enabled
|| cipso_v4_cache_bucketsize
<= 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
< cipso_v4_cache_bucketsize
) {
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
);
481 * cipso_v4_doi_free_rcu - Frees a DOI definition via the RCU pointer
482 * @entry: the entry's RCU field
485 * This function is designed to be used as a callback to the call_rcu()
486 * function so that the memory allocated to the DOI definition can be released
490 static void cipso_v4_doi_free_rcu(struct rcu_head
*entry
)
492 struct cipso_v4_doi
*doi_def
;
494 doi_def
= container_of(entry
, struct cipso_v4_doi
, rcu
);
495 cipso_v4_doi_free(doi_def
);
499 * cipso_v4_doi_remove - Remove an existing DOI from the CIPSO protocol engine
500 * @doi: the DOI value
501 * @audit_secid: the LSM secid to use in the audit message
504 * Removes a DOI definition from the CIPSO engine. The NetLabel routines will
505 * be called to release their own LSM domain mappings as well as our own
506 * domain list. Returns zero on success and negative values on failure.
509 int cipso_v4_doi_remove(u32 doi
, struct netlbl_audit
*audit_info
)
512 struct cipso_v4_doi
*doi_def
;
513 struct audit_buffer
*audit_buf
;
515 spin_lock(&cipso_v4_doi_list_lock
);
516 doi_def
= cipso_v4_doi_search(doi
);
518 spin_unlock(&cipso_v4_doi_list_lock
);
520 goto doi_remove_return
;
522 if (!refcount_dec_and_test(&doi_def
->refcount
)) {
523 spin_unlock(&cipso_v4_doi_list_lock
);
525 goto doi_remove_return
;
527 list_del_rcu(&doi_def
->list
);
528 spin_unlock(&cipso_v4_doi_list_lock
);
530 cipso_v4_cache_invalidate();
531 call_rcu(&doi_def
->rcu
, cipso_v4_doi_free_rcu
);
535 audit_buf
= netlbl_audit_start(AUDIT_MAC_CIPSOV4_DEL
, audit_info
);
537 audit_log_format(audit_buf
,
538 " cipso_doi=%u res=%u",
539 doi
, ret_val
== 0 ? 1 : 0);
540 audit_log_end(audit_buf
);
547 * cipso_v4_doi_getdef - Returns a reference to a valid DOI definition
548 * @doi: the DOI value
551 * Searches for a valid DOI definition and if one is found it is returned to
552 * the caller. Otherwise NULL is returned. The caller must ensure that
553 * rcu_read_lock() is held while accessing the returned definition and the DOI
554 * definition reference count is decremented when the caller is done.
557 struct cipso_v4_doi
*cipso_v4_doi_getdef(u32 doi
)
559 struct cipso_v4_doi
*doi_def
;
562 doi_def
= cipso_v4_doi_search(doi
);
564 goto doi_getdef_return
;
565 if (!refcount_inc_not_zero(&doi_def
->refcount
))
574 * cipso_v4_doi_putdef - Releases a reference for the given DOI definition
575 * @doi_def: the DOI definition
578 * Releases a DOI definition reference obtained from cipso_v4_doi_getdef().
581 void cipso_v4_doi_putdef(struct cipso_v4_doi
*doi_def
)
586 if (!refcount_dec_and_test(&doi_def
->refcount
))
588 spin_lock(&cipso_v4_doi_list_lock
);
589 list_del_rcu(&doi_def
->list
);
590 spin_unlock(&cipso_v4_doi_list_lock
);
592 cipso_v4_cache_invalidate();
593 call_rcu(&doi_def
->rcu
, cipso_v4_doi_free_rcu
);
597 * cipso_v4_doi_walk - Iterate through the DOI definitions
598 * @skip_cnt: skip past this number of DOI definitions, updated
599 * @callback: callback for each DOI definition
600 * @cb_arg: argument for the callback function
603 * Iterate over the DOI definition list, skipping the first @skip_cnt entries.
604 * For each entry call @callback, if @callback returns a negative value stop
605 * 'walking' through the list and return. Updates the value in @skip_cnt upon
606 * return. Returns zero on success, negative values on failure.
609 int cipso_v4_doi_walk(u32
*skip_cnt
,
610 int (*callback
) (struct cipso_v4_doi
*doi_def
, void *arg
),
613 int ret_val
= -ENOENT
;
615 struct cipso_v4_doi
*iter_doi
;
618 list_for_each_entry_rcu(iter_doi
, &cipso_v4_doi_list
, list
)
619 if (refcount_read(&iter_doi
->refcount
) > 0) {
620 if (doi_cnt
++ < *skip_cnt
)
622 ret_val
= callback(iter_doi
, cb_arg
);
625 goto doi_walk_return
;
636 * Label Mapping Functions
640 * cipso_v4_map_lvl_valid - Checks to see if the given level is understood
641 * @doi_def: the DOI definition
642 * @level: the level to check
645 * Checks the given level against the given DOI definition and returns a
646 * negative value if the level does not have a valid mapping and a zero value
647 * if the level is defined by the DOI.
650 static int cipso_v4_map_lvl_valid(const struct cipso_v4_doi
*doi_def
, u8 level
)
652 switch (doi_def
->type
) {
653 case CIPSO_V4_MAP_PASS
:
655 case CIPSO_V4_MAP_TRANS
:
656 if ((level
< doi_def
->map
.std
->lvl
.cipso_size
) &&
657 (doi_def
->map
.std
->lvl
.cipso
[level
] < CIPSO_V4_INV_LVL
))
666 * cipso_v4_map_lvl_hton - Perform a level mapping from the host to the network
667 * @doi_def: the DOI definition
668 * @host_lvl: the host MLS level
669 * @net_lvl: the network/CIPSO MLS level
672 * Perform a label mapping to translate a local MLS level to the correct
673 * CIPSO level using the given DOI definition. Returns zero on success,
674 * negative values otherwise.
677 static int cipso_v4_map_lvl_hton(const struct cipso_v4_doi
*doi_def
,
681 switch (doi_def
->type
) {
682 case CIPSO_V4_MAP_PASS
:
685 case CIPSO_V4_MAP_TRANS
:
686 if (host_lvl
< doi_def
->map
.std
->lvl
.local_size
&&
687 doi_def
->map
.std
->lvl
.local
[host_lvl
] < CIPSO_V4_INV_LVL
) {
688 *net_lvl
= doi_def
->map
.std
->lvl
.local
[host_lvl
];
698 * cipso_v4_map_lvl_ntoh - Perform a level mapping from the network to the host
699 * @doi_def: the DOI definition
700 * @net_lvl: the network/CIPSO MLS level
701 * @host_lvl: the host MLS level
704 * Perform a label mapping to translate a CIPSO level to the correct local MLS
705 * level using the given DOI definition. Returns zero on success, negative
709 static int cipso_v4_map_lvl_ntoh(const struct cipso_v4_doi
*doi_def
,
713 struct cipso_v4_std_map_tbl
*map_tbl
;
715 switch (doi_def
->type
) {
716 case CIPSO_V4_MAP_PASS
:
719 case CIPSO_V4_MAP_TRANS
:
720 map_tbl
= doi_def
->map
.std
;
721 if (net_lvl
< map_tbl
->lvl
.cipso_size
&&
722 map_tbl
->lvl
.cipso
[net_lvl
] < CIPSO_V4_INV_LVL
) {
723 *host_lvl
= doi_def
->map
.std
->lvl
.cipso
[net_lvl
];
733 * cipso_v4_map_cat_rbm_valid - Checks to see if the category bitmap is valid
734 * @doi_def: the DOI definition
735 * @bitmap: category bitmap
736 * @bitmap_len: bitmap length in bytes
739 * Checks the given category bitmap against the given DOI definition and
740 * returns a negative value if any of the categories in the bitmap do not have
741 * a valid mapping and a zero value if all of the categories are valid.
744 static int cipso_v4_map_cat_rbm_valid(const struct cipso_v4_doi
*doi_def
,
745 const unsigned char *bitmap
,
749 u32 bitmap_len_bits
= bitmap_len
* 8;
753 switch (doi_def
->type
) {
754 case CIPSO_V4_MAP_PASS
:
756 case CIPSO_V4_MAP_TRANS
:
757 cipso_cat_size
= doi_def
->map
.std
->cat
.cipso_size
;
758 cipso_array
= doi_def
->map
.std
->cat
.cipso
;
760 cat
= netlbl_bitmap_walk(bitmap
,
766 if (cat
>= cipso_cat_size
||
767 cipso_array
[cat
] >= CIPSO_V4_INV_CAT
)
780 * cipso_v4_map_cat_rbm_hton - Perform a category mapping from host to network
781 * @doi_def: the DOI definition
782 * @secattr: the security attributes
783 * @net_cat: the zero'd out category bitmap in network/CIPSO format
784 * @net_cat_len: the length of the CIPSO bitmap in bytes
787 * Perform a label mapping to translate a local MLS category bitmap to the
788 * correct CIPSO bitmap using the given DOI definition. Returns the minimum
789 * size in bytes of the network bitmap on success, negative values otherwise.
792 static int cipso_v4_map_cat_rbm_hton(const struct cipso_v4_doi
*doi_def
,
793 const struct netlbl_lsm_secattr
*secattr
,
794 unsigned char *net_cat
,
798 u32 net_spot
= CIPSO_V4_INV_CAT
;
799 u32 net_spot_max
= 0;
800 u32 net_clen_bits
= net_cat_len
* 8;
801 u32 host_cat_size
= 0;
802 u32
*host_cat_array
= NULL
;
804 if (doi_def
->type
== CIPSO_V4_MAP_TRANS
) {
805 host_cat_size
= doi_def
->map
.std
->cat
.local_size
;
806 host_cat_array
= doi_def
->map
.std
->cat
.local
;
810 host_spot
= netlbl_catmap_walk(secattr
->attr
.mls
.cat
,
815 switch (doi_def
->type
) {
816 case CIPSO_V4_MAP_PASS
:
817 net_spot
= host_spot
;
819 case CIPSO_V4_MAP_TRANS
:
820 if (host_spot
>= host_cat_size
)
822 net_spot
= host_cat_array
[host_spot
];
823 if (net_spot
>= CIPSO_V4_INV_CAT
)
827 if (net_spot
>= net_clen_bits
)
829 netlbl_bitmap_setbit(net_cat
, net_spot
, 1);
831 if (net_spot
> net_spot_max
)
832 net_spot_max
= net_spot
;
835 if (++net_spot_max
% 8)
836 return net_spot_max
/ 8 + 1;
837 return net_spot_max
/ 8;
841 * cipso_v4_map_cat_rbm_ntoh - Perform a category mapping from network to host
842 * @doi_def: the DOI definition
843 * @net_cat: the category bitmap in network/CIPSO format
844 * @net_cat_len: the length of the CIPSO bitmap in bytes
845 * @secattr: the security attributes
848 * Perform a label mapping to translate a CIPSO bitmap to the correct local
849 * MLS category bitmap using the given DOI definition. Returns zero on
850 * success, negative values on failure.
853 static int cipso_v4_map_cat_rbm_ntoh(const struct cipso_v4_doi
*doi_def
,
854 const unsigned char *net_cat
,
856 struct netlbl_lsm_secattr
*secattr
)
860 u32 host_spot
= CIPSO_V4_INV_CAT
;
861 u32 net_clen_bits
= net_cat_len
* 8;
862 u32 net_cat_size
= 0;
863 u32
*net_cat_array
= NULL
;
865 if (doi_def
->type
== CIPSO_V4_MAP_TRANS
) {
866 net_cat_size
= doi_def
->map
.std
->cat
.cipso_size
;
867 net_cat_array
= doi_def
->map
.std
->cat
.cipso
;
871 net_spot
= netlbl_bitmap_walk(net_cat
,
881 switch (doi_def
->type
) {
882 case CIPSO_V4_MAP_PASS
:
883 host_spot
= net_spot
;
885 case CIPSO_V4_MAP_TRANS
:
886 if (net_spot
>= net_cat_size
)
888 host_spot
= net_cat_array
[net_spot
];
889 if (host_spot
>= CIPSO_V4_INV_CAT
)
893 ret_val
= netlbl_catmap_setbit(&secattr
->attr
.mls
.cat
,
904 * cipso_v4_map_cat_enum_valid - Checks to see if the categories are valid
905 * @doi_def: the DOI definition
906 * @enumcat: category list
907 * @enumcat_len: length of the category list in bytes
910 * Checks the given categories against the given DOI definition and returns a
911 * negative value if any of the categories do not have a valid mapping and a
912 * zero value if all of the categories are valid.
915 static int cipso_v4_map_cat_enum_valid(const struct cipso_v4_doi
*doi_def
,
916 const unsigned char *enumcat
,
923 if (doi_def
->type
!= CIPSO_V4_MAP_PASS
|| enumcat_len
& 0x01)
926 for (iter
= 0; iter
< enumcat_len
; iter
+= 2) {
927 cat
= get_unaligned_be16(&enumcat
[iter
]);
937 * cipso_v4_map_cat_enum_hton - Perform a category mapping from host to network
938 * @doi_def: the DOI definition
939 * @secattr: the security attributes
940 * @net_cat: the zero'd out category list in network/CIPSO format
941 * @net_cat_len: the length of the CIPSO category list in bytes
944 * Perform a label mapping to translate a local MLS category bitmap to the
945 * correct CIPSO category list using the given DOI definition. Returns the
946 * size in bytes of the network category bitmap on success, negative values
950 static int cipso_v4_map_cat_enum_hton(const struct cipso_v4_doi
*doi_def
,
951 const struct netlbl_lsm_secattr
*secattr
,
952 unsigned char *net_cat
,
959 cat
= netlbl_catmap_walk(secattr
->attr
.mls
.cat
, cat
+ 1);
962 if ((cat_iter
+ 2) > net_cat_len
)
965 *((__be16
*)&net_cat
[cat_iter
]) = htons(cat
);
973 * cipso_v4_map_cat_enum_ntoh - Perform a category mapping from network to host
974 * @doi_def: the DOI definition
975 * @net_cat: the category list in network/CIPSO format
976 * @net_cat_len: the length of the CIPSO bitmap in bytes
977 * @secattr: the security attributes
980 * Perform a label mapping to translate a CIPSO category list to the correct
981 * local MLS category bitmap using the given DOI definition. Returns zero on
982 * success, negative values on failure.
985 static int cipso_v4_map_cat_enum_ntoh(const struct cipso_v4_doi
*doi_def
,
986 const unsigned char *net_cat
,
988 struct netlbl_lsm_secattr
*secattr
)
993 for (iter
= 0; iter
< net_cat_len
; iter
+= 2) {
994 ret_val
= netlbl_catmap_setbit(&secattr
->attr
.mls
.cat
,
995 get_unaligned_be16(&net_cat
[iter
]),
1005 * cipso_v4_map_cat_rng_valid - Checks to see if the categories are valid
1006 * @doi_def: the DOI definition
1007 * @rngcat: category list
1008 * @rngcat_len: length of the category list in bytes
1011 * Checks the given categories against the given DOI definition and returns a
1012 * negative value if any of the categories do not have a valid mapping and a
1013 * zero value if all of the categories are valid.
1016 static int cipso_v4_map_cat_rng_valid(const struct cipso_v4_doi
*doi_def
,
1017 const unsigned char *rngcat
,
1022 u32 cat_prev
= CIPSO_V4_MAX_REM_CATS
+ 1;
1025 if (doi_def
->type
!= CIPSO_V4_MAP_PASS
|| rngcat_len
& 0x01)
1028 for (iter
= 0; iter
< rngcat_len
; iter
+= 4) {
1029 cat_high
= get_unaligned_be16(&rngcat
[iter
]);
1030 if ((iter
+ 4) <= rngcat_len
)
1031 cat_low
= get_unaligned_be16(&rngcat
[iter
+ 2]);
1035 if (cat_high
> cat_prev
)
1045 * cipso_v4_map_cat_rng_hton - Perform a category mapping from host to network
1046 * @doi_def: the DOI definition
1047 * @secattr: the security attributes
1048 * @net_cat: the zero'd out category list in network/CIPSO format
1049 * @net_cat_len: the length of the CIPSO category list in bytes
1052 * Perform a label mapping to translate a local MLS category bitmap to the
1053 * correct CIPSO category list using the given DOI definition. Returns the
1054 * size in bytes of the network category bitmap on success, negative values
1058 static int cipso_v4_map_cat_rng_hton(const struct cipso_v4_doi
*doi_def
,
1059 const struct netlbl_lsm_secattr
*secattr
,
1060 unsigned char *net_cat
,
1064 u16 array
[CIPSO_V4_TAG_RNG_CAT_MAX
* 2];
1068 /* make sure we don't overflow the 'array[]' variable */
1070 (CIPSO_V4_OPT_LEN_MAX
- CIPSO_V4_HDR_LEN
- CIPSO_V4_TAG_RNG_BLEN
))
1074 iter
= netlbl_catmap_walk(secattr
->attr
.mls
.cat
, iter
+ 1);
1077 cat_size
+= (iter
== 0 ? 0 : sizeof(u16
));
1078 if (cat_size
> net_cat_len
)
1080 array
[array_cnt
++] = iter
;
1082 iter
= netlbl_catmap_walkrng(secattr
->attr
.mls
.cat
, iter
);
1085 cat_size
+= sizeof(u16
);
1086 if (cat_size
> net_cat_len
)
1088 array
[array_cnt
++] = iter
;
1091 for (iter
= 0; array_cnt
> 0;) {
1092 *((__be16
*)&net_cat
[iter
]) = htons(array
[--array_cnt
]);
1095 if (array
[array_cnt
] != 0) {
1096 *((__be16
*)&net_cat
[iter
]) = htons(array
[array_cnt
]);
1105 * cipso_v4_map_cat_rng_ntoh - Perform a category mapping from network to host
1106 * @doi_def: the DOI definition
1107 * @net_cat: the category list in network/CIPSO format
1108 * @net_cat_len: the length of the CIPSO bitmap in bytes
1109 * @secattr: the security attributes
1112 * Perform a label mapping to translate a CIPSO category list to the correct
1113 * local MLS category bitmap using the given DOI definition. Returns zero on
1114 * success, negative values on failure.
1117 static int cipso_v4_map_cat_rng_ntoh(const struct cipso_v4_doi
*doi_def
,
1118 const unsigned char *net_cat
,
1120 struct netlbl_lsm_secattr
*secattr
)
1127 for (net_iter
= 0; net_iter
< net_cat_len
; net_iter
+= 4) {
1128 cat_high
= get_unaligned_be16(&net_cat
[net_iter
]);
1129 if ((net_iter
+ 4) <= net_cat_len
)
1130 cat_low
= get_unaligned_be16(&net_cat
[net_iter
+ 2]);
1134 ret_val
= netlbl_catmap_setrng(&secattr
->attr
.mls
.cat
,
1146 * Protocol Handling Functions
1150 * cipso_v4_gentag_hdr - Generate a CIPSO option header
1151 * @doi_def: the DOI definition
1152 * @len: the total tag length in bytes, not including this header
1153 * @buf: the CIPSO option buffer
1156 * Write a CIPSO header into the beginning of @buffer.
1159 static void cipso_v4_gentag_hdr(const struct cipso_v4_doi
*doi_def
,
1163 buf
[0] = IPOPT_CIPSO
;
1164 buf
[1] = CIPSO_V4_HDR_LEN
+ len
;
1165 *(__be32
*)&buf
[2] = htonl(doi_def
->doi
);
1169 * cipso_v4_gentag_rbm - Generate a CIPSO restricted bitmap tag (type #1)
1170 * @doi_def: the DOI definition
1171 * @secattr: the security attributes
1172 * @buffer: the option buffer
1173 * @buffer_len: length of buffer in bytes
1176 * Generate a CIPSO option using the restricted bitmap tag, tag type #1. The
1177 * actual buffer length may be larger than the indicated size due to
1178 * translation between host and network category bitmaps. Returns the size of
1179 * the tag on success, negative values on failure.
1182 static int cipso_v4_gentag_rbm(const struct cipso_v4_doi
*doi_def
,
1183 const struct netlbl_lsm_secattr
*secattr
,
1184 unsigned char *buffer
,
1191 if ((secattr
->flags
& NETLBL_SECATTR_MLS_LVL
) == 0)
1194 ret_val
= cipso_v4_map_lvl_hton(doi_def
,
1195 secattr
->attr
.mls
.lvl
,
1200 if (secattr
->flags
& NETLBL_SECATTR_MLS_CAT
) {
1201 ret_val
= cipso_v4_map_cat_rbm_hton(doi_def
,
1208 /* This will send packets using the "optimized" format when
1209 * possible as specified in section 3.4.2.6 of the
1211 if (cipso_v4_rbm_optfmt
&& ret_val
> 0 && ret_val
<= 10)
1214 tag_len
= 4 + ret_val
;
1218 buffer
[0] = CIPSO_V4_TAG_RBITMAP
;
1219 buffer
[1] = tag_len
;
1226 * cipso_v4_parsetag_rbm - Parse a CIPSO restricted bitmap tag
1227 * @doi_def: the DOI definition
1228 * @tag: the CIPSO tag
1229 * @secattr: the security attributes
1232 * Parse a CIPSO restricted bitmap tag (tag type #1) and return the security
1233 * attributes in @secattr. Return zero on success, negatives values on
1237 static int cipso_v4_parsetag_rbm(const struct cipso_v4_doi
*doi_def
,
1238 const unsigned char *tag
,
1239 struct netlbl_lsm_secattr
*secattr
)
1242 u8 tag_len
= tag
[1];
1245 ret_val
= cipso_v4_map_lvl_ntoh(doi_def
, tag
[3], &level
);
1248 secattr
->attr
.mls
.lvl
= level
;
1249 secattr
->flags
|= NETLBL_SECATTR_MLS_LVL
;
1252 ret_val
= cipso_v4_map_cat_rbm_ntoh(doi_def
,
1257 netlbl_catmap_free(secattr
->attr
.mls
.cat
);
1261 secattr
->flags
|= NETLBL_SECATTR_MLS_CAT
;
1268 * cipso_v4_gentag_enum - Generate a CIPSO enumerated tag (type #2)
1269 * @doi_def: the DOI definition
1270 * @secattr: the security attributes
1271 * @buffer: the option buffer
1272 * @buffer_len: length of buffer in bytes
1275 * Generate a CIPSO option using the enumerated tag, tag type #2. Returns the
1276 * size of the tag on success, negative values on failure.
1279 static int cipso_v4_gentag_enum(const struct cipso_v4_doi
*doi_def
,
1280 const struct netlbl_lsm_secattr
*secattr
,
1281 unsigned char *buffer
,
1288 if (!(secattr
->flags
& NETLBL_SECATTR_MLS_LVL
))
1291 ret_val
= cipso_v4_map_lvl_hton(doi_def
,
1292 secattr
->attr
.mls
.lvl
,
1297 if (secattr
->flags
& NETLBL_SECATTR_MLS_CAT
) {
1298 ret_val
= cipso_v4_map_cat_enum_hton(doi_def
,
1305 tag_len
= 4 + ret_val
;
1309 buffer
[0] = CIPSO_V4_TAG_ENUM
;
1310 buffer
[1] = tag_len
;
1317 * cipso_v4_parsetag_enum - Parse a CIPSO enumerated tag
1318 * @doi_def: the DOI definition
1319 * @tag: the CIPSO tag
1320 * @secattr: the security attributes
1323 * Parse a CIPSO enumerated tag (tag type #2) and return the security
1324 * attributes in @secattr. Return zero on success, negatives values on
1328 static int cipso_v4_parsetag_enum(const struct cipso_v4_doi
*doi_def
,
1329 const unsigned char *tag
,
1330 struct netlbl_lsm_secattr
*secattr
)
1333 u8 tag_len
= tag
[1];
1336 ret_val
= cipso_v4_map_lvl_ntoh(doi_def
, tag
[3], &level
);
1339 secattr
->attr
.mls
.lvl
= level
;
1340 secattr
->flags
|= NETLBL_SECATTR_MLS_LVL
;
1343 ret_val
= cipso_v4_map_cat_enum_ntoh(doi_def
,
1348 netlbl_catmap_free(secattr
->attr
.mls
.cat
);
1352 secattr
->flags
|= NETLBL_SECATTR_MLS_CAT
;
1359 * cipso_v4_gentag_rng - Generate a CIPSO ranged tag (type #5)
1360 * @doi_def: the DOI definition
1361 * @secattr: the security attributes
1362 * @buffer: the option buffer
1363 * @buffer_len: length of buffer in bytes
1366 * Generate a CIPSO option using the ranged tag, tag type #5. Returns the
1367 * size of the tag on success, negative values on failure.
1370 static int cipso_v4_gentag_rng(const struct cipso_v4_doi
*doi_def
,
1371 const struct netlbl_lsm_secattr
*secattr
,
1372 unsigned char *buffer
,
1379 if (!(secattr
->flags
& NETLBL_SECATTR_MLS_LVL
))
1382 ret_val
= cipso_v4_map_lvl_hton(doi_def
,
1383 secattr
->attr
.mls
.lvl
,
1388 if (secattr
->flags
& NETLBL_SECATTR_MLS_CAT
) {
1389 ret_val
= cipso_v4_map_cat_rng_hton(doi_def
,
1396 tag_len
= 4 + ret_val
;
1400 buffer
[0] = CIPSO_V4_TAG_RANGE
;
1401 buffer
[1] = tag_len
;
1408 * cipso_v4_parsetag_rng - Parse a CIPSO ranged tag
1409 * @doi_def: the DOI definition
1410 * @tag: the CIPSO tag
1411 * @secattr: the security attributes
1414 * Parse a CIPSO ranged tag (tag type #5) and return the security attributes
1415 * in @secattr. Return zero on success, negatives values on failure.
1418 static int cipso_v4_parsetag_rng(const struct cipso_v4_doi
*doi_def
,
1419 const unsigned char *tag
,
1420 struct netlbl_lsm_secattr
*secattr
)
1423 u8 tag_len
= tag
[1];
1426 ret_val
= cipso_v4_map_lvl_ntoh(doi_def
, tag
[3], &level
);
1429 secattr
->attr
.mls
.lvl
= level
;
1430 secattr
->flags
|= NETLBL_SECATTR_MLS_LVL
;
1433 ret_val
= cipso_v4_map_cat_rng_ntoh(doi_def
,
1438 netlbl_catmap_free(secattr
->attr
.mls
.cat
);
1442 secattr
->flags
|= NETLBL_SECATTR_MLS_CAT
;
1449 * cipso_v4_gentag_loc - Generate a CIPSO local tag (non-standard)
1450 * @doi_def: the DOI definition
1451 * @secattr: the security attributes
1452 * @buffer: the option buffer
1453 * @buffer_len: length of buffer in bytes
1456 * Generate a CIPSO option using the local tag. Returns the size of the tag
1457 * on success, negative values on failure.
1460 static int cipso_v4_gentag_loc(const struct cipso_v4_doi
*doi_def
,
1461 const struct netlbl_lsm_secattr
*secattr
,
1462 unsigned char *buffer
,
1465 if (!(secattr
->flags
& NETLBL_SECATTR_SECID
))
1468 buffer
[0] = CIPSO_V4_TAG_LOCAL
;
1469 buffer
[1] = CIPSO_V4_TAG_LOC_BLEN
;
1470 *(u32
*)&buffer
[2] = secattr
->attr
.secid
;
1472 return CIPSO_V4_TAG_LOC_BLEN
;
1476 * cipso_v4_parsetag_loc - Parse a CIPSO local tag
1477 * @doi_def: the DOI definition
1478 * @tag: the CIPSO tag
1479 * @secattr: the security attributes
1482 * Parse a CIPSO local tag and return the security attributes in @secattr.
1483 * Return zero on success, negatives values on failure.
1486 static int cipso_v4_parsetag_loc(const struct cipso_v4_doi
*doi_def
,
1487 const unsigned char *tag
,
1488 struct netlbl_lsm_secattr
*secattr
)
1490 secattr
->attr
.secid
= *(u32
*)&tag
[2];
1491 secattr
->flags
|= NETLBL_SECATTR_SECID
;
1497 * cipso_v4_optptr - Find the CIPSO option in the packet
1501 * Parse the packet's IP header looking for a CIPSO option. Returns a pointer
1502 * to the start of the CIPSO option on success, NULL if one is not found.
1505 unsigned char *cipso_v4_optptr(const struct sk_buff
*skb
)
1507 const struct iphdr
*iph
= ip_hdr(skb
);
1508 unsigned char *optptr
= (unsigned char *)&(ip_hdr(skb
)[1]);
1512 for (optlen
= iph
->ihl
*4 - sizeof(struct iphdr
); optlen
> 1; ) {
1513 switch (optptr
[0]) {
1522 if (!taglen
|| taglen
> optlen
)
1524 if (optptr
[0] == IPOPT_CIPSO
)
1535 * cipso_v4_validate - Validate a CIPSO option
1536 * @option: the start of the option, on error it is set to point to the error
1539 * This routine is called to validate a CIPSO option, it checks all of the
1540 * fields to ensure that they are at least valid, see the draft snippet below
1541 * for details. If the option is valid then a zero value is returned and
1542 * the value of @option is unchanged. If the option is invalid then a
1543 * non-zero value is returned and @option is adjusted to point to the
1544 * offending portion of the option. From the IETF draft ...
1546 * "If any field within the CIPSO options, such as the DOI identifier, is not
1547 * recognized the IP datagram is discarded and an ICMP 'parameter problem'
1548 * (type 12) is generated and returned. The ICMP code field is set to 'bad
1549 * parameter' (code 0) and the pointer is set to the start of the CIPSO field
1550 * that is unrecognized."
1553 int cipso_v4_validate(const struct sk_buff
*skb
, unsigned char **option
)
1555 unsigned char *opt
= *option
;
1557 unsigned char opt_iter
;
1558 unsigned char err_offset
= 0;
1561 struct cipso_v4_doi
*doi_def
= NULL
;
1564 /* caller already checks for length values that are too large */
1568 goto validate_return
;
1572 doi_def
= cipso_v4_doi_search(get_unaligned_be32(&opt
[2]));
1575 goto validate_return_locked
;
1578 opt_iter
= CIPSO_V4_HDR_LEN
;
1579 tag
= opt
+ opt_iter
;
1580 while (opt_iter
< opt_len
) {
1581 for (tag_iter
= 0; doi_def
->tags
[tag_iter
] != tag
[0];)
1582 if (doi_def
->tags
[tag_iter
] == CIPSO_V4_TAG_INVALID
||
1583 ++tag_iter
== CIPSO_V4_TAG_MAXCNT
) {
1584 err_offset
= opt_iter
;
1585 goto validate_return_locked
;
1588 if (opt_iter
+ 1 == opt_len
) {
1589 err_offset
= opt_iter
;
1590 goto validate_return_locked
;
1593 if (tag_len
> (opt_len
- opt_iter
)) {
1594 err_offset
= opt_iter
+ 1;
1595 goto validate_return_locked
;
1599 case CIPSO_V4_TAG_RBITMAP
:
1600 if (tag_len
< CIPSO_V4_TAG_RBM_BLEN
) {
1601 err_offset
= opt_iter
+ 1;
1602 goto validate_return_locked
;
1605 /* We are already going to do all the verification
1606 * necessary at the socket layer so from our point of
1607 * view it is safe to turn these checks off (and less
1608 * work), however, the CIPSO draft says we should do
1609 * all the CIPSO validations here but it doesn't
1610 * really specify _exactly_ what we need to validate
1611 * ... so, just make it a sysctl tunable. */
1612 if (cipso_v4_rbm_strictvalid
) {
1613 if (cipso_v4_map_lvl_valid(doi_def
,
1615 err_offset
= opt_iter
+ 3;
1616 goto validate_return_locked
;
1618 if (tag_len
> CIPSO_V4_TAG_RBM_BLEN
&&
1619 cipso_v4_map_cat_rbm_valid(doi_def
,
1622 err_offset
= opt_iter
+ 4;
1623 goto validate_return_locked
;
1627 case CIPSO_V4_TAG_ENUM
:
1628 if (tag_len
< CIPSO_V4_TAG_ENUM_BLEN
) {
1629 err_offset
= opt_iter
+ 1;
1630 goto validate_return_locked
;
1633 if (cipso_v4_map_lvl_valid(doi_def
,
1635 err_offset
= opt_iter
+ 3;
1636 goto validate_return_locked
;
1638 if (tag_len
> CIPSO_V4_TAG_ENUM_BLEN
&&
1639 cipso_v4_map_cat_enum_valid(doi_def
,
1642 err_offset
= opt_iter
+ 4;
1643 goto validate_return_locked
;
1646 case CIPSO_V4_TAG_RANGE
:
1647 if (tag_len
< CIPSO_V4_TAG_RNG_BLEN
) {
1648 err_offset
= opt_iter
+ 1;
1649 goto validate_return_locked
;
1652 if (cipso_v4_map_lvl_valid(doi_def
,
1654 err_offset
= opt_iter
+ 3;
1655 goto validate_return_locked
;
1657 if (tag_len
> CIPSO_V4_TAG_RNG_BLEN
&&
1658 cipso_v4_map_cat_rng_valid(doi_def
,
1661 err_offset
= opt_iter
+ 4;
1662 goto validate_return_locked
;
1665 case CIPSO_V4_TAG_LOCAL
:
1666 /* This is a non-standard tag that we only allow for
1667 * local connections, so if the incoming interface is
1668 * not the loopback device drop the packet. Further,
1669 * there is no legitimate reason for setting this from
1670 * userspace so reject it if skb is NULL. */
1671 if (!skb
|| !(skb
->dev
->flags
& IFF_LOOPBACK
)) {
1672 err_offset
= opt_iter
;
1673 goto validate_return_locked
;
1675 if (tag_len
!= CIPSO_V4_TAG_LOC_BLEN
) {
1676 err_offset
= opt_iter
+ 1;
1677 goto validate_return_locked
;
1681 err_offset
= opt_iter
;
1682 goto validate_return_locked
;
1686 opt_iter
+= tag_len
;
1689 validate_return_locked
:
1692 *option
= opt
+ err_offset
;
1697 * cipso_v4_error - Send the correct response for a bad packet
1699 * @error: the error code
1700 * @gateway: CIPSO gateway flag
1703 * Based on the error code given in @error, send an ICMP error message back to
1704 * the originating host. From the IETF draft ...
1706 * "If the contents of the CIPSO [option] are valid but the security label is
1707 * outside of the configured host or port label range, the datagram is
1708 * discarded and an ICMP 'destination unreachable' (type 3) is generated and
1709 * returned. The code field of the ICMP is set to 'communication with
1710 * destination network administratively prohibited' (code 9) or to
1711 * 'communication with destination host administratively prohibited'
1712 * (code 10). The value of the code is dependent on whether the originator
1713 * of the ICMP message is acting as a CIPSO host or a CIPSO gateway. The
1714 * recipient of the ICMP message MUST be able to handle either value. The
1715 * same procedure is performed if a CIPSO [option] can not be added to an
1716 * IP packet because it is too large to fit in the IP options area."
1718 * "If the error is triggered by receipt of an ICMP message, the message is
1719 * discarded and no response is permitted (consistent with general ICMP
1720 * processing rules)."
1723 void cipso_v4_error(struct sk_buff
*skb
, int error
, u32 gateway
)
1725 unsigned char optbuf
[sizeof(struct ip_options
) + 40];
1726 struct ip_options
*opt
= (struct ip_options
*)optbuf
;
1728 if (ip_hdr(skb
)->protocol
== IPPROTO_ICMP
|| error
!= -EACCES
)
1732 * We might be called above the IP layer,
1733 * so we can not use icmp_send and IPCB here.
1736 memset(opt
, 0, sizeof(struct ip_options
));
1737 opt
->optlen
= ip_hdr(skb
)->ihl
*4 - sizeof(struct iphdr
);
1738 if (__ip_options_compile(dev_net(skb
->dev
), opt
, skb
, NULL
))
1742 __icmp_send(skb
, ICMP_DEST_UNREACH
, ICMP_NET_ANO
, 0, opt
);
1744 __icmp_send(skb
, ICMP_DEST_UNREACH
, ICMP_HOST_ANO
, 0, opt
);
1748 * cipso_v4_genopt - Generate a CIPSO option
1749 * @buf: the option buffer
1750 * @buf_len: the size of opt_buf
1751 * @doi_def: the CIPSO DOI to use
1752 * @secattr: the security attributes
1755 * Generate a CIPSO option using the DOI definition and security attributes
1756 * passed to the function. Returns the length of the option on success and
1757 * negative values on failure.
1760 static int cipso_v4_genopt(unsigned char *buf
, u32 buf_len
,
1761 const struct cipso_v4_doi
*doi_def
,
1762 const struct netlbl_lsm_secattr
*secattr
)
1767 if (buf_len
<= CIPSO_V4_HDR_LEN
)
1770 /* XXX - This code assumes only one tag per CIPSO option which isn't
1771 * really a good assumption to make but since we only support the MAC
1772 * tags right now it is a safe assumption. */
1775 memset(buf
, 0, buf_len
);
1776 switch (doi_def
->tags
[iter
]) {
1777 case CIPSO_V4_TAG_RBITMAP
:
1778 ret_val
= cipso_v4_gentag_rbm(doi_def
,
1780 &buf
[CIPSO_V4_HDR_LEN
],
1781 buf_len
- CIPSO_V4_HDR_LEN
);
1783 case CIPSO_V4_TAG_ENUM
:
1784 ret_val
= cipso_v4_gentag_enum(doi_def
,
1786 &buf
[CIPSO_V4_HDR_LEN
],
1787 buf_len
- CIPSO_V4_HDR_LEN
);
1789 case CIPSO_V4_TAG_RANGE
:
1790 ret_val
= cipso_v4_gentag_rng(doi_def
,
1792 &buf
[CIPSO_V4_HDR_LEN
],
1793 buf_len
- CIPSO_V4_HDR_LEN
);
1795 case CIPSO_V4_TAG_LOCAL
:
1796 ret_val
= cipso_v4_gentag_loc(doi_def
,
1798 &buf
[CIPSO_V4_HDR_LEN
],
1799 buf_len
- CIPSO_V4_HDR_LEN
);
1806 } while (ret_val
< 0 &&
1807 iter
< CIPSO_V4_TAG_MAXCNT
&&
1808 doi_def
->tags
[iter
] != CIPSO_V4_TAG_INVALID
);
1811 cipso_v4_gentag_hdr(doi_def
, buf
, ret_val
);
1812 return CIPSO_V4_HDR_LEN
+ ret_val
;
1816 * cipso_v4_sock_setattr - Add a CIPSO option to a socket
1818 * @doi_def: the CIPSO DOI to use
1819 * @secattr: the specific security attributes of the socket
1822 * Set the CIPSO option on the given socket using the DOI definition and
1823 * security attributes passed to the function. This function requires
1824 * exclusive access to @sk, which means it either needs to be in the
1825 * process of being created or locked. Returns zero on success and negative
1826 * values on failure.
1829 int cipso_v4_sock_setattr(struct sock
*sk
,
1830 const struct cipso_v4_doi
*doi_def
,
1831 const struct netlbl_lsm_secattr
*secattr
)
1833 int ret_val
= -EPERM
;
1834 unsigned char *buf
= NULL
;
1837 struct ip_options_rcu
*old
, *opt
= NULL
;
1838 struct inet_sock
*sk_inet
;
1839 struct inet_connection_sock
*sk_conn
;
1841 /* In the case of sock_create_lite(), the sock->sk field is not
1842 * defined yet but it is not a problem as the only users of these
1843 * "lite" PF_INET sockets are functions which do an accept() call
1844 * afterwards so we will label the socket as part of the accept(). */
1848 /* We allocate the maximum CIPSO option size here so we are probably
1849 * being a little wasteful, but it makes our life _much_ easier later
1850 * on and after all we are only talking about 40 bytes. */
1851 buf_len
= CIPSO_V4_OPT_LEN_MAX
;
1852 buf
= kmalloc(buf_len
, GFP_ATOMIC
);
1855 goto socket_setattr_failure
;
1858 ret_val
= cipso_v4_genopt(buf
, buf_len
, doi_def
, secattr
);
1860 goto socket_setattr_failure
;
1863 /* We can't use ip_options_get() directly because it makes a call to
1864 * ip_options_get_alloc() which allocates memory with GFP_KERNEL and
1865 * we won't always have CAP_NET_RAW even though we _always_ want to
1866 * set the IPOPT_CIPSO option. */
1867 opt_len
= (buf_len
+ 3) & ~3;
1868 opt
= kzalloc(sizeof(*opt
) + opt_len
, GFP_ATOMIC
);
1871 goto socket_setattr_failure
;
1873 memcpy(opt
->opt
.__data
, buf
, buf_len
);
1874 opt
->opt
.optlen
= opt_len
;
1875 opt
->opt
.cipso
= sizeof(struct iphdr
);
1879 sk_inet
= inet_sk(sk
);
1881 old
= rcu_dereference_protected(sk_inet
->inet_opt
,
1882 lockdep_sock_is_held(sk
));
1883 if (sk_inet
->is_icsk
) {
1884 sk_conn
= inet_csk(sk
);
1886 sk_conn
->icsk_ext_hdr_len
-= old
->opt
.optlen
;
1887 sk_conn
->icsk_ext_hdr_len
+= opt
->opt
.optlen
;
1888 sk_conn
->icsk_sync_mss(sk
, sk_conn
->icsk_pmtu_cookie
);
1890 rcu_assign_pointer(sk_inet
->inet_opt
, opt
);
1892 kfree_rcu(old
, rcu
);
1896 socket_setattr_failure
:
1903 * cipso_v4_req_setattr - Add a CIPSO option to a connection request socket
1904 * @req: the connection request socket
1905 * @doi_def: the CIPSO DOI to use
1906 * @secattr: the specific security attributes of the socket
1909 * Set the CIPSO option on the given socket using the DOI definition and
1910 * security attributes passed to the function. Returns zero on success and
1911 * negative values on failure.
1914 int cipso_v4_req_setattr(struct request_sock
*req
,
1915 const struct cipso_v4_doi
*doi_def
,
1916 const struct netlbl_lsm_secattr
*secattr
)
1918 int ret_val
= -EPERM
;
1919 unsigned char *buf
= NULL
;
1922 struct ip_options_rcu
*opt
= NULL
;
1923 struct inet_request_sock
*req_inet
;
1925 /* We allocate the maximum CIPSO option size here so we are probably
1926 * being a little wasteful, but it makes our life _much_ easier later
1927 * on and after all we are only talking about 40 bytes. */
1928 buf_len
= CIPSO_V4_OPT_LEN_MAX
;
1929 buf
= kmalloc(buf_len
, GFP_ATOMIC
);
1932 goto req_setattr_failure
;
1935 ret_val
= cipso_v4_genopt(buf
, buf_len
, doi_def
, secattr
);
1937 goto req_setattr_failure
;
1940 /* We can't use ip_options_get() directly because it makes a call to
1941 * ip_options_get_alloc() which allocates memory with GFP_KERNEL and
1942 * we won't always have CAP_NET_RAW even though we _always_ want to
1943 * set the IPOPT_CIPSO option. */
1944 opt_len
= (buf_len
+ 3) & ~3;
1945 opt
= kzalloc(sizeof(*opt
) + opt_len
, GFP_ATOMIC
);
1948 goto req_setattr_failure
;
1950 memcpy(opt
->opt
.__data
, buf
, buf_len
);
1951 opt
->opt
.optlen
= opt_len
;
1952 opt
->opt
.cipso
= sizeof(struct iphdr
);
1956 req_inet
= inet_rsk(req
);
1957 opt
= xchg((__force
struct ip_options_rcu
**)&req_inet
->ireq_opt
, opt
);
1959 kfree_rcu(opt
, rcu
);
1963 req_setattr_failure
:
1970 * cipso_v4_delopt - Delete the CIPSO option from a set of IP options
1971 * @opt_ptr: IP option pointer
1974 * Deletes the CIPSO IP option from a set of IP options and makes the necessary
1975 * adjustments to the IP option structure. Returns zero on success, negative
1976 * values on failure.
1979 static int cipso_v4_delopt(struct ip_options_rcu __rcu
**opt_ptr
)
1981 struct ip_options_rcu
*opt
= rcu_dereference_protected(*opt_ptr
, 1);
1984 if (!opt
|| opt
->opt
.cipso
== 0)
1986 if (opt
->opt
.srr
|| opt
->opt
.rr
|| opt
->opt
.ts
|| opt
->opt
.router_alert
) {
1989 unsigned char *cipso_ptr
;
1993 cipso_off
= opt
->opt
.cipso
- sizeof(struct iphdr
);
1994 cipso_ptr
= &opt
->opt
.__data
[cipso_off
];
1995 cipso_len
= cipso_ptr
[1];
1997 if (opt
->opt
.srr
> opt
->opt
.cipso
)
1998 opt
->opt
.srr
-= cipso_len
;
1999 if (opt
->opt
.rr
> opt
->opt
.cipso
)
2000 opt
->opt
.rr
-= cipso_len
;
2001 if (opt
->opt
.ts
> opt
->opt
.cipso
)
2002 opt
->opt
.ts
-= cipso_len
;
2003 if (opt
->opt
.router_alert
> opt
->opt
.cipso
)
2004 opt
->opt
.router_alert
-= cipso_len
;
2007 memmove(cipso_ptr
, cipso_ptr
+ cipso_len
,
2008 opt
->opt
.optlen
- cipso_off
- cipso_len
);
2010 /* determining the new total option length is tricky because of
2011 * the padding necessary, the only thing i can think to do at
2012 * this point is walk the options one-by-one, skipping the
2013 * padding at the end to determine the actual option size and
2014 * from there we can determine the new total option length */
2017 while (iter
< opt
->opt
.optlen
)
2018 if (opt
->opt
.__data
[iter
] != IPOPT_NOP
) {
2019 iter
+= opt
->opt
.__data
[iter
+ 1];
2023 hdr_delta
= opt
->opt
.optlen
;
2024 opt
->opt
.optlen
= (optlen_new
+ 3) & ~3;
2025 hdr_delta
-= opt
->opt
.optlen
;
2027 /* only the cipso option was present on the socket so we can
2028 * remove the entire option struct */
2030 hdr_delta
= opt
->opt
.optlen
;
2031 kfree_rcu(opt
, rcu
);
2038 * cipso_v4_sock_delattr - Delete the CIPSO option from a socket
2042 * Removes the CIPSO option from a socket, if present.
2045 void cipso_v4_sock_delattr(struct sock
*sk
)
2047 struct inet_sock
*sk_inet
;
2050 sk_inet
= inet_sk(sk
);
2052 hdr_delta
= cipso_v4_delopt(&sk_inet
->inet_opt
);
2053 if (sk_inet
->is_icsk
&& hdr_delta
> 0) {
2054 struct inet_connection_sock
*sk_conn
= inet_csk(sk
);
2055 sk_conn
->icsk_ext_hdr_len
-= hdr_delta
;
2056 sk_conn
->icsk_sync_mss(sk
, sk_conn
->icsk_pmtu_cookie
);
2061 * cipso_v4_req_delattr - Delete the CIPSO option from a request socket
2062 * @reg: the request socket
2065 * Removes the CIPSO option from a request socket, if present.
2068 void cipso_v4_req_delattr(struct request_sock
*req
)
2070 cipso_v4_delopt(&inet_rsk(req
)->ireq_opt
);
2074 * cipso_v4_getattr - Helper function for the cipso_v4_*_getattr functions
2075 * @cipso: the CIPSO v4 option
2076 * @secattr: the security attributes
2079 * Inspect @cipso and return the security attributes in @secattr. Returns zero
2080 * on success and negative values on failure.
2083 int cipso_v4_getattr(const unsigned char *cipso
,
2084 struct netlbl_lsm_secattr
*secattr
)
2086 int ret_val
= -ENOMSG
;
2088 struct cipso_v4_doi
*doi_def
;
2090 if (cipso_v4_cache_check(cipso
, cipso
[1], secattr
) == 0)
2093 doi
= get_unaligned_be32(&cipso
[2]);
2095 doi_def
= cipso_v4_doi_search(doi
);
2097 goto getattr_return
;
2098 /* XXX - This code assumes only one tag per CIPSO option which isn't
2099 * really a good assumption to make but since we only support the MAC
2100 * tags right now it is a safe assumption. */
2102 case CIPSO_V4_TAG_RBITMAP
:
2103 ret_val
= cipso_v4_parsetag_rbm(doi_def
, &cipso
[6], secattr
);
2105 case CIPSO_V4_TAG_ENUM
:
2106 ret_val
= cipso_v4_parsetag_enum(doi_def
, &cipso
[6], secattr
);
2108 case CIPSO_V4_TAG_RANGE
:
2109 ret_val
= cipso_v4_parsetag_rng(doi_def
, &cipso
[6], secattr
);
2111 case CIPSO_V4_TAG_LOCAL
:
2112 ret_val
= cipso_v4_parsetag_loc(doi_def
, &cipso
[6], secattr
);
2116 secattr
->type
= NETLBL_NLTYPE_CIPSOV4
;
2124 * cipso_v4_sock_getattr - Get the security attributes from a sock
2126 * @secattr: the security attributes
2129 * Query @sk to see if there is a CIPSO option attached to the sock and if
2130 * there is return the CIPSO security attributes in @secattr. This function
2131 * requires that @sk be locked, or privately held, but it does not do any
2132 * locking itself. Returns zero on success and negative values on failure.
2135 int cipso_v4_sock_getattr(struct sock
*sk
, struct netlbl_lsm_secattr
*secattr
)
2137 struct ip_options_rcu
*opt
;
2141 opt
= rcu_dereference(inet_sk(sk
)->inet_opt
);
2142 if (opt
&& opt
->opt
.cipso
)
2143 res
= cipso_v4_getattr(opt
->opt
.__data
+
2145 sizeof(struct iphdr
),
2152 * cipso_v4_skbuff_setattr - Set the CIPSO option on a packet
2154 * @secattr: the security attributes
2157 * Set the CIPSO option on the given packet based on the security attributes.
2158 * Returns a pointer to the IP header on success and NULL on failure.
2161 int cipso_v4_skbuff_setattr(struct sk_buff
*skb
,
2162 const struct cipso_v4_doi
*doi_def
,
2163 const struct netlbl_lsm_secattr
*secattr
)
2167 struct ip_options
*opt
= &IPCB(skb
)->opt
;
2168 unsigned char buf
[CIPSO_V4_OPT_LEN_MAX
];
2169 u32 buf_len
= CIPSO_V4_OPT_LEN_MAX
;
2173 ret_val
= cipso_v4_genopt(buf
, buf_len
, doi_def
, secattr
);
2177 opt_len
= (buf_len
+ 3) & ~3;
2179 /* we overwrite any existing options to ensure that we have enough
2180 * room for the CIPSO option, the reason is that we _need_ to guarantee
2181 * that the security label is applied to the packet - we do the same
2182 * thing when using the socket options and it hasn't caused a problem,
2183 * if we need to we can always revisit this choice later */
2185 len_delta
= opt_len
- opt
->optlen
;
2186 /* if we don't ensure enough headroom we could panic on the skb_push()
2187 * call below so make sure we have enough, we are also "mangling" the
2188 * packet so we should probably do a copy-on-write call anyway */
2189 ret_val
= skb_cow(skb
, skb_headroom(skb
) + len_delta
);
2193 if (len_delta
> 0) {
2194 /* we assume that the header + opt->optlen have already been
2195 * "pushed" in ip_options_build() or similar */
2197 skb_push(skb
, len_delta
);
2198 memmove((char *)iph
- len_delta
, iph
, iph
->ihl
<< 2);
2199 skb_reset_network_header(skb
);
2201 } else if (len_delta
< 0) {
2203 memset(iph
+ 1, IPOPT_NOP
, opt
->optlen
);
2207 if (opt
->optlen
> 0)
2208 memset(opt
, 0, sizeof(*opt
));
2209 opt
->optlen
= opt_len
;
2210 opt
->cipso
= sizeof(struct iphdr
);
2211 opt
->is_changed
= 1;
2213 /* we have to do the following because we are being called from a
2214 * netfilter hook which means the packet already has had the header
2215 * fields populated and the checksum calculated - yes this means we
2216 * are doing more work than needed but we do it to keep the core
2217 * stack clean and tidy */
2218 memcpy(iph
+ 1, buf
, buf_len
);
2219 if (opt_len
> buf_len
)
2220 memset((char *)(iph
+ 1) + buf_len
, 0, opt_len
- buf_len
);
2221 if (len_delta
!= 0) {
2222 iph
->ihl
= 5 + (opt_len
>> 2);
2223 iph
->tot_len
= htons(skb
->len
);
2231 * cipso_v4_skbuff_delattr - Delete any CIPSO options from a packet
2235 * Removes any and all CIPSO options from the given packet. Returns zero on
2236 * success, negative values on failure.
2239 int cipso_v4_skbuff_delattr(struct sk_buff
*skb
)
2243 struct ip_options
*opt
= &IPCB(skb
)->opt
;
2244 unsigned char *cipso_ptr
;
2246 if (opt
->cipso
== 0)
2249 /* since we are changing the packet we should make a copy */
2250 ret_val
= skb_cow(skb
, skb_headroom(skb
));
2254 /* the easiest thing to do is just replace the cipso option with noop
2255 * options since we don't change the size of the packet, although we
2256 * still need to recalculate the checksum */
2259 cipso_ptr
= (unsigned char *)iph
+ opt
->cipso
;
2260 memset(cipso_ptr
, IPOPT_NOOP
, cipso_ptr
[1]);
2262 opt
->is_changed
= 1;
2274 * cipso_v4_init - Initialize the CIPSO module
2277 * Initialize the CIPSO module and prepare it for use. Returns zero on success
2278 * and negative values on failure.
2281 static int __init
cipso_v4_init(void)
2285 ret_val
= cipso_v4_cache_init();
2287 panic("Failed to initialize the CIPSO/IPv4 cache (%d)\n",
2293 subsys_initcall(cipso_v4_init
);