====== Wi-Fi HotSpot (Captive Portal for Wi-Fi authorization) ======
{{indexmenu_n>7}}
===== Introduction =====
The module provides an opportunity to implement the following case: [[en:dpi:dpi_options:use_cases:dpi_bestpractice_wifi_login]]

===== Architecture =====

{{ :en:dpi:dpi_components:module_wi-fi_hotspot:wifi_hotspot_scheme.png?nolink&700 |}}
===== Scenarios of use =====

When a subscriber connects to Wi-Fi, the router requests the DCHP server to obtain a new IP address. The server returns the addresses to the router and runs the shell-script, which activates the tariff with limited access and the “White List”. It makes sense to include in the white lists, for example, the site of the provider or organization providing public Wi-Fi.

Then the subscriber is redirected to the browser start page, where he needs to go through the authorization by phone number. The web server receives a successful authorization response from the SMS gateway and, using a shell-script, disables restrictions specified on the DPI and redirects the subscriber to the desired page.

{{ :en:dpi:dpi_components:module_wi-fi_hotspot:wifi-hotspot_case.png?nolink&800 |}}

<note>Also see the "[[en:dpi:dpi_options:use_cases:wifi_hotspot_session_management]]" scenario.</note>

===== Installation and Upgrade =====

==== Hardware Recommendations ====
In order to run the module you can use the following hardware or virtual machines matching the following characteristics:
  - CPU 2.5 GHz, 1 pcs
  - RAM 512 MB - 1 GB
  - HDD 20 GB - 50 GB
  - Operating system CentOS 7.x, CentOS 8.x, [[en:veos:installation|VEOS]], CentOS Stream 8.x, Oracle Linux Server 8.x, AlmaLinux 8.x
  - NIC ranging from 10 Mbps

<note warning>**Attention!** Do not install the module on the same hardware running the DPI or the SSG DPI 2 management interface! Use a dedicated virtual machine instead.</note>

==== Before installation ====

=== New Virtual Machine ===

  - Make sure the openssh-clients is installed, it is required to connect to the DPI
  - The rest of environment will be installed automatically

=== Old Virtual Machine ===

  - Make sure the openssh-clients is installed, it is required to connect to the DPI
  - If PHP version <7.1 is installed, uninstall the old one: <code>yum -y remove php*</code> The new version will be installed automatically during dpiui2 installation.
  - If MySql is installed, uninstall it:<code>yum remove mysql mysql-server mysql-community-common</code> Also delete the MySql directory: <code>mv /var/lib/mysql /var/lib/mysql_old_backup</code> During wifi_hotspot installation MariaDB 10.4+ will be installed


=== CentOS 6 ===

Recommended operating system is Cent Cent OS  7+
If you need to install the module on Cent OS 6, make sure that supervisor 3+ is installed. If you do not have the needed package, plese install it using the following commands:
<code>
sudo wget https://vasexperts.ru/install/supervisor-3.0-1.gf.el6.noarch.rpm
yum install supervisor-3.0-1.gf.el6.noarch.rpm
</code>

==== Installation ====


<note warning>Before installing or upgrading, check your internet connection. Run scripts with root privilege or using sudo.</note>

<note important>**Attention**: You should to disable selinux. To do this, set SELINUX = disabled in the /etc/selinux/config file and restart server.</note>

<note important>**Attention**: If you've configured the virtual machine using [[en:dpi:dpi_components:module_wi-fi_hotspot|HotSpot Management]] section before you install this module, all the needed tools and settings will be installed automatically.</note>

To install, run the script:
<code>
#!/usr/bin/env bash

info () {
    echo -e " info:    $@ ";
}

ok () {
    echo -e " done:    $@ ";
}

error () {
    echo -e  " ERROR:  $@";
}

CENTOSRELEASE=`cat /etc/redhat-release`
SUBSTR=`echo $CENTOSRELEASE|cut -c1-22`
SUBSTR2=`echo $CENTOSRELEASE|cut -c1-26`

#Check OS version
CentOsVersion=0
if [ "$SUBSTR" = "CentOS Linux release 7" ]
    then
        CentOsVersion=70
elif [ "$SUBSTR2" == "CentOS release 6.5 (Final)" ]
    then
        CentOsVersion=65
elif [ "$SUBSTR2" == "CentOS release 6.4 (Final)" ]
    then
        CentOsVersion=64
