Socket/Protocols/INet/INet6Address.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   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.
  12 //
  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.
  17 //
  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.
  22
  23 /** \file
  24     \brief INet6Address public header */
  25
  26 #ifndef HH_INet6Address_
  27 #define HH_INet6Address_ 1
  28
  29 // Custom includes
  30 #include <iostream>
  31 #include <string>
  32 #include <boost/cstdint.hpp>
  33 #include <boost/array.hpp>
  34 #include <boost/operators.hpp>
  35 #include "../../../Utils/safe_bool.hh"
  36 #include "../../../Utils/Tags.hh"
  37 #include "INet4Address.hh"
  38 #include "../AddressExceptions.hh"
  39
  40 //#include "INet6Address.mpp"
  41 #include "INet6Address.ih"
  42 ///////////////////////////////hh.p////////////////////////////////////////
  43
  44 namespace senf {
  45
  46     /** \brief IPv6 network address
  47
  48         This implementation of an IPv6 address is based strictly on
  49         <a href="http://tools.ietf.org/html/rfc4291">RFC 4291</a>: Internet Protocol
  50         Version 6 (IPv6) Addressing Architecture. This class provides accessors to all the
  51         information fields defined in this document.
  52
  53         The IPv6 addressing architecture however has several other components defined in other
  54         RFC's. These RFC's should be implemented in additional modules:
  55
  56         \li <a href="http://tools.ietf.org/html/rfc4193">RFC 4193</a>:
  57             Unique Local Addresses (ULA). Defines the fc00::/7 prefix
  58         \li <a href="http://tools.ietf.org/html/rfc3306">RFC 3306</a>:
  59             Unicast-Prefix-based IPv6 Multicast Addresses. Defines the ff30::/12 prefix
  60         \li <a href="http://tools.ietf.org/html/rfc3956">RFC 3956</a>:
  61             Embedding the Rendezvous Point (RP) Address in an IPv6 Multicast
  62             Address. Defines the ff70::/12 prefix
  63         \li <a href="http://tools.ietf.org/html/rfc3056">RFC 3056</a>:
  64             Connection of IPv6 Domains via IPv4 Clouds. Defines 6to4 tunneling and the
  65             2002::/16 prefix
  66         \li <a href="http://tools.ietf.org/html/rfc3849">RFC 3849</a>:
  67             IPv6 Address Prefix Reserved for Documentation. Defines the 2001:db8::/32 prefix
  68
  69         Here an overview of well-known prefixes:
  70
  71         <table class="senf">
  72         <tr><th>Prefix</th>                  <th>Description</th>                        <th>Definition</th> <th>Note</th></tr>
  73         <tr><td><tt>::/96</tt></td>          <td>IPv4 compatible IPv6 address</td>       <td>RFC4291</td>    <td>deprecated</td></tr>
  74         <tr><td><tt>\::ffff:0:0/96</tt></td>  <td>IPv6 mapped IPv4 address</td>           <td>RFC4291</td>    <td></td></tr>
  75         <tr><td><tt>2000::/3</tt></td>       <td>Global unicast addresses</td>           <td>RFC3587</td>    <td>only noted, not defined</td></tr>
  76         <tr><td><tt>2001:db8::/32</tt></td>  <td>Documentation-only prefix</td>          <td>RFC3849</td>    <td></td></tr>
  77         <tr><td><tt>2002::/16</tt></td>      <td>6to4 addressing</td>                    <td>RFC3056</td>    <td></td></tr>
  78         <tr><td><tt>fc00::/7</tt></td>       <td>ULA</td>                                <td>RFC4193</td>    <td></td></tr>
  79         <tr><td><tt>fe80::/64</tt></td>      <td>Link-local addresses</td>               <td>RFC4291</td>    <td></td></tr>
  80         <tr><td><tt>fec0::/10</tt></td>      <td>Site-local addresses </td>              <td>RFC4291</td>    <td>deprecated</td></tr>
  81         <tr><td><tt>ff00::/8</tt></td>       <td>Multicast</td>                          <td>RFC4291</td>    <td></td></tr>
  82         <tr><td><tt>ff00::/12</tt></td>      <td>Globally allocated multicast</td>       <td>RFC4291</td>    <td></td></tr>
  83         <tr><td><tt>ff10::/12</tt></td>      <td>Locally allocated multicast</td>        <td>RFC4291</td>    <td></td></tr>
  84         <tr><td><tt>ff30::/12</tt></td>      <td>Unicast prefic based multicast</td>     <td>RFC3306</td>    <td></td></tr>
  85         <tr><td><tt>ff70::/12</tt></td>      <td>Multicast address with embedded RP</td> <td>RFC3956</td>    <td></td></tr>
  86         </table>
  87
  88         The following statements all create the same INet6 address
  89         <code>2001:db8::a0b1:1a2b:3dff:fe4e:5f00</code>:
  90         \code
  91         \\ Used to construct constant INet6 addresses
  92         INet6Address(0x2001u,0xDB8u,0x0u,0xA0B1u 0x1A2Bu,0x3DFFu,0xFE4Eu,0x5F00u)
  93
  94         // Construct INet6 address from it's string representation
  95         INet6Address::from_string("2001:db8::a0b1:1a2b:3dff:fe4e:5f00")
  96
  97         // Construct an INet6 address from raw data. 'from_data' takes an arbitrary iterator (e.g. a
  98         // pointer) as argument. Here we use a fixed array but normally you will need this to build
  99         // an INet6 address in a packet parser
 100         char rawBytes[] = { 0x20, 0x01, 0x0D, 0xB8, 0x00, 0x00, 0xA0, 0xB1,
 101                             0x1a, 0x2b, 0x3d, 0xff, 0xfe, 0x4e, 0xff, 0x00 };
 102         INet6Address::from_data(rawBytes)
 103         \endcode
 104
 105         Since INet6Address class is based on \c boost::array and is built as a fixed-size sequence
 106         of 16 bytes, you can access the raw data bytes of the address (in network byte order) using
 107         \c begin(), \c end() or \c operator[]
 108         \code
 109         INet6Address ina = ...;
 110         Packet::iterator i = ...;
 111         std::copy(ina.begin(), ina.end(), i); // Copies 16 bytes
 112         \endcode
 113
 114         \see CheckINet6Network \n INet6Network
 115         \ingroup addr_group
 116
 117         \implementation We awkwardly need to use static named constructors (<tt>from_</tt> members)
 118             instead of ordinarily overloaded constructors for one simple reason: <tt>char *</tt>
 119             doubles as string literal and as arbitrary data iterator. The iterator constructor can
 120             therefore not be distinguished from initialization with a string literal. Therefore we
 121             need to disambiguate using the named constructors.
 122      */
 123     class INet6Address
 124         : public boost::array<boost::uint8_t,16>,
 125           public comparable_safe_bool<INet6Address>
 126     {
 127     public:
 128         ///////////////////////////////////////////////////////////////////////////
 129         // Types
 130
 131         static INet6Address const None;        ///< The empty (::0) address
 132         static INet6Address const Loopback;    ///< The loopback (::1) address
 133         static INet6Address const AllNodes;    ///< The 'all nodes' link-local multicast address
 134         static INet6Address const AllRouters;  ///< The 'all routers' link-local multicast address
 135
 136         enum Resolve_t { ResolveINet6, ResolveINet4 };
 137
 138         /** \brief Possible scope values
 139
 140             List of all possible scope values. This list includes all scope values defined for
 141             multicast addresses in <a href="http://tools.ietf.org/html/rfc4291">RFC 4291</a>.
 142             The values \ref LinkScope, \ref SiteScope and \ref GlobalScope are also used with
 143             unicast addresses.
 144          */
 145         enum ScopeId {
 146               InterfaceScope    =  1    /**< Interface only scope */
 147             , LinkScope         =  2    /**< Link-local scope */
 148             , AdminScope        =  4    /**< Administration defined local scope */
 149             , SiteScope         =  5    /**< Site-local scope */
 150             , OrganizationScope =  8    /**< Scope covering multiple sites of an organization */
 151             , GlobalScope       = 14    /**< Global Internet scope */
 152
 153             , ReservedScope     =  0    /**< Reserved scope value */
 154             , UnassignedScope   =  6    /**< Unassigned scope, may be defined locally */
 155         };
 156
 157         ///////////////////////////////////////////////////////////////////////////
 158         ///\name Structors and default members
 159         ///@{
 160
 161         explicit INet6Address(senf::NoInit_t); ///< Construct uninitialized (!) address
 162         INet6Address(boost::uint16_t a0=0u, boost::uint16_t a1=0u, boost::uint16_t a2=0u,
 163                      boost::uint16_t a3=0u, boost::uint16_t a4=0u, boost::uint16_t a5=0u,
 164                      boost::uint16_t a6=0u, boost::uint16_t a7=0u);
 165                                         ///< Construct an address constant
 166
 167         static INet6Address from_string(std::string const & s, Resolve_t resolve = ResolveINet6);
 168                                         ///< Convert string to address
 169                                         /**< This member will try to convert the given string into
 170                                              an IP address. from_string() supports all standard IP
 171                                              literal representations as well es hostnames.
 172                                              \attention This call may block if \a s represents a
 173                                                  hostname which must be looked up via some network
 174                                                  protocol like DNS or NIS
 175                                              \throws AddressSyntaxException if the address cannot be
 176                                                  converted for some reason
 177                                              \param[in] s Address literal or hostname
 178                                              \param[in] resolve If this is set to \c ResolveINet4,
 179                                                  the call will additionally try to interpret \a s as
 180                                                  an IPv4 address if no valid IPv6 address is
 181                                                  found. The address will be returned as mapped IPv6
 182                                                  address. */
 183
 184         template <class InputIterator>
 185         static INet6Address from_data(InputIterator i);
 186                                         ///< Construct address from 16 bytes of raw data
 187                                         /**< from_data will build an address from 16 bytes of raw
 188                                              data as accessed by the iterator. The data must be in
 189                                              network byte order. */
 190
 191         static INet6Address from_inet4address(INet4Address addr);
 192                                         ///< Construct an IPv6-mapped IPv4 address
 193                                         /**< This will construct an address of the form
 194                                              <tt>::FFFF::w.x.y.z</tt> where <tt>w.x.y.z</tt> is
 195                                              the INet4Address value. This kind of address is called
 196                                              an IPv6-mapped IPv4 address (see
 197                                              <a href="http://tools.ietf.org/html/rfc4291">RFC 4291</a>).
 198                                              \par
 199                                              IPv4 compatible IPv6 addresses are not directly
 200                                              supported, they are deprecated in the RFC. */
 201         ///@}
 202         ///////////////////////////////////////////////////////////////////////////
 203         ///\name Accessors
 204         ///@{
 205
 206         boost::uint64_t network() const; ///< Return 64bit network part
 207         bool hasEuid64() const;         ///< \c true, if address is based on an EUID-64
 208         boost::uint64_t id() const;     ///< Return interface id (EUID-64)
 209         bool universalId() const;       ///< \c true, if the id() is universally assigned
 210         bool groupId() const;           ///< \c true, if the id()'s \a group bit is set
 211
 212         bool unicast() const;           ///< \c true, if address is unicast
 213         bool multicast() const;         ///< \c true, if address is multicast
 214
 215         ScopeId scope() const;          ///< Get address's scope
 216                                         /**< The scope of an address is one of the \ref ScopeId
 217                                              values. We need to differentiate between unicast and
 218                                              multicast addresses: unicast addresses only have local,
 219                                              site or global scope (where site scope is deprecated),
 220                                              multicast address can have a number of scope values of
 221                                              which local, site and global are a few. See the \ref
 222                                              ScopeId enumerators. */
 223         bool globalScope() const;       ///< \c true, if address is global unicast or multicast
 224         bool linkScope() const;         ///< \c true, if address is link-local unicast or multicast
 225
 226         INet4Address inet4address() const; ///< Return embedded IPv4 address
 227                                         /**< Returns the IPv4 address embedded within an IPv4
 228                                              compatible or IPv4 mapped unicast address. This address
 229                                              is given by the last 32 bits of the IPv6 address. \par
 230                                              The value returned is only a valid IPv4 address if
 231                                              either ipv4Compatible() or ipv4Mapped() return \c
 232                                              true. */
 233         bool ipv4Compatible() const;    ///< \c true, if address is IPv4 compatible
 234                                         /**< IPv4 compatible IPv6 addresses are deprecated. */
 235         bool ipv4Mapped() const;        ///< \c true, if address is IPv4 mapped
 236
 237         bool globalMulticastAddr() const; ///< \c true, if T bit is \e not set
 238                                         /**< Any multicast address with a cleared T bit must be
 239                                              globally assigned. See
 240                                              <a href="http://tools.ietf.org/html/rfc4291">RFC 4291</a>. */
 241         bool prefixMulticastAddr() const; ///< \c true, if P bit is set
 242                                         /**< In <a href="http://tools.ietf.org/html/rfc4291">RFC 4291</a>,
 243                                              the P bit is specified as defining a
 244                                              unicast prefix based multicast address. See
 245                                              <a href="http://tools.ietf.org/html/rfc3306">RFC 3306</a>. */
 246         bool embeddedRpAddr() const;    ///< \c true, if R bit is set
 247                                         /**< In <a href="http://tools.ietf.org/html/rfc4291">RFC 4291</a>,
 248                                              the R bit is specified as defining a multicast address
 249                                              with embedded rendezvous point. See
 250                                              <a href="http://tools.ietf.org/html/rfc3956">RFC 3956</a>. */
 251
 252         bool boolean_test() const;      ///< \c true, if address != '::' (None)
 253
 254         ///@}
 255         ///\name Mutators
 256         ///@{
 257
 258         void network(boost::uint64_t net); ///< Set network part of address
 259         void id(boost::uint64_t id);    ///< Set interface id part of address
 260
 261         ///@}
 262
 263     };
 264
 265     /** \brief Output INet6Address instance as it's string representation
 266         \related INet6Address
 267      */
 268     std::ostream & operator<<(std::ostream & os, INet6Address const & addr);
 269
 270     /** \brief Check INet6Address against a fixed network prefix
 271
 272         This helper allows to easily and efficiently check an INet6Address against an arbitrary but
 273         constant network prefix. It takes from 1 to 8 arguments for the network address and an
 274         additional last argument providing the prefix length. So
 275
 276         \par ""
 277             <tt>senf::CheckINet6Network<</tt> <i>addr_1</i> <tt>,</tt> <i>addr_2</i> <tt>,</tt>
 278             ... <tt>,</tt> <i>prefix_len</i> <tt>></tt>
 279
 280         represents the network
 281
 282         \par ""
 283             <i>addr_1</i> <tt>:</tt> <i>addr_2</i> <tt>:</tt> ... <tt>::/</tt> <i>prefix_len</i> .
 284
 285         The class exposes a single static member <tt>match(</tt> <i>addr</i> <tt>)</tt> which
 286         matches the INet6Address \a addr against the prefix:
 287
 288         \code
 289         if (senf::CheckINet6Network<0x2000u,0xDB8u,32u>::match(addr)) {
 290             // 'addr' is within in the 2001:db8::/32 documentation-only network
 291             ...
 292         }
 293         \endcode
 294
 295         The code generated by this call is highly optimized and probably as efficient as it can get.
 296      */
 297     template <unsigned a0, unsigned a1, unsigned a2=0u, unsigned a3=0u, unsigned a4=0u,
 298               unsigned a5=0u, unsigned a6=0u, unsigned a7=0u, unsigned a8=0u>
 299     struct CheckINet6Network
 300         : public detail::CheckINet6Network_impl<a0,a1,a2,a3,a4,a5,a6,a7,a8>
 301     {};
 302
 303     /** \brief IPv6 network prefix
 304
 305         This class represents an IPv6 network prefix in CIDR notation.
 306       */
 307     class INet6Network
 308         : public boost::equality_comparable<INet6Network>,
 309           public comparable_safe_bool<INet6Network>
 310     {
 311     public:
 312         ///////////////////////////////////////////////////////////////////////////
 313         ///\name Structors and default members
 314         ///@{
 315
 316         INet6Network();                 ///< Construct empty (::/0) network
 317         INet6Network(INet6Address address, unsigned prefix_len);
 318                                         ///< Construct network from given address and prefix length
 319         explicit INet6Network(std::string s); ///< Construct network from CIDR notation
 320
 321         ///@}
 322         ///////////////////////////////////////////////////////////////////////////
 323
 324         INet6Address const & address() const; ///< Get the network address
 325         unsigned prefix_len() const;    ///< Get the network prefix length
 326
 327         bool boolean_test() const;      ///< \c true, if INet6Network is non-empty
 328         bool operator==(INet6Network const & other) const;
 329                                         ///< Compare two networks for equality
 330
 331         bool match(INet6Address addr) const; ///< \c true, if the network includes \a addr
 332         bool match(INet6Network net) const; ///< \c true, if the network includes \a net
 333                                         /**< The is true, if \a net is sub-network (or the same as)
 334                                              \c this. */
 335         INet6Address host(boost::uint64_t id); ///< Return the host with the given id
 336                                         /**< Returns the host with the given number within the
 337                                              network. This call replaces the lower 64 bits of the
 338                                              network address with the given id. */
 339
 340         INet6Network subnet(boost::uint64_t net, unsigned prefix_len);
 341                                         ///< Return the given subnet of \c this
 342                                         /**< The returned INet6Network will be a subnet of \c this
 343                                              with the given network number. The network number is
 344                                              comprised by the bits above \a prefix_len:
 345                                              \code
 346                                              INet6Network("2001:db8::/32").subnet(0x12u,40u) == INet6Network("2001:db8:1200::/40")
 347                                              INet6Network("2001:db8:1200::/40").subnet(0x2345,64u) == INet6Network("2001:db8:1200:2345::/64")
 348                                              \endcode
 349                                              \param[in] net network number
 350                                              \param[in] prefix_len length of subnet prefix */
 351
 352     protected:
 353
 354     private:
 355         unsigned prefix_len_;
 356         INet6Address address_;
 357     };
 358
 359     /** \brief Output INet6Network instance as it's string representation
 360         \related INet6Network
 361      */
 362     std::ostream & operator<<(std::ostream & os, INet6Network const & addr);
 363 }
 364
 365 ///////////////////////////////hh.e////////////////////////////////////////
 366 #include "INet6Address.cci"
 367 #include "INet6Address.ct"
 368 #include "INet6Address.cti"
 369 #endif
 370
 371 \f
 372 // Local Variables:
 373 // mode: c++
 374 // fill-column: 100
 375 // comment-column: 40
 376 // c-file-style: "senf"
 377 // indent-tabs-mode: nil
 378 // ispell-local-dictionary: "american"
 379 // compile-command: "scons -u test"
 380 // End: