aboutsummaryrefslogtreecommitdiffstats
path: root/net/netlabel/netlabel_mgmt.h
blob: fd6c6acbfa08d58b89dd34b2ec6acc8fa6524ca1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
/*
 * NetLabel Management Support
 *
 * This file defines the management functions for the NetLabel system.  The
 * NetLabel system manages static and dynamic label mappings for network
 * protocols such as CIPSO and RIPSO.
 *
 * Author: Paul Moore <paul.moore@hp.com>
 *
 */

/*
 * (c) Copyright Hewlett-Packard Development Company, L.P., 2006
 *
 * This program is free software;  you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY;  without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
 * the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program;  if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 */

#ifndef _NETLABEL_MGMT_H
#define _NETLABEL_MGMT_H

#include <net/netlabel.h>

/*
 * The following NetLabel payloads are supported by the management interface,
 * all of which are preceeded by the nlmsghdr struct.
 *
 * o ACK:
 *   Sent by the kernel in response to an applications message, applications
 *   should never send this message.
 *
 *   +----------------------+-----------------------+
 *   | seq number (32 bits) | return code (32 bits) |
 *   +----------------------+-----------------------+
 *
 *     seq number:  the sequence number of the original message, taken from the
 *                  nlmsghdr structure
 *     return code: return value, based on errno values
 *
 * o ADD:
 *   Sent by an application to add a domain mapping to the NetLabel system.
 *   The kernel should respond with an ACK.
 *
 *   +-------------------+
 *   | domains (32 bits) | ...
 *   +-------------------+
 *
 *     domains: the number of domains in the message
 *
 *   +--------------------------+-------------------------+
 *   | domain string (variable) | protocol type (32 bits) | ...
 *   +--------------------------+-------------------------+
 *
 *   +-------------- ---- --- -- -
 *   | mapping data                ... repeated
 *   +-------------- ---- --- -- -
 *
 *     domain string: the domain string, NULL terminated
 *     protocol type: the protocol type (defined by NETLBL_NLTYPE_*)
 *     mapping data:  specific to the map type (see below)
 *
 *   NETLBL_NLTYPE_UNLABELED
 *
 *     No mapping data for this protocol type.
 *
 *   NETLBL_NLTYPE_CIPSOV4
 *
 *   +---------------+
 *   | doi (32 bits) |
 *   +---------------+
 *
 *     doi:  the CIPSO DOI value
 *
 * o REMOVE:
 *   Sent by an application to remove a domain mapping from the NetLabel
 *   system.  The kernel should ACK this message.
 *
 *   +-------------------+
 *   | domains (32 bits) | ...
 *   +-------------------+
 *
 *     domains: the number of domains in the message
 *
 *   +--------------------------+
 *   | domain string (variable) | ...
 *   +--------------------------+
 *
 *     domain string: the domain string, NULL terminated
 *
 * o LIST:
 *   This message can be sent either from an application or by the kernel in
 *   response to an application generated LIST message.  When sent by an
 *   application there is no payload.  The kernel should respond to a LIST
 *   message either with a LIST message on success or an ACK message on
 *   failure.
 *
 *   +-------------------+
 *   | domains (32 bits) | ...
 *   +-------------------+
 *
 *     domains: the number of domains in the message
 *
 *   +--------------------------+
 *   | domain string (variable) | ...
 *   +--------------------------+
 *
 *   +-------------------------+-------------- ---- --- -- -
 *   | protocol type (32 bits) | mapping data                ... repeated
 *   +-------------------------+-------------- ---- --- -- -
 *
 *     domain string: the domain string, NULL terminated
 *     protocol type: the protocol type (defined by NETLBL_NLTYPE_*)
 *     mapping data:  specific to the map type (see below)
 *
 *   NETLBL_NLTYPE_UNLABELED
 *
 *     No mapping data for this protocol type.
 *
 *   NETLBL_NLTYPE_CIPSOV4
 *
 *   +----------------+---------------+
 *   | type (32 bits) | doi (32 bits) |
 *   +----------------+---------------+
 *
 *     type: the CIPSO mapping table type (defined in the cipso_ipv4.h header
 *           as CIPSO_V4_MAP_*)
 *     doi:  the CIPSO DOI value
 *
 * o ADDDEF:
 *   Sent by an application to set the default domain mapping for the NetLabel
 *   system.  The kernel should respond with an ACK.
 *
 *   +-------------------------+-------------- ---- --- -- -
 *   | protocol type (32 bits) | mapping data                ... repeated
 *   +-------------------------+-------------- ---- --- -- -
 *
 *     protocol type: the protocol type (defined by NETLBL_NLTYPE_*)
 *     mapping data:  specific to the map type (see below)
 *
 *   NETLBL_NLTYPE_UNLABELED
 *
 *     No mapping data for this protocol type.
 *
 *   NETLBL_NLTYPE_CIPSOV4
 *
 *   +---------------+
 *   | doi (32 bits) |
 *   +---------------+
 *
 *     doi:  the CIPSO DOI value
 *
 * o REMOVEDEF:
 *   Sent by an application to remove the default domain mapping from the
 *   NetLabel system, there is no payload.  The kernel should ACK this message.
 *
 * o LISTDEF:
 *   This message can be sent either from an application or by the kernel in
 *   response to an application generated LISTDEF message.  When sent by an
 *   application there is no payload.  The kernel should respond to a
 *   LISTDEF message either with a LISTDEF message on success or an ACK message
 *   on failure.
 *
 *   +-------------------------+-------------- ---- --- -- -
 *   | protocol type (32 bits) | mapping data                ... repeated
 *   +-------------------------+-------------- ---- --- -- -
 *
 *     protocol type: the protocol type (defined by NETLBL_NLTYPE_*)
 *     mapping data:  specific to the map type (see below)
 *
 *   NETLBL_NLTYPE_UNLABELED
 *
 *     No mapping data for this protocol type.
 *
 *   NETLBL_NLTYPE_CIPSOV4
 *
 *   +----------------+---------------+
 *   | type (32 bits) | doi (32 bits) |
 *   +----------------+---------------+
 *
 *     type: the CIPSO mapping table type (defined in the cipso_ipv4.h header
 *           as CIPSO_V4_MAP_*)
 *     doi:  the CIPSO DOI value
 *
 * o MODULES:
 *   Sent by an application to request a list of configured NetLabel modules
 *   in the kernel.  When sent by an application there is no payload.
 *
 *   +-------------------+
 *   | modules (32 bits) | ...
 *   +-------------------+
 *
 *     modules: the number of modules in the message, if this is an application
 *              generated message and the value is zero then return a list of
 *              the configured modules
 *
 *   +------------------+
 *   | module (32 bits) | ... repeated
 *   +------------------+
 *
 *     module: the module number as defined by NETLBL_NLTYPE_*
 *
 * o VERSION:
 *   Sent by an application to request the NetLabel version string.  When sent
 *   by an application there is no payload.  This message type is also used by
 *   the kernel to respond to an VERSION request.
 *
 *   +-------------------+
 *   | version (32 bits) |
 *   +-------------------+
 *
 *     version: the protocol version number
 *
 */

/* NetLabel Management commands */
enum {
	NLBL_MGMT_C_UNSPEC,
	NLBL_MGMT_C_ACK,
	NLBL_MGMT_C_ADD,
	NLBL_MGMT_C_REMOVE,
	NLBL_MGMT_C_LIST,
	NLBL_MGMT_C_ADDDEF,
	NLBL_MGMT_C_REMOVEDEF,
	NLBL_MGMT_C_LISTDEF,
	NLBL_MGMT_C_MODULES,
	NLBL_MGMT_C_VERSION,
	__NLBL_MGMT_C_MAX,
};
#define NLBL_MGMT_C_MAX (__NLBL_MGMT_C_MAX - 1)

/* NetLabel protocol functions */
int netlbl_mgmt_genl_init(void);

#endif