2 * CIPSO - Commercial IP Security Option
4 * This is an implementation of the CIPSO 2.2 protocol as specified in
5 * draft-ietf-cipso-ipsecurity-01.txt with additional tag types as found in
6 * FIPS-188. While CIPSO never became a full IETF RFC standard many vendors
7 * have chosen to adopt the protocol and over the years it has become a
8 * de-facto standard for labeled networking.
10 * The CIPSO draft specification can be found in the kernel's Documentation
11 * directory as well as the following URL:
12 * http://netlabel.sourceforge.net/files/draft-ietf-cipso-ipsecurity-01.txt
13 * The FIPS-188 specification can be found at the following URL:
14 * http://www.itl.nist.gov/fipspubs/fip188.htm
16 * Author: Paul Moore <paul.moore@hp.com>
21 * (c) Copyright Hewlett-Packard Development Company, L.P., 2006, 2008
23 * This program is free software; you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation; either version 2 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
31 * the GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program; if not, write to the Free Software
35 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
39 #include <linux/init.h>
40 #include <linux/types.h>
41 #include <linux/rcupdate.h>
42 #include <linux/list.h>
43 #include <linux/spinlock.h>
44 #include <linux/string.h>
45 #include <linux/jhash.h>
46 #include <linux/audit.h>
47 #include <linux/slab.h>
51 #include <net/netlabel.h>
52 #include <net/cipso_ipv4.h>
53 #include <asm/atomic.h>
55 #include <asm/unaligned.h>
57 /* List of available DOI definitions */
58 /* XXX - This currently assumes a minimal number of different DOIs in use,
59 * if in practice there are a lot of different DOIs this list should
60 * probably be turned into a hash table or something similar so we
61 * can do quick lookups. */
62 static DEFINE_SPINLOCK(cipso_v4_doi_list_lock
);
63 static LIST_HEAD(cipso_v4_doi_list
);
65 /* Label mapping cache */
66 int cipso_v4_cache_enabled
= 1;
67 int cipso_v4_cache_bucketsize
= 10;
68 #define CIPSO_V4_CACHE_BUCKETBITS 7
69 #define CIPSO_V4_CACHE_BUCKETS (1 << CIPSO_V4_CACHE_BUCKETBITS)
70 #define CIPSO_V4_CACHE_REORDERLIMIT 10
71 struct cipso_v4_map_cache_bkt
{
74 struct list_head list
;
76 struct cipso_v4_map_cache_entry
{
81 struct netlbl_lsm_cache
*lsm_data
;
84 struct list_head list
;
86 static struct cipso_v4_map_cache_bkt
*cipso_v4_cache
= NULL
;
88 /* Restricted bitmap (tag #1) flags */
89 int cipso_v4_rbm_optfmt
= 0;
90 int cipso_v4_rbm_strictvalid
= 1;
96 /* Maximum size of the CIPSO IP option, derived from the fact that the maximum
97 * IPv4 header size is 60 bytes and the base IPv4 header is 20 bytes long. */
98 #define CIPSO_V4_OPT_LEN_MAX 40
100 /* Length of the base CIPSO option, this includes the option type (1 byte), the
101 * option length (1 byte), and the DOI (4 bytes). */
102 #define CIPSO_V4_HDR_LEN 6
104 /* Base length of the restrictive category bitmap tag (tag #1). */
105 #define CIPSO_V4_TAG_RBM_BLEN 4
107 /* Base length of the enumerated category tag (tag #2). */
108 #define CIPSO_V4_TAG_ENUM_BLEN 4
110 /* Base length of the ranged categories bitmap tag (tag #5). */
111 #define CIPSO_V4_TAG_RNG_BLEN 4
112 /* The maximum number of category ranges permitted in the ranged category tag
113 * (tag #5). You may note that the IETF draft states that the maximum number
114 * of category ranges is 7, but if the low end of the last category range is
115 * zero then it is possibile to fit 8 category ranges because the zero should
117 #define CIPSO_V4_TAG_RNG_CAT_MAX 8
119 /* Base length of the local tag (non-standard tag).
120 * Tag definition (may change between kernel versions)
123 * +----------+----------+----------+----------+
124 * | 10000000 | 00000110 | 32-bit secid value |
125 * +----------+----------+----------+----------+
126 * | in (host byte order)|
127 * +----------+----------+
130 #define CIPSO_V4_TAG_LOC_BLEN 6
137 * cipso_v4_bitmap_walk - Walk a bitmap looking for a bit
138 * @bitmap: the bitmap
139 * @bitmap_len: length in bits
140 * @offset: starting offset
141 * @state: if non-zero, look for a set (1) bit else look for a cleared (0) bit
144 * Starting at @offset, walk the bitmap from left to right until either the
145 * desired bit is found or we reach the end. Return the bit offset, -1 if
146 * not found, or -2 if error.
148 static int cipso_v4_bitmap_walk(const unsigned char *bitmap
,
155 unsigned char bitmask
;
158 /* gcc always rounds to zero when doing integer division */
159 byte_offset
= offset
/ 8;
160 byte
= bitmap
[byte_offset
];
162 bitmask
= 0x80 >> (offset
% 8);
164 while (bit_spot
< bitmap_len
) {
165 if ((state
&& (byte
& bitmask
) == bitmask
) ||
166 (state
== 0 && (byte
& bitmask
) == 0))
172 byte
= bitmap
[++byte_offset
];
181 * cipso_v4_bitmap_setbit - Sets a single bit in a bitmap
182 * @bitmap: the bitmap
184 * @state: if non-zero, set the bit (1) else clear the bit (0)
187 * Set a single bit in the bitmask. Returns zero on success, negative values
190 static void cipso_v4_bitmap_setbit(unsigned char *bitmap
,
197 /* gcc always rounds to zero when doing integer division */
199 bitmask
= 0x80 >> (bit
% 8);
201 bitmap
[byte_spot
] |= bitmask
;
203 bitmap
[byte_spot
] &= ~bitmask
;
207 * cipso_v4_cache_entry_free - Frees a cache entry
208 * @entry: the entry to free
211 * This function frees the memory associated with a cache entry including the
212 * LSM cache data if there are no longer any users, i.e. reference count == 0.
215 static void cipso_v4_cache_entry_free(struct cipso_v4_map_cache_entry
*entry
)
218 netlbl_secattr_cache_free(entry
->lsm_data
);
224 * cipso_v4_map_cache_hash - Hashing function for the CIPSO cache
226 * @key_len: the length of the key in bytes
229 * The CIPSO tag hashing function. Returns a 32-bit hash value.
232 static u32
cipso_v4_map_cache_hash(const unsigned char *key
, u32 key_len
)
234 return jhash(key
, key_len
, 0);
238 * Label Mapping Cache Functions
242 * cipso_v4_cache_init - Initialize the CIPSO cache
245 * Initializes the CIPSO label mapping cache, this function should be called
246 * before any of the other functions defined in this file. Returns zero on
247 * success, negative values on error.
250 static int cipso_v4_cache_init(void)
254 cipso_v4_cache
= kcalloc(CIPSO_V4_CACHE_BUCKETS
,
255 sizeof(struct cipso_v4_map_cache_bkt
),
257 if (cipso_v4_cache
== NULL
)
260 for (iter
= 0; iter
< CIPSO_V4_CACHE_BUCKETS
; iter
++) {
261 spin_lock_init(&cipso_v4_cache
[iter
].lock
);
262 cipso_v4_cache
[iter
].size
= 0;
263 INIT_LIST_HEAD(&cipso_v4_cache
[iter
].list
);
270 * cipso_v4_cache_invalidate - Invalidates the current CIPSO cache
273 * Invalidates and frees any entries in the CIPSO cache. Returns zero on
274 * success and negative values on failure.
277 void cipso_v4_cache_invalidate(void)
279 struct cipso_v4_map_cache_entry
*entry
, *tmp_entry
;
282 for (iter
= 0; iter
< CIPSO_V4_CACHE_BUCKETS
; iter
++) {
283 spin_lock_bh(&cipso_v4_cache
[iter
].lock
);
284 list_for_each_entry_safe(entry
,
286 &cipso_v4_cache
[iter
].list
, list
) {
287 list_del(&entry
->list
);
288 cipso_v4_cache_entry_free(entry
);
290 cipso_v4_cache
[iter
].size
= 0;
291 spin_unlock_bh(&cipso_v4_cache
[iter
].lock
);
296 * cipso_v4_cache_check - Check the CIPSO cache for a label mapping
297 * @key: the buffer to check
298 * @key_len: buffer length in bytes
299 * @secattr: the security attribute struct to use
302 * This function checks the cache to see if a label mapping already exists for
303 * the given key. If there is a match then the cache is adjusted and the
304 * @secattr struct is populated with the correct LSM security attributes. The
305 * cache is adjusted in the following manner if the entry is not already the
306 * first in the cache bucket:
308 * 1. The cache entry's activity counter is incremented
309 * 2. The previous (higher ranking) entry's activity counter is decremented
310 * 3. If the difference between the two activity counters is geater than
311 * CIPSO_V4_CACHE_REORDERLIMIT the two entries are swapped
313 * Returns zero on success, -ENOENT for a cache miss, and other negative values
317 static int cipso_v4_cache_check(const unsigned char *key
,
319 struct netlbl_lsm_secattr
*secattr
)
322 struct cipso_v4_map_cache_entry
*entry
;
323 struct cipso_v4_map_cache_entry
*prev_entry
= NULL
;
326 if (!cipso_v4_cache_enabled
)
329 hash
= cipso_v4_map_cache_hash(key
, key_len
);
330 bkt
= hash
& (CIPSO_V4_CACHE_BUCKETS
- 1);
331 spin_lock_bh(&cipso_v4_cache
[bkt
].lock
);
332 list_for_each_entry(entry
, &cipso_v4_cache
[bkt
].list
, list
) {
333 if (entry
->hash
== hash
&&
334 entry
->key_len
== key_len
&&
335 memcmp(entry
->key
, key
, key_len
) == 0) {
336 entry
->activity
+= 1;
337 atomic_inc(&entry
->lsm_data
->refcount
);
338 secattr
->cache
= entry
->lsm_data
;
339 secattr
->flags
|= NETLBL_SECATTR_CACHE
;
340 secattr
->type
= NETLBL_NLTYPE_CIPSOV4
;
341 if (prev_entry
== NULL
) {
342 spin_unlock_bh(&cipso_v4_cache
[bkt
].lock
);
346 if (prev_entry
->activity
> 0)
347 prev_entry
->activity
-= 1;
348 if (entry
->activity
> prev_entry
->activity
&&
349 entry
->activity
- prev_entry
->activity
>
350 CIPSO_V4_CACHE_REORDERLIMIT
) {
351 __list_del(entry
->list
.prev
, entry
->list
.next
);
352 __list_add(&entry
->list
,
353 prev_entry
->list
.prev
,
357 spin_unlock_bh(&cipso_v4_cache
[bkt
].lock
);
362 spin_unlock_bh(&cipso_v4_cache
[bkt
].lock
);
368 * cipso_v4_cache_add - Add an entry to the CIPSO cache
370 * @secattr: the packet's security attributes
373 * Add a new entry into the CIPSO label mapping cache. Add the new entry to
374 * head of the cache bucket's list, if the cache bucket is out of room remove
375 * the last entry in the list first. It is important to note that there is
376 * currently no checking for duplicate keys. Returns zero on success,
377 * negative values on failure.
380 int cipso_v4_cache_add(const struct sk_buff
*skb
,
381 const struct netlbl_lsm_secattr
*secattr
)
383 int ret_val
= -EPERM
;
385 struct cipso_v4_map_cache_entry
*entry
= NULL
;
386 struct cipso_v4_map_cache_entry
*old_entry
= NULL
;
387 unsigned char *cipso_ptr
;
390 if (!cipso_v4_cache_enabled
|| cipso_v4_cache_bucketsize
<= 0)
393 cipso_ptr
= CIPSO_V4_OPTPTR(skb
);
394 cipso_ptr_len
= cipso_ptr
[1];
396 entry
= kzalloc(sizeof(*entry
), GFP_ATOMIC
);
399 entry
->key
= kmemdup(cipso_ptr
, cipso_ptr_len
, GFP_ATOMIC
);
400 if (entry
->key
== NULL
) {
402 goto cache_add_failure
;
404 entry
->key_len
= cipso_ptr_len
;
405 entry
->hash
= cipso_v4_map_cache_hash(cipso_ptr
, cipso_ptr_len
);
406 atomic_inc(&secattr
->cache
->refcount
);
407 entry
->lsm_data
= secattr
->cache
;
409 bkt
= entry
->hash
& (CIPSO_V4_CACHE_BUCKETS
- 1);
410 spin_lock_bh(&cipso_v4_cache
[bkt
].lock
);
411 if (cipso_v4_cache
[bkt
].size
< cipso_v4_cache_bucketsize
) {
412 list_add(&entry
->list
, &cipso_v4_cache
[bkt
].list
);
413 cipso_v4_cache
[bkt
].size
+= 1;
415 old_entry
= list_entry(cipso_v4_cache
[bkt
].list
.prev
,
416 struct cipso_v4_map_cache_entry
, list
);
417 list_del(&old_entry
->list
);
418 list_add(&entry
->list
, &cipso_v4_cache
[bkt
].list
);
419 cipso_v4_cache_entry_free(old_entry
);
421 spin_unlock_bh(&cipso_v4_cache
[bkt
].lock
);
427 cipso_v4_cache_entry_free(entry
);
436 * cipso_v4_doi_search - Searches for a DOI definition
437 * @doi: the DOI to search for
440 * Search the DOI definition list for a DOI definition with a DOI value that
441 * matches @doi. The caller is responsibile for calling rcu_read_[un]lock().
442 * Returns a pointer to the DOI definition on success and NULL on failure.
444 static struct cipso_v4_doi
*cipso_v4_doi_search(u32 doi
)
446 struct cipso_v4_doi
*iter
;
448 list_for_each_entry_rcu(iter
, &cipso_v4_doi_list
, list
)
449 if (iter
->doi
== doi
&& atomic_read(&iter
->refcount
))
455 * cipso_v4_doi_add - Add a new DOI to the CIPSO protocol engine
456 * @doi_def: the DOI structure
457 * @audit_info: NetLabel audit information
460 * The caller defines a new DOI for use by the CIPSO engine and calls this
461 * function to add it to the list of acceptable domains. The caller must
462 * ensure that the mapping table specified in @doi_def->map meets all of the
463 * requirements of the mapping type (see cipso_ipv4.h for details). Returns
464 * zero on success and non-zero on failure.
467 int cipso_v4_doi_add(struct cipso_v4_doi
*doi_def
,
468 struct netlbl_audit
*audit_info
)
470 int ret_val
= -EINVAL
;
474 struct audit_buffer
*audit_buf
;
477 doi_type
= doi_def
->type
;
479 if (doi_def
== NULL
|| doi_def
->doi
== CIPSO_V4_DOI_UNKNOWN
)
481 for (iter
= 0; iter
< CIPSO_V4_TAG_MAXCNT
; iter
++) {
482 switch (doi_def
->tags
[iter
]) {
483 case CIPSO_V4_TAG_RBITMAP
:
485 case CIPSO_V4_TAG_RANGE
:
486 case CIPSO_V4_TAG_ENUM
:
487 if (doi_def
->type
!= CIPSO_V4_MAP_PASS
)
490 case CIPSO_V4_TAG_LOCAL
:
491 if (doi_def
->type
!= CIPSO_V4_MAP_LOCAL
)
494 case CIPSO_V4_TAG_INVALID
:
503 atomic_set(&doi_def
->refcount
, 1);
505 spin_lock(&cipso_v4_doi_list_lock
);
506 if (cipso_v4_doi_search(doi_def
->doi
) != NULL
) {
507 spin_unlock(&cipso_v4_doi_list_lock
);
511 list_add_tail_rcu(&doi_def
->list
, &cipso_v4_doi_list
);
512 spin_unlock(&cipso_v4_doi_list_lock
);
516 audit_buf
= netlbl_audit_start(AUDIT_MAC_CIPSOV4_ADD
, audit_info
);
517 if (audit_buf
!= NULL
) {
518 const char *type_str
;
520 case CIPSO_V4_MAP_TRANS
:
523 case CIPSO_V4_MAP_PASS
:
526 case CIPSO_V4_MAP_LOCAL
:
530 type_str
= "(unknown)";
532 audit_log_format(audit_buf
,
533 " cipso_doi=%u cipso_type=%s res=%u",
534 doi
, type_str
, ret_val
== 0 ? 1 : 0);
535 audit_log_end(audit_buf
);
542 * cipso_v4_doi_free - Frees a DOI definition
543 * @entry: the entry's RCU field
546 * This function frees all of the memory associated with a DOI definition.
549 void cipso_v4_doi_free(struct cipso_v4_doi
*doi_def
)
554 switch (doi_def
->type
) {
555 case CIPSO_V4_MAP_TRANS
:
556 kfree(doi_def
->map
.std
->lvl
.cipso
);
557 kfree(doi_def
->map
.std
->lvl
.local
);
558 kfree(doi_def
->map
.std
->cat
.cipso
);
559 kfree(doi_def
->map
.std
->cat
.local
);
566 * cipso_v4_doi_free_rcu - Frees a DOI definition via the RCU pointer
567 * @entry: the entry's RCU field
570 * This function is designed to be used as a callback to the call_rcu()
571 * function so that the memory allocated to the DOI definition can be released
575 static void cipso_v4_doi_free_rcu(struct rcu_head
*entry
)
577 struct cipso_v4_doi
*doi_def
;
579 doi_def
= container_of(entry
, struct cipso_v4_doi
, rcu
);
580 cipso_v4_doi_free(doi_def
);
584 * cipso_v4_doi_remove - Remove an existing DOI from the CIPSO protocol engine
585 * @doi: the DOI value
586 * @audit_secid: the LSM secid to use in the audit message
589 * Removes a DOI definition from the CIPSO engine. The NetLabel routines will
590 * be called to release their own LSM domain mappings as well as our own
591 * domain list. Returns zero on success and negative values on failure.
594 int cipso_v4_doi_remove(u32 doi
, struct netlbl_audit
*audit_info
)
597 struct cipso_v4_doi
*doi_def
;
598 struct audit_buffer
*audit_buf
;
600 spin_lock(&cipso_v4_doi_list_lock
);
601 doi_def
= cipso_v4_doi_search(doi
);
602 if (doi_def
== NULL
) {
603 spin_unlock(&cipso_v4_doi_list_lock
);
605 goto doi_remove_return
;
607 if (!atomic_dec_and_test(&doi_def
->refcount
)) {
608 spin_unlock(&cipso_v4_doi_list_lock
);
610 goto doi_remove_return
;
612 list_del_rcu(&doi_def
->list
);
613 spin_unlock(&cipso_v4_doi_list_lock
);
615 cipso_v4_cache_invalidate();
616 call_rcu(&doi_def
->rcu
, cipso_v4_doi_free_rcu
);
620 audit_buf
= netlbl_audit_start(AUDIT_MAC_CIPSOV4_DEL
, audit_info
);
621 if (audit_buf
!= NULL
) {
622 audit_log_format(audit_buf
,
623 " cipso_doi=%u res=%u",
624 doi
, ret_val
== 0 ? 1 : 0);
625 audit_log_end(audit_buf
);
632 * cipso_v4_doi_getdef - Returns a reference to a valid DOI definition
633 * @doi: the DOI value
636 * Searches for a valid DOI definition and if one is found it is returned to
637 * the caller. Otherwise NULL is returned. The caller must ensure that
638 * rcu_read_lock() is held while accessing the returned definition and the DOI
639 * definition reference count is decremented when the caller is done.
642 struct cipso_v4_doi
*cipso_v4_doi_getdef(u32 doi
)
644 struct cipso_v4_doi
*doi_def
;
647 doi_def
= cipso_v4_doi_search(doi
);
649 goto doi_getdef_return
;
650 if (!atomic_inc_not_zero(&doi_def
->refcount
))
659 * cipso_v4_doi_putdef - Releases a reference for the given DOI definition
660 * @doi_def: the DOI definition
663 * Releases a DOI definition reference obtained from cipso_v4_doi_getdef().
666 void cipso_v4_doi_putdef(struct cipso_v4_doi
*doi_def
)
671 if (!atomic_dec_and_test(&doi_def
->refcount
))
673 spin_lock(&cipso_v4_doi_list_lock
);
674 list_del_rcu(&doi_def
->list
);
675 spin_unlock(&cipso_v4_doi_list_lock
);
677 cipso_v4_cache_invalidate();
678 call_rcu(&doi_def
->rcu
, cipso_v4_doi_free_rcu
);
682 * cipso_v4_doi_walk - Iterate through the DOI definitions
683 * @skip_cnt: skip past this number of DOI definitions, updated
684 * @callback: callback for each DOI definition
685 * @cb_arg: argument for the callback function
688 * Iterate over the DOI definition list, skipping the first @skip_cnt entries.
689 * For each entry call @callback, if @callback returns a negative value stop
690 * 'walking' through the list and return. Updates the value in @skip_cnt upon
691 * return. Returns zero on success, negative values on failure.
694 int cipso_v4_doi_walk(u32
*skip_cnt
,
695 int (*callback
) (struct cipso_v4_doi
*doi_def
, void *arg
),
698 int ret_val
= -ENOENT
;
700 struct cipso_v4_doi
*iter_doi
;
703 list_for_each_entry_rcu(iter_doi
, &cipso_v4_doi_list
, list
)
704 if (atomic_read(&iter_doi
->refcount
) > 0) {
705 if (doi_cnt
++ < *skip_cnt
)
707 ret_val
= callback(iter_doi
, cb_arg
);
710 goto doi_walk_return
;
721 * Label Mapping Functions
725 * cipso_v4_map_lvl_valid - Checks to see if the given level is understood
726 * @doi_def: the DOI definition
727 * @level: the level to check
730 * Checks the given level against the given DOI definition and returns a
731 * negative value if the level does not have a valid mapping and a zero value
732 * if the level is defined by the DOI.
735 static int cipso_v4_map_lvl_valid(const struct cipso_v4_doi
*doi_def
, u8 level
)
737 switch (doi_def
->type
) {
738 case CIPSO_V4_MAP_PASS
:
740 case CIPSO_V4_MAP_TRANS
:
741 if (doi_def
->map
.std
->lvl
.cipso
[level
] < CIPSO_V4_INV_LVL
)
750 * cipso_v4_map_lvl_hton - Perform a level mapping from the host to the network
751 * @doi_def: the DOI definition
752 * @host_lvl: the host MLS level
753 * @net_lvl: the network/CIPSO MLS level
756 * Perform a label mapping to translate a local MLS level to the correct
757 * CIPSO level using the given DOI definition. Returns zero on success,
758 * negative values otherwise.
761 static int cipso_v4_map_lvl_hton(const struct cipso_v4_doi
*doi_def
,
765 switch (doi_def
->type
) {
766 case CIPSO_V4_MAP_PASS
:
769 case CIPSO_V4_MAP_TRANS
:
770 if (host_lvl
< doi_def
->map
.std
->lvl
.local_size
&&
771 doi_def
->map
.std
->lvl
.local
[host_lvl
] < CIPSO_V4_INV_LVL
) {
772 *net_lvl
= doi_def
->map
.std
->lvl
.local
[host_lvl
];
782 * cipso_v4_map_lvl_ntoh - Perform a level mapping from the network to the host
783 * @doi_def: the DOI definition
784 * @net_lvl: the network/CIPSO MLS level
785 * @host_lvl: the host MLS level
788 * Perform a label mapping to translate a CIPSO level to the correct local MLS
789 * level using the given DOI definition. Returns zero on success, negative
793 static int cipso_v4_map_lvl_ntoh(const struct cipso_v4_doi
*doi_def
,
797 struct cipso_v4_std_map_tbl
*map_tbl
;
799 switch (doi_def
->type
) {
800 case CIPSO_V4_MAP_PASS
:
803 case CIPSO_V4_MAP_TRANS
:
804 map_tbl
= doi_def
->map
.std
;
805 if (net_lvl
< map_tbl
->lvl
.cipso_size
&&
806 map_tbl
->lvl
.cipso
[net_lvl
] < CIPSO_V4_INV_LVL
) {
807 *host_lvl
= doi_def
->map
.std
->lvl
.cipso
[net_lvl
];
817 * cipso_v4_map_cat_rbm_valid - Checks to see if the category bitmap is valid
818 * @doi_def: the DOI definition
819 * @bitmap: category bitmap
820 * @bitmap_len: bitmap length in bytes
823 * Checks the given category bitmap against the given DOI definition and
824 * returns a negative value if any of the categories in the bitmap do not have
825 * a valid mapping and a zero value if all of the categories are valid.
828 static int cipso_v4_map_cat_rbm_valid(const struct cipso_v4_doi
*doi_def
,
829 const unsigned char *bitmap
,
833 u32 bitmap_len_bits
= bitmap_len
* 8;
837 switch (doi_def
->type
) {
838 case CIPSO_V4_MAP_PASS
:
840 case CIPSO_V4_MAP_TRANS
:
841 cipso_cat_size
= doi_def
->map
.std
->cat
.cipso_size
;
842 cipso_array
= doi_def
->map
.std
->cat
.cipso
;
844 cat
= cipso_v4_bitmap_walk(bitmap
,
850 if (cat
>= cipso_cat_size
||
851 cipso_array
[cat
] >= CIPSO_V4_INV_CAT
)
864 * cipso_v4_map_cat_rbm_hton - Perform a category mapping from host to network
865 * @doi_def: the DOI definition
866 * @secattr: the security attributes
867 * @net_cat: the zero'd out category bitmap in network/CIPSO format
868 * @net_cat_len: the length of the CIPSO bitmap in bytes
871 * Perform a label mapping to translate a local MLS category bitmap to the
872 * correct CIPSO bitmap using the given DOI definition. Returns the minimum
873 * size in bytes of the network bitmap on success, negative values otherwise.
876 static int cipso_v4_map_cat_rbm_hton(const struct cipso_v4_doi
*doi_def
,
877 const struct netlbl_lsm_secattr
*secattr
,
878 unsigned char *net_cat
,
882 u32 net_spot
= CIPSO_V4_INV_CAT
;
883 u32 net_spot_max
= 0;
884 u32 net_clen_bits
= net_cat_len
* 8;
885 u32 host_cat_size
= 0;
886 u32
*host_cat_array
= NULL
;
888 if (doi_def
->type
== CIPSO_V4_MAP_TRANS
) {
889 host_cat_size
= doi_def
->map
.std
->cat
.local_size
;
890 host_cat_array
= doi_def
->map
.std
->cat
.local
;
894 host_spot
= netlbl_secattr_catmap_walk(secattr
->attr
.mls
.cat
,
899 switch (doi_def
->type
) {
900 case CIPSO_V4_MAP_PASS
:
901 net_spot
= host_spot
;
903 case CIPSO_V4_MAP_TRANS
:
904 if (host_spot
>= host_cat_size
)
906 net_spot
= host_cat_array
[host_spot
];
907 if (net_spot
>= CIPSO_V4_INV_CAT
)
911 if (net_spot
>= net_clen_bits
)
913 cipso_v4_bitmap_setbit(net_cat
, net_spot
, 1);
915 if (net_spot
> net_spot_max
)
916 net_spot_max
= net_spot
;
919 if (++net_spot_max
% 8)
920 return net_spot_max
/ 8 + 1;
921 return net_spot_max
/ 8;
925 * cipso_v4_map_cat_rbm_ntoh - Perform a category mapping from network to host
926 * @doi_def: the DOI definition
927 * @net_cat: the category bitmap in network/CIPSO format
928 * @net_cat_len: the length of the CIPSO bitmap in bytes
929 * @secattr: the security attributes
932 * Perform a label mapping to translate a CIPSO bitmap to the correct local
933 * MLS category bitmap using the given DOI definition. Returns zero on
934 * success, negative values on failure.
937 static int cipso_v4_map_cat_rbm_ntoh(const struct cipso_v4_doi
*doi_def
,
938 const unsigned char *net_cat
,
940 struct netlbl_lsm_secattr
*secattr
)
944 u32 host_spot
= CIPSO_V4_INV_CAT
;
945 u32 net_clen_bits
= net_cat_len
* 8;
946 u32 net_cat_size
= 0;
947 u32
*net_cat_array
= NULL
;
949 if (doi_def
->type
== CIPSO_V4_MAP_TRANS
) {
950 net_cat_size
= doi_def
->map
.std
->cat
.cipso_size
;
951 net_cat_array
= doi_def
->map
.std
->cat
.cipso
;
955 net_spot
= cipso_v4_bitmap_walk(net_cat
,
965 switch (doi_def
->type
) {
966 case CIPSO_V4_MAP_PASS
:
967 host_spot
= net_spot
;
969 case CIPSO_V4_MAP_TRANS
:
970 if (net_spot
>= net_cat_size
)
972 host_spot
= net_cat_array
[net_spot
];
973 if (host_spot
>= CIPSO_V4_INV_CAT
)
977 ret_val
= netlbl_secattr_catmap_setbit(secattr
->attr
.mls
.cat
,
988 * cipso_v4_map_cat_enum_valid - Checks to see if the categories are valid
989 * @doi_def: the DOI definition
990 * @enumcat: category list
991 * @enumcat_len: length of the category list in bytes
994 * Checks the given categories against the given DOI definition and returns a
995 * negative value if any of the categories do not have a valid mapping and a
996 * zero value if all of the categories are valid.
999 static int cipso_v4_map_cat_enum_valid(const struct cipso_v4_doi
*doi_def
,
1000 const unsigned char *enumcat
,
1007 if (doi_def
->type
!= CIPSO_V4_MAP_PASS
|| enumcat_len
& 0x01)
1010 for (iter
= 0; iter
< enumcat_len
; iter
+= 2) {
1011 cat
= get_unaligned_be16(&enumcat
[iter
]);
1012 if (cat
<= cat_prev
)
1021 * cipso_v4_map_cat_enum_hton - Perform a category mapping from host to network
1022 * @doi_def: the DOI definition
1023 * @secattr: the security attributes
1024 * @net_cat: the zero'd out category list in network/CIPSO format
1025 * @net_cat_len: the length of the CIPSO category list in bytes
1028 * Perform a label mapping to translate a local MLS category bitmap to the
1029 * correct CIPSO category list using the given DOI definition. Returns the
1030 * size in bytes of the network category bitmap on success, negative values
1034 static int cipso_v4_map_cat_enum_hton(const struct cipso_v4_doi
*doi_def
,
1035 const struct netlbl_lsm_secattr
*secattr
,
1036 unsigned char *net_cat
,
1043 cat
= netlbl_secattr_catmap_walk(secattr
->attr
.mls
.cat
,
1047 if ((cat_iter
+ 2) > net_cat_len
)
1050 *((__be16
*)&net_cat
[cat_iter
]) = htons(cat
);
1058 * cipso_v4_map_cat_enum_ntoh - Perform a category mapping from network to host
1059 * @doi_def: the DOI definition
1060 * @net_cat: the category list in network/CIPSO format
1061 * @net_cat_len: the length of the CIPSO bitmap in bytes
1062 * @secattr: the security attributes
1065 * Perform a label mapping to translate a CIPSO category list to the correct
1066 * local MLS category bitmap using the given DOI definition. Returns zero on
1067 * success, negative values on failure.
1070 static int cipso_v4_map_cat_enum_ntoh(const struct cipso_v4_doi
*doi_def
,
1071 const unsigned char *net_cat
,
1073 struct netlbl_lsm_secattr
*secattr
)
1078 for (iter
= 0; iter
< net_cat_len
; iter
+= 2) {
1079 ret_val
= netlbl_secattr_catmap_setbit(secattr
->attr
.mls
.cat
,
1080 get_unaligned_be16(&net_cat
[iter
]),
1090 * cipso_v4_map_cat_rng_valid - Checks to see if the categories are valid
1091 * @doi_def: the DOI definition
1092 * @rngcat: category list
1093 * @rngcat_len: length of the category list in bytes
1096 * Checks the given categories against the given DOI definition and returns a
1097 * negative value if any of the categories do not have a valid mapping and a
1098 * zero value if all of the categories are valid.
1101 static int cipso_v4_map_cat_rng_valid(const struct cipso_v4_doi
*doi_def
,
1102 const unsigned char *rngcat
,
1107 u32 cat_prev
= CIPSO_V4_MAX_REM_CATS
+ 1;
1110 if (doi_def
->type
!= CIPSO_V4_MAP_PASS
|| rngcat_len
& 0x01)
1113 for (iter
= 0; iter
< rngcat_len
; iter
+= 4) {
1114 cat_high
= get_unaligned_be16(&rngcat
[iter
]);
1115 if ((iter
+ 4) <= rngcat_len
)
1116 cat_low
= get_unaligned_be16(&rngcat
[iter
+ 2]);
1120 if (cat_high
> cat_prev
)
1130 * cipso_v4_map_cat_rng_hton - Perform a category mapping from host to network
1131 * @doi_def: the DOI definition
1132 * @secattr: the security attributes
1133 * @net_cat: the zero'd out category list in network/CIPSO format
1134 * @net_cat_len: the length of the CIPSO category list in bytes
1137 * Perform a label mapping to translate a local MLS category bitmap to the
1138 * correct CIPSO category list using the given DOI definition. Returns the
1139 * size in bytes of the network category bitmap on success, negative values
1143 static int cipso_v4_map_cat_rng_hton(const struct cipso_v4_doi
*doi_def
,
1144 const struct netlbl_lsm_secattr
*secattr
,
1145 unsigned char *net_cat
,
1149 u16 array
[CIPSO_V4_TAG_RNG_CAT_MAX
* 2];
1153 /* make sure we don't overflow the 'array[]' variable */
1155 (CIPSO_V4_OPT_LEN_MAX
- CIPSO_V4_HDR_LEN
- CIPSO_V4_TAG_RNG_BLEN
))
1159 iter
= netlbl_secattr_catmap_walk(secattr
->attr
.mls
.cat
,
1163 cat_size
+= (iter
== 0 ? 0 : sizeof(u16
));
1164 if (cat_size
> net_cat_len
)
1166 array
[array_cnt
++] = iter
;
1168 iter
= netlbl_secattr_catmap_walk_rng(secattr
->attr
.mls
.cat
,
1172 cat_size
+= sizeof(u16
);
1173 if (cat_size
> net_cat_len
)
1175 array
[array_cnt
++] = iter
;
1178 for (iter
= 0; array_cnt
> 0;) {
1179 *((__be16
*)&net_cat
[iter
]) = htons(array
[--array_cnt
]);
1182 if (array
[array_cnt
] != 0) {
1183 *((__be16
*)&net_cat
[iter
]) = htons(array
[array_cnt
]);
1192 * cipso_v4_map_cat_rng_ntoh - Perform a category mapping from network to host
1193 * @doi_def: the DOI definition
1194 * @net_cat: the category list in network/CIPSO format
1195 * @net_cat_len: the length of the CIPSO bitmap in bytes
1196 * @secattr: the security attributes
1199 * Perform a label mapping to translate a CIPSO category list to the correct
1200 * local MLS category bitmap using the given DOI definition. Returns zero on
1201 * success, negative values on failure.
1204 static int cipso_v4_map_cat_rng_ntoh(const struct cipso_v4_doi
*doi_def
,
1205 const unsigned char *net_cat
,
1207 struct netlbl_lsm_secattr
*secattr
)
1214 for (net_iter
= 0; net_iter
< net_cat_len
; net_iter
+= 4) {
1215 cat_high
= get_unaligned_be16(&net_cat
[net_iter
]);
1216 if ((net_iter
+ 4) <= net_cat_len
)
1217 cat_low
= get_unaligned_be16(&net_cat
[net_iter
+ 2]);
1221 ret_val
= netlbl_secattr_catmap_setrng(secattr
->attr
.mls
.cat
,
1233 * Protocol Handling Functions
1237 * cipso_v4_gentag_hdr - Generate a CIPSO option header
1238 * @doi_def: the DOI definition
1239 * @len: the total tag length in bytes, not including this header
1240 * @buf: the CIPSO option buffer
1243 * Write a CIPSO header into the beginning of @buffer.
1246 static void cipso_v4_gentag_hdr(const struct cipso_v4_doi
*doi_def
,
1250 buf
[0] = IPOPT_CIPSO
;
1251 buf
[1] = CIPSO_V4_HDR_LEN
+ len
;
1252 *(__be32
*)&buf
[2] = htonl(doi_def
->doi
);
1256 * cipso_v4_gentag_rbm - Generate a CIPSO restricted bitmap tag (type #1)
1257 * @doi_def: the DOI definition
1258 * @secattr: the security attributes
1259 * @buffer: the option buffer
1260 * @buffer_len: length of buffer in bytes
1263 * Generate a CIPSO option using the restricted bitmap tag, tag type #1. The
1264 * actual buffer length may be larger than the indicated size due to
1265 * translation between host and network category bitmaps. Returns the size of
1266 * the tag on success, negative values on failure.
1269 static int cipso_v4_gentag_rbm(const struct cipso_v4_doi
*doi_def
,
1270 const struct netlbl_lsm_secattr
*secattr
,
1271 unsigned char *buffer
,
1278 if ((secattr
->flags
& NETLBL_SECATTR_MLS_LVL
) == 0)
1281 ret_val
= cipso_v4_map_lvl_hton(doi_def
,
1282 secattr
->attr
.mls
.lvl
,
1287 if (secattr
->flags
& NETLBL_SECATTR_MLS_CAT
) {
1288 ret_val
= cipso_v4_map_cat_rbm_hton(doi_def
,
1295 /* This will send packets using the "optimized" format when
1296 * possibile as specified in section 3.4.2.6 of the
1298 if (cipso_v4_rbm_optfmt
&& ret_val
> 0 && ret_val
<= 10)
1301 tag_len
= 4 + ret_val
;
1305 buffer
[0] = CIPSO_V4_TAG_RBITMAP
;
1306 buffer
[1] = tag_len
;
1313 * cipso_v4_parsetag_rbm - Parse a CIPSO restricted bitmap tag
1314 * @doi_def: the DOI definition
1315 * @tag: the CIPSO tag
1316 * @secattr: the security attributes
1319 * Parse a CIPSO restricted bitmap tag (tag type #1) and return the security
1320 * attributes in @secattr. Return zero on success, negatives values on
1324 static int cipso_v4_parsetag_rbm(const struct cipso_v4_doi
*doi_def
,
1325 const unsigned char *tag
,
1326 struct netlbl_lsm_secattr
*secattr
)
1329 u8 tag_len
= tag
[1];
1332 ret_val
= cipso_v4_map_lvl_ntoh(doi_def
, tag
[3], &level
);
1335 secattr
->attr
.mls
.lvl
= level
;
1336 secattr
->flags
|= NETLBL_SECATTR_MLS_LVL
;
1339 secattr
->attr
.mls
.cat
=
1340 netlbl_secattr_catmap_alloc(GFP_ATOMIC
);
1341 if (secattr
->attr
.mls
.cat
== NULL
)
1344 ret_val
= cipso_v4_map_cat_rbm_ntoh(doi_def
,
1349 netlbl_secattr_catmap_free(secattr
->attr
.mls
.cat
);
1353 secattr
->flags
|= NETLBL_SECATTR_MLS_CAT
;
1360 * cipso_v4_gentag_enum - Generate a CIPSO enumerated tag (type #2)
1361 * @doi_def: the DOI definition
1362 * @secattr: the security attributes
1363 * @buffer: the option buffer
1364 * @buffer_len: length of buffer in bytes
1367 * Generate a CIPSO option using the enumerated tag, tag type #2. Returns the
1368 * size of the tag on success, negative values on failure.
1371 static int cipso_v4_gentag_enum(const struct cipso_v4_doi
*doi_def
,
1372 const struct netlbl_lsm_secattr
*secattr
,
1373 unsigned char *buffer
,
1380 if (!(secattr
->flags
& NETLBL_SECATTR_MLS_LVL
))
1383 ret_val
= cipso_v4_map_lvl_hton(doi_def
,
1384 secattr
->attr
.mls
.lvl
,
1389 if (secattr
->flags
& NETLBL_SECATTR_MLS_CAT
) {
1390 ret_val
= cipso_v4_map_cat_enum_hton(doi_def
,
1397 tag_len
= 4 + ret_val
;
1401 buffer
[0] = CIPSO_V4_TAG_ENUM
;
1402 buffer
[1] = tag_len
;
1409 * cipso_v4_parsetag_enum - Parse a CIPSO enumerated tag
1410 * @doi_def: the DOI definition
1411 * @tag: the CIPSO tag
1412 * @secattr: the security attributes
1415 * Parse a CIPSO enumerated tag (tag type #2) and return the security
1416 * attributes in @secattr. Return zero on success, negatives values on
1420 static int cipso_v4_parsetag_enum(const struct cipso_v4_doi
*doi_def
,
1421 const unsigned char *tag
,
1422 struct netlbl_lsm_secattr
*secattr
)
1425 u8 tag_len
= tag
[1];
1428 ret_val
= cipso_v4_map_lvl_ntoh(doi_def
, tag
[3], &level
);
1431 secattr
->attr
.mls
.lvl
= level
;
1432 secattr
->flags
|= NETLBL_SECATTR_MLS_LVL
;
1435 secattr
->attr
.mls
.cat
=
1436 netlbl_secattr_catmap_alloc(GFP_ATOMIC
);
1437 if (secattr
->attr
.mls
.cat
== NULL
)
1440 ret_val
= cipso_v4_map_cat_enum_ntoh(doi_def
,
1445 netlbl_secattr_catmap_free(secattr
->attr
.mls
.cat
);
1449 secattr
->flags
|= NETLBL_SECATTR_MLS_CAT
;
1456 * cipso_v4_gentag_rng - Generate a CIPSO ranged tag (type #5)
1457 * @doi_def: the DOI definition
1458 * @secattr: the security attributes
1459 * @buffer: the option buffer
1460 * @buffer_len: length of buffer in bytes
1463 * Generate a CIPSO option using the ranged tag, tag type #5. Returns the
1464 * size of the tag on success, negative values on failure.
1467 static int cipso_v4_gentag_rng(const struct cipso_v4_doi
*doi_def
,
1468 const struct netlbl_lsm_secattr
*secattr
,
1469 unsigned char *buffer
,
1476 if (!(secattr
->flags
& NETLBL_SECATTR_MLS_LVL
))
1479 ret_val
= cipso_v4_map_lvl_hton(doi_def
,
1480 secattr
->attr
.mls
.lvl
,
1485 if (secattr
->flags
& NETLBL_SECATTR_MLS_CAT
) {
1486 ret_val
= cipso_v4_map_cat_rng_hton(doi_def
,
1493 tag_len
= 4 + ret_val
;
1497 buffer
[0] = CIPSO_V4_TAG_RANGE
;
1498 buffer
[1] = tag_len
;
1505 * cipso_v4_parsetag_rng - Parse a CIPSO ranged tag
1506 * @doi_def: the DOI definition
1507 * @tag: the CIPSO tag
1508 * @secattr: the security attributes
1511 * Parse a CIPSO ranged tag (tag type #5) and return the security attributes
1512 * in @secattr. Return zero on success, negatives values on failure.
1515 static int cipso_v4_parsetag_rng(const struct cipso_v4_doi
*doi_def
,
1516 const unsigned char *tag
,
1517 struct netlbl_lsm_secattr
*secattr
)
1520 u8 tag_len
= tag
[1];
1523 ret_val
= cipso_v4_map_lvl_ntoh(doi_def
, tag
[3], &level
);
1526 secattr
->attr
.mls
.lvl
= level
;
1527 secattr
->flags
|= NETLBL_SECATTR_MLS_LVL
;
1530 secattr
->attr
.mls
.cat
=
1531 netlbl_secattr_catmap_alloc(GFP_ATOMIC
);
1532 if (secattr
->attr
.mls
.cat
== NULL
)
1535 ret_val
= cipso_v4_map_cat_rng_ntoh(doi_def
,
1540 netlbl_secattr_catmap_free(secattr
->attr
.mls
.cat
);
1544 secattr
->flags
|= NETLBL_SECATTR_MLS_CAT
;
1551 * cipso_v4_gentag_loc - Generate a CIPSO local tag (non-standard)
1552 * @doi_def: the DOI definition
1553 * @secattr: the security attributes
1554 * @buffer: the option buffer
1555 * @buffer_len: length of buffer in bytes
1558 * Generate a CIPSO option using the local tag. Returns the size of the tag
1559 * on success, negative values on failure.
1562 static int cipso_v4_gentag_loc(const struct cipso_v4_doi
*doi_def
,
1563 const struct netlbl_lsm_secattr
*secattr
,
1564 unsigned char *buffer
,
1567 if (!(secattr
->flags
& NETLBL_SECATTR_SECID
))
1570 buffer
[0] = CIPSO_V4_TAG_LOCAL
;
1571 buffer
[1] = CIPSO_V4_TAG_LOC_BLEN
;
1572 *(u32
*)&buffer
[2] = secattr
->attr
.secid
;
1574 return CIPSO_V4_TAG_LOC_BLEN
;
1578 * cipso_v4_parsetag_loc - Parse a CIPSO local tag
1579 * @doi_def: the DOI definition
1580 * @tag: the CIPSO tag
1581 * @secattr: the security attributes
1584 * Parse a CIPSO local tag and return the security attributes in @secattr.
1585 * Return zero on success, negatives values on failure.
1588 static int cipso_v4_parsetag_loc(const struct cipso_v4_doi
*doi_def
,
1589 const unsigned char *tag
,
1590 struct netlbl_lsm_secattr
*secattr
)
1592 secattr
->attr
.secid
= *(u32
*)&tag
[2];
1593 secattr
->flags
|= NETLBL_SECATTR_SECID
;
1599 * cipso_v4_validate - Validate a CIPSO option
1600 * @option: the start of the option, on error it is set to point to the error
1603 * This routine is called to validate a CIPSO option, it checks all of the
1604 * fields to ensure that they are at least valid, see the draft snippet below
1605 * for details. If the option is valid then a zero value is returned and
1606 * the value of @option is unchanged. If the option is invalid then a
1607 * non-zero value is returned and @option is adjusted to point to the
1608 * offending portion of the option. From the IETF draft ...
1610 * "If any field within the CIPSO options, such as the DOI identifier, is not
1611 * recognized the IP datagram is discarded and an ICMP 'parameter problem'
1612 * (type 12) is generated and returned. The ICMP code field is set to 'bad
1613 * parameter' (code 0) and the pointer is set to the start of the CIPSO field
1614 * that is unrecognized."
1617 int cipso_v4_validate(const struct sk_buff
*skb
, unsigned char **option
)
1619 unsigned char *opt
= *option
;
1621 unsigned char opt_iter
;
1622 unsigned char err_offset
= 0;
1625 struct cipso_v4_doi
*doi_def
= NULL
;
1628 /* caller already checks for length values that are too large */
1632 goto validate_return
;
1636 doi_def
= cipso_v4_doi_search(get_unaligned_be32(&opt
[2]));
1637 if (doi_def
== NULL
) {
1639 goto validate_return_locked
;
1642 opt_iter
= CIPSO_V4_HDR_LEN
;
1643 tag
= opt
+ opt_iter
;
1644 while (opt_iter
< opt_len
) {
1645 for (tag_iter
= 0; doi_def
->tags
[tag_iter
] != tag
[0];)
1646 if (doi_def
->tags
[tag_iter
] == CIPSO_V4_TAG_INVALID
||
1647 ++tag_iter
== CIPSO_V4_TAG_MAXCNT
) {
1648 err_offset
= opt_iter
;
1649 goto validate_return_locked
;
1653 if (tag_len
> (opt_len
- opt_iter
)) {
1654 err_offset
= opt_iter
+ 1;
1655 goto validate_return_locked
;
1659 case CIPSO_V4_TAG_RBITMAP
:
1660 if (tag_len
< CIPSO_V4_TAG_RBM_BLEN
) {
1661 err_offset
= opt_iter
+ 1;
1662 goto validate_return_locked
;
1665 /* We are already going to do all the verification
1666 * necessary at the socket layer so from our point of
1667 * view it is safe to turn these checks off (and less
1668 * work), however, the CIPSO draft says we should do
1669 * all the CIPSO validations here but it doesn't
1670 * really specify _exactly_ what we need to validate
1671 * ... so, just make it a sysctl tunable. */
1672 if (cipso_v4_rbm_strictvalid
) {
1673 if (cipso_v4_map_lvl_valid(doi_def
,
1675 err_offset
= opt_iter
+ 3;
1676 goto validate_return_locked
;
1678 if (tag_len
> CIPSO_V4_TAG_RBM_BLEN
&&
1679 cipso_v4_map_cat_rbm_valid(doi_def
,
1682 err_offset
= opt_iter
+ 4;
1683 goto validate_return_locked
;
1687 case CIPSO_V4_TAG_ENUM
:
1688 if (tag_len
< CIPSO_V4_TAG_ENUM_BLEN
) {
1689 err_offset
= opt_iter
+ 1;
1690 goto validate_return_locked
;
1693 if (cipso_v4_map_lvl_valid(doi_def
,
1695 err_offset
= opt_iter
+ 3;
1696 goto validate_return_locked
;
1698 if (tag_len
> CIPSO_V4_TAG_ENUM_BLEN
&&
1699 cipso_v4_map_cat_enum_valid(doi_def
,
1702 err_offset
= opt_iter
+ 4;
1703 goto validate_return_locked
;
1706 case CIPSO_V4_TAG_RANGE
:
1707 if (tag_len
< CIPSO_V4_TAG_RNG_BLEN
) {
1708 err_offset
= opt_iter
+ 1;
1709 goto validate_return_locked
;
1712 if (cipso_v4_map_lvl_valid(doi_def
,
1714 err_offset
= opt_iter
+ 3;
1715 goto validate_return_locked
;
1717 if (tag_len
> CIPSO_V4_TAG_RNG_BLEN
&&
1718 cipso_v4_map_cat_rng_valid(doi_def
,
1721 err_offset
= opt_iter
+ 4;
1722 goto validate_return_locked
;
1725 case CIPSO_V4_TAG_LOCAL
:
1726 /* This is a non-standard tag that we only allow for
1727 * local connections, so if the incoming interface is
1728 * not the loopback device drop the packet. */
1729 if (!(skb
->dev
->flags
& IFF_LOOPBACK
)) {
1730 err_offset
= opt_iter
;
1731 goto validate_return_locked
;
1733 if (tag_len
!= CIPSO_V4_TAG_LOC_BLEN
) {
1734 err_offset
= opt_iter
+ 1;
1735 goto validate_return_locked
;
1739 err_offset
= opt_iter
;
1740 goto validate_return_locked
;
1744 opt_iter
+= tag_len
;
1747 validate_return_locked
:
1750 *option
= opt
+ err_offset
;
1755 * cipso_v4_error - Send the correct reponse for a bad packet
1757 * @error: the error code
1758 * @gateway: CIPSO gateway flag
1761 * Based on the error code given in @error, send an ICMP error message back to
1762 * the originating host. From the IETF draft ...
1764 * "If the contents of the CIPSO [option] are valid but the security label is
1765 * outside of the configured host or port label range, the datagram is
1766 * discarded and an ICMP 'destination unreachable' (type 3) is generated and
1767 * returned. The code field of the ICMP is set to 'communication with
1768 * destination network administratively prohibited' (code 9) or to
1769 * 'communication with destination host administratively prohibited'
1770 * (code 10). The value of the code is dependent on whether the originator
1771 * of the ICMP message is acting as a CIPSO host or a CIPSO gateway. The
1772 * recipient of the ICMP message MUST be able to handle either value. The
1773 * same procedure is performed if a CIPSO [option] can not be added to an
1774 * IP packet because it is too large to fit in the IP options area."
1776 * "If the error is triggered by receipt of an ICMP message, the message is
1777 * discarded and no response is permitted (consistent with general ICMP
1778 * processing rules)."
1781 void cipso_v4_error(struct sk_buff
*skb
, int error
, u32 gateway
)
1783 if (ip_hdr(skb
)->protocol
== IPPROTO_ICMP
|| error
!= -EACCES
)
1787 icmp_send(skb
, ICMP_DEST_UNREACH
, ICMP_NET_ANO
, 0);
1789 icmp_send(skb
, ICMP_DEST_UNREACH
, ICMP_HOST_ANO
, 0);
1793 * cipso_v4_genopt - Generate a CIPSO option
1794 * @buf: the option buffer
1795 * @buf_len: the size of opt_buf
1796 * @doi_def: the CIPSO DOI to use
1797 * @secattr: the security attributes
1800 * Generate a CIPSO option using the DOI definition and security attributes
1801 * passed to the function. Returns the length of the option on success and
1802 * negative values on failure.
1805 static int cipso_v4_genopt(unsigned char *buf
, u32 buf_len
,
1806 const struct cipso_v4_doi
*doi_def
,
1807 const struct netlbl_lsm_secattr
*secattr
)
1812 if (buf_len
<= CIPSO_V4_HDR_LEN
)
1815 /* XXX - This code assumes only one tag per CIPSO option which isn't
1816 * really a good assumption to make but since we only support the MAC
1817 * tags right now it is a safe assumption. */
1820 memset(buf
, 0, buf_len
);
1821 switch (doi_def
->tags
[iter
]) {
1822 case CIPSO_V4_TAG_RBITMAP
:
1823 ret_val
= cipso_v4_gentag_rbm(doi_def
,
1825 &buf
[CIPSO_V4_HDR_LEN
],
1826 buf_len
- CIPSO_V4_HDR_LEN
);
1828 case CIPSO_V4_TAG_ENUM
:
1829 ret_val
= cipso_v4_gentag_enum(doi_def
,
1831 &buf
[CIPSO_V4_HDR_LEN
],
1832 buf_len
- CIPSO_V4_HDR_LEN
);
1834 case CIPSO_V4_TAG_RANGE
:
1835 ret_val
= cipso_v4_gentag_rng(doi_def
,
1837 &buf
[CIPSO_V4_HDR_LEN
],
1838 buf_len
- CIPSO_V4_HDR_LEN
);
1840 case CIPSO_V4_TAG_LOCAL
:
1841 ret_val
= cipso_v4_gentag_loc(doi_def
,
1843 &buf
[CIPSO_V4_HDR_LEN
],
1844 buf_len
- CIPSO_V4_HDR_LEN
);
1851 } while (ret_val
< 0 &&
1852 iter
< CIPSO_V4_TAG_MAXCNT
&&
1853 doi_def
->tags
[iter
] != CIPSO_V4_TAG_INVALID
);
1856 cipso_v4_gentag_hdr(doi_def
, buf
, ret_val
);
1857 return CIPSO_V4_HDR_LEN
+ ret_val
;
1861 * cipso_v4_sock_setattr - Add a CIPSO option to a socket
1863 * @doi_def: the CIPSO DOI to use
1864 * @secattr: the specific security attributes of the socket
1867 * Set the CIPSO option on the given socket using the DOI definition and
1868 * security attributes passed to the function. This function requires
1869 * exclusive access to @sk, which means it either needs to be in the
1870 * process of being created or locked. Returns zero on success and negative
1871 * values on failure.
1874 int cipso_v4_sock_setattr(struct sock
*sk
,
1875 const struct cipso_v4_doi
*doi_def
,
1876 const struct netlbl_lsm_secattr
*secattr
)
1878 int ret_val
= -EPERM
;
1879 unsigned char *buf
= NULL
;
1882 struct ip_options
*opt
= NULL
;
1883 struct inet_sock
*sk_inet
;
1884 struct inet_connection_sock
*sk_conn
;
1886 /* In the case of sock_create_lite(), the sock->sk field is not
1887 * defined yet but it is not a problem as the only users of these
1888 * "lite" PF_INET sockets are functions which do an accept() call
1889 * afterwards so we will label the socket as part of the accept(). */
1893 /* We allocate the maximum CIPSO option size here so we are probably
1894 * being a little wasteful, but it makes our life _much_ easier later
1895 * on and after all we are only talking about 40 bytes. */
1896 buf_len
= CIPSO_V4_OPT_LEN_MAX
;
1897 buf
= kmalloc(buf_len
, GFP_ATOMIC
);
1900 goto socket_setattr_failure
;
1903 ret_val
= cipso_v4_genopt(buf
, buf_len
, doi_def
, secattr
);
1905 goto socket_setattr_failure
;
1908 /* We can't use ip_options_get() directly because it makes a call to
1909 * ip_options_get_alloc() which allocates memory with GFP_KERNEL and
1910 * we won't always have CAP_NET_RAW even though we _always_ want to
1911 * set the IPOPT_CIPSO option. */
1912 opt_len
= (buf_len
+ 3) & ~3;
1913 opt
= kzalloc(sizeof(*opt
) + opt_len
, GFP_ATOMIC
);
1916 goto socket_setattr_failure
;
1918 memcpy(opt
->__data
, buf
, buf_len
);
1919 opt
->optlen
= opt_len
;
1920 opt
->cipso
= sizeof(struct iphdr
);
1924 sk_inet
= inet_sk(sk
);
1925 if (sk_inet
->is_icsk
) {
1926 sk_conn
= inet_csk(sk
);
1928 sk_conn
->icsk_ext_hdr_len
-= sk_inet
->opt
->optlen
;
1929 sk_conn
->icsk_ext_hdr_len
+= opt
->optlen
;
1930 sk_conn
->icsk_sync_mss(sk
, sk_conn
->icsk_pmtu_cookie
);
1932 opt
= xchg(&sk_inet
->opt
, opt
);
1937 socket_setattr_failure
:
1944 * cipso_v4_req_setattr - Add a CIPSO option to a connection request socket
1945 * @req: the connection request socket
1946 * @doi_def: the CIPSO DOI to use
1947 * @secattr: the specific security attributes of the socket
1950 * Set the CIPSO option on the given socket using the DOI definition and
1951 * security attributes passed to the function. Returns zero on success and
1952 * negative values on failure.
1955 int cipso_v4_req_setattr(struct request_sock
*req
,
1956 const struct cipso_v4_doi
*doi_def
,
1957 const struct netlbl_lsm_secattr
*secattr
)
1959 int ret_val
= -EPERM
;
1960 unsigned char *buf
= NULL
;
1963 struct ip_options
*opt
= NULL
;
1964 struct inet_request_sock
*req_inet
;
1966 /* We allocate the maximum CIPSO option size here so we are probably
1967 * being a little wasteful, but it makes our life _much_ easier later
1968 * on and after all we are only talking about 40 bytes. */
1969 buf_len
= CIPSO_V4_OPT_LEN_MAX
;
1970 buf
= kmalloc(buf_len
, GFP_ATOMIC
);
1973 goto req_setattr_failure
;
1976 ret_val
= cipso_v4_genopt(buf
, buf_len
, doi_def
, secattr
);
1978 goto req_setattr_failure
;
1981 /* We can't use ip_options_get() directly because it makes a call to
1982 * ip_options_get_alloc() which allocates memory with GFP_KERNEL and
1983 * we won't always have CAP_NET_RAW even though we _always_ want to
1984 * set the IPOPT_CIPSO option. */
1985 opt_len
= (buf_len
+ 3) & ~3;
1986 opt
= kzalloc(sizeof(*opt
) + opt_len
, GFP_ATOMIC
);
1989 goto req_setattr_failure
;
1991 memcpy(opt
->__data
, buf
, buf_len
);
1992 opt
->optlen
= opt_len
;
1993 opt
->cipso
= sizeof(struct iphdr
);
1997 req_inet
= inet_rsk(req
);
1998 opt
= xchg(&req_inet
->opt
, opt
);
2003 req_setattr_failure
:
2010 * cipso_v4_delopt - Delete the CIPSO option from a set of IP options
2011 * @opt_ptr: IP option pointer
2014 * Deletes the CIPSO IP option from a set of IP options and makes the necessary
2015 * adjustments to the IP option structure. Returns zero on success, negative
2016 * values on failure.
2019 static int cipso_v4_delopt(struct ip_options
**opt_ptr
)
2022 struct ip_options
*opt
= *opt_ptr
;
2024 if (opt
->srr
|| opt
->rr
|| opt
->ts
|| opt
->router_alert
) {
2027 unsigned char *cipso_ptr
;
2031 cipso_off
= opt
->cipso
- sizeof(struct iphdr
);
2032 cipso_ptr
= &opt
->__data
[cipso_off
];
2033 cipso_len
= cipso_ptr
[1];
2035 if (opt
->srr
> opt
->cipso
)
2036 opt
->srr
-= cipso_len
;
2037 if (opt
->rr
> opt
->cipso
)
2038 opt
->rr
-= cipso_len
;
2039 if (opt
->ts
> opt
->cipso
)
2040 opt
->ts
-= cipso_len
;
2041 if (opt
->router_alert
> opt
->cipso
)
2042 opt
->router_alert
-= cipso_len
;
2045 memmove(cipso_ptr
, cipso_ptr
+ cipso_len
,
2046 opt
->optlen
- cipso_off
- cipso_len
);
2048 /* determining the new total option length is tricky because of
2049 * the padding necessary, the only thing i can think to do at
2050 * this point is walk the options one-by-one, skipping the
2051 * padding at the end to determine the actual option size and
2052 * from there we can determine the new total option length */
2055 while (iter
< opt
->optlen
)
2056 if (opt
->__data
[iter
] != IPOPT_NOP
) {
2057 iter
+= opt
->__data
[iter
+ 1];
2061 hdr_delta
= opt
->optlen
;
2062 opt
->optlen
= (optlen_new
+ 3) & ~3;
2063 hdr_delta
-= opt
->optlen
;
2065 /* only the cipso option was present on the socket so we can
2066 * remove the entire option struct */
2068 hdr_delta
= opt
->optlen
;
2076 * cipso_v4_sock_delattr - Delete the CIPSO option from a socket
2080 * Removes the CIPSO option from a socket, if present.
2083 void cipso_v4_sock_delattr(struct sock
*sk
)
2086 struct ip_options
*opt
;
2087 struct inet_sock
*sk_inet
;
2089 sk_inet
= inet_sk(sk
);
2091 if (opt
== NULL
|| opt
->cipso
== 0)
2094 hdr_delta
= cipso_v4_delopt(&sk_inet
->opt
);
2095 if (sk_inet
->is_icsk
&& hdr_delta
> 0) {
2096 struct inet_connection_sock
*sk_conn
= inet_csk(sk
);
2097 sk_conn
->icsk_ext_hdr_len
-= hdr_delta
;
2098 sk_conn
->icsk_sync_mss(sk
, sk_conn
->icsk_pmtu_cookie
);
2103 * cipso_v4_req_delattr - Delete the CIPSO option from a request socket
2104 * @reg: the request socket
2107 * Removes the CIPSO option from a request socket, if present.
2110 void cipso_v4_req_delattr(struct request_sock
*req
)
2112 struct ip_options
*opt
;
2113 struct inet_request_sock
*req_inet
;
2115 req_inet
= inet_rsk(req
);
2116 opt
= req_inet
->opt
;
2117 if (opt
== NULL
|| opt
->cipso
== 0)
2120 cipso_v4_delopt(&req_inet
->opt
);
2124 * cipso_v4_getattr - Helper function for the cipso_v4_*_getattr functions
2125 * @cipso: the CIPSO v4 option
2126 * @secattr: the security attributes
2129 * Inspect @cipso and return the security attributes in @secattr. Returns zero
2130 * on success and negative values on failure.
2133 static int cipso_v4_getattr(const unsigned char *cipso
,
2134 struct netlbl_lsm_secattr
*secattr
)
2136 int ret_val
= -ENOMSG
;
2138 struct cipso_v4_doi
*doi_def
;
2140 if (cipso_v4_cache_check(cipso
, cipso
[1], secattr
) == 0)
2143 doi
= get_unaligned_be32(&cipso
[2]);
2145 doi_def
= cipso_v4_doi_search(doi
);
2146 if (doi_def
== NULL
)
2147 goto getattr_return
;
2148 /* XXX - This code assumes only one tag per CIPSO option which isn't
2149 * really a good assumption to make but since we only support the MAC
2150 * tags right now it is a safe assumption. */
2152 case CIPSO_V4_TAG_RBITMAP
:
2153 ret_val
= cipso_v4_parsetag_rbm(doi_def
, &cipso
[6], secattr
);
2155 case CIPSO_V4_TAG_ENUM
:
2156 ret_val
= cipso_v4_parsetag_enum(doi_def
, &cipso
[6], secattr
);
2158 case CIPSO_V4_TAG_RANGE
:
2159 ret_val
= cipso_v4_parsetag_rng(doi_def
, &cipso
[6], secattr
);
2161 case CIPSO_V4_TAG_LOCAL
:
2162 ret_val
= cipso_v4_parsetag_loc(doi_def
, &cipso
[6], secattr
);
2166 secattr
->type
= NETLBL_NLTYPE_CIPSOV4
;
2174 * cipso_v4_sock_getattr - Get the security attributes from a sock
2176 * @secattr: the security attributes
2179 * Query @sk to see if there is a CIPSO option attached to the sock and if
2180 * there is return the CIPSO security attributes in @secattr. This function
2181 * requires that @sk be locked, or privately held, but it does not do any
2182 * locking itself. Returns zero on success and negative values on failure.
2185 int cipso_v4_sock_getattr(struct sock
*sk
, struct netlbl_lsm_secattr
*secattr
)
2187 struct ip_options
*opt
;
2189 opt
= inet_sk(sk
)->opt
;
2190 if (opt
== NULL
|| opt
->cipso
== 0)
2193 return cipso_v4_getattr(opt
->__data
+ opt
->cipso
- sizeof(struct iphdr
),
2198 * cipso_v4_skbuff_setattr - Set the CIPSO option on a packet
2200 * @secattr: the security attributes
2203 * Set the CIPSO option on the given packet based on the security attributes.
2204 * Returns a pointer to the IP header on success and NULL on failure.
2207 int cipso_v4_skbuff_setattr(struct sk_buff
*skb
,
2208 const struct cipso_v4_doi
*doi_def
,
2209 const struct netlbl_lsm_secattr
*secattr
)
2213 struct ip_options
*opt
= &IPCB(skb
)->opt
;
2214 unsigned char buf
[CIPSO_V4_OPT_LEN_MAX
];
2215 u32 buf_len
= CIPSO_V4_OPT_LEN_MAX
;
2219 ret_val
= cipso_v4_genopt(buf
, buf_len
, doi_def
, secattr
);
2223 opt_len
= (buf_len
+ 3) & ~3;
2225 /* we overwrite any existing options to ensure that we have enough
2226 * room for the CIPSO option, the reason is that we _need_ to guarantee
2227 * that the security label is applied to the packet - we do the same
2228 * thing when using the socket options and it hasn't caused a problem,
2229 * if we need to we can always revisit this choice later */
2231 len_delta
= opt_len
- opt
->optlen
;
2232 /* if we don't ensure enough headroom we could panic on the skb_push()
2233 * call below so make sure we have enough, we are also "mangling" the
2234 * packet so we should probably do a copy-on-write call anyway */
2235 ret_val
= skb_cow(skb
, skb_headroom(skb
) + len_delta
);
2239 if (len_delta
> 0) {
2240 /* we assume that the header + opt->optlen have already been
2241 * "pushed" in ip_options_build() or similar */
2243 skb_push(skb
, len_delta
);
2244 memmove((char *)iph
- len_delta
, iph
, iph
->ihl
<< 2);
2245 skb_reset_network_header(skb
);
2247 } else if (len_delta
< 0) {
2249 memset(iph
+ 1, IPOPT_NOP
, opt
->optlen
);
2253 if (opt
->optlen
> 0)
2254 memset(opt
, 0, sizeof(*opt
));
2255 opt
->optlen
= opt_len
;
2256 opt
->cipso
= sizeof(struct iphdr
);
2257 opt
->is_changed
= 1;
2259 /* we have to do the following because we are being called from a
2260 * netfilter hook which means the packet already has had the header
2261 * fields populated and the checksum calculated - yes this means we
2262 * are doing more work than needed but we do it to keep the core
2263 * stack clean and tidy */
2264 memcpy(iph
+ 1, buf
, buf_len
);
2265 if (opt_len
> buf_len
)
2266 memset((char *)(iph
+ 1) + buf_len
, 0, opt_len
- buf_len
);
2267 if (len_delta
!= 0) {
2268 iph
->ihl
= 5 + (opt_len
>> 2);
2269 iph
->tot_len
= htons(skb
->len
);
2277 * cipso_v4_skbuff_delattr - Delete any CIPSO options from a packet
2281 * Removes any and all CIPSO options from the given packet. Returns zero on
2282 * success, negative values on failure.
2285 int cipso_v4_skbuff_delattr(struct sk_buff
*skb
)
2289 struct ip_options
*opt
= &IPCB(skb
)->opt
;
2290 unsigned char *cipso_ptr
;
2292 if (opt
->cipso
== 0)
2295 /* since we are changing the packet we should make a copy */
2296 ret_val
= skb_cow(skb
, skb_headroom(skb
));
2300 /* the easiest thing to do is just replace the cipso option with noop
2301 * options since we don't change the size of the packet, although we
2302 * still need to recalculate the checksum */
2305 cipso_ptr
= (unsigned char *)iph
+ opt
->cipso
;
2306 memset(cipso_ptr
, IPOPT_NOOP
, cipso_ptr
[1]);
2308 opt
->is_changed
= 1;
2316 * cipso_v4_skbuff_getattr - Get the security attributes from the CIPSO option
2318 * @secattr: the security attributes
2321 * Parse the given packet's CIPSO option and return the security attributes.
2322 * Returns zero on success and negative values on failure.
2325 int cipso_v4_skbuff_getattr(const struct sk_buff
*skb
,
2326 struct netlbl_lsm_secattr
*secattr
)
2328 return cipso_v4_getattr(CIPSO_V4_OPTPTR(skb
), secattr
);
2336 * cipso_v4_init - Initialize the CIPSO module
2339 * Initialize the CIPSO module and prepare it for use. Returns zero on success
2340 * and negative values on failure.
2343 static int __init
cipso_v4_init(void)
2347 ret_val
= cipso_v4_cache_init();
2349 panic("Failed to initialize the CIPSO/IPv4 cache (%d)\n",
2355 subsys_initcall(cipso_v4_init
);