4 |
5 |
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | edgemax-dhcpv6-pd-wizard
2 | ========================
3 |
4 | Feature Wizard for DHCPv6-PD on Ubiquiti EdgeMax Routers. Tested and validated on my home Comcast IPv6 environment.
5 |
6 | Development status
7 | ==================
8 | WIP: I'm figuring out how to make an EdgeMax feature wizard for the first time, borrowed heavily from the UPnP example.
9 | Instructions here
10 |
11 | Usage
12 | =====
13 | Known to work with 1.4.x and 1.5.x firmware
14 |
15 | 1. Apply the following configuration to your router to configure radvd (in this example, WAN=eth0, LAN=br0)
16 | ```
17 | set interfaces bridge br0 ipv6 dup-addr-detect-transmits 1
18 | set interfaces bridge br0 ipv6 router-advert cur-hop-limit 64
19 | set interfaces bridge br0 ipv6 router-advert default-preference high
20 | set interfaces bridge br0 ipv6 router-advert link-mtu 0
21 | set interfaces bridge br0 ipv6 router-advert managed-flag true
22 | set interfaces bridge br0 ipv6 router-advert max-interval 600
23 | set interfaces bridge br0 ipv6 router-advert other-config-flag true
24 | set interfaces bridge br0 ipv6 router-advert prefix '::/64' autonomous-flag true
25 | set interfaces bridge br0 ipv6 router-advert prefix '::/64' on-link-flag true
26 | set interfaces bridge br0 ipv6 router-advert prefix '::/64' valid-lifetime 2592000
27 | set interfaces bridge br0 ipv6 router-advert reachable-time 0
28 | set interfaces bridge br0 ipv6 router-advert retrans-timer 0
29 | set interfaces bridge br0 ipv6 router-advert send-advert true
30 | set interfaces ethernet eth0 ipv6 dup-addr-detect-transmits 1
31 | set protocols static interface-route6 '::/0' next-hop-interface eth0
32 | ```
33 |
34 | 2. Download and install the feature wizard
35 |
36 | #### End user installation:
37 | * Download the wizard .tar file: https://github.com/irvingpop/edgemax-dhcpv6-pd-wizard/releases/download/v0.0.1/edgemax-dhcpv6-pd-wizard-0.0.1.tar
38 | * Uncompress it (`gzip -d`) so that it simply `master.tar`
39 | * upload `master.tar` to https://your-router/#Wizard (click on the + symbol next to Feature Wizards in the left-hand pane)
40 |
41 | #### Developer installation:
42 | Git clone and scp these files into `/config/wizard/feature/dhcpv6-pd` on your EdgeMax device.
43 |
44 | ```
45 | /var/www/wizard/feature/wide-dhcpv6-client/validator.json
46 | /var/www/wizard/feature/wide-dhcpv6-client/wizard-run
47 | /var/www/wizard/feature/wide-dhcpv6-client/wizard.html
48 | ```
49 |
50 | #### Settings:
51 | * Internal interface: Your LAN interface (currently only one supported)
52 | * External interface: Your WAN interface (currently only one supported)
53 |
54 |
55 | TODO
56 | ====
57 | * Handling of multiple Prefix Delegations
58 | * Better integration with UBNT/Vayatta system (Persist this data and installation across firmware upgrades, CLI integration, etc)
59 | * IPv6 status reporting in the Wizard UI
60 | * Automatic detection/setting of router-advert settings
61 | * Automatic detection/setting of non-foot-shooting IPv6 LOCAL Firewall rules. Example:
62 |
63 | ```
64 | set firewall ipv6-name WAN6_LOCAL default-action drop
65 | set firewall ipv6-name WAN6_LOCAL description 'IPv6 Internet to router'
66 | set firewall ipv6-name WAN6_LOCAL enable-default-log
67 | set firewall ipv6-name WAN6_LOCAL rule 1 action accept
68 | set firewall ipv6-name WAN6_LOCAL rule 1 state established enable
69 | set firewall ipv6-name WAN6_LOCAL rule 1 state related enable
70 | set firewall ipv6-name WAN6_LOCAL rule 2 action accept
71 | set firewall ipv6-name WAN6_LOCAL rule 2 description ICMPv6
72 | set firewall ipv6-name WAN6_LOCAL rule 2 limit burst 1
73 | set firewall ipv6-name WAN6_LOCAL rule 2 protocol icmpv6
74 | set firewall ipv6-name WAN6_LOCAL rule 3 action accept
75 | set firewall ipv6-name WAN6_LOCAL rule 3 description 'for DHCPv6'
76 | set firewall ipv6-name WAN6_LOCAL rule 3 destination port 546-547
77 | set firewall ipv6-name WAN6_LOCAL rule 3 protocol udp
78 | set firewall ipv6-name WAN6_LOCAL rule 100 action drop
79 | set firewall ipv6-name WAN6_LOCAL rule 100 log enable
80 | set firewall ipv6-name WAN6_LOCAL rule 100 state invalid enable
81 | ```
82 |
--------------------------------------------------------------------------------
/wizard-run:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | ACTION=$1
4 | INPUT=$2
5 |
6 | pfx="firewall options mss-clamp"
7 | cmd=/opt/vyatta/sbin/vyatta-cfg-cmd-wrapper
8 | cli=cli-shell-api
9 |
10 | load () {
11 | int=`cat /var/lib/dhcpv6/internal-interface`
12 | ext=`cat /var/lib/dhcpv6/external-interface`
13 | str=''
14 | [ -n "$str" ] && str+=','
15 | str+="{\"dhcpv6-lan\":\"$int\",\"dhcpv6-wan\":\"$ext\"}"
16 |
17 | intfs=($(ls /sys/class/net/ | grep -v '^lo$'))
18 | ilist=''
19 | for int in "${intfs[@]}"; do
20 | [ -n "$ilist" ] && ilist+=','
21 | ilist+="\"$int\""
22 | done
23 | ilist="{\"options\":[$ilist],\"other\":\"true\"}"
24 |
25 | echo -n "{\"success\":\"1\",\"data\":{\"dhcpv6-config\":[$str]},"
26 | echo "\"definition\":{\"dhcpv6-lan\":$ilist,\"dhcpv6-wan\":$ilist}}"
27 | }
28 |
29 | apply () {
30 | local ret=0
31 | local output=''
32 | local -A ints
33 |
34 | eval "nints=($(cat $INPUT | jq '."dhcpv6-config"[]."dhcpv6-lan"'))"
35 | eval "nexts=($(cat $INPUT | jq '."dhcpv6-config"[]."dhcpv6-wan"'))"
36 |
37 | for ((i = 0; i < ${#nints[@]}; i++)); do
38 | int="${nints[i]}"
39 | ext="${nexts[i]}"
40 | if [ "$int" == "$ext" ]; then
41 | ret=1
42 | output='Internal and external interfaces cannot be the same'
43 | break
44 | fi
45 | if [ -n "${ints[$int]}" ]; then
46 | ret=1
47 | output='The same internal interface can only be in one entry'
48 | break
49 | fi
50 | ints[$int]=1
51 | done
52 |
53 | if [ $ret == 0 ]; then
54 | echo ${nints[0]} > /var/lib/dhcpv6/internal-interface
55 | echo ${nexts[0]} > /var/lib/dhcpv6/external-interface
56 |
57 | # Enable WAN interface to accept Router Advertisement even if forwarding is enabled
58 | sysctl -w net.ipv6.conf.${nexts[0]}.accept_ra=2 > /dev/null 2>&1
59 | cat > /etc/sysctl.d/40-ipv6.conf < /etc/default/wide-dhcpv6-client < /etc/wide-dhcpv6/dhcp6c.conf < /etc/wide-dhcpv6/dhcp6c-script <> \$new_resolv_conf
101 | fi
102 | if [ -n "\$new_domain_name_servers" ]; then
103 | for nameserver in \$new_domain_name_servers; do
104 | # No need to add an already existing nameserver
105 | res=\$(grep "nameserver \$nameserver" \$old_resolv_conf)
106 | if [ -z "\$res" ]; then
107 | echo nameserver \$nameserver >> \$new_resolv_conf
108 | fi
109 | done
110 | fi
111 |
112 | # Use resolvconf if available
113 | if [ -h "\$old_resolv_conf" -a -x "\$RESOLVCONF" ]; then
114 | for IFACE in \$INTERFACES; do
115 | cat \$new_resolv_conf | \$RESOLVCONF -a \$IFACE
116 | done
117 | else
118 | # To preserve IPv4 informations...
119 | cat \$old_resolv_conf >> \$new_resolv_conf
120 | chown --reference=\$old_resolv_conf \$new_resolv_conf
121 | chmod --reference=\$old_resolv_conf \$new_resolv_conf
122 | mv -f \$new_resolv_conf \$old_resolv_conf
123 | fi
124 | fi
125 |
126 | /etc/init.d/radvd restart
127 |
128 | exit 0
129 | EOF
130 |
131 | cat > /etc/wide-dhcpv6/dhcp6c-ifupdown < /dev/null 2>&1 ; [ \$? -eq 1 ] && exit 0
141 |
142 | . /etc/default/wide-dhcpv6-client
143 |
144 | case \$MODE in
145 | start|stop)
146 | for i in \$INTERFACES ; do
147 | if [ "\$IFACE" = "\$i" ] ; then
148 | /usr/sbin/dhcp6ctl \$MODE interface \$IFACE
149 | /etc/init.d/radvd restart
150 | exit 0
151 | fi
152 | done
153 | ;;
154 | *)
155 | if [ "\$VERBOSITY" = "1" ] ; then
156 | echo "dhcp6c-ifupdown: unknown mode \"\$MODE\""
157 | fi
158 | exit 1
159 | ;;
160 | esac
161 | EOF
162 |
163 | cat > /etc/init.d/wide-dhcpv6-client < /dev/null 2>&1; then
208 | test "\$1" != -v || echo "\$NAME is running."
209 | return 0
210 | else
211 | test "\$1" != -v || echo "\$NAME is not running but \$DHCP6CPID exists."
212 | return 1
213 | fi
214 | }
215 |
216 | case "\$1" in
217 | start)
218 | log_daemon_msg "Starting \$DESC" "\$NAME"
219 | start-stop-daemon --start --quiet --pidfile \$DHCP6CPID \\
220 | --oknodo --exec \$DHCP6CBIN -- -Pdefault \$INTERFACES
221 | sleep 2
222 | if check_status -q; then
223 | log_end_msg 0
224 | else
225 | log_end_msg 1
226 | exit 1
227 | fi
228 | ;;
229 | stop)
230 | log_daemon_msg "Stopping \$DESC" "\$NAME"
231 | start-stop-daemon --stop --quiet --pidfile \$DHCP6CPID --oknodo
232 | log_end_msg \$?
233 | rm -f \$DHCP6CPID
234 | ;;
235 | restart|force-reload)
236 | \$0 stop
237 | sleep 2
238 | \$0 start
239 | if [ "\$?" != "0" ]; then
240 | exit 1
241 | fi
242 | ;;
243 | status)
244 | echo "Status of \$NAME: "
245 | check_status -v
246 | exit "\$?"
247 | ;;
248 | *)
249 | echo "Usage: \$0 (start|stop|restart|force-reload|status)"
250 | exit 1
251 | esac
252 |
253 | exit 0
254 | EOF
255 |
256 | update-rc.d wide-dhcpv6-client defaults > /dev/null 2>&1
257 | if [ `/usr/sbin/service wide-dhcpv6-client status` ]; then
258 | output=`/usr/sbin/service wide-dhcpv6-client restart 2>&1`
259 | ret=$?
260 | else
261 | output=`/usr/sbin/service wide-dhcpv6-client start 2>&1`
262 | ret=$?
263 | fi
264 |
265 | fi
266 |
267 | if [ $ret == 0 ]; then
268 | echo "{\"success\":\"1\"}"
269 | else
270 | echo "{\"success\":\"0\",\"error\": \"${output//\"/\'}\"}"
271 | fi
272 |
273 | }
274 |
275 | case "$ACTION" in
276 | load)
277 | load
278 | ;;
279 | apply)
280 | apply
281 | ;;
282 | esac
283 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright {yyyy} {name of copyright owner}
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
--------------------------------------------------------------------------------