4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 \brief INet6Address public header */
26 #ifndef HH_SENF_Socket_Protocols_INet_INet6Address_
27 #define HH_SENF_Socket_Protocols_INet_INet6Address_ 1
32 #include <netinet/in.h>
33 #include <boost/cstdint.hpp>
34 #include <boost/array.hpp>
35 #include <boost/operators.hpp>
36 #include "../../../Utils/safe_bool.hh"
37 #include "../../../Utils/Tags.hh"
38 #include "INet4Address.hh"
39 #include "../AddressExceptions.hh"
40 #include "../Raw/MACAddress.hh"
41 #include "../Raw/EUI64.hh"
43 //#include "INet6Address.mpp"
44 #include "INet6Address.ih"
45 ///////////////////////////////hh.p////////////////////////////////////////
51 /** \brief INet6 network address
53 This implementation of an INet6 address is based strictly on
54 <a href="http://tools.ietf.org/html/rfc4291">RFC 4291</a>: Internet Protocol
55 Version 6 (INet6) Addressing Architecture. This class provides accessors to all the
56 information fields defined in this document.
58 The INet6 addressing architecture however has several other components defined in other
59 RFC's. These RFC's should be implemented in additional modules:
61 \li <a href="http://tools.ietf.org/html/rfc4193">RFC 4193</a>:
62 Unique Local Addresses (ULA). Defines the fc00::/7 prefix
63 \li <a href="http://tools.ietf.org/html/rfc3306">RFC 3306</a>:
64 Unicast-Prefix-based INet6 Multicast Addresses. Defines the ff30::/12 prefix
65 \li <a href="http://tools.ietf.org/html/rfc3956">RFC 3956</a>:
66 Embedding the Rendezvous Point (RP) Address in an INet6 Multicast
67 Address. Defines the ff70::/12 prefix
68 \li <a href="http://tools.ietf.org/html/rfc3056">RFC 3056</a>:
69 Connection of INet6 Domains via INet4 Clouds. Defines 6to4 tunneling and the
71 \li <a href="http://tools.ietf.org/html/rfc3849">RFC 3849</a>:
72 INet6 Address Prefix Reserved for Documentation. Defines the 2001:db8::/32 prefix
74 Here an overview of well-known prefixes:
78 <tr><th>Prefix</th> <th>Description</th> <th>Definition</th> <th>Note</th></tr>
79 <tr><td><tt>::/96</tt></td> <td>INet4 compatible INet6 address</td> <td>RFC4291</td> <td>deprecated</td></tr>
80 <tr><td><tt>::ffff:0:0/96</tt></td> <td>INet6 mapped INet4 address</td> <td>RFC4291</td> <td></td></tr>
81 <tr><td><tt>2000::/3</tt></td> <td>Global unicast addresses</td> <td>RFC3587</td> <td>only noted, not defined</td></tr>
82 <tr><td><tt>2001:db8::/32</tt></td> <td>Documentation-only prefix</td> <td>RFC3849</td> <td></td></tr>
83 <tr><td><tt>2002::/16</tt></td> <td>6to4 addressing</td> <td>RFC3056</td> <td></td></tr>
84 <tr><td><tt>fc00::/7</tt></td> <td>ULA</td> <td>RFC4193</td> <td></td></tr>
85 <tr><td><tt>fe80::/64</tt></td> <td>Link-local addresses</td> <td>RFC4291</td> <td></td></tr>
86 <tr><td><tt>fec0::/10</tt></td> <td>Site-local addresses </td> <td>RFC4291</td> <td>deprecated</td></tr>
87 <tr><td><tt>ff00::/8</tt></td> <td>Multicast</td> <td>RFC4291</td> <td></td></tr>
88 <tr><td><tt>ff00::/12</tt></td> <td>Globally allocated multicast</td> <td>RFC4291</td> <td></td></tr>
89 <tr><td><tt>ff10::/12</tt></td> <td>Locally allocated multicast</td> <td>RFC4291</td> <td></td></tr>
90 <tr><td><tt>ff30::/12</tt></td> <td>Unicast prefic based multicast</td> <td>RFC3306</td> <td></td></tr>
91 <tr><td><tt>ff70::/12</tt></td> <td>Multicast address with embedded RP</td> <td>RFC3956</td> <td></td></tr>
95 The following statements all create the same INet6 address
96 <code>2001:db8::a0b1:1a2b:3dff:fe4e:5f00</code>:
98 // Used to construct constant INet6 addresses
99 INet6Address(0x2001u,0xDB8u,0x0u,0xA0B1u 0x1A2Bu,0x3DFFu,0xFE4Eu,0x5F00u)
101 // Construct INet6 address from it's string representation
102 INet6Address::from_string("2001:db8::a0b1:1a2b:3dff:fe4e:5f00")
104 // Construct an INet6 address from raw data. 'from_data' takes an arbitrary iterator (e.g. a
105 // pointer) as argument. Here we use a fixed array but normally you will need this to build
106 // an INet6 address in a packet parser
107 char rawBytes[] = { 0x20, 0x01, 0x0D, 0xB8, 0x00, 0x00, 0xA0, 0xB1,
108 0x1a, 0x2b, 0x3d, 0xff, 0xfe, 0x4e, 0xff, 0x00 };
109 INet6Address::from_data(rawBytes)
112 Since INet6Address class is based on \c boost::array and is built as a fixed-size sequence
113 of 16 bytes, you can access the raw data bytes of the address (in network byte order) using
114 \c begin(), \c end() or \c operator[]
116 INet6Address ina = ...;
117 Packet::iterator i = ...;
118 std::copy(ina.begin(), ina.end(), i); // Copies 16 bytes
121 \see CheckINet6Network \n INet6Network
124 \implementation We awkwardly need to use static named constructors (<tt>from_</tt> members)
125 instead of ordinarily overloaded constructors for one simple reason: <tt>char *</tt>
126 doubles as string literal and as arbitrary data iterator. The iterator constructor can
127 therefore not be distinguished from initialization with a string literal. Therefore we
128 need to disambiguate using the named constructors.
131 : public boost::array<boost::uint8_t,16>,
132 public comparable_safe_bool<INet6Address>
135 ///////////////////////////////////////////////////////////////////////////
138 static INet6Address const None; ///< The empty (::0) address
139 static INet6Address const Loopback; ///< The loopback (::1) address
140 static INet6Address const AllNodes; ///< The 'all nodes' link-local multicast address
141 static INet6Address const AllRouters; ///< The 'all routers' link-local multicast address
143 enum Resolve_t { ResolveINet6, ResolveINet4 };
145 /** \brief Possible scope values
147 List of all possible scope values. This list includes all scope values defined for
148 multicast addresses in <a href="http://tools.ietf.org/html/rfc4291">RFC 4291</a>.
149 The values \ref LinkScope, \ref SiteScope and \ref GlobalScope are also used with
153 InterfaceScope = 1 /**< Interface only scope */
154 , LinkScope = 2 /**< Link-local scope */
155 , AdminScope = 4 /**< Administration defined local scope */
156 , SiteScope = 5 /**< Site-local scope */
157 , OrganizationScope = 8 /**< Scope covering multiple sites of an organization */
158 , GlobalScope = 14 /**< Global Internet scope */
160 , ReservedScope = 0 /**< Reserved scope value */
161 , UnassignedScope = 6 /**< Unassigned scope, may be defined locally */
164 ///////////////////////////////////////////////////////////////////////////
165 ///\name Structors and default members
168 explicit INet6Address(senf::NoInit_t); ///< Construct uninitialized (!) address
169 explicit INet6Address(boost::uint16_t a0=0u, boost::uint16_t a1=0u, boost::uint16_t a2=0u,
170 boost::uint16_t a3=0u, boost::uint16_t a4=0u, boost::uint16_t a5=0u,
171 boost::uint16_t a6=0u, boost::uint16_t a7=0u);
172 ///< Construct an address constant
174 static INet6Address from_in6addr(in6_addr const & in6addr); ///< Construct from std C struct
176 static INet6Address from_string(std::string const & s, Resolve_t resolve = ResolveINet6);
177 ///< Convert string to address
178 /**< This member will try to convert the given string into
179 an IP address. from_string() supports all standard IP
180 literal representations as well es hostnames.
181 \attention This call may block if \a s represents a
182 hostname which must be looked up via some network
183 protocol like DNS or NIS
184 \throws AddressSyntaxException if the address cannot be
185 converted for some reason
186 \param[in] s Address literal or hostname
187 \param[in] resolve If this is set to \c ResolveINet4,
188 the call will additionally try to interpret \a s as
189 an INet4 address if no valid INet6 address is
190 found. The address will be returned as mapped INet6
193 template <class InputIterator>
194 static INet6Address from_data(InputIterator i);
195 ///< Construct address from 16 bytes of raw data
196 /**< from_data will build an address from 16 bytes of raw
197 data as accessed by the iterator. The data must be in
198 network byte order. */
200 static INet6Address from_inet4address(INet4Address const & addr);
201 ///< Construct an INet6-mapped INet4 address
202 /**< This will construct an address of the form
203 <tt>::FFFF::w.x.y.z</tt> where <tt>w.x.y.z</tt> is
204 the INet4Address value. This kind of address is called
205 an INet6-mapped INet4 address (see
206 <a href="http://tools.ietf.org/html/rfc4291">RFC 4291</a>).
208 INet4 compatible INet6 addresses are not directly
209 supported, they are deprecated in the RFC. */
210 static INet6Address from_mac(senf::MACAddress const & mac);
211 ///< Construct a link-local INet6 address
212 /**< This will construct a link local address of the form
213 <tt>fe80::xxxx:xxff:fexx:xxxx</tt>. */
215 static INet6Address from_eui64(senf::EUI64 const & eui);
216 ///< Construct link-local INet6 address
217 /**< This will construct a link local address of the form
218 <tt>fe80::xxxx:xxxx:xxxx:xxxx</tt>. */
220 in6_addr toin6_addr() const; ///< get the linux in6_addr struct (convinience only)
223 ///////////////////////////////////////////////////////////////////////////
227 INet6Network network() const; ///< Return <tt>/64</tt> Network of this address
228 bool hasEUI64() const; ///< \c true, if address is based on an EUID-64
229 EUI64 id() const; ///< Return interface id (EUID-64)
230 bool universalId() const; ///< \c true, if the id() is universally assigned
231 bool groupId() const; ///< \c true, if the id()'s \a group bit is set
233 bool unicast() const; ///< \c true, if address is unicast
234 bool multicast() const; ///< \c true, if address is multicast
235 /**< To support a linux specific extension, INet4 multicast
236 addressed mapped to INet6 are also interpreted as
237 multicast addresses. This is NOT part of the standard,
238 however the standard officially only allows unicast v4
239 addresses to be mapped to v6 so this does not collide
240 with any standard conforming use. */
242 ScopeId scope() const; ///< Get address's scope
243 /**< The scope of an address is one of the \ref ScopeId
244 values. We need to differentiate between unicast and
245 multicast addresses: unicast addresses only have local,
246 site or global scope (where site scope is deprecated),
247 multicast address can have a number of scope values of
248 which local, site and global are a few. See the \ref
249 ScopeId enumerators. */
250 bool globalScope() const; ///< \c true, if address is global unicast or multicast
251 bool linkScope() const; ///< \c true, if address is link-local unicast or multicast
253 INet4Address inet4address() const; ///< Return embedded INet4 address
254 /**< Returns the INet4 address embedded within an INet4
255 compatible or INet4 mapped unicast address. This address
256 is given by the last 32 bits of the INet6 address. \par
257 The value returned is only a valid INet4 address if
258 either inet4Compatible() or inet4Mapped() return \c
260 bool inet4Compatible() const; ///< \c true, if address is INet4 compatible
261 /**< INet4 compatible INet6 addresses are deprecated. */
262 bool inet4Mapped() const; ///< \c true, if address is INet4 mapped
264 bool globalMulticastAddr() const; ///< \c true, if T bit is \e not set
265 /**< Any multicast address with a cleared T bit must be
266 globally assigned. See
267 <a href="http://tools.ietf.org/html/rfc4291">RFC 4291</a>. */
268 bool prefixMulticastAddr() const; ///< \c true, if P bit is set
269 /**< In <a href="http://tools.ietf.org/html/rfc4291">RFC 4291</a>,
270 the P bit is specified as defining a
271 unicast prefix based multicast address. See
272 <a href="http://tools.ietf.org/html/rfc3306">RFC 3306</a>. */
273 bool embeddedRpAddr() const; ///< \c true, if R bit is set
274 /**< In <a href="http://tools.ietf.org/html/rfc4291">RFC 4291</a>,
275 the R bit is specified as defining a multicast address
276 with embedded rendezvous point. See
277 <a href="http://tools.ietf.org/html/rfc3956">RFC 3956</a>. */
279 bool boolean_test() const; ///< \c true, if address != '::' (None)
285 void network(boost::uint64_t net); ///< Set network part of address
286 void id(boost::uint64_t id); ///< Set interface id part of address
292 /** \brief Output INet6Address instance as it's string representation
293 \related INet6Address
295 std::ostream & operator<<(std::ostream & os, INet6Address const & addr);
296 /** \brief Try to initialize INet6Address instance from a string representation
297 sets std::ios::failbit on the stream if an error occurred
298 \see INet6Address from_string()
299 \related INet6Address
301 std::istream & operator>>(std::istream & is, INet6Address & addr);
303 /** \brief Check INet6Address against a fixed network prefix
305 This helper allows to easily and efficiently check an INet6Address against an arbitrary but
306 constant network prefix. It takes from 1 to 8 arguments for the network address and an
307 additional last argument providing the prefix length. So
310 <tt>senf::CheckINet6Network<</tt> <i>addr_1</i> <tt>,</tt> <i>addr_2</i> <tt>,</tt>
311 ... <tt>,</tt> <i>prefix_len</i> <tt>></tt>
313 represents the network
316 <i>addr_1</i> <tt>:</tt> <i>addr_2</i> <tt>:</tt> ... <tt>::/</tt> <i>prefix_len</i> .
318 The class exposes a single static member <tt>match(</tt> <i>addr</i> <tt>)</tt> which
319 matches the INet6Address \a addr against the prefix:
322 if (senf::CheckINet6Network<0x2000u,0xDB8u,32u>::match(addr)) {
323 // 'addr' is within in the 2001:db8::/32 documentation-only network
328 The code generated by this call is highly optimized and probably as efficient as it can get.
330 template <unsigned a0, unsigned a1, unsigned a2=0u, unsigned a3=0u, unsigned a4=0u,
331 unsigned a5=0u, unsigned a6=0u, unsigned a7=0u, unsigned a8=0u>
332 struct CheckINet6Network
334 : public detail::CheckINet6Network_impl<a0,a1,a2,a3,a4,a5,a6,a7,a8>
338 /** \brief INet6 network prefix
340 This class represents an INet6 network prefix in CIDR notation.
343 : public boost::equality_comparable<INet6Network>,
344 public comparable_safe_bool<INet6Network>
347 ///////////////////////////////////////////////////////////////////////////
348 ///\name Structors and default members
351 INet6Network(); ///< Construct empty (::/0) network
352 INet6Network(INet6Address const & address, unsigned prefix_len);
353 ///< Construct network from given address and prefix length
354 explicit INet6Network(std::string const & s); ///< Construct network from CIDR notation
357 ///////////////////////////////////////////////////////////////////////////
359 INet6Address const & address() const; ///< Get the network address
360 unsigned prefix_len() const; ///< Get the network prefix length
362 bool boolean_test() const; ///< \c true, if INet6Network is non-empty
363 bool operator==(INet6Network const & other) const;
364 ///< Compare two networks for equality
366 bool match(INet6Address const & addr) const; ///< \c true, if the network includes \a addr
367 bool match(INet6Network const & net) const; ///< \c true, if the network includes \a net
368 /**< The is true, if \a net is sub-network (or the same as)
370 INet6Address host(boost::uint64_t id); ///< Return the host with the given id
371 /**< Returns the host with the given number within the
372 network. This call replaces the lower 64 bits of the
373 network address with the given id. */
375 INet6Network subnet(boost::uint64_t net, unsigned prefix_len);
376 ///< Return the given subnet of \c this
377 /**< The returned INet6Network will be a subnet of \c this
378 with the given network number. The network number is
379 comprised by the bits above \a prefix_len:
381 INet6Network("2001:db8::/32").subnet(0x12u,40u) == INet6Network("2001:db8:1200::/40")
382 INet6Network("2001:db8:1200::/40").subnet(0x2345,64u) == INet6Network("2001:db8:1200:2345::/64")
384 \param[in] net network number
385 \param[in] prefix_len length of subnet prefix */
390 unsigned prefix_len_;
391 INet6Address address_;
394 /** \brief Output INet6Network instance as it's string representation
395 \related INet6Network
397 std::ostream & operator<<(std::ostream & os, INet6Network const & addr);
400 ///////////////////////////////hh.e////////////////////////////////////////
401 #include "INet6Address.cci"
402 #include "INet6Address.ct"
403 #include "INet6Address.cti"
410 // comment-column: 40
411 // c-file-style: "senf"
412 // indent-tabs-mode: nil
413 // ispell-local-dictionary: "american"
414 // compile-command: "scons -u test"