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
  44 /* known doi values */
  45 #define CIPSO_V4_DOI_UNKNOWN          0x00000000
  46
  47 /* tag types */
  48 #define CIPSO_V4_TAG_INVALID          0
  49 #define CIPSO_V4_TAG_RBITMAP          1
  50 #define CIPSO_V4_TAG_ENUM             2
  51 #define CIPSO_V4_TAG_RANGE            5
  52 #define CIPSO_V4_TAG_PBITMAP          6
  53 #define CIPSO_V4_TAG_FREEFORM         7
  54
  55 /* doi mapping types */
  56 #define CIPSO_V4_MAP_UNKNOWN          0
  57 #define CIPSO_V4_MAP_STD              1
  58 #define CIPSO_V4_MAP_PASS             2
  59
  60 /* limits */
  61 #define CIPSO_V4_MAX_REM_LVLS         255
  62 #define CIPSO_V4_INV_LVL              0x80000000
  63 #define CIPSO_V4_MAX_LOC_LVLS         (CIPSO_V4_INV_LVL - 1)
  64 #define CIPSO_V4_MAX_REM_CATS         65534
  65 #define CIPSO_V4_INV_CAT              0x80000000
  66 #define CIPSO_V4_MAX_LOC_CATS         (CIPSO_V4_INV_CAT - 1)
  67
  68 /*
  69  * CIPSO DOI definitions
  70  */
  71
  72 /* DOI definition struct */
  73 #define CIPSO_V4_TAG_MAXCNT           5
  74 struct cipso_v4_doi {
  75         u32 doi;
  76         u32 type;
  77         union {
  78                 struct cipso_v4_std_map_tbl *std;
  79         } map;
  80         u8 tags[CIPSO_V4_TAG_MAXCNT];
  81
  82         u32 valid;
  83         struct list_head list;
  84         struct rcu_head rcu;
  85         struct list_head dom_list;
  86 };
  87
  88 /* Standard CIPSO mapping table */
  89 /* NOTE: the highest order bit (i.e. 0x80000000) is an 'invalid' flag, if the
  90  *       bit is set then consider that value as unspecified, meaning the
  91  *       mapping for that particular level/category is invalid */
  92 struct cipso_v4_std_map_tbl {
  93         struct {
  94                 u32 *cipso;
  95                 u32 *local;
  96                 u32 cipso_size;
  97                 u32 local_size;
  98         } lvl;
  99         struct {
 100                 u32 *cipso;
 101                 u32 *local;
 102                 u32 cipso_size;
 103                 u32 local_size;
 104         } cat;
 105 };
 106
 107 /*
 108  * Sysctl Variables
 109  */
 110
 111 #ifdef CONFIG_NETLABEL
 112 extern int cipso_v4_cache_enabled;
 113 extern int cipso_v4_cache_bucketsize;
 114 extern int cipso_v4_rbm_optfmt;
 115 extern int cipso_v4_rbm_strictvalid;
 116 #endif
 117
 118 /*
 119  * Helper Functions
 120  */
 121
 122 #define CIPSO_V4_OPTEXIST(x) (IPCB(x)->opt.cipso != 0)
 123 #define CIPSO_V4_OPTPTR(x) ((x)->nh.raw + IPCB(x)->opt.cipso)
 124
 125 /*
 126  * DOI List Functions
 127  */
 128
 129 #ifdef CONFIG_NETLABEL
 130 int cipso_v4_doi_add(struct cipso_v4_doi *doi_def);
 131 int cipso_v4_doi_remove(u32 doi,
 132                         struct netlbl_audit *audit_info,
 133                         void (*callback) (struct rcu_head * head));
 134 struct cipso_v4_doi *cipso_v4_doi_getdef(u32 doi);
 135 int cipso_v4_doi_walk(u32 *skip_cnt,
 136                      int (*callback) (struct cipso_v4_doi *doi_def, void *arg),
 137                      void *cb_arg);
 138 int cipso_v4_doi_domhsh_add(struct cipso_v4_doi *doi_def, const char *domain);
 139 int cipso_v4_doi_domhsh_remove(struct cipso_v4_doi *doi_def,
 140                                const char *domain);
 141 #else
 142 static inline int cipso_v4_doi_add(struct cipso_v4_doi *doi_def)
 143 {
 144         return -ENOSYS;
 145 }
 146
 147 static inline int cipso_v4_doi_remove(u32 doi,
 148                                     struct netlbl_audit *audit_info,
 149                                     void (*callback) (struct rcu_head * head))
 150 {
 151         return 0;
 152 }
 153
 154 static inline struct cipso_v4_doi *cipso_v4_doi_getdef(u32 doi)
 155 {
 156         return NULL;
 157 }
 158
 159 static inline int cipso_v4_doi_walk(u32 *skip_cnt,
 160                      int (*callback) (struct cipso_v4_doi *doi_def, void *arg),
 161                      void *cb_arg)
 162 {
 163         return 0;
 164 }
 165
 166 static inline int cipso_v4_doi_domhsh_add(struct cipso_v4_doi *doi_def,
 167                                           const char *domain)
 168 {
 169         return -ENOSYS;
 170 }
 171
 172 static inline int cipso_v4_doi_domhsh_remove(struct cipso_v4_doi *doi_def,
 173                                              const char *domain)
 174 {
 175         return 0;
 176 }
 177 #endif /* CONFIG_NETLABEL */
 178
 179 /*
 180  * Label Mapping Cache Functions
 181  */
 182
 183 #ifdef CONFIG_NETLABEL
 184 void cipso_v4_cache_invalidate(void);
 185 int cipso_v4_cache_add(const struct sk_buff *skb,
 186                        const struct netlbl_lsm_secattr *secattr);
 187 #else
 188 static inline void cipso_v4_cache_invalidate(void)
 189 {
 190         return;
 191 }
 192
 193 static inline int cipso_v4_cache_add(const struct sk_buff *skb,
 194                                      const struct netlbl_lsm_secattr *secattr)
 195 {
 196         return 0;
 197 }
 198 #endif /* CONFIG_NETLABEL */
 199
 200 /*
 201  * Protocol Handling Functions
 202  */
 203
 204 #ifdef CONFIG_NETLABEL
 205 void cipso_v4_error(struct sk_buff *skb, int error, u32 gateway);
 206 int cipso_v4_socket_setattr(const struct socket *sock,
 207                             const struct cipso_v4_doi *doi_def,
 208                             const struct netlbl_lsm_secattr *secattr);
 209 int cipso_v4_sock_getattr(struct sock *sk, struct netlbl_lsm_secattr *secattr);
 210 int cipso_v4_socket_getattr(const struct socket *sock,
 211                             struct netlbl_lsm_secattr *secattr);
 212 int cipso_v4_skbuff_getattr(const struct sk_buff *skb,
 213                             struct netlbl_lsm_secattr *secattr);
 214 int cipso_v4_validate(unsigned char **option);
 215 #else
 216 static inline void cipso_v4_error(struct sk_buff *skb,
 217                                   int error,
 218                                   u32 gateway)
 219 {
 220         return;
 221 }
 222
 223 static inline int cipso_v4_socket_setattr(const struct socket *sock,
 224                                   const struct cipso_v4_doi *doi_def,
 225                                   const struct netlbl_lsm_secattr *secattr)
 226 {
 227         return -ENOSYS;
 228 }
 229
 230 static inline int cipso_v4_sock_getattr(struct sock *sk,
 231                                         struct netlbl_lsm_secattr *secattr)
 232 {
 233         return -ENOSYS;
 234 }
 235
 236 static inline int cipso_v4_socket_getattr(const struct socket *sock,
 237                                           struct netlbl_lsm_secattr *secattr)
 238 {
 239         return -ENOSYS;
 240 }
 241
 242 static inline int cipso_v4_skbuff_getattr(const struct sk_buff *skb,
 243                                           struct netlbl_lsm_secattr *secattr)
 244 {
 245         return -ENOSYS;
 246 }
 247
 248 static inline int cipso_v4_validate(unsigned char **option)
 249 {
 250         return -ENOSYS;
 251 }
 252 #endif /* CONFIG_NETLABEL */
 253
 254 #endif /* _CIPSO_IPV4_H */