updated copyright information
[strongswan.git] / src / charon / config / traffic_selector.h
1 /**
2 * @file traffic_selector.h
3 *
4 * @brief Interface of traffic_selector_t.
5 *
6 */
7
8 /*
9 * Copyright (C) 2005-2006 Martin Willi
10 * Copyright (C) 2005 Jan Hutter
11 * Hochschule fuer Technik Rapperswil
12 *
13 * This program is free software; you can redistribute it and/or modify it
14 * under the terms of the GNU General Public License as published by the
15 * Free Software Foundation; either version 2 of the License, or (at your
16 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
17 *
18 * This program is distributed in the hope that it will be useful, but
19 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
20 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 * for more details.
22 */
23
24 #ifndef TRAFFIC_SELECTOR_H_
25 #define TRAFFIC_SELECTOR_H_
26
27 #include <types.h>
28 #include <utils/host.h>
29
30 typedef enum ts_type_t ts_type_t;
31
32 /**
33 * Traffic selector types.
34 *
35 * @ingroup config
36 */
37 enum ts_type_t {
38
39 /**
40 * A range of IPv4 addresses, represented by two four (4) octet
41 * values. The first value is the beginning IPv4 address
42 * (inclusive) and the second value is the ending IPv4 address
43 * (inclusive). All addresses falling between the two specified
44 * addresses are considered to be within the list.
45 */
46 TS_IPV4_ADDR_RANGE = 7,
47
48 /**
49 * A range of IPv6 addresses, represented by two sixteen (16)
50 * octet values. The first value is the beginning IPv6 address
51 * (inclusive) and the second value is the ending IPv6 address
52 * (inclusive). All addresses falling between the two specified
53 * addresses are considered to be within the list.
54 */
55 TS_IPV6_ADDR_RANGE = 8
56 };
57
58 /**
59 * string mappings for ts_type_t
60 */
61 extern mapping_t ts_type_m[];
62
63
64 typedef struct traffic_selector_t traffic_selector_t;
65
66 /**
67 * @brief Object representing a traffic selector entry.
68 *
69 * A traffic selector defines an range of addresses
70 * and a range of ports. IPv6 is not fully supported yet.
71 *
72 * @b Constructors:
73 * - traffic_selector_create_from_bytes()
74 * - traffic_selector_create_from_string()
75 *
76 * @todo Add IPv6 support
77 *
78 * @ingroup config
79 */
80 struct traffic_selector_t {
81
82 /**
83 * @brief Compare two traffic selectors, and create a new one
84 * which is the largest subset of both (subnet & port).
85 *
86 * Resulting traffic_selector is newly created and must be destroyed.
87 *
88 * @param this first to compare
89 * @param other second to compare
90 * @return
91 * - created subset of them
92 * - or NULL if no match between this and other
93 */
94 traffic_selector_t *(*get_subset) (traffic_selector_t *this, traffic_selector_t *other);
95
96 /**
97 * @brief Clone a traffic selector.
98 *
99 * @param this traffic selector to clone
100 * @return clone of it
101 */
102 traffic_selector_t *(*clone) (traffic_selector_t *this);
103
104 /**
105 * @brief Get starting address of this ts as a chunk.
106 *
107 * Data is in network order and represents the address.
108 * Size depends on protocol.
109 *
110 * Resulting chunk data is allocated and must be freed!
111 *
112 * @param this calling object
113 * @return chunk containing the address
114 */
115 chunk_t (*get_from_address) (traffic_selector_t *this);
116
117 /**
118 * @brief Get ending address of this ts as a chunk.
119 *
120 * Data is in network order and represents the address.
121 * Size depends on protocol.
122 *
123 * Resulting chunk data is allocated and must be freed!
124 *
125 * @param this calling object
126 * @return chunk containing the address
127 */
128 chunk_t (*get_to_address) (traffic_selector_t *this);
129
130 /**
131 * @brief Get starting port of this ts.
132 *
133 * Port is in host order, since the parser converts it.
134 * Size depends on protocol.
135 *
136 * @param this calling object
137 * @return port
138 */
139 u_int16_t (*get_from_port) (traffic_selector_t *this);
140
141 /**
142 * @brief Get ending port of this ts.
143 *
144 * Port is in host order, since the parser converts it.
145 * Size depends on protocol.
146 *
147 * @param this calling object
148 * @return port
149 */
150 u_int16_t (*get_to_port) (traffic_selector_t *this);
151
152 /**
153 * @brief Get the type of the traffic selector.
154 *
155 * @param this calling obect
156 * @return ts_type_t specifying the type
157 */
158 ts_type_t (*get_type) (traffic_selector_t *this);
159
160 /**
161 * @brief Get the protocol id of this ts.
162 *
163 * @param this calling obect
164 * @return protocol id
165 */
166 u_int8_t (*get_protocol) (traffic_selector_t *this);
167
168 /**
169 * @brief Get the netmask of the address range.
170 *
171 * Returns the number of bits associated to the subnet.
172 * (As the "24" in "192.168.0.0/24"). This is approximated
173 * if the address range is not a complete subnet! Since Linux
174 * does not support full IP address ranges (yet), we can't do this
175 * (much) better.
176 *
177 * @param this calling obect
178 * @return netmask as "bits for subnet"
179 */
180 u_int8_t (*get_netmask) (traffic_selector_t *this);
181
182 /**
183 * @brief Update the address of a traffic selector.
184 *
185 * Update the address range of a traffic selector,
186 * if the current address is 0.0.0.0. The new address range
187 * starts from the supplied address and also ends there
188 * (which means it is a one-host-address-range ;-).
189 *
190 * @param this calling obect
191 * @param host host_t specifying the address range
192 */
193 void (*update_address_range) (traffic_selector_t *this, host_t* host);
194
195 /**
196 * @brief Destroys the ts object
197 *
198 * @param this calling object
199 */
200 void (*destroy) (traffic_selector_t *this);
201 };
202
203 /**
204 * @brief Create a new traffic selector using human readable params.
205 *
206 * @param protocol protocol for this ts, such as TCP or UDP
207 * @param type type of following addresses, such as TS_IPV4_ADDR_RANGE
208 * @param from_addr start of address range as string
209 * @param from_port port number in host order
210 * @param to_addr end of address range as string
211 * @param to_port port number in host order
212 * @return
213 * - traffic_selector_t object
214 * - NULL if invalid address strings/protocol
215 *
216 * @ingroup config
217 */
218 traffic_selector_t *traffic_selector_create_from_string(u_int8_t protocol, ts_type_t type, char *from_addr, u_int16_t from_port, char *to_addr, u_int16_t to_port);
219
220 /**
221 * @brief Create a new traffic selector using data read from the net.
222 *
223 * There exists a mix of network and host order in the params.
224 * But the parser gives us this data in this format, so we
225 * don't have to convert twice.
226 *
227 * @param protocol protocol for this ts, such as TCP or UDP
228 * @param type type of following addresses, such as TS_IPV4_ADDR_RANGE
229 * @param from_address start of address range, network order
230 * @param from_port port number, host order
231 * @param to_address end of address range as string, network
232 * @param to_port port number, host order
233 * @return
234 * - traffic_selector_t object
235 * - NULL if invalid address input/protocol
236 *
237 * @ingroup config
238 */
239 traffic_selector_t *traffic_selector_create_from_bytes(u_int8_t protocol, ts_type_t type, chunk_t from_address, int16_t from_port, chunk_t to_address, u_int16_t to_port);
240
241 /**
242 * @brief Create a new traffic selector defining a whole subnet.
243 *
244 * In most cases, definition of a traffic selector for full subnets
245 * is sufficient. This constructor creates a traffic selector for
246 * all protocols, all ports and the address range specified by the
247 * subnet.
248 * Additionally, a protocol and a port may be specified. Port ranges
249 * are not supported via this constructor.
250 *
251 * @param net subnet to use
252 * @param netbits size of the subnet, as used in e.g. 192.168.0.0/24 notation
253 * @return
254 * - traffic_selector_t object
255 * - NULL if address family of net not supported
256 *
257 * @ingroup config
258 */
259 traffic_selector_t *traffic_selector_create_from_subnet(host_t *net, u_int8_t netbits, u_int8_t protocol, u_int16_t port);
260
261 #endif /* TRAFFIC_SELECTOR_H_ */