else
    CentOsVersion=60
fi

#Configure repos
info "Configuring repos..."

rpm --import http://vasexperts.ru/centos/RPM-GPG-KEY-vasexperts.ru
rpm -Uvh http://vasexperts.ru/centos/6/x86_64/vasexperts-repo-1-0.noarch.rpm


MARIADB_REPO=/etc/yum.repos.d/mariadb.repo
if [ "$CentOsVersion" == 70 ]
then
        rpm -Uvh https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
        rpm -Uvh https://mirror.webtatic.com/yum/el7/webtatic-release.rpm
        
        echo "[mariadb]
name=MariaDB
baseurl=http://yum.mariadb.org/10.4/centos7-amd64
gpgkey=https://yum.mariadb.org/RPM-GPG-KEY-MariaDB
gpgcheck=1" > $MARIADB_REPO

else

        rpm -Uvh https://dl.fedoraproject.org/pub/epel/epel-release-latest-6.noarch.rpm
        rpm -Uvh https://mirror.webtatic.com/yum/el6/latest.rpm
        
        MACHINE_TYPE=`uname -m`
        if [ ${MACHINE_TYPE} == 'x86_64' ] 
        then

echo "[mariadb]
name=MariaDB
baseurl=http://yum.mariadb.org/10.4/centos6-amd64
gpgkey=https://yum.mariadb.org/RPM-GPG-KEY-MariaDB
gpgcheck=1" > $MARIADB_REPO

else
echo "[mariadb]
name=MariaDB
baseurl=http://yum.mariadb.org/10.4/centos6-x86
gpgkey=https://yum.mariadb.org/RPM-GPG-KEY-MariaDB
gpgcheck=1" > $MARIADB_REPO
fi


fi
ok "Finished Configuring repos."

#wifi_hotspot install
info "Wifi hotspot package installing..."

yum install -y wifi_hotspot --exclude=php-common*;

info "Finished wifi_hotspot package installing."
</code>

The rpm wifi_hotspot package will be installed. It will be configured automatically according to the default configuration.

Installation/upgrading of the following environment will be performed during the installation:
  - PHP >= 7.1
  - MariaDB >= 10.4
  - Apache
  - Composer
  - PHP SSH2 lib
  - Laravel/Lumen

The necessary ports will be opened, and cron will be launched to perform scheduled background tasks during the installation process.

The module will be installed to the \\ <code>/var/www/html/wifi_hotspot/</code> directory.

After the installation, enter in the browser:
\\ <code>http://<IP address of VM>/</code>

==== Upgrade ====
To update a previously installed version, run the following command: <code>yum install -y wifi_hotspot</code>

==== Configuration ====

System settings of the module are in the .env file: <code>/var/www/html/wifi_hotspot/backend/.env</code>

The contents of the file are as follows:
<code>
#System settings, it’s worth to avoid modifying it
APP_ENV=local
APP_DEBUG=true
APP_KEY=
APP_TIMEZONE=UTC

#System settings for connecting to the MySql database, it’s worth to avoid modifying it
DB_CONNECTION=mysql
DB_HOST=localhost
DB_PORT=3306
DB_DATABASE=wifi_hotspot
DB_USERNAME=root
DB_PASSWORD=vasexperts

#Settings for connecting to the SMTP server. They serve to send authorization data in debug mode.
CFG_SMTP_UNAME=smtptestvasexperts@gmail.com
CFG_SMTP_PW=
CFG_SMTP_HOST=smtp.gmail.com
CFG_SMTP_PORT=587
CFG_SMTP_SECURE=tls
CFG_SMTP_SENDER=smtptestvasexperts@gmail.com

#System settings, modifying is fobidden
CACHE_DRIVER=file
QUEUE_DRIVER=database
SESSION_DRIVER=cookie

#Debugging mode for interaction between Hotspot and DPI. When enabled, a request to the SMS/call authorization service is not sent. Authorization code 0000.
#Default 0
DEBUG_MODE=0

</code>

<note important>If .env file has been modified, you should run the following command:\\ <code>php /var/www/html/wifi_hotspot/backend/artisan queue:restart</code></note>
==== Version Information ====
=== Version v.1.4.4 (26.09.2024) ===
  * Added the ability to authorize an outgoing call (available for version dpiui2 >= 2.35.4)
  * Added the ability to apply services/tariffs for a subscriber via a Web hook to a third-party service (available for version dpiui2 >= 2.35.4)
  * Bugfix

