OPBootstrap.sh

#Copyright 2021 punkt.de GmbH
#Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
#
#Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
#
#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 BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS 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.
#Code from https://github.com/punktDe/vagrant-opnsense/tree/main (2024)
#Modifications by ScioShield

opnsense_release='24.1'                # Which OPNsense release to install
virtual_machine_ip='192.168.56.2'     # IP address of the firewall in the host-only network

fetch -o opnsense-bootstrap.sh https://raw.githubusercontent.com/opnsense/update/$opnsense_release/src/bootstrap/opnsense-bootstrap.sh.in

# Remove reboot command from bootstrap script
sed -i '' -e '/reboot$/d' opnsense-bootstrap.sh

# Start bootstrap
sh ./opnsense-bootstrap.sh -r $opnsense_release -y

# Set correct interface names so OPNsense's order matches Vagrant's
sed -i '' -e 's/mismatch0/em1/' /usr/local/etc/config.xml
sed -i '' -e 's/mismatch1/em0/' /usr/local/etc/config.xml

# Update the subnet of LAN to a /26
sed -i '' '/<lan>/,/<\/lan>/s/<subnet>[^<]*<\/subnet>/<subnet>26<\/subnet>/' /usr/local/etc/config.xml

# Append the remaining interfaces
cat > interface.xml << EOF
    <opt1>
      <if>em2</if>
      <descr>Assets</descr>
      <enable>1</enable>
      <spoofmac/>
      <ipaddr>192.168.56.65</ipaddr>
      <subnet>26</subnet>
    </opt1>
    <opt2>
      <if>em3</if>
      <descr>Targets</descr>
      <enable>1</enable>
      <spoofmac/>
      <ipaddr>192.168.56.129</ipaddr>
      <subnet>26</subnet>
    </opt2>
    <opt3>
      <if>em4</if>
      <descr>Hackers</descr>
      <enable>1</enable>
      <spoofmac/>
      <ipaddr>192.168.56.193</ipaddr>
      <subnet>26</subnet>
    </opt3>
EOF

# Append the remaining interfaces
sed -i '' -e '/<interfaces>/r interface.xml' /usr/local/etc/config.xml

# Remove IPv6 configuration from WAN
sed -i '' -e '/<ipaddrv6>dhcp6<\/ipaddrv6>/d' /usr/local/etc/config.xml

# Remove IPv6 configuration from LAN
sed -i '' -e '/<ipaddrv6>track6<\/ipaddrv6>/d' /usr/local/etc/config.xml
sed -i '' -e '/<subnetv6>64<\/subnetv6>/d' /usr/local/etc/config.xml
sed -i '' -e '/<track6-interface>wan<\/track6-interface>/d' /usr/local/etc/config.xml
sed -i '' -e '/<track6-prefix-id>0<\/track6-prefix-id>/d' /usr/local/etc/config.xml

# Change OPNsense LAN IP addresses to VirtualBox compatible one
sed -i '' -e "s/192\.168\.1\.1</${virtual_machine_ip}</" /usr/local/etc/config.xml

# Change hostname
sed -i '' -e "s/<hostname>OPNsense<\/hostname>/<hostname>tartarus-opnsense<\/hostname>/" /usr/local/etc/config.xml
sed -i '' -e "s/<domain>localdomain<\/domain>/<domain>home.arpa<\/domain>/" /usr/local/etc/config.xml

# Add DHCP for OPT2
cat > dhcp.xml << EOF
  <dhcpd>
    <lan>
      <enable/>
      <range>
        <from>192.168.56.12</from>
        <to>192.168.56.60</to>
      </range>
    </lan>
    <opt2>
      <enable>1</enable>
      <gateway>192.168.56.129</gateway>
      <ddnsdomainalgorithm>hmac-md5</ddnsdomainalgorithm>
      <numberoptions>
        <item/>
      </numberoptions>
      <range>
        <from>192.168.56.130</from>
        <to>192.168.56.190</to>
      </range>
      <winsserver/>
      <dnsserver/>
      <ntpserver/>
    </opt2>
  </dhcpd>
EOF

# Remove the DHCP config
sed -i '' -e '/<dhcpd>/,/<\/dhcpd>/d' /usr/local/etc/config.xml

# Append the DHCP config
sed -i '' -e '/<\/interfaces>/r dhcp.xml' /usr/local/etc/config.xml

# Create SSH file
cat > ssh.xml << EOF
      <enabled>enabled</enabled>
EOF

# Enable SSH by default
sed -i '' -e '/<group>admins<\/group>/r ssh.xml' /usr/local/etc/config.xml

# Create Filter file
cat > filter.xml << EOF
    <rule>
      <type>pass</type>
      <interface>wan</interface>
      <ipprotocol>inet</ipprotocol>
      <statetype>keep state</statetype>
      <direction>in</direction>
      <quick>1</quick>
      <protocol>tcp</protocol>
      <source>
        <any>1</any>
      </source>
      <destination>
        <network>(self)</network>
        <port>22</port>
      </destination>
    </rule>
    <rule>
      <type>pass</type>
      <interface>wan</interface>
      <ipprotocol>inet</ipprotocol>
      <statetype>keep state</statetype>
      <direction>in</direction>
      <quick>1</quick>
      <protocol>tcp</protocol>
      <source>
        <any>1</any>
      </source>
      <destination>
        <network>(self)</network>
        <port>443</port>
      </destination>
    </rule>
EOF

# Insert the rule into OPNsense config.xml
sed -i '' -e '/<filter>/r filter.xml' /usr/local/etc/config.xml

# Do not block private networks on WAN
sed -i '' -e '/<blockpriv>1<\/blockpriv>/d' /usr/local/etc/config.xml

# Reset shell of Vagrant user
/usr/sbin/pw usermod vagrant -s /bin/sh

# Create XML config for Vagrant user
key=$(b64encode -r dummy <.ssh/authorized_keys | tr -d '\n')
cat > vagrant.xml << EOF
    <user>
      <name>vagrant</name>
      <descr>Vagrant User</descr>
      <scope>system</scope>
      <groupname>admins</groupname>
      <password>*</password>
      <uid>1001</uid>
      <shell>/bin/sh</shell>
      <authorizedkeys>${key}</authorizedkeys>
    </user>
EOF

# Create XML config for OPNsense admins
cat >> admins.xml << EOF
      <member>1001</member>
EOF

# Add Vagrant user - OPNsense style
sed -i '' -e '/<\/member>/r admins.xml' /usr/local/etc/config.xml
sed -i '' -e '/<\/user>/r vagrant.xml' /usr/local/etc/config.xml

# Change home directory to group nobody
chgrp -R nobody /usr/home/vagrant

# Display helpful message for the user
echo '#####################################################'
echo '#                                                   #'
echo '#  OPNsense provisioning finished - shutting down.  #'
echo '#  Use `vagrant up opnsense --provision`            #'
echo '#  to start your OPNsense.                          #'
echo '#  !!!!!The Provision is mandatory!!!!!             #'
echo '#                                                   #'
echo '#####################################################'

# Reboot the system
shutdown -r now