[NetLabel]: audit fixups due to delayed feedback
[safe/jmp/linux-2.6] / include / net / netlabel.h
1 /*
2  * NetLabel System
3  *
4  * The NetLabel system manages static and dynamic label mappings for network
5  * protocols such as CIPSO and RIPSO.
6  *
7  * Author: Paul Moore <paul.moore@hp.com>
8  *
9  */
10
11 /*
12  * (c) Copyright Hewlett-Packard Development Company, L.P., 2006
13  *
14  * This program is free software;  you can redistribute it and/or modify
15  * it under the terms of the GNU General Public License as published by
16  * the Free Software Foundation; either version 2 of the License, or
17  * (at your option) any later version.
18  *
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY;  without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
22  * the GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program;  if not, write to the Free Software
26  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27  *
28  */
29
30 #ifndef _NETLABEL_H
31 #define _NETLABEL_H
32
33 #include <linux/types.h>
34 #include <linux/net.h>
35 #include <linux/skbuff.h>
36 #include <net/netlink.h>
37
38 /*
39  * NetLabel - A management interface for maintaining network packet label
40  *            mapping tables for explicit packet labling protocols.
41  *
42  * Network protocols such as CIPSO and RIPSO require a label translation layer
43  * to convert the label on the packet into something meaningful on the host
44  * machine.  In the current Linux implementation these mapping tables live
45  * inside the kernel; NetLabel provides a mechanism for user space applications
46  * to manage these mapping tables.
47  *
48  * NetLabel makes use of the Generic NETLINK mechanism as a transport layer to
49  * send messages between kernel and user space.  The general format of a
50  * NetLabel message is shown below:
51  *
52  *  +-----------------+-------------------+--------- --- -- -
53  *  | struct nlmsghdr | struct genlmsghdr | payload
54  *  +-----------------+-------------------+--------- --- -- -
55  *
56  * The 'nlmsghdr' and 'genlmsghdr' structs should be dealt with like normal.
57  * The payload is dependent on the subsystem specified in the
58  * 'nlmsghdr->nlmsg_type' and should be defined below, supporting functions
59  * should be defined in the corresponding net/netlabel/netlabel_<subsys>.h|c
60  * file.  All of the fields in the NetLabel payload are NETLINK attributes, see
61  * the include/net/netlink.h file for more information on NETLINK attributes.
62  *
63  */
64
65 /*
66  * NetLabel NETLINK protocol
67  */
68
69 #define NETLBL_PROTO_VERSION            1
70
71 /* NetLabel NETLINK types/families */
72 #define NETLBL_NLTYPE_NONE              0
73 #define NETLBL_NLTYPE_MGMT              1
74 #define NETLBL_NLTYPE_MGMT_NAME         "NLBL_MGMT"
75 #define NETLBL_NLTYPE_RIPSO             2
76 #define NETLBL_NLTYPE_RIPSO_NAME        "NLBL_RIPSO"
77 #define NETLBL_NLTYPE_CIPSOV4           3
78 #define NETLBL_NLTYPE_CIPSOV4_NAME      "NLBL_CIPSOv4"
79 #define NETLBL_NLTYPE_CIPSOV6           4
80 #define NETLBL_NLTYPE_CIPSOV6_NAME      "NLBL_CIPSOv6"
81 #define NETLBL_NLTYPE_UNLABELED         5
82 #define NETLBL_NLTYPE_UNLABELED_NAME    "NLBL_UNLBL"
83
84 /*
85  * NetLabel - Kernel API for accessing the network packet label mappings.
86  *
87  * The following functions are provided for use by other kernel modules,
88  * specifically kernel LSM modules, to provide a consistent, transparent API
89  * for dealing with explicit packet labeling protocols such as CIPSO and
90  * RIPSO.  The functions defined here are implemented in the
91  * net/netlabel/netlabel_kapi.c file.
92  *
93  */
94
95 /* NetLabel audit information */
96 struct netlbl_audit {
97         u32 secid;
98         uid_t loginuid;
99 };
100
101 /* Domain mapping definition struct */
102 struct netlbl_dom_map;
103
104 /* Domain mapping operations */
105 int netlbl_domhsh_remove(const char *domain, struct netlbl_audit *audit_info);
106
107 /* LSM security attributes */
108 struct netlbl_lsm_cache {
109         void (*free) (const void *data);
110         void *data;
111 };
112 struct netlbl_lsm_secattr {
113         char *domain;
114
115         u32 mls_lvl;
116         u32 mls_lvl_vld;
117         unsigned char *mls_cat;
118         size_t mls_cat_len;
119
120         struct netlbl_lsm_cache cache;
121 };
122
123 /*
124  * LSM security attribute operations
125  */
126
127
128 /**
129  * netlbl_secattr_init - Initialize a netlbl_lsm_secattr struct
130  * @secattr: the struct to initialize
131  *
132  * Description:
133  * Initialize an already allocated netlbl_lsm_secattr struct.  Returns zero on
134  * success, negative values on error.
135  *
136  */
137 static inline int netlbl_secattr_init(struct netlbl_lsm_secattr *secattr)
138 {
139         memset(secattr, 0, sizeof(*secattr));
140         return 0;
141 }
142
143 /**
144  * netlbl_secattr_destroy - Clears a netlbl_lsm_secattr struct
145  * @secattr: the struct to clear
146  * @clear_cache: cache clear flag
147  *
148  * Description:
149  * Destroys the @secattr struct, including freeing all of the internal buffers.
150  * If @clear_cache is true then free the cache fields, otherwise leave them
151  * intact.  The struct must be reset with a call to netlbl_secattr_init()
152  * before reuse.
153  *
154  */
155 static inline void netlbl_secattr_destroy(struct netlbl_lsm_secattr *secattr,
156                                           u32 clear_cache)
157 {
158         if (clear_cache && secattr->cache.data != NULL && secattr->cache.free)
159                 secattr->cache.free(secattr->cache.data);
160         kfree(secattr->domain);
161         kfree(secattr->mls_cat);
162 }
163
164 /**
165  * netlbl_secattr_alloc - Allocate and initialize a netlbl_lsm_secattr struct
166  * @flags: the memory allocation flags
167  *
168  * Description:
169  * Allocate and initialize a netlbl_lsm_secattr struct.  Returns a valid
170  * pointer on success, or NULL on failure.
171  *
172  */
173 static inline struct netlbl_lsm_secattr *netlbl_secattr_alloc(int flags)
174 {
175         return kzalloc(sizeof(struct netlbl_lsm_secattr), flags);
176 }
177
178 /**
179  * netlbl_secattr_free - Frees a netlbl_lsm_secattr struct
180  * @secattr: the struct to free
181  * @clear_cache: cache clear flag
182  *
183  * Description:
184  * Frees @secattr including all of the internal buffers.  If @clear_cache is
185  * true then free the cache fields, otherwise leave them intact.
186  *
187  */
188 static inline void netlbl_secattr_free(struct netlbl_lsm_secattr *secattr,
189                                        u32 clear_cache)
190 {
191         netlbl_secattr_destroy(secattr, clear_cache);
192         kfree(secattr);
193 }
194
195 /*
196  * LSM protocol operations
197  */
198
199 #ifdef CONFIG_NETLABEL
200 int netlbl_socket_setattr(const struct socket *sock,
201                           const struct netlbl_lsm_secattr *secattr);
202 int netlbl_sock_getattr(struct sock *sk,
203                         struct netlbl_lsm_secattr *secattr);
204 int netlbl_socket_getattr(const struct socket *sock,
205                           struct netlbl_lsm_secattr *secattr);
206 int netlbl_skbuff_getattr(const struct sk_buff *skb,
207                           struct netlbl_lsm_secattr *secattr);
208 void netlbl_skbuff_err(struct sk_buff *skb, int error);
209 #else
210 static inline int netlbl_socket_setattr(const struct socket *sock,
211                                      const struct netlbl_lsm_secattr *secattr)
212 {
213         return -ENOSYS;
214 }
215
216 static inline int netlbl_sock_getattr(struct sock *sk,
217                                       struct netlbl_lsm_secattr *secattr)
218 {
219         return -ENOSYS;
220 }
221
222 static inline int netlbl_socket_getattr(const struct socket *sock,
223                                         struct netlbl_lsm_secattr *secattr)
224 {
225         return -ENOSYS;
226 }
227
228 static inline int netlbl_skbuff_getattr(const struct sk_buff *skb,
229                                         struct netlbl_lsm_secattr *secattr)
230 {
231         return -ENOSYS;
232 }
233
234 static inline void netlbl_skbuff_err(struct sk_buff *skb, int error)
235 {
236         return;
237 }
238 #endif /* CONFIG_NETLABEL */
239
240 /*
241  * LSM label mapping cache operations
242  */
243
244 #ifdef CONFIG_NETLABEL
245 void netlbl_cache_invalidate(void);
246 int netlbl_cache_add(const struct sk_buff *skb,
247                      const struct netlbl_lsm_secattr *secattr);
248 #else
249 static inline void netlbl_cache_invalidate(void)
250 {
251         return;
252 }
253
254 static inline int netlbl_cache_add(const struct sk_buff *skb,
255                                    const struct netlbl_lsm_secattr *secattr)
256 {
257         return 0;
258 }
259 #endif /* CONFIG_NETLABEL */
260
261 #endif /* _NETLABEL_H */