=== Version v.1.3.5 (18.06.2024) ===
  * Added the ability to set a priority authorization method (available for version dpiui2 >= 2.34.5)
  * Added the ability to enable debug mode for the Hotspot interaction script with SKAT (option DEBUG_MODE in /var/www/html/wifi_hotspot/backend/.env)
  * Bugfix

=== Version v.1.3.3 (16.10.2023) ===
  * Added possibility of auto substitution of code from SMS into the code input field (on mobile devices);
  * Added option in the configuration file (backend/.env) OLD_AAA_FILE_LIFETIME_DAYS to delete AAA-session files after a specified number of days (default is 0 - do not delete)

=== Version v.1.2.19 (11.04.2022) ===
Corrects errors that occurred when using services that did not support phone numbers with a leading "+" and/or "8" sign:
  * Added possibility to delete leading "+" sign in phone number
  * Added option to replace the leading "8" with "7" in the phone number

=== Version v.1.2.17 (01.03.2022) ===
  * Fixed errors in subscriber authorization/deauthorization script;
  * Extended subscriber authorization/deauthorization logs
  * Added ability to export AAA sessions
  * Added the ability to configure the length of subscribers authorization code

=== Version v.1.2.4 (02.10.2020) ===
   * Bugs fixed

=== Version v.1.1.0 (06.11.2019) ===
   * The process of replacing the logo and icons through the dpiui2 interface reworked
   * The size limitation of logo or icon file from 64kb to 750kb changed

=== Version v.1.0.10 (10/25/2019) ===
   * Correction of the display of the portal on mobile devices
   * Correction of the re-authorization algorithm

=== Version v.1.0.7 (15.09.2019) ===
   * Created a new Wi-Fi HotSpot module

===== Subscriber Interaction =====

Interaction between HotSpot and the subscriber on the SSG and the commands executed during this process:
  - Script triggered by DHCP (unloaded on SSG at ''/var/dpiui2/add_captive_portal_auth.sh''). Service profile 5 and policing profile for authorization are applied to the subscriber's IP <code bash>fdpi_ctrl load --service 5 --profile.name='hotspot_white_list_profile' --ip $1
fdpi_ctrl load --policing --profile.name='wifi_hotspot_auth_policing' --ip $1</code>
  - Commands executed on the SSG upon successful user authorization:
    - If a subscriber with this login already exists: <code bash>fdpi_ctrl list --bind --login='[phone]'</code>
    - Remove the policing profile for authorization from the subscriber: <code bash>fdpi_ctrl del --policing --ip=[ip]</code>
    - Remove service 5 from the subscriber: <code bash>fdpi_ctrl del --service 5 --ip=[ip]</code>
    - Remove service 11 (NAT) from the subscriber: <code bash>fdpi_ctrl del --service 11 --ip=[ip]</code>
    - Create a bind subscriber: <code bash>fdpi_ctrl load --bind --user='[phone]:[ip]'</code>
    - Apply the policing profile for internet access to the subscriber: <code bash>fdpi_ctrl load --policing --profile.name='wifi_hotspot_policing' --login='[phone]'</code>
    - If services are set in the GUI form that need to be applied to the subscriber: <code bash>fdpi_ctrl load --service [service] --login='[phone]'</code>
    - If service profiles are set in the GUI form that need to be applied to the subscriber: <code bash>fdpi_ctrl load --service [service] --profile.name='[profile_name]' --login='[phone]'</code>
  - Commands executed on the SSG when the authorized user's session has expired:
    - Remove the policing profile for internet access from the subscriber: <code bash>fdpi_ctrl del --policing --login='[phone]'</code>
    - Retrieve the list of services applied to the subscriber and remove them: <code bash>fdpi_ctrl list --service --login='[phone]'
	fdpi_ctrl del --service [service] --login='[phone]'</code>
    - Delete the bind subscriber: <code bash>fdpi_ctrl del --bind --login='[phone]'</code>
    - Execute the script on the SSG to add service profile 5 and policing profile for authorization (see item 1) <code bash>sh /var/dpiui2/add_captive_portal_auth.sh [ip]</code>