-
Notifications
You must be signed in to change notification settings - Fork 787
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
wizard: reimplement system setup, for #8352
- Loading branch information
1 parent
b945789
commit 9731fe9
Showing
22 changed files
with
926 additions
and
2,056 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 55 additions & 0 deletions
55
src/opnsense/mvc/app/controllers/OPNsense/Core/Api/InitialSetupController.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * Copyright (c) 2025 Deciso B.V. | ||
| * All rights reserved. | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions are met: | ||
| * | ||
| * 1. Redistributions of source code must retain the above copyright notice, | ||
| * this list of conditions and the following disclaimer. | ||
| * | ||
| * 2. Redistributions in binary form must reproduce the above copyright | ||
| * notice, this list of conditions and the following disclaimer in the | ||
| * documentation and/or other materials provided with the distribution. | ||
| * | ||
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, | ||
| * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY | ||
| * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE | ||
| * AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, | ||
| * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | ||
| * POSSIBILITY OF SUCH DAMAGE. | ||
| */ | ||
|
|
||
| namespace OPNsense\Core\Api; | ||
|
|
||
| use OPNsense\Base\ApiMutableModelControllerBase; | ||
| use OPNsense\Core\Backend; | ||
| use OPNsense\Core\Config; | ||
|
|
||
| /** | ||
| * Class InitialSetupController | ||
| * @package OPNsense\Core | ||
| */ | ||
| class InitialSetupController extends ApiMutableModelControllerBase | ||
| { | ||
| protected static $internalModelName = 'wizard'; | ||
| protected static $internalModelClass = 'OPNsense\Core\InitialSetup'; | ||
|
|
||
| public function configureAction() | ||
| { | ||
| $result = parent::setAction(); | ||
| if ($result['result'] == 'saved') { | ||
| $result = $this->getModel()->updateConfig(); | ||
| (new Backend())->configdRun("service reload delay", true); | ||
| return $result; | ||
| } else { | ||
| return $result; | ||
| } | ||
| } | ||
| } |
70 changes: 70 additions & 0 deletions
70
src/opnsense/mvc/app/controllers/OPNsense/Core/InitialSetupController.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * Copyright (C) 2025 Deciso B.V. | ||
| * | ||
| * All rights reserved. | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions are met: | ||
| * | ||
| * 1. Redistributions of source code must retain the above copyright notice, | ||
| * this list of conditions and the following disclaimer. | ||
| * | ||
| * 2. Redistributions in binary form must reproduce the above copyright | ||
| * notice, this list of conditions and the following disclaimer in the | ||
| * documentation and/or other materials provided with the distribution. | ||
| * | ||
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, | ||
| * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY | ||
| * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE | ||
| * AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, | ||
| * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | ||
| * POSSIBILITY OF SUCH DAMAGE. | ||
| * | ||
| */ | ||
|
|
||
| namespace OPNsense\Core; | ||
|
|
||
| class InitialSetupController extends \OPNsense\Base\IndexController | ||
| { | ||
| public function indexAction() | ||
| { | ||
| $this->view->all_tabs = [ | ||
| 'step_0' => [ | ||
| 'title' => gettext('Welcome'), | ||
| 'message' => gettext( | ||
| 'This wizard will guide you through the initial system configuration. '. | ||
| 'The wizard may be stopped at any time by clicking the logo image at the top of the screen.' | ||
| ) | ||
| ], | ||
| 'step_1' => [ | ||
| 'title' => gettext('General Information'), | ||
| 'form' => $this->getForm('wizard_general_info') | ||
| ], | ||
| 'step_2' => [ | ||
| 'title' => gettext('Network [WAN]'), | ||
| 'form' => $this->getForm('wizard_network_wan') | ||
| ], | ||
| 'step_3' => [ | ||
| 'title' => gettext('Network [LAN]'), | ||
| 'form' => $this->getForm('wizard_network_lan') | ||
| ], | ||
| 'step_4' => [ | ||
| 'title' => gettext('Set initial password'), | ||
| 'form' => $this->getForm('wizard_root_password') | ||
| ], | ||
| 'step_final' => [ | ||
| 'title' => gettext('Finish'), | ||
| 'message' => gettext( | ||
| 'This is the last step in the wizard, click apply to reconfigure the firewall.' | ||
| ) | ||
| ], | ||
| ]; | ||
| $this->view->pick('OPNsense/Core/initial_setup'); | ||
| } | ||
| } |
68 changes: 68 additions & 0 deletions
68
src/opnsense/mvc/app/controllers/OPNsense/Core/forms/wizard_general_info.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| <form> | ||
| <field> | ||
| <id>wizard.hostname</id> | ||
| <label>Hostname</label> | ||
| <type>text</type> | ||
| </field> | ||
| <field> | ||
| <id>wizard.domain</id> | ||
| <label>Domain</label> | ||
| <type>text</type> | ||
| </field> | ||
| <field> | ||
| <id>wizard.language</id> | ||
| <label>Language</label> | ||
| <type>dropdown</type> | ||
| </field> | ||
| <field> | ||
| <id>wizard.dns_servers</id> | ||
| <label>DNS Servers</label> | ||
| <type>select_multiple</type> | ||
| <style>tokenize</style> | ||
| <allownew>true</allownew> | ||
| <help>Set primary domain name server IPv4 or IPv6 address. Repeat this option to set secondary DNS server addresses.</help> | ||
| </field> | ||
| <field> | ||
| <id>wizard.dnsallowoverride</id> | ||
| <label>Override DNS</label> | ||
| <type>checkbox</type> | ||
| <help>Allow DNS servers to be overridden by DHCP/PPP on WAN</help> | ||
| </field> | ||
| <field> | ||
| <type>header</type> | ||
| <label>DNS [Unbound]</label> | ||
| </field> | ||
| <field> | ||
| <id>wizard.unbound.enabled</id> | ||
| <label>Enable Resolver</label> | ||
| <type>checkbox</type> | ||
| </field> | ||
| <field> | ||
| <id>wizard.unbound.dnssec</id> | ||
| <label>Enable DNSSEC Support</label> | ||
| <type>checkbox</type> | ||
| </field> | ||
| <field> | ||
| <id>wizard.unbound.dnssecstripped</id> | ||
| <label>Harden DNSSEC data</label> | ||
| <type>checkbox</type> | ||
| <help>DNSSEC data is required for trust-anchored zones. If such data is absent, the zone becomes bogus. If this is disabled and no DNSSEC data is received, then the zone is made insecure.</help> | ||
| </field> | ||
| <field> | ||
| <type>header</type> | ||
| <label><![CDATA[Time & Timezone]]></label> | ||
| </field> | ||
| <field> | ||
| <id>wizard.timeservers</id> | ||
| <label>Time Servers</label> | ||
| <type>select_multiple</type> | ||
| <style>tokenize</style> | ||
| <allownew>true</allownew> | ||
| <help>Hostnames of the timeservers to use to acquire time for this firewall.</help> | ||
| </field> | ||
| <field> | ||
| <id>wizard.timezone</id> | ||
| <label>Timezone</label> | ||
| <type>dropdown</type> | ||
| </field> | ||
| </form> |
20 changes: 20 additions & 0 deletions
20
src/opnsense/mvc/app/controllers/OPNsense/Core/forms/wizard_network_lan.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| <form> | ||
| <field> | ||
| <id>wizard.interfaces.lan.disable</id> | ||
| <label>Disable LAN</label> | ||
| <type>checkbox</type> | ||
| <help>Disable LAN, usually only relevant in "wan" only scenarios.</help> | ||
| </field> | ||
| <field> | ||
| <id>wizard.interfaces.lan.ipaddr</id> | ||
| <label>IP Address</label> | ||
| <type>text</type> | ||
| <help>Ip address and cidr to configure on this interface, e.g. 192.168.1.1/24.</help> | ||
| </field> | ||
| <field> | ||
| <id>wizard.interfaces.lan.configure_dhcp</id> | ||
| <label>Configure DHPC server</label> | ||
| <type>checkbox</type> | ||
| <help>Configure DHCP server for this network, when disabled dhcp services will not be available on this network after finishing the wizard.</help> | ||
| </field> | ||
| </form> |
83 changes: 83 additions & 0 deletions
83
src/opnsense/mvc/app/controllers/OPNsense/Core/forms/wizard_network_wan.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| <form> | ||
| <field> | ||
| <id>wizard.interfaces.wan.ipv4_type</id> | ||
| <label>Type</label> | ||
| <type>dropdown</type> | ||
| </field> | ||
| <field> | ||
| <id>wizard.interfaces.wan.spoofmac</id> | ||
| <label>MAC (spoofed)</label> | ||
| <type>text</type> | ||
| <help>Usually this option is left empty, unless your provider requires you to connect using a specific mac address.</help> | ||
| </field> | ||
| <field> | ||
| <id>wizard.interfaces.wan.mtu</id> | ||
| <label>MTU</label> | ||
| <type>text</type> | ||
| <help>Set the MTU of the WAN interface. If you leave this field blank, an MTU of 1492 bytes for PPPoE and 1500 bytes for all other connection types will be assumed.</help> | ||
| </field> | ||
| <field> | ||
| <id>wizard.interfaces.wan.mss</id> | ||
| <label>MSS</label> | ||
| <type>text</type> | ||
| <help>If you enter a value in this field, then MSS clamping for TCP connections to the value entered above minus 40 (TCP/IP header size) will be in effect. If you leave this field blank, an MSS of 1492 bytes for PPPoE and 1500 bytes for all other connection types will be assumed. This should match the above MTU value in most all cases.</help> | ||
| </field> | ||
| <field> | ||
| <id>wizard.interfaces.wan.ipaddr</id> | ||
| <label>IP Address</label> | ||
| <type>text</type> | ||
| <style>wan_options wan_options_static</style> | ||
| <help>Ip address and cidr to configure on this interface, e.g. 192.168.1.1/24.</help> | ||
| </field> | ||
| <field> | ||
| <id>wizard.interfaces.wan.gateway</id> | ||
| <label>Gateway</label> | ||
| <type>text</type> | ||
| <style>wan_options wan_options_static</style> | ||
| <help>Gateway address to use, e.g. 192.168.1.254.</help> | ||
| </field> | ||
| <field> | ||
| <id>wizard.interfaces.wan.dhcphostname</id> | ||
| <label>DHCP hostname</label> | ||
| <type>text</type> | ||
| <style>wan_options wan_options_dhcp</style> | ||
| <help>The value in this field is sent as the DHCP client identifier and hostname when requesting a DHCP lease. Some ISPs may require this (for client identification).</help> | ||
| </field> | ||
| <field> | ||
| <id>wizard.interfaces.wan.pppoe_username</id> | ||
| <label>PPPoE Username</label> | ||
| <type>text</type> | ||
| <style>wan_options wan_options_pppoe</style> | ||
| <help></help> | ||
| </field> | ||
| <field> | ||
| <id>wizard.interfaces.wan.pppoe_password</id> | ||
| <label>PPPoE Password</label> | ||
| <type>password</type> | ||
| <style>wan_options wan_options_pppoe</style> | ||
| <help></help> | ||
| </field> | ||
| <field> | ||
| <id>wizard.interfaces.wan.pppoe_provider</id> | ||
| <label>PPPoE Service name</label> | ||
| <type>text</type> | ||
| <style>wan_options wan_options_pppoe</style> | ||
| <help></help> | ||
| </field> | ||
| <field> | ||
| <type>header</type> | ||
| <label><![CDATA[Default policies]]></label> | ||
| </field> | ||
| <field> | ||
| <id>wizard.interfaces.wan.blockpriv</id> | ||
| <label>Block RFC1918 Private Networks</label> | ||
| <type>checkbox</type> | ||
| <help>When set, this option blocks traffic from IP addresses that are reserved for private networks as per RFC 1918 (10/8, 172.16/12, 192.168/16) as well as loopback addresses (127/8) and Carrier-grade NAT addresses (100.64/10). This option should only be set for WAN interfaces that use the public IP address space.</help> | ||
| </field> | ||
| <field> | ||
| <id>wizard.interfaces.wan.blockbogons</id> | ||
| <label>Block bogon networks</label> | ||
| <type>checkbox</type> | ||
| <help>When set, this option blocks traffic from IP addresses that are reserved (but not RFC 1918) or not yet assigned by IANA.</help> | ||
| </field> | ||
| </form> |
13 changes: 13 additions & 0 deletions
13
src/opnsense/mvc/app/controllers/OPNsense/Core/forms/wizard_root_password.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| <form> | ||
| <field> | ||
| <id>wizard.password</id> | ||
| <label>Root Password</label> | ||
| <type>password</type> | ||
| <help>Leave empty to keep current one</help> | ||
| </field> | ||
| <field> | ||
| <id>wizard.password_confirm</id> | ||
| <label>Root Password Confirmation</label> | ||
| <type>password</type> | ||
| </field> | ||
| </form> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.