2 * CALIPSO - Common Architecture Label IPv6 Security Option
4 * This is an implementation of the CALIPSO protocol as specified in
7 * Authors: Paul Moore <paul.moore@hp.com>
8 * Huw Davies <huw@codeweavers.com>
12 /* (c) Copyright Hewlett-Packard Development Company, L.P., 2006, 2008
13 * (c) Copyright Huw Davies <huw@codeweavers.com>, 2015
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 2 of the License, or
18 * (at your option) any later version.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
23 * the GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with this program; if not, see <http://www.gnu.org/licenses/>.
30 #include <linux/init.h>
31 #include <linux/types.h>
32 #include <linux/rcupdate.h>
33 #include <linux/list.h>
34 #include <linux/spinlock.h>
35 #include <linux/string.h>
36 #include <linux/jhash.h>
37 #include <linux/audit.h>
38 #include <linux/slab.h>
42 #include <net/netlabel.h>
43 #include <net/calipso.h>
44 #include <linux/atomic.h>
45 #include <linux/bug.h>
46 #include <asm/unaligned.h>
47 #include <linux/crc-ccitt.h>
49 /* Maximium size of the calipso option including
50 * the two-byte TLV header.
52 #define CALIPSO_OPT_LEN_MAX (2 + 252)
54 /* Size of the minimum calipso option including
55 * the two-byte TLV header.
57 #define CALIPSO_HDR_LEN (2 + 8)
59 /* Maximium size of the calipso option including
60 * the two-byte TLV header and upto 3 bytes of
61 * leading pad and 7 bytes of trailing pad.
63 #define CALIPSO_OPT_LEN_MAX_WITH_PAD (3 + CALIPSO_OPT_LEN_MAX + 7)
65 /* Maximium size of u32 aligned buffer required to hold calipso
66 * option. Max of 3 initial pad bytes starting from buffer + 3.
67 * i.e. the worst case is when the previous tlv finishes on 4n + 3.
69 #define CALIPSO_MAX_BUFFER (6 + CALIPSO_OPT_LEN_MAX)
71 /* List of available DOI definitions */
72 static DEFINE_SPINLOCK(calipso_doi_list_lock);
73 static LIST_HEAD(calipso_doi_list);
75 /* Label mapping cache */
76 int calipso_cache_enabled = 1;
77 int calipso_cache_bucketsize = 10;
78 #define CALIPSO_CACHE_BUCKETBITS 7
79 #define CALIPSO_CACHE_BUCKETS BIT(CALIPSO_CACHE_BUCKETBITS)
80 #define CALIPSO_CACHE_REORDERLIMIT 10
81 struct calipso_map_cache_bkt {
84 struct list_head list;
87 struct calipso_map_cache_entry {
92 struct netlbl_lsm_cache *lsm_data;
95 struct list_head list;
98 static struct calipso_map_cache_bkt *calipso_cache;
100 /* Label Mapping Cache Functions
104 * calipso_cache_entry_free - Frees a cache entry
105 * @entry: the entry to free
108 * This function frees the memory associated with a cache entry including the
109 * LSM cache data if there are no longer any users, i.e. reference count == 0.
112 static void calipso_cache_entry_free(struct calipso_map_cache_entry *entry)
115 netlbl_secattr_cache_free(entry->lsm_data);
121 * calipso_map_cache_hash - Hashing function for the CALIPSO cache
123 * @key_len: the length of the key in bytes
126 * The CALIPSO tag hashing function. Returns a 32-bit hash value.
129 static u32 calipso_map_cache_hash(const unsigned char *key, u32 key_len)
131 return jhash(key, key_len, 0);
135 * calipso_cache_init - Initialize the CALIPSO cache
138 * Initializes the CALIPSO label mapping cache, this function should be called
139 * before any of the other functions defined in this file. Returns zero on
140 * success, negative values on error.
143 static int __init calipso_cache_init(void)
147 calipso_cache = kcalloc(CALIPSO_CACHE_BUCKETS,
148 sizeof(struct calipso_map_cache_bkt),
153 for (iter = 0; iter < CALIPSO_CACHE_BUCKETS; iter++) {
154 spin_lock_init(&calipso_cache[iter].lock);
155 calipso_cache[iter].size = 0;
156 INIT_LIST_HEAD(&calipso_cache[iter].list);
163 * calipso_cache_invalidate - Invalidates the current CALIPSO cache
166 * Invalidates and frees any entries in the CALIPSO cache. Returns zero on
167 * success and negative values on failure.
170 static void calipso_cache_invalidate(void)
172 struct calipso_map_cache_entry *entry, *tmp_entry;
175 for (iter = 0; iter < CALIPSO_CACHE_BUCKETS; iter++) {
176 spin_lock_bh(&calipso_cache[iter].lock);
177 list_for_each_entry_safe(entry,
179 &calipso_cache[iter].list, list) {
180 list_del(&entry->list);
181 calipso_cache_entry_free(entry);
183 calipso_cache[iter].size = 0;
184 spin_unlock_bh(&calipso_cache[iter].lock);
189 * calipso_cache_check - Check the CALIPSO cache for a label mapping
190 * @key: the buffer to check
191 * @key_len: buffer length in bytes
192 * @secattr: the security attribute struct to use
195 * This function checks the cache to see if a label mapping already exists for
196 * the given key. If there is a match then the cache is adjusted and the
197 * @secattr struct is populated with the correct LSM security attributes. The
198 * cache is adjusted in the following manner if the entry is not already the
199 * first in the cache bucket:
201 * 1. The cache entry's activity counter is incremented
202 * 2. The previous (higher ranking) entry's activity counter is decremented
203 * 3. If the difference between the two activity counters is geater than
204 * CALIPSO_CACHE_REORDERLIMIT the two entries are swapped
206 * Returns zero on success, -ENOENT for a cache miss, and other negative values
210 static int calipso_cache_check(const unsigned char *key,
212 struct netlbl_lsm_secattr *secattr)
215 struct calipso_map_cache_entry *entry;
216 struct calipso_map_cache_entry *prev_entry = NULL;
219 if (!calipso_cache_enabled)
222 hash = calipso_map_cache_hash(key, key_len);
223 bkt = hash & (CALIPSO_CACHE_BUCKETS - 1);
224 spin_lock_bh(&calipso_cache[bkt].lock);
225 list_for_each_entry(entry, &calipso_cache[bkt].list, list) {
226 if (entry->hash == hash &&
227 entry->key_len == key_len &&
228 memcmp(entry->key, key, key_len) == 0) {
229 entry->activity += 1;
230 refcount_inc(&entry->lsm_data->refcount);
231 secattr->cache = entry->lsm_data;
232 secattr->flags |= NETLBL_SECATTR_CACHE;
233 secattr->type = NETLBL_NLTYPE_CALIPSO;
235 spin_unlock_bh(&calipso_cache[bkt].lock);
239 if (prev_entry->activity > 0)
240 prev_entry->activity -= 1;
241 if (entry->activity > prev_entry->activity &&
242 entry->activity - prev_entry->activity >
243 CALIPSO_CACHE_REORDERLIMIT) {
244 __list_del(entry->list.prev, entry->list.next);
245 __list_add(&entry->list,
246 prev_entry->list.prev,
250 spin_unlock_bh(&calipso_cache[bkt].lock);
255 spin_unlock_bh(&calipso_cache[bkt].lock);
261 * calipso_cache_add - Add an entry to the CALIPSO cache
262 * @calipso_ptr: the CALIPSO option
263 * @secattr: the packet's security attributes
266 * Add a new entry into the CALIPSO label mapping cache. Add the new entry to
267 * head of the cache bucket's list, if the cache bucket is out of room remove
268 * the last entry in the list first. It is important to note that there is
269 * currently no checking for duplicate keys. Returns zero on success,
270 * negative values on failure. The key stored starts at calipso_ptr + 2,
271 * i.e. the type and length bytes are not stored, this corresponds to
272 * calipso_ptr[1] bytes of data.
275 static int calipso_cache_add(const unsigned char *calipso_ptr,
276 const struct netlbl_lsm_secattr *secattr)
278 int ret_val = -EPERM;
280 struct calipso_map_cache_entry *entry = NULL;
281 struct calipso_map_cache_entry *old_entry = NULL;
284 if (!calipso_cache_enabled || calipso_cache_bucketsize <= 0)
287 calipso_ptr_len = calipso_ptr[1];
289 entry = kzalloc(sizeof(*entry), GFP_ATOMIC);
292 entry->key = kmemdup(calipso_ptr + 2, calipso_ptr_len, GFP_ATOMIC);
295 goto cache_add_failure;
297 entry->key_len = calipso_ptr_len;
298 entry->hash = calipso_map_cache_hash(calipso_ptr, calipso_ptr_len);
299 refcount_inc(&secattr->cache->refcount);
300 entry->lsm_data = secattr->cache;
302 bkt = entry->hash & (CALIPSO_CACHE_BUCKETS - 1);
303 spin_lock_bh(&calipso_cache[bkt].lock);
304 if (calipso_cache[bkt].size < calipso_cache_bucketsize) {
305 list_add(&entry->list, &calipso_cache[bkt].list);
306 calipso_cache[bkt].size += 1;
308 old_entry = list_entry(calipso_cache[bkt].list.prev,
309 struct calipso_map_cache_entry, list);
310 list_del(&old_entry->list);
311 list_add(&entry->list, &calipso_cache[bkt].list);
312 calipso_cache_entry_free(old_entry);
314 spin_unlock_bh(&calipso_cache[bkt].lock);
320 calipso_cache_entry_free(entry);
324 /* DOI List Functions
328 * calipso_doi_search - Searches for a DOI definition
329 * @doi: the DOI to search for
332 * Search the DOI definition list for a DOI definition with a DOI value that
333 * matches @doi. The caller is responsible for calling rcu_read_[un]lock().
334 * Returns a pointer to the DOI definition on success and NULL on failure.
336 static struct calipso_doi *calipso_doi_search(u32 doi)
338 struct calipso_doi *iter;
340 list_for_each_entry_rcu(iter, &calipso_doi_list, list)
341 if (iter->doi == doi && refcount_read(&iter->refcount))
347 * calipso_doi_add - Add a new DOI to the CALIPSO protocol engine
348 * @doi_def: the DOI structure
349 * @audit_info: NetLabel audit information
352 * The caller defines a new DOI for use by the CALIPSO engine and calls this
353 * function to add it to the list of acceptable domains. The caller must
354 * ensure that the mapping table specified in @doi_def->map meets all of the
355 * requirements of the mapping type (see calipso.h for details). Returns
356 * zero on success and non-zero on failure.
359 static int calipso_doi_add(struct calipso_doi *doi_def,
360 struct netlbl_audit *audit_info)
362 int ret_val = -EINVAL;
365 struct audit_buffer *audit_buf;
368 doi_type = doi_def->type;
370 if (doi_def->doi == CALIPSO_DOI_UNKNOWN)
373 refcount_set(&doi_def->refcount, 1);
375 spin_lock(&calipso_doi_list_lock);
376 if (calipso_doi_search(doi_def->doi)) {
377 spin_unlock(&calipso_doi_list_lock);
381 list_add_tail_rcu(&doi_def->list, &calipso_doi_list);
382 spin_unlock(&calipso_doi_list_lock);
386 audit_buf = netlbl_audit_start(AUDIT_MAC_CALIPSO_ADD, audit_info);
388 const char *type_str;
391 case CALIPSO_MAP_PASS:
395 type_str = "(unknown)";
397 audit_log_format(audit_buf,
398 " calipso_doi=%u calipso_type=%s res=%u",
399 doi, type_str, ret_val == 0 ? 1 : 0);
400 audit_log_end(audit_buf);
407 * calipso_doi_free - Frees a DOI definition
408 * @doi_def: the DOI definition
411 * This function frees all of the memory associated with a DOI definition.
414 static void calipso_doi_free(struct calipso_doi *doi_def)
420 * calipso_doi_free_rcu - Frees a DOI definition via the RCU pointer
421 * @entry: the entry's RCU field
424 * This function is designed to be used as a callback to the call_rcu()
425 * function so that the memory allocated to the DOI definition can be released
429 static void calipso_doi_free_rcu(struct rcu_head *entry)
431 struct calipso_doi *doi_def;
433 doi_def = container_of(entry, struct calipso_doi, rcu);
434 calipso_doi_free(doi_def);
438 * calipso_doi_remove - Remove an existing DOI from the CALIPSO protocol engine
439 * @doi: the DOI value
440 * @audit_secid: the LSM secid to use in the audit message
443 * Removes a DOI definition from the CALIPSO engine. The NetLabel routines will
444 * be called to release their own LSM domain mappings as well as our own
445 * domain list. Returns zero on success and negative values on failure.
448 static int calipso_doi_remove(u32 doi, struct netlbl_audit *audit_info)
451 struct calipso_doi *doi_def;
452 struct audit_buffer *audit_buf;
454 spin_lock(&calipso_doi_list_lock);
455 doi_def = calipso_doi_search(doi);
457 spin_unlock(&calipso_doi_list_lock);
459 goto doi_remove_return;
461 if (!refcount_dec_and_test(&doi_def->refcount)) {
462 spin_unlock(&calipso_doi_list_lock);
464 goto doi_remove_return;
466 list_del_rcu(&doi_def->list);
467 spin_unlock(&calipso_doi_list_lock);
469 call_rcu(&doi_def->rcu, calipso_doi_free_rcu);
473 audit_buf = netlbl_audit_start(AUDIT_MAC_CALIPSO_DEL, audit_info);
475 audit_log_format(audit_buf,
476 " calipso_doi=%u res=%u",
477 doi, ret_val == 0 ? 1 : 0);
478 audit_log_end(audit_buf);
485 * calipso_doi_getdef - Returns a reference to a valid DOI definition
486 * @doi: the DOI value
489 * Searches for a valid DOI definition and if one is found it is returned to
490 * the caller. Otherwise NULL is returned. The caller must ensure that
491 * calipso_doi_putdef() is called when the caller is done.
494 static struct calipso_doi *calipso_doi_getdef(u32 doi)
496 struct calipso_doi *doi_def;
499 doi_def = calipso_doi_search(doi);
501 goto doi_getdef_return;
502 if (!refcount_inc_not_zero(&doi_def->refcount))
511 * calipso_doi_putdef - Releases a reference for the given DOI definition
512 * @doi_def: the DOI definition
515 * Releases a DOI definition reference obtained from calipso_doi_getdef().
518 static void calipso_doi_putdef(struct calipso_doi *doi_def)
523 if (!refcount_dec_and_test(&doi_def->refcount))
525 spin_lock(&calipso_doi_list_lock);
526 list_del_rcu(&doi_def->list);
527 spin_unlock(&calipso_doi_list_lock);
529 call_rcu(&doi_def->rcu, calipso_doi_free_rcu);
533 * calipso_doi_walk - Iterate through the DOI definitions
534 * @skip_cnt: skip past this number of DOI definitions, updated
535 * @callback: callback for each DOI definition
536 * @cb_arg: argument for the callback function
539 * Iterate over the DOI definition list, skipping the first @skip_cnt entries.
540 * For each entry call @callback, if @callback returns a negative value stop
541 * 'walking' through the list and return. Updates the value in @skip_cnt upon
542 * return. Returns zero on success, negative values on failure.
545 static int calipso_doi_walk(u32 *skip_cnt,
546 int (*callback)(struct calipso_doi *doi_def,
550 int ret_val = -ENOENT;
552 struct calipso_doi *iter_doi;
555 list_for_each_entry_rcu(iter_doi, &calipso_doi_list, list)
556 if (refcount_read(&iter_doi->refcount) > 0) {
557 if (doi_cnt++ < *skip_cnt)
559 ret_val = callback(iter_doi, cb_arg);
562 goto doi_walk_return;
573 * calipso_validate - Validate a CALIPSO option
575 * @option: the start of the option
578 * This routine is called to validate a CALIPSO option.
579 * If the option is valid then %true is returned, otherwise
580 * %false is returned.
582 * The caller should have already checked that the length of the
583 * option (including the TLV header) is >= 10 and that the catmap
584 * length is consistent with the option length.
586 * We leave checks on the level and categories to the socket layer.
588 bool calipso_validate(const struct sk_buff *skb, const unsigned char *option)
590 struct calipso_doi *doi_def;
592 u16 crc, len = option[1] + 2;
593 static const u8 zero[2];
595 /* The original CRC runs over the option including the TLV header
596 * with the CRC-16 field (at offset 8) zeroed out. */
597 crc = crc_ccitt(0xffff, option, 8);
598 crc = crc_ccitt(crc, zero, sizeof(zero));
600 crc = crc_ccitt(crc, option + 10, len - 10);
602 if (option[8] != (crc & 0xff) || option[9] != ((crc >> 8) & 0xff))
606 doi_def = calipso_doi_search(get_unaligned_be32(option + 2));
614 * calipso_map_cat_hton - Perform a category mapping from host to network
615 * @doi_def: the DOI definition
616 * @secattr: the security attributes
617 * @net_cat: the zero'd out category bitmap in network/CALIPSO format
618 * @net_cat_len: the length of the CALIPSO bitmap in bytes
621 * Perform a label mapping to translate a local MLS category bitmap to the
622 * correct CALIPSO bitmap using the given DOI definition. Returns the minimum
623 * size in bytes of the network bitmap on success, negative values otherwise.
626 static int calipso_map_cat_hton(const struct calipso_doi *doi_def,
627 const struct netlbl_lsm_secattr *secattr,
628 unsigned char *net_cat,
632 u32 net_spot_max = 0;
633 u32 net_clen_bits = net_cat_len * 8;
636 spot = netlbl_catmap_walk(secattr->attr.mls.cat,
640 if (spot >= net_clen_bits)
642 netlbl_bitmap_setbit(net_cat, spot, 1);
644 if (spot > net_spot_max)
648 return (net_spot_max / 32 + 1) * 4;
652 * calipso_map_cat_ntoh - Perform a category mapping from network to host
653 * @doi_def: the DOI definition
654 * @net_cat: the category bitmap in network/CALIPSO format
655 * @net_cat_len: the length of the CALIPSO bitmap in bytes
656 * @secattr: the security attributes
659 * Perform a label mapping to translate a CALIPSO bitmap to the correct local
660 * MLS category bitmap using the given DOI definition. Returns zero on
661 * success, negative values on failure.
664 static int calipso_map_cat_ntoh(const struct calipso_doi *doi_def,
665 const unsigned char *net_cat,
667 struct netlbl_lsm_secattr *secattr)
671 u32 net_clen_bits = net_cat_len * 8;
674 spot = netlbl_bitmap_walk(net_cat,
684 ret_val = netlbl_catmap_setbit(&secattr->attr.mls.cat,
695 * calipso_pad_write - Writes pad bytes in TLV format
697 * @offset: offset from start of buffer to write padding
698 * @count: number of pad bytes to write
701 * Write @count bytes of TLV padding into @buffer starting at offset @offset.
702 * @count should be less than 8 - see RFC 4942.
705 static int calipso_pad_write(unsigned char *buf, unsigned int offset,
708 if (WARN_ON_ONCE(count >= 8))
715 buf[offset] = IPV6_TLV_PAD1;
718 buf[offset] = IPV6_TLV_PADN;
719 buf[offset + 1] = count - 2;
721 memset(buf + offset + 2, 0, count - 2);
728 * calipso_genopt - Generate a CALIPSO option
729 * @buf: the option buffer
730 * @start: offset from which to write
731 * @buf_len: the size of opt_buf
732 * @doi_def: the CALIPSO DOI to use
733 * @secattr: the security attributes
736 * Generate a CALIPSO option using the DOI definition and security attributes
737 * passed to the function. This also generates upto three bytes of leading
738 * padding that ensures that the option is 4n + 2 aligned. It returns the
739 * number of bytes written (including any initial padding).
741 static int calipso_genopt(unsigned char *buf, u32 start, u32 buf_len,
742 const struct calipso_doi *doi_def,
743 const struct netlbl_lsm_secattr *secattr)
748 static const unsigned char padding[4] = {2, 1, 0, 3};
749 unsigned char *calipso;
751 /* CALIPSO has 4n + 2 alignment */
752 pad = padding[start & 3];
753 if (buf_len <= start + pad + CALIPSO_HDR_LEN)
756 if ((secattr->flags & NETLBL_SECATTR_MLS_LVL) == 0)
759 len = CALIPSO_HDR_LEN;
761 if (secattr->flags & NETLBL_SECATTR_MLS_CAT) {
762 ret_val = calipso_map_cat_hton(doi_def,
764 buf + start + pad + len,
765 buf_len - start - pad - len);
771 calipso_pad_write(buf, start, pad);
772 calipso = buf + start + pad;
774 calipso[0] = IPV6_TLV_CALIPSO;
775 calipso[1] = len - 2;
776 *(__be32 *)(calipso + 2) = htonl(doi_def->doi);
777 calipso[6] = (len - CALIPSO_HDR_LEN) / 4;
778 calipso[7] = secattr->attr.mls.lvl,
779 crc = ~crc_ccitt(0xffff, calipso, len);
780 calipso[8] = crc & 0xff;
781 calipso[9] = (crc >> 8) & 0xff;
785 /* Hop-by-hop hdr helper functions
789 * calipso_opt_update - Replaces socket's hop options with a new set
791 * @hop: new hop options
794 * Replaces @sk's hop options with @hop. @hop may be NULL to leave
795 * the socket with no hop options.
798 static int calipso_opt_update(struct sock *sk, struct ipv6_opt_hdr *hop)
800 struct ipv6_txoptions *old = txopt_get(inet6_sk(sk)), *txopts;
802 txopts = ipv6_renew_options_kern(sk, old, IPV6_HOPOPTS,
803 hop, hop ? ipv6_optlen(hop) : 0);
806 return PTR_ERR(txopts);
808 txopts = ipv6_update_options(sk, txopts);
810 atomic_sub(txopts->tot_len, &sk->sk_omem_alloc);
818 * calipso_tlv_len - Returns the length of the TLV
819 * @opt: the option header
820 * @offset: offset of the TLV within the header
823 * Returns the length of the TLV option at offset @offset within
824 * the option header @opt. Checks that the entire TLV fits inside
825 * the option header, returns a negative value if this is not the case.
827 static int calipso_tlv_len(struct ipv6_opt_hdr *opt, unsigned int offset)
829 unsigned char *tlv = (unsigned char *)opt;
830 unsigned int opt_len = ipv6_optlen(opt), tlv_len;
832 if (offset < sizeof(*opt) || offset >= opt_len)
834 if (tlv[offset] == IPV6_TLV_PAD1)
836 if (offset + 1 >= opt_len)
838 tlv_len = tlv[offset + 1] + 2;
839 if (offset + tlv_len > opt_len)
845 * calipso_opt_find - Finds the CALIPSO option in an IPv6 hop options header
846 * @hop: the hop options header
847 * @start: on return holds the offset of any leading padding
848 * @end: on return holds the offset of the first non-pad TLV after CALIPSO
851 * Finds the space occupied by a CALIPSO option (including any leading and
854 * If a CALIPSO option exists set @start and @end to the
855 * offsets within @hop of the start of padding before the first
856 * CALIPSO option and the end of padding after the first CALIPSO
857 * option. In this case the function returns 0.
859 * In the absence of a CALIPSO option, @start and @end will be
860 * set to the start and end of any trailing padding in the header.
861 * This is useful when appending a new option, as the caller may want
862 * to overwrite some of this padding. In this case the function will
865 static int calipso_opt_find(struct ipv6_opt_hdr *hop, unsigned int *start,
868 int ret_val = -ENOENT, tlv_len;
869 unsigned int opt_len, offset, offset_s = 0, offset_e = 0;
870 unsigned char *opt = (unsigned char *)hop;
872 opt_len = ipv6_optlen(hop);
873 offset = sizeof(*hop);
875 while (offset < opt_len) {
876 tlv_len = calipso_tlv_len(hop, offset);
880 switch (opt[offset]) {
886 case IPV6_TLV_CALIPSO:
901 *start = offset_s + calipso_tlv_len(hop, offset_s);
903 *start = sizeof(*hop);
905 *end = offset_e + calipso_tlv_len(hop, offset_e);
913 * calipso_opt_insert - Inserts a CALIPSO option into an IPv6 hop opt hdr
914 * @hop: the original hop options header
915 * @doi_def: the CALIPSO DOI to use
916 * @secattr: the specific security attributes of the socket
919 * Creates a new hop options header based on @hop with a
920 * CALIPSO option added to it. If @hop already contains a CALIPSO
921 * option this is overwritten, otherwise the new option is appended
922 * after any existing options. If @hop is NULL then the new header
923 * will contain just the CALIPSO option and any needed padding.
926 static struct ipv6_opt_hdr *
927 calipso_opt_insert(struct ipv6_opt_hdr *hop,
928 const struct calipso_doi *doi_def,
929 const struct netlbl_lsm_secattr *secattr)
931 unsigned int start, end, buf_len, pad, hop_len;
932 struct ipv6_opt_hdr *new;
936 hop_len = ipv6_optlen(hop);
937 ret_val = calipso_opt_find(hop, &start, &end);
938 if (ret_val && ret_val != -ENOENT)
939 return ERR_PTR(ret_val);
942 start = sizeof(*hop);
946 buf_len = hop_len + start - end + CALIPSO_OPT_LEN_MAX_WITH_PAD;
947 new = kzalloc(buf_len, GFP_ATOMIC);
949 return ERR_PTR(-ENOMEM);
951 if (start > sizeof(*hop))
952 memcpy(new, hop, start);
953 ret_val = calipso_genopt((unsigned char *)new, start, buf_len, doi_def,
957 return ERR_PTR(ret_val);
960 buf_len = start + ret_val;
961 /* At this point buf_len aligns to 4n, so (buf_len & 4) pads to 8n */
962 pad = ((buf_len & 4) + (end & 7)) & 7;
963 calipso_pad_write((unsigned char *)new, buf_len, pad);
966 if (end != hop_len) {
967 memcpy((char *)new + buf_len, (char *)hop + end, hop_len - end);
968 buf_len += hop_len - end;
971 new->hdrlen = buf_len / 8 - 1;
977 * calipso_opt_del - Removes the CALIPSO option from an option header
978 * @hop: the original header
979 * @new: the new header
982 * Creates a new header based on @hop without any CALIPSO option. If @hop
983 * doesn't contain a CALIPSO option it returns -ENOENT. If @hop contains
984 * no other non-padding options, it returns zero with @new set to NULL.
985 * Otherwise it returns zero, creates a new header without the CALIPSO
986 * option (and removing as much padding as possible) and returns with
987 * @new set to that header.
990 static int calipso_opt_del(struct ipv6_opt_hdr *hop,
991 struct ipv6_opt_hdr **new)
994 unsigned int start, end, delta, pad, hop_len;
996 ret_val = calipso_opt_find(hop, &start, &end);
1000 hop_len = ipv6_optlen(hop);
1001 if (start == sizeof(*hop) && end == hop_len) {
1002 /* There's no other option in the header so return NULL */
1007 delta = (end - start) & ~7;
1008 *new = kzalloc(hop_len - delta, GFP_ATOMIC);
1012 memcpy(*new, hop, start);
1013 (*new)->hdrlen -= delta / 8;
1014 pad = (end - start) & 7;
1015 calipso_pad_write((unsigned char *)*new, start, pad);
1017 memcpy((char *)*new + start + pad, (char *)hop + end,
1024 * calipso_opt_getattr - Get the security attributes from a memory block
1025 * @calipso: the CALIPSO option
1026 * @secattr: the security attributes
1029 * Inspect @calipso and return the security attributes in @secattr.
1030 * Returns zero on success and negative values on failure.
1033 static int calipso_opt_getattr(const unsigned char *calipso,
1034 struct netlbl_lsm_secattr *secattr)
1036 int ret_val = -ENOMSG;
1037 u32 doi, len = calipso[1], cat_len = calipso[6] * 4;
1038 struct calipso_doi *doi_def;
1040 if (cat_len + 8 > len)
1043 if (calipso_cache_check(calipso + 2, calipso[1], secattr) == 0)
1046 doi = get_unaligned_be32(calipso + 2);
1048 doi_def = calipso_doi_search(doi);
1050 goto getattr_return;
1052 secattr->attr.mls.lvl = calipso[7];
1053 secattr->flags |= NETLBL_SECATTR_MLS_LVL;
1056 ret_val = calipso_map_cat_ntoh(doi_def,
1061 netlbl_catmap_free(secattr->attr.mls.cat);
1062 goto getattr_return;
1065 secattr->flags |= NETLBL_SECATTR_MLS_CAT;
1068 secattr->type = NETLBL_NLTYPE_CALIPSO;
1079 * calipso_sock_getattr - Get the security attributes from a sock
1081 * @secattr: the security attributes
1084 * Query @sk to see if there is a CALIPSO option attached to the sock and if
1085 * there is return the CALIPSO security attributes in @secattr. This function
1086 * requires that @sk be locked, or privately held, but it does not do any
1087 * locking itself. Returns zero on success and negative values on failure.
1090 static int calipso_sock_getattr(struct sock *sk,
1091 struct netlbl_lsm_secattr *secattr)
1093 struct ipv6_opt_hdr *hop;
1094 int opt_len, len, ret_val = -ENOMSG, offset;
1096 struct ipv6_txoptions *txopts = txopt_get(inet6_sk(sk));
1098 if (!txopts || !txopts->hopopt)
1101 hop = txopts->hopopt;
1102 opt = (unsigned char *)hop;
1103 opt_len = ipv6_optlen(hop);
1104 offset = sizeof(*hop);
1105 while (offset < opt_len) {
1106 len = calipso_tlv_len(hop, offset);
1111 switch (opt[offset]) {
1112 case IPV6_TLV_CALIPSO:
1113 if (len < CALIPSO_HDR_LEN)
1116 ret_val = calipso_opt_getattr(&opt[offset],
1130 * calipso_sock_setattr - Add a CALIPSO option to a socket
1132 * @doi_def: the CALIPSO DOI to use
1133 * @secattr: the specific security attributes of the socket
1136 * Set the CALIPSO option on the given socket using the DOI definition and
1137 * security attributes passed to the function. This function requires
1138 * exclusive access to @sk, which means it either needs to be in the
1139 * process of being created or locked. Returns zero on success and negative
1140 * values on failure.
1143 static int calipso_sock_setattr(struct sock *sk,
1144 const struct calipso_doi *doi_def,
1145 const struct netlbl_lsm_secattr *secattr)
1148 struct ipv6_opt_hdr *old, *new;
1149 struct ipv6_txoptions *txopts = txopt_get(inet6_sk(sk));
1153 old = txopts->hopopt;
1155 new = calipso_opt_insert(old, doi_def, secattr);
1158 return PTR_ERR(new);
1160 ret_val = calipso_opt_update(sk, new);
1167 * calipso_sock_delattr - Delete the CALIPSO option from a socket
1171 * Removes the CALIPSO option from a socket, if present.
1174 static void calipso_sock_delattr(struct sock *sk)
1176 struct ipv6_opt_hdr *new_hop;
1177 struct ipv6_txoptions *txopts = txopt_get(inet6_sk(sk));
1179 if (!txopts || !txopts->hopopt)
1182 if (calipso_opt_del(txopts->hopopt, &new_hop))
1185 calipso_opt_update(sk, new_hop);
1192 /* request sock functions.
1196 * calipso_req_setattr - Add a CALIPSO option to a connection request socket
1197 * @req: the connection request socket
1198 * @doi_def: the CALIPSO DOI to use
1199 * @secattr: the specific security attributes of the socket
1202 * Set the CALIPSO option on the given socket using the DOI definition and
1203 * security attributes passed to the function. Returns zero on success and
1204 * negative values on failure.
1207 static int calipso_req_setattr(struct request_sock *req,
1208 const struct calipso_doi *doi_def,
1209 const struct netlbl_lsm_secattr *secattr)
1211 struct ipv6_txoptions *txopts;
1212 struct inet_request_sock *req_inet = inet_rsk(req);
1213 struct ipv6_opt_hdr *old, *new;
1214 struct sock *sk = sk_to_full_sk(req_to_sk(req));
1216 if (req_inet->ipv6_opt && req_inet->ipv6_opt->hopopt)
1217 old = req_inet->ipv6_opt->hopopt;
1221 new = calipso_opt_insert(old, doi_def, secattr);
1223 return PTR_ERR(new);
1225 txopts = ipv6_renew_options_kern(sk, req_inet->ipv6_opt, IPV6_HOPOPTS,
1226 new, new ? ipv6_optlen(new) : 0);
1231 return PTR_ERR(txopts);
1233 txopts = xchg(&req_inet->ipv6_opt, txopts);
1235 atomic_sub(txopts->tot_len, &sk->sk_omem_alloc);
1243 * calipso_req_delattr - Delete the CALIPSO option from a request socket
1244 * @reg: the request socket
1247 * Removes the CALIPSO option from a request socket, if present.
1250 static void calipso_req_delattr(struct request_sock *req)
1252 struct inet_request_sock *req_inet = inet_rsk(req);
1253 struct ipv6_opt_hdr *new;
1254 struct ipv6_txoptions *txopts;
1255 struct sock *sk = sk_to_full_sk(req_to_sk(req));
1257 if (!req_inet->ipv6_opt || !req_inet->ipv6_opt->hopopt)
1260 if (calipso_opt_del(req_inet->ipv6_opt->hopopt, &new))
1261 return; /* Nothing to do */
1263 txopts = ipv6_renew_options_kern(sk, req_inet->ipv6_opt, IPV6_HOPOPTS,
1264 new, new ? ipv6_optlen(new) : 0);
1266 if (!IS_ERR(txopts)) {
1267 txopts = xchg(&req_inet->ipv6_opt, txopts);
1269 atomic_sub(txopts->tot_len, &sk->sk_omem_alloc);
1276 /* skbuff functions.
1280 * calipso_skbuff_optptr - Find the CALIPSO option in the packet
1284 * Parse the packet's IP header looking for a CALIPSO option. Returns a pointer
1285 * to the start of the CALIPSO option on success, NULL if one if not found.
1288 static unsigned char *calipso_skbuff_optptr(const struct sk_buff *skb)
1290 const struct ipv6hdr *ip6_hdr = ipv6_hdr(skb);
1293 if (ip6_hdr->nexthdr != NEXTHDR_HOP)
1296 offset = ipv6_find_tlv(skb, sizeof(*ip6_hdr), IPV6_TLV_CALIPSO);
1298 return (unsigned char *)ip6_hdr + offset;
1304 * calipso_skbuff_setattr - Set the CALIPSO option on a packet
1306 * @doi_def: the CALIPSO DOI to use
1307 * @secattr: the security attributes
1310 * Set the CALIPSO option on the given packet based on the security attributes.
1311 * Returns a pointer to the IP header on success and NULL on failure.
1314 static int calipso_skbuff_setattr(struct sk_buff *skb,
1315 const struct calipso_doi *doi_def,
1316 const struct netlbl_lsm_secattr *secattr)
1319 struct ipv6hdr *ip6_hdr;
1320 struct ipv6_opt_hdr *hop;
1321 unsigned char buf[CALIPSO_MAX_BUFFER];
1322 int len_delta, new_end, pad, payload;
1323 unsigned int start, end;
1325 ip6_hdr = ipv6_hdr(skb);
1326 if (ip6_hdr->nexthdr == NEXTHDR_HOP) {
1327 hop = (struct ipv6_opt_hdr *)(ip6_hdr + 1);
1328 ret_val = calipso_opt_find(hop, &start, &end);
1329 if (ret_val && ret_val != -ENOENT)
1336 memset(buf, 0, sizeof(buf));
1337 ret_val = calipso_genopt(buf, start & 3, sizeof(buf), doi_def, secattr);
1341 new_end = start + ret_val;
1342 /* At this point new_end aligns to 4n, so (new_end & 4) pads to 8n */
1343 pad = ((new_end & 4) + (end & 7)) & 7;
1344 len_delta = new_end - (int)end + pad;
1345 ret_val = skb_cow(skb, skb_headroom(skb) + len_delta);
1349 ip6_hdr = ipv6_hdr(skb); /* Reset as skb_cow() may have moved it */
1353 skb_push(skb, len_delta);
1355 skb_pull(skb, -len_delta);
1356 memmove((char *)ip6_hdr - len_delta, ip6_hdr,
1357 sizeof(*ip6_hdr) + start);
1358 skb_reset_network_header(skb);
1359 ip6_hdr = ipv6_hdr(skb);
1360 payload = ntohs(ip6_hdr->payload_len);
1361 ip6_hdr->payload_len = htons(payload + len_delta);
1364 hop = (struct ipv6_opt_hdr *)(ip6_hdr + 1);
1366 struct ipv6_opt_hdr *new_hop = (struct ipv6_opt_hdr *)buf;
1368 new_hop->nexthdr = ip6_hdr->nexthdr;
1369 new_hop->hdrlen = len_delta / 8 - 1;
1370 ip6_hdr->nexthdr = NEXTHDR_HOP;
1372 hop->hdrlen += len_delta / 8;
1374 memcpy((char *)hop + start, buf + (start & 3), new_end - start);
1375 calipso_pad_write((unsigned char *)hop, new_end, pad);
1381 * calipso_skbuff_delattr - Delete any CALIPSO options from a packet
1385 * Removes any and all CALIPSO options from the given packet. Returns zero on
1386 * success, negative values on failure.
1389 static int calipso_skbuff_delattr(struct sk_buff *skb)
1392 struct ipv6hdr *ip6_hdr;
1393 struct ipv6_opt_hdr *old_hop;
1394 u32 old_hop_len, start = 0, end = 0, delta, size, pad;
1396 if (!calipso_skbuff_optptr(skb))
1399 /* since we are changing the packet we should make a copy */
1400 ret_val = skb_cow(skb, skb_headroom(skb));
1404 ip6_hdr = ipv6_hdr(skb);
1405 old_hop = (struct ipv6_opt_hdr *)(ip6_hdr + 1);
1406 old_hop_len = ipv6_optlen(old_hop);
1408 ret_val = calipso_opt_find(old_hop, &start, &end);
1412 if (start == sizeof(*old_hop) && end == old_hop_len) {
1413 /* There's no other option in the header so we delete
1414 * the whole thing. */
1415 delta = old_hop_len;
1416 size = sizeof(*ip6_hdr);
1417 ip6_hdr->nexthdr = old_hop->nexthdr;
1419 delta = (end - start) & ~7;
1421 old_hop->hdrlen -= delta / 8;
1422 pad = (end - start) & 7;
1423 size = sizeof(*ip6_hdr) + start + pad;
1424 calipso_pad_write((unsigned char *)old_hop, start, pad);
1428 skb_pull(skb, delta);
1429 memmove((char *)ip6_hdr + delta, ip6_hdr, size);
1430 skb_reset_network_header(skb);
1436 static const struct netlbl_calipso_ops ops = {
1437 .doi_add = calipso_doi_add,
1438 .doi_free = calipso_doi_free,
1439 .doi_remove = calipso_doi_remove,
1440 .doi_getdef = calipso_doi_getdef,
1441 .doi_putdef = calipso_doi_putdef,
1442 .doi_walk = calipso_doi_walk,
1443 .sock_getattr = calipso_sock_getattr,
1444 .sock_setattr = calipso_sock_setattr,
1445 .sock_delattr = calipso_sock_delattr,
1446 .req_setattr = calipso_req_setattr,
1447 .req_delattr = calipso_req_delattr,
1448 .opt_getattr = calipso_opt_getattr,
1449 .skbuff_optptr = calipso_skbuff_optptr,
1450 .skbuff_setattr = calipso_skbuff_setattr,
1451 .skbuff_delattr = calipso_skbuff_delattr,
1452 .cache_invalidate = calipso_cache_invalidate,
1453 .cache_add = calipso_cache_add
1457 * calipso_init - Initialize the CALIPSO module
1460 * Initialize the CALIPSO module and prepare it for use. Returns zero on
1461 * success and negative values on failure.
1464 int __init calipso_init(void)
1468 ret_val = calipso_cache_init();
1470 netlbl_calipso_ops_register(&ops);
1474 void calipso_exit(void)
1476 netlbl_calipso_ops_register(NULL);
1477 calipso_cache_invalidate();
1478 kfree(calipso_cache);