include/net/cipso_ipv4.h

   1 /*
   2  * CIPSO - Commercial IP Security Option
   3  *
   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, copies of both documents can be found in the Documentation
   7  * directory.  While CIPSO never became a full IETF RFC standard many vendors
   8  * have chosen to adopt the protocol and over the years it has become a
   9  * de-facto standard for labeled networking.
  10  *
  11  * Author: Paul Moore <paul.moore@hp.com>
  12  *
  13  */
  14
  15 /*
  16  * (c) Copyright Hewlett-Packard Development Company, L.P., 2006
  17  *
  18  * This program is free software;  you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation; either version 2 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY;  without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
  26  * the GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program;  if not, write to the Free Software
  30  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  31  *
  32  */
  33
  34 #ifndef _CIPSO_IPV4_H
  35 #define _CIPSO_IPV4_H
  36
  37 #include <linux/types.h>
  38 #include <linux/rcupdate.h>
  39 #include <linux/list.h>
  40 #include <linux/net.h>
  41 #include <linux/skbuff.h>
  42 #include <net/netlabel.h>
  43 #include <asm/atomic.h>
  44
  45 /* known doi values */
  46 #define CIPSO_V4_DOI_UNKNOWN          0x00000000
  47
  48 /* standard tag types */
  49 #define CIPSO_V4_TAG_INVALID          0
  50 #define CIPSO_V4_TAG_RBITMAP          1
  51 #define CIPSO_V4_TAG_ENUM             2
  52 #define CIPSO_V4_TAG_RANGE            5
  53 #define CIPSO_V4_TAG_PBITMAP          6
  54 #define CIPSO_V4_TAG_FREEFORM         7
  55
  56 /* non-standard tag types (tags > 127) */
  57 #define CIPSO_V4_TAG_LOCAL            128
  58
  59 /* doi mapping types */
  60 #define CIPSO_V4_MAP_UNKNOWN          0
  61 #define CIPSO_V4_MAP_TRANS            1
  62 #define CIPSO_V4_MAP_PASS             2
  63 #define CIPSO_V4_MAP_LOCAL            3
  64
  65 /* limits */
  66 #define CIPSO_V4_MAX_REM_LVLS         255
  67 #define CIPSO_V4_INV_LVL              0x80000000
  68 #define CIPSO_V4_MAX_LOC_LVLS         (CIPSO_V4_INV_LVL - 1)
  69 #define CIPSO_V4_MAX_REM_CATS         65534
  70 #define CIPSO_V4_INV_CAT              0x80000000
  71 #define CIPSO_V4_MAX_LOC_CATS         (CIPSO_V4_INV_CAT - 1)
  72
  73 /*
  74  * CIPSO DOI definitions
  75  */
  76
  77 /* DOI definition struct */
  78 #define CIPSO_V4_TAG_MAXCNT           5
  79 struct cipso_v4_doi {
  80         u32 doi;
  81         u32 type;
  82         union {
  83                 struct cipso_v4_std_map_tbl *std;
  84         } map;
  85         u8 tags[CIPSO_V4_TAG_MAXCNT];
  86
  87         atomic_t refcount;
  88         struct list_head list;
  89         struct rcu_head rcu;
  90 };
  91
  92 /* Standard CIPSO mapping table */
  93 /* NOTE: the highest order bit (i.e. 0x80000000) is an 'invalid' flag, if the
  94  *       bit is set then consider that value as unspecified, meaning the
  95  *       mapping for that particular level/category is invalid */
  96 struct cipso_v4_std_map_tbl {
  97         struct {
  98                 u32 *cipso;
  99                 u32 *local;
 100                 u32 cipso_size;
 101                 u32 local_size;
 102         } lvl;
 103         struct {
 104                 u32 *cipso;
 105                 u32 *local;
 106                 u32 cipso_size;
 107                 u32 local_size;
 108         } cat;
 109 };
 110
 111 /*
 112  * Sysctl Variables
 113  */
 114
 115 #ifdef CONFIG_NETLABEL
 116 extern int cipso_v4_cache_enabled;
 117 extern int cipso_v4_cache_bucketsize;
 118 extern int cipso_v4_rbm_optfmt;
 119 extern int cipso_v4_rbm_strictvalid;
 120 #endif
 121
 122 /*
 123  * Helper Functions
 124  */
 125
 126 #define CIPSO_V4_OPTEXIST(x) (IPCB(x)->opt.cipso != 0)
 127 #define CIPSO_V4_OPTPTR(x) (skb_network_header(x) + IPCB(x)->opt.cipso)
 128
 129 /*
 130  * DOI List Functions
 131  */
 132
 133 #ifdef CONFIG_NETLABEL
 134 int cipso_v4_doi_add(struct cipso_v4_doi *doi_def);
 135 void cipso_v4_doi_free(struct cipso_v4_doi *doi_def);
 136 int cipso_v4_doi_remove(u32 doi, struct netlbl_audit *audit_info);
 137 struct cipso_v4_doi *cipso_v4_doi_getdef(u32 doi);
 138 void cipso_v4_doi_putdef(struct cipso_v4_doi *doi_def);
 139 int cipso_v4_doi_walk(u32 *skip_cnt,
 140                      int (*callback) (struct cipso_v4_doi *doi_def, void *arg),
 141                      void *cb_arg);
 142 #else
 143 static inline int cipso_v4_doi_add(struct cipso_v4_doi *doi_def)
 144 {
 145         return -ENOSYS;
 146 }
 147
 148 static inline void cipso_v4_doi_free(struct cipso_v4_doi *doi_def)
 149 {
 150         return;
 151 }
 152
 153 static inline int cipso_v4_doi_remove(u32 doi,
 154                                       struct netlbl_audit *audit_info)
 155 {
 156         return 0;
 157 }
 158
 159 static inline struct cipso_v4_doi *cipso_v4_doi_getdef(u32 doi)
 160 {
 161         return NULL;
 162 }
 163
 164 static inline int cipso_v4_doi_walk(u32 *skip_cnt,
 165                      int (*callback) (struct cipso_v4_doi *doi_def, void *arg),
 166                      void *cb_arg)
 167 {
 168         return 0;
 169 }
 170
 171 static inline int cipso_v4_doi_domhsh_add(struct cipso_v4_doi *doi_def,
 172                                           const char *domain)
 173 {
 174         return -ENOSYS;
 175 }
 176
 177 static inline int cipso_v4_doi_domhsh_remove(struct cipso_v4_doi *doi_def,
 178                                              const char *domain)
 179 {
 180         return 0;
 181 }
 182 #endif /* CONFIG_NETLABEL */
 183
 184 /*
 185  * Label Mapping Cache Functions
 186  */
 187
 188 #ifdef CONFIG_NETLABEL
 189 void cipso_v4_cache_invalidate(void);
 190 int cipso_v4_cache_add(const struct sk_buff *skb,
 191                        const struct netlbl_lsm_secattr *secattr);
 192 #else
 193 static inline void cipso_v4_cache_invalidate(void)
 194 {
 195         return;
 196 }
 197
 198 static inline int cipso_v4_cache_add(const struct sk_buff *skb,
 199                                      const struct netlbl_lsm_secattr *secattr)
 200 {
 201         return 0;
 202 }
 203 #endif /* CONFIG_NETLABEL */
 204
 205 /*
 206  * Protocol Handling Functions
 207  */
 208
 209 #ifdef CONFIG_NETLABEL
 210 void cipso_v4_error(struct sk_buff *skb, int error, u32 gateway);
 211 int cipso_v4_sock_setattr(struct sock *sk,
 212                           const struct cipso_v4_doi *doi_def,
 213                           const struct netlbl_lsm_secattr *secattr);
 214 void cipso_v4_sock_delattr(struct sock *sk);
 215 int cipso_v4_sock_getattr(struct sock *sk, struct netlbl_lsm_secattr *secattr);
 216 int cipso_v4_skbuff_setattr(struct sk_buff *skb,
 217                             const struct cipso_v4_doi *doi_def,
 218                             const struct netlbl_lsm_secattr *secattr);
 219 int cipso_v4_skbuff_delattr(struct sk_buff *skb);
 220 int cipso_v4_skbuff_getattr(const struct sk_buff *skb,
 221                             struct netlbl_lsm_secattr *secattr);
 222 int cipso_v4_validate(const struct sk_buff *skb, unsigned char **option);
 223 #else
 224 static inline void cipso_v4_error(struct sk_buff *skb,
 225                                   int error,
 226                                   u32 gateway)
 227 {
 228         return;
 229 }
 230
 231 static inline int cipso_v4_sock_setattr(struct sock *sk,
 232                                       const struct cipso_v4_doi *doi_def,
 233                                       const struct netlbl_lsm_secattr *secattr)
 234 {
 235         return -ENOSYS;
 236 }
 237
 238 static inline void cipso_v4_sock_delattr(struct sock *sk)
 239 {
 240 }
 241
 242 static inline int cipso_v4_sock_getattr(struct sock *sk,
 243                                         struct netlbl_lsm_secattr *secattr)
 244 {
 245         return -ENOSYS;
 246 }
 247
 248 static inline int cipso_v4_skbuff_setattr(struct sk_buff *skb,
 249                                       const struct cipso_v4_doi *doi_def,
 250                                       const struct netlbl_lsm_secattr *secattr)
 251 {
 252         return -ENOSYS;
 253 }
 254
 255 static inline int cipso_v4_skbuff_delattr(struct sk_buff *skb)
 256 {
 257         return -ENOSYS;
 258 }
 259
 260 static inline int cipso_v4_skbuff_getattr(const struct sk_buff *skb,
 261                                           struct netlbl_lsm_secattr *secattr)
 262 {
 263         return -ENOSYS;
 264 }
 265
 266 static inline int cipso_v4_validate(const struct sk_buff *skb,
 267                                     unsigned char **option)
 268 {
 269         return -ENOSYS;
 270 }
 271 #endif /* CONFIG_NETLABEL */
 272
 273 #endif /* _CIPSO_IPV4_H */