routerbox/utils/he_ipv6/example.tunnelbroker.xml

121 lines
5.4 KiB
XML
Raw Normal View History

2020-05-11 16:23:34 -04:00
<?xml version="1.0" encoding="UTF-8" ?>
<heIPv6 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://tunnelbroker.net/"
xsi:schemaLocation="https://tunnelbroker.net/ http://schema.xml.r00t2.io/projects/he_ipv6.xsd">
2020-05-12 01:21:52 -04:00
<!--
This is a sample XML configuration file to use with he_ipv6.py.
If you do not yet have an IPv6 Tunnelbroker.net allocation, you can get one (for free!) at:
https://www.tunnelbroker.net/tunnel_detail.php?tid=584532
I highly recommend their (free) certification as well if you're brand-new to IPv6:
https://ipv6.he.net/certification/
-->
2020-05-11 16:23:34 -04:00
<creds>
2020-05-12 01:21:52 -04:00
<!--
Credentials are kept separate from tunnel configuration because you can have multiple (up to 5) tunnels per user.
The updateKey is *not* your password! You can find it in the "Advanced" tab of your tunnel's configuration on
your tunnelbroker.net panel.
-->
2020-05-11 16:23:34 -04:00
<cred id="ipv6user">
<user>ipv6user</user>
<updateKey>xXxXxXxXxXxXxXXX</updateKey>
</cred>
<cred id="anotheruser">
<user>someotheruser</user>
<updateKey>0000000000000000</updateKey>
</cred>
</creds>
<tunnels>
2020-05-12 01:21:52 -04:00
<!--
Each tunnel MUST have an "id" and a "creds" attribute. The "creds" attribute should reference an "id" of a
creds/cred object.
The tunnel ID can be found by logging into your tunnelbroker.net pannel, clicking on the tunnel you wish to use, and
looking at the URL in your browser.
It is in the format of https://www.tunnelbroker.net/tunnel_detail.php?tid=[TUNNEL ID]
So if it takes you to e.g. https://www.tunnelbroker.net/tunnel_detail.php?tid=12345, your tunnel ID would
be "12345".
The below directives give you a Section and Value Name. This refers to the tunnelbroker.net panel page for the
specific tunnel you're configuring. e.g. To use the above example, this information is found at
https://www.tunnelbroker.net/tunnel_detail.php?tid=12345
-->
2020-05-11 16:23:34 -04:00
<tunnel id="12345" creds="ipv6user">
2020-05-12 01:21:52 -04:00
<!--
The "server" element is the remote SIT endpoint.
Section: IPv6 Tunnel Endpoints
Value Name: Server IPv4 Address
-->
2020-05-11 16:23:34 -04:00
<server>192.0.2.1</server>
2020-05-12 01:21:52 -04:00
<!--
The "client" element is the local SIT endpoint.
Section: IPv6 Tunnel Endpoints
Value Name: Client IPv6 Address
2020-05-12 01:21:52 -04:00
-->
<client prefix="64">2001:DB8:3::2</client>
2020-05-12 01:21:52 -04:00
<!--
Allocations that are handed to your tunnel.
2020-05-12 01:21:52 -04:00
Section: Routed IPv6 Prefixes
-->
<allocations>
2020-05-12 01:21:52 -04:00
<!--
Each alloc has the following attributes:
* "prefix" - the prefix size specified by your tunnelbroker.
* "id" - an identifier for each allocation to be used in assignments/assign items.
2020-05-12 01:21:52 -04:00
Value Name: Routed /64
-->
<alloc prefix="64" id="lan">2001:DB8:1:2::</alloc>
2020-05-12 01:21:52 -04:00
<!--
You may not have a /48 as it's opt-in. It's highly recommended, though, so you can provide global IPv6 addresses
to the rest of your LAN(s).
2020-05-12 01:21:52 -04:00
Value Name: Routed /48
-->
<alloc prefix="48" id="multilan">2001:DB8:2::</alloc>
</allocations>
2020-05-12 01:21:52 -04:00
<!--
Where to assign the allocations. The default allocation prefix is a /64 (prefix="64"), since that's what SLAAC
recommends.
Note that if you use your /64 allocation, and don't specify a longer prefix to it, you can only have one
assignment.
It has two optional attributes:
* "radvd" - a boolean; if true, /etc/radvd.conf will be automatically.
* "radvdDns" - a boolean, only used if radvd is true; if true, will specify the server's IP as an RDSS.
generated and restarted.
2020-05-12 01:21:52 -04:00
-->
<assignments radvd="true" radvdDns="true">
<!--
Each assignment has the following required attributes:
* "prefix" - the size of the subnet, "64" (/64) by default since that's what SLAAC recommends. Note that if
you use your /64 allocation and don't specify a longer prefix, you can only have one assignment
for that allocation.
* "alloc" - this should match an "id" attribute of an allocations/alloc item.
* "iface" - which network interface on the machine that the allocation should be added to.
Sections of the alloc referenced in the "alloc" attribute will then be carved out. Make sure you don't exceed
your allocation size! (A /48 has 65536 /64s in it.)
The interface will be assigned :1 (the first host in the subnet) as well, so it is recommended that you do not
assign a /128.
-->
<assign prefix="64" alloc="lan" iface="eth0"/>
<assign prefix="64" alloc="multilan" iface="eth0"/>
<assign prefix="64" alloc="multilan" iface="eth1"/>
<assign prefix="64" alloc="multilan" iface="eth2"/>
</assignments>
2020-05-11 16:23:34 -04:00
</tunnel>
2020-05-12 01:21:52 -04:00
<!--
And you can, of course, specify multiple tunnels.
-->
2020-05-11 16:23:34 -04:00
<tunnel id="54321" creds="ipv6user">
<server>192.0.2.1</server>
2020-05-11 16:50:45 -04:00
<client prefix="64">2001:DB8:6::2</client>
<allocations>
<alloc prefix="64" id="lan">2001:DB8:4:2:</alloc>
<alloc prefix="48" id="biglan">2001:DB8:5::</alloc>
</allocations>
<assignments>
<!-- Uses the default prefix of /64 each. -->
<assign alloc="lan" iface="eth0"/>
<assign alloc="biglan" iface="eth1"/>
<assign alloc="biglan" iface="eth1"/>
<assign alloc="biglan" iface="eth1"/>
</assignments>
2020-05-11 16:23:34 -04:00
</tunnel>
</tunnels>
</heIPv6>