Manual:IP/Hotspot: Difference between revisions

From MikroTik Wiki
Jump to navigation Jump to search
← Older edit
 
(26 intermediate revisions by 5 users not shown)
Line 10: Line 10:
* login page modification, where you can put information about the company;
* login page modification, where you can put information about the company;
* automatic and transparent change any IP address of a client to a valid address;
* automatic and transparent change any IP address of a client to a valid address;
* starting from v6.48 HotSpot can inform DHCP clients that they are behind a captive portal (RFC7710);


Hotspot can work reliably only when IPv4 is used. Hotspot relies on Firewall NAT rules which currently are not supported for IPv6.


==ip hotspot setup==
===Sub Categories===
The simplest way to setup HotSpot server on a router, by
/ip hotspot setup
Router will ask you the questions, when successfully finished default configuration will be added for HotSpot server. Once your run setup command, you will be asked for the particular questions,


* '''hotspot interface''' (name of the interface) : interface name to run HotSpot on. To run HotSpot on bridge interface, make sure public interfaces are not included to the bridge
{{ycgu-cooltable-3
* '''local address of network''' (IP address; default: ''10.5.50.1/24'') : HotSpot gateway address
|title-left='''List of reference sub-pages'''
* '''masquerade network''' (yes '''/''' no; default: ''yes'') : Whether to masquerade HotSpot network, when '''yes''' rule is added to ''/ip firewall nat'' with ''action=masquerade''
|title-center='''Case studies'''
* '''address pool of network''' (name) : Address pool for HotSpot network, which is used to change user IP address to a valid address. Useful for providing network access to mobile clients that are not willing to change their networking settings
|title-right='''List of examples'''
* '''select certificate''' (none '''/''' import-other-certificate) : choose SSL certificate, when HTTPS authorization method is required
|content-left=
* '''ip address of smtp server''' (IP address; default: ''0.0.0.0'') : IP address of the SMTP server, where to redirect HotSpot's network SMTP requests (25 TCP port)  
<splist
* '''dns servers''' (IP address) : DNS server addresses used for HotSpot clients, configuration taken from ''/ip dns'' menu of the HotSpot gateway
showparent=yes
* '''dns name''' (name; default: ''blank'') : domain name of the HotSpot server, full quality domain name is required, for example www.example.com
/>
* '''name of local hotspot user''' (name; default: ''admin'') : username of one automatically created HotSpot user, added to ''/ip hotspot user''
 
* '''password for the user''' (name) : password for automatically created HotSpot user
|content-center=
<DynamicPageList>
category = Hotspot
category = Manual
category = Case Studies
namespace = Manual
shownamespace = false
</DynamicPageList>
 
 
|content-right=
<DynamicPageList>
category = Manual
category = Hotspot
category = Examples
namespace = Manual
shownamespace = false
</DynamicPageList>
 
}}
 
==HotSpot Setup==
The simplest way to setup HotSpot server on a router is by '''<code>/ip hotspot setup</code>''' command.
Router will ask to enter parameters required to successfully set up HotSpot. When finished, default configuration will be added for HotSpot server.
 
<pre>
[admin@MikroTik] /ip hotspot> setup
Select interface to run HotSpot on
 
hotspot interface: ether3
Set HotSpot address for interface
 
local address of network: 10.5.50.1/24
masquerade network: yes
Set pool for HotSpot addresses
 
address pool of network: 10.5.50.2-10.5.50.254
Select hotspot SSL certificate
 
select certificate: none
Select SMTP server
 
ip address of smtp server: 0.0.0.0
Setup DNS configuration
 
dns servers: 10.1.101.1
DNS name of local hotspot server
 
dns name: myhotspot
Create local hotspot user
 
name of local hotspot user: admin
password for the user:
[admin@MikroTik] /ip hotspot>
</pre>
 
What was created:
<pre>
[admin@MikroTik] /ip hotspot> print
Flags: X - disabled, I - invalid, S - HTTPS
#  NAME        INTERFACE      ADDRESS-POOL      PROFILE      IDLE-TIMEOUT
0  hotspot1    ether3          hs-pool-3          hsprof1      5m
[admin@MikroTik] /ip hotspot>
[admin@MikroTik] /ip pool> print
# NAME                                        RANGES                       
0 hs-pool-3                                  10.5.50.2-10.5.50.254         
[admin@MikroTik] /ip pool> /ip dhcp-server
[admin@MikroTik] /ip dhcp-server> print
Flags: X - disabled, I - invalid
#  NAME      INTERFACE    RELAY          ADDRESS-POOL    LEASE-TIME ADD-ARP
0  dhcp1    ether3                      hs-pool-3      1h       
[admin@MikroTik] /ip dhcp-server> /ip firewall nat
[admin@MikroTik] /ip firewall nat> print
Flags: X - disabled, I - invalid, D - dynamic
0 X ;;; place hotspot rules here
    chain=unused-hs-chain action=passthrough
 
1  ;;; masquerade hotspot network
    chain=srcnat action=masquerade src-address=10.5.50.0/24
[admin@MikroTik] /ip firewall nat>
 
</pre>
 
'''Parameters asked during setup process'''
 
{{Mr-arg-table-h
|prop=Parameter
|desc=Description
}}
 
{{Mr-arg-table
|arg=hotspot interface
|type=string
|default=allow
|desc=Interface name on which to run HotSpot. To run HotSpot on a bridge interface, make sure public interfaces are not included to the bridge ports.
}}
 
{{Mr-arg-table
|arg=local address of network
|type=IP
|default=10.5.50.1/24
|desc=HotSpot gateway address
}}
 
 
{{Mr-arg-table
|arg=masquerade network
|type=yes {{!}} no
|default=yes
|desc=Whether to masquerade HotSpot network, when '''yes''' rule is added to ''/ip firewall nat'' with ''action=masquerade''
}}
 
{{Mr-arg-table
|arg=address pool of network
|type=string
|default=yes
|desc=Address pool for HotSpot network, which is used to change user IP address to a valid address. Useful if providing network access to mobile clients that are not willing to change their networking settings.
}}
 
{{Mr-arg-table
|arg=select certificate
|type=none {{!}} import-other-certificate
|default=
|desc=Choose SSL certificate, when HTTPS authorization method is required.
}}
 
{{Mr-arg-table
|arg=ip address of smtp server
|type=IP
|default=0.0.0.0
|desc=IP address of the SMTP server, where to redirect HotSpot's network SMTP requests (25 TCP port)  
}}
 
{{Mr-arg-table
|arg=dns servers
|type=IP
|default=0.0.0.0
|desc=DNS server addresses used for HotSpot clients, configuration taken from ''/ip dns'' menu of the HotSpot gateway
}}
 
{{Mr-arg-table
|arg=dns name
|type=string
|default=""
|desc=domain name of the HotSpot server, full quality domain name is required, for example www.example.com
}}
 
{{Mr-arg-table
|arg=name of local hotspot user
|type=string
|default="admin"
|desc=username of one automatically created HotSpot user, added to ''/ip hotspot user''
}}
 
{{Mr-arg-table-end
|arg=password for the user'
|type=string
|default=
|desc=Password for automatically created HotSpot user
}}


==ip hotspot==
==ip hotspot==
Line 35: Line 193:
* '''address-pool''' (name '''/''' none; default: ''none'') : address space used to change HotSpot client ''any'' IP address to a valid address. Useful for providing public network access to mobile clients that are not willing to change their networking settings
* '''address-pool''' (name '''/''' none; default: ''none'') : address space used to change HotSpot client ''any'' IP address to a valid address. Useful for providing public network access to mobile clients that are not willing to change their networking settings
* '''idle-timeout''' (time '''/''' none; default: ''5m'') : period of inactivity for unauthorized clients. When there is no traffic from this client (literally client computer should be switched off), once the timeout is reached, user is dropped from the HotSpot host list, its used address becomes available
* '''idle-timeout''' (time '''/''' none; default: ''5m'') : period of inactivity for unauthorized clients. When there is no traffic from this client (literally client computer should be switched off), once the timeout is reached, user is dropped from the HotSpot host list, its used address becomes available
* '''keepalive-timeout''' (time '''/''' none; default: ''none'') : Value of how long host can stay out of reach to be removed from the HotSpot.
* '''login-timeout''' (time '''/''' none; default: ''none'') : period of time after which if host hasn't been authorized it self with system the host entry gets deleted from host table. Loop repeats until host logs in the system. Enable if there are situations where host cannot login after being to long in host table unauthorized.
* '''interface''' (name of interface) : interface to run HotSpot on  
* '''interface''' (name of interface) : interface to run HotSpot on  
* '''addresses-per-mac''' (integer '''/''' unlimited; default: 2) :  number of IP addresses allowed to be bind with the MAC address, when multiple HotSpot clients connected with one MAC-address
* '''addresses-per-mac''' (integer '''/''' unlimited; default: 2) :  number of IP addresses allowed to be bind with the MAC address, when multiple HotSpot clients connected with one MAC-address
* '''profile''' (name; default: ''default'') - HotSpot server default HotSpot profile, which is located in ''/ip hotspot profile''
* '''profile''' (name; default: ''default'') - HotSpot server default HotSpot profile, which is located in ''/ip hotspot profile''


==ip hotspot profile==
keepalive-timeout (read-only; time) : the exact value of the keepalive-timeout, that is applied for user. Value shows how long host can stay out of reach to be removed from the HotSpot
 
HotSpot profile used for common settings of the HotSpot server, which are applied for all users connected to HotSpot server. Profile allows to specify HotSpot server login options, whether to use RADIUS server for clients and much more.
 
* '''name''' (text) :  HotSpot profile name or identifier
* '''dns-name''' (text) : DNS name of the HotSpot server, it appears as the location of the login page in the web browser. Fully qualified domain name is required, like www.myhotspot.com not www.hotspot
* '''hotspot-address''' (IP address; default: ''0.0.0.0'') : IP address for the HotSpot server ?!
* '''html-directory''' (text; default: ''hotspot'') : HotSpot HTML pages are stored in the particular directory, for example login page, status page, etc. To change HotSpot login page, connect to the router with FTP and download ''hotspot'' folder contents. Basic HTML skills required to change HotSpot login page.
* '''http-cookie-lifetime''' (time; default: ''3d'') : HTTP cookie validity time, the option is related to ''cookie'' HotSpot login method
* '''http-proxy''' (IP address; default: ''0.0.0.0'') : address of the proxy server for HotSpot service, when default value is used all request are resolved by the local ''/ip proxy''
* '''login-by''' (multiple choice: cookie '''/''' http-chap '''/''' http-pap '''/''' https '''/''' mac '''/''' mac '''/''' trial; default: http-chap, cookie) : used HotSpot authentication method
** cookie - may only be used with other HTTP authentication method. HTTP cookie is generated, when user authenticates in HotSpot for the first time. User is not asked for the login/password and authenticated automatically, until ''cookie-lifetime'' is active
** http-chap - login/password is required for the user to authenticate in HotSpot. CHAP challenge-response method with MD5 hashing algorithm is used for protecting passwords.
** http-pap -  login/password is required for user to authenticate in HotSpot. Username and password are sent over network in plain text.
** https - login/password is required for user to authenticate in HotSpot. Client login/password exchange between client and server is encrypted with SSL tunnel
** mac - client is authenticated without asking login form. Client MAC-address is added to ''/ip hotspot user'' database, client is authenticated as soon as connected to the HotSpot
** trial - client is allowed to use internet without HotSpot login for the specified amount of time
* '''mac-auth-password''' (text) :  used together with MAC authentication, field used to specify password for the users to be authenticated by their MAC addresses. The following option is required, when specific RADIUS server rejects authentication for the clients with blank password
* '''nas-port-time''' (text; default: ''wireless-802.11'') :  NAS-Port-Type value to be sent to RADIUS server, NAS-Port-Type values are described in the RADIUS [http://www.ietf.org/rfc/rfc2865.txt RFC]. This optional value attribute indicates the type of the physical port of the HotSpot server
* '''radius-accounting''' (yes '''/''' no; default: ''yes'') : send RADIUS server accounting information for each user, when ''yes'' is used
* '''radius-default-domain''' (text) :  default domain to use for RADIUS requests. Allows to use separate RADIUS server per ''/ip hotspot profile''
* '''radius-interim-update''' (time '''/''' received) : how often to send accounting updates. When ''received'' is configured, interim-time is used from RADIUS server
* '''radius-location-name ''' (text) : RADIUS-Location-Id to be sent to RADIUS server. To identify location of the HotSpot server during the communication with RADIUS server. Value is optional and used together with RADIUS server
* '''smtp-server''' (IP address; default: ''0.0.0.0'') : SMTP server address to be used to redirect HotSpot users SMTP requests
* '''split-user-domain''' (yes '''/''' no; default: no) : Split username from domain name when the username is given in "user@domain" or in "domain\user" format from RADIUS server
* '''ssl-certificate''' (name '''/''' none; default: none) : name of the SSL certificate on the router to use only for HTTPS authentication
* '''trial-uptime''' (time '''/''' time; default: ''30m '''/''' 1d'') : used only with ''trial'' authentication method. First time specifies, how long trial user identified by MAC address can use access to public networks without HotSpot authentication. Second time specifies amount of time, that has to pass that user is allowed to use trial again
* '''trial-user-profile''' (name; default: ''default'') : specifies ''ip hotspot user profile'' for trial users
* '''use-radius''' (yes '''/''' no; default: no) : whether to use RADIUS server of authorization and accounting. When ''yes'' RADIUS server should be added to ''radius'' menu, firstly local ''ip hotspot user'' database is used, only then information is sent to RADIUS server
 
==ip hotspot user==
HotSpot users is menu, where client user/password information is actually added, additional configuration options for HotSpot users are configured here as well.
 
* '''name''' (name) : user name, HotSpot login page username, when MAC-address authentication is used name is configured as client's MAC-address
* '''address''' (IP address; default: ''0.0.0.0'') : IP address, when specified client will get the address from the HotSpot one-to-one NAT translations. Address does not restrict HotSpot login only from this address
* '''comment''' (text) : comment, additional information for HotSpot user, it might be used for scripts to change parameters for specific clients 
* '''email''' (text) : HotSpot client e-mail, informational value for the HotSpot user
* '''limit-bytes-in''' (integer; default: "0") : maximal amount of bytes can be received from user, user is disconnected from HotSpot after limit is reached
* '''limit-bytes-out''' (integer; default: "0") : maximal amount of bytes can be transmitted from user, user is disconnected from HotSpot after limit is reached
* '''limit-bytes-total''' (integer; default: "0") : (limit-bytes-in+limit-bytes-out), user is disconnected from HotSpot after limit is reached
* '''limit-uptime''' (time; default: "0s") : uptime limit for the HotSpot client, user is disconnected from HotSpot as soon as uptime is reached
* '''mac-address''' (MAC-address; default: "00:00:00:00:00:00") : MAC-address, client is allowed to login only from the MAC-address, when value is not 00:00:00:00:00:00
* '''password''' (text) : user password
* '''profile''' (name; default; "default") : user profile, it is configured in /ip hotspot user profile
* '''routes''' (text) : routes added to HotSpot gateway, when client is connected. The route format "'dst-address gateway metric'" (for example, "192.168.1.0/24 192.168.0.1 1")
* '''server''' ('name '''/''' all; default: all) : HotSpot server name user is allowed to login
 
==ip hotspot user profile==
User profile menu is used for common HotSpot client settings. Profiles are like User groups with the same set of settings, rate-limit, filter chain name, etc.
 
* '''name''' (text) : user profile name for identification
* '''address-pool''' (name '''/''' none; default: ''none'') : IP pool name which the users will be given IP from. When user has improper network settings configuration on the computer, HotSpot server makes translation and assigns correct IP address from the pool instead of incorrect one
* '''advertise''' (yes '''/''' no; default: ''no'') : to enable forced advertisement popups. After certain interval specific web-page is being displayed for HotSpot users. Advertisement page might be blocked by browsers popup blockers
* '''advertise-interval''' (multiple choice: time; default: ''30m,10m'') : set of interval between showing advertisement popup. After the list is done, the last value is used for all further advertisements, 10 minutes
* '''advertise-timeout''' (time '''/''' immediately never; default: ''1m'') :  how long to wait for advertisement to be shown, before blocking network access for HotSpot client. Connection to Internet is not allowed, when advertisement is not shown
* '''advertise-url''' (multiple choice: text; default: ''http://www.mikrotik.com/, http://www.routerboard.com/'') : list of URLs to show for advertisement popups. When the last item reached, next time the first is shown
* '''idle-timeout''' (time '''/''' none; default: ''none'') : maximal period of inactivity for authorized HotSpot clients. Timer is counting, when there is no traffic coming from that client and going through the router, for example computer is switched off. User is logged out, dropped of the host list, the address used by the user is freed, when timeout is reached
* '''incoming-filter''' (name) : name of the firewall chain applied to incoming packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot
* '''incoming-packet-mark''' (name) : packet mark put on incoming packets from every user of this profile
* '''keepalive-timeout''' (''NUMBER/NUMBER'') : keepalive timeout for authorized HotSpot clients. Used to detect, that the computer of the client is alive and reachable. User is logged out, when timeout value is reached
* '''on-login''' (text; default "") : script name to be executed, when user logs in to the HotSpot from the particular profile
* '''on-logout''' (text; default "") : script name to be executed, when user logs out from the HotSpot
* '''open-status-page''' (always '''/''' http-login; default: ''always'') : option to show status page for user authenticated with mac login method. For example to show advertisement on status page (alogin.html)
** http-login - open status page only for HTTP login (includes cookie and HTTPS)
**always - open HTTP status page in case of mac login as well
* '''outgoing-filter''' (') : name of the firewall chain applied to outgoing packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot
* '''outgoing-packet-mark''' (name) : packet mark put on outgoing packets from every user of this profile
* '''rate-limit''' (text; default: "") : dynamic queue simple is created for user, once it logs in to the HotSpot. Rate-limitation is configured in form [rx-rate[/tx-rate] [rx-burst-rate[/tx-burst-rate] [rx-burst-threshold[/tx-burst-threshold] [rx-burst-time[/tx-burst-time] [priority] [rx-rate-min[/tx-rate-min]]]]. For example to set 1M download, 512k upload for the client, rate-limit=512k/1M
* '''session-timeout''' (time; default ''0s'') : allowed session time for client.  After this time, the user is logged out unconditionally
* '''shared-users''' (integer; default: ''1'') - allowed number of simultaneously logged in users with the same HotSpot username
* '''status-auto-refresh''' (time '''/''' none; default: ''none'') - HotSpot status page autorefresh interval
* '''transparent-proxy''' (yes '''/''' no; default: ''yes'') - to use transparent HTTP proxy for the authorized users of this profile


==ip hotspot active==
==ip hotspot active==
Line 120: Line 209:
* '''address''' (read-only; IP address) : IP address of the HotSpot user
* '''address''' (read-only; IP address) : IP address of the HotSpot user
* '''mac-address''' (read-only; MAC-address) : MAC-address of the HotSpot user
* '''mac-address''' (read-only; MAC-address) : MAC-address of the HotSpot user
* '''login-by''' (read-only; multiple choice: cookie '''/''' http-chap '''/''' http-pap '''/''' https '''/''' mac '''/''' mac '''/''' trial) : authentication method used by HotSpot client
* '''login-by''' (read-only; multiple choice: cookie '''/''' http-chap '''/''' http-pap '''/''' https '''/''' mac '''/''' mac-cookie '''/''' trial) : authentication method used by HotSpot client
* '''uptime''' (read-only; time) : current session time of the user, it is showing how long user has been logged in  
* '''uptime''' (read-only; time) : current session time of the user, it is showing how long user has been logged in  
* '''idle-time''' (read-only; time) : the amount of time user has been idle
* '''idle-time''' (read-only; time) : the amount of time user has been idle
Line 147: Line 236:
* '''packet-out''' (read-only; integer) : amount of packets send to unauthorized client
* '''packet-out''' (read-only; integer) : amount of packets send to unauthorized client


==ip hotspot ip-binding==
==IP Bindings==
 
<p id="shbox">
<b>Sub-menu:</b> <code>/ip hotspot ip-binding</code><br />
</p>
<br />
 
IP-Binding HotSpot menu allows to setup static One-to-One NAT translations, allows to bypass specific HotSpot clients without any authentication, and also allows to block specific hosts and subnets from HotSpot network
IP-Binding HotSpot menu allows to setup static One-to-One NAT translations, allows to bypass specific HotSpot clients without any authentication, and also allows to block specific hosts and subnets from HotSpot network


* '''mac-address''' (MAC address; default "") : MAC address of the client
* '''address''' (IP address '''/''' netmask; default "") : the original IP address of the client
* '''to-address''' (IP address; default "") :  new IP address of the client, translation occurs on the router (client does not know anything about the translation)
* '''server''' (name '''/'''' all; default: "all") : name of the HotSpot server
* '''type''' (regular '''/''' bypassed '''/''' blocked) : type of the IP-binding action
** regular - performs One-to-One NAT according to the rule, translates '''address''' to '''to-address'''
** bypassed - performs the translation, but excludes client from login to the HotSpot
** blocked - translation is not performed and packets from host are dropped


==ip hotspot walled-garden==
{{Mr-arg-table-h
HTTP walled-garden, menu allows to set authentication bypass for HTTP and HTTPs resources
|prop=Property
|desc=Description
}}
 
{{Mr-arg-table
|arg=address
|type=IP Range
|default=""
|desc=The original IP address of the client
}}
 
{{Mr-arg-table
|arg=mac-address
|type=MAC
|default=""
|desc=MAC address of the client
}}
 
{{Mr-arg-table
|arg=server
|type=string {{!}} all
|default="all"
|desc=Name of the HotSpot server.
* '''all''' - will be applied to all hotspot servers
}}
 
{{Mr-arg-table
|arg=to-address
|type=IP
|default=""
|desc=New IP address of the client, translation occurs on the router (client does not know anything about the translation)
}}
 
{{Mr-arg-table-end
|arg=type
|type=blocked {{!}} bypassed {{!}} regular
|default=""
|desc=Type of the IP-binding action
* '''regular''' - performs One-to-One NAT according to the rule, translates '''address''' to '''to-address'''
* '''bypassed''' - performs the translation, but excludes client from login to the HotSpot
* '''blocked''' - translation is not performed and packets from host are dropped
}}
 
==Cookies==
 
<p id="shbox">
<b>Sub-menu:</b> <code>/ip hotspot cookie</code><br />
</p>
<br />
 
Menu contains all cookies sent to the HotSpot clients, which are authorized by cookie method, all the entries are read-only.
 
 
{{Mr-arg-table-h
|prop=Property
|desc=Description
}}
 
{{Mr-arg-ro-table
|arg=domain
|type=string
|desc=Domain name (if split from username)
}}
 
{{Mr-arg-ro-table
|arg=expires-in
|type=time
|desc=How long the cookie is valid
}}
 
{{Mr-arg-ro-table
|arg=mac-address
|type=MAC
|desc=Client's MAC-address
}}
 
{{Mr-arg-ro-table-end
|arg=user
|type=string
|desc=HotSpot username
}}
 
== Using DHCP option to advertise HotSpot URL ==
 
Most devices, such as modern smartphones, do some kind of background checking to see if they are behind a captive portal. They do this by requesting a known webpage and comparing the contents of that page, to what they should be. If contents are different, the device assumes there is a login page, and creates a popup with this login page.
 
This does not always happen, as this "known webpage" could be blocked, whitelisted, or not accessible in internal networks. To improve on this mechanism, RFC 7710 was created, allowing the HotSpot to inform all DHCP clients that they are behind a captive-portal device and that they will need to authenticate to get Internet access, regardless of what webpages they do or do not request.


* '''action''' (allow '''/''' deny; default: "allow") : action to perform, when packet matches the rule
This DHCP option field ir enabled automatically, but only if the router has a DNS name configured and has a valid SSL certificate (so that the login page can be accessed over https). When these requirements are met, a special DHCP option will be sent, containing a link to <code>https://<dns-name-of-hotspot>/api</code>. This link contains information in JSON format, instructing the client device of the captive portal status, and the location of the login page.
** allow - allow access to the web-page without authorization
** deny - the authorization is required to access the web-page
* '''server''' (name) : name of the HotSpot server, rule is applied to
* '''src-address''' (IP address) : source address of the user, usually IP address of the HotSpot client
* '''dst-address''' (IP address) : destination IP address, IP address of the WEB-server
* '''method''' (text) : HTTP method of the request
* '''dst-host''' (wildcard; default: "") : domain name of the destination web-server
* '''dst-port''' (integer; default: "") : TCP port number, client sends request to
* '''path''' (text; default: "") : the path of the request, path comes after http://dst_host/


==ip hotspot walled-garden ip==
Contents of <code>https://<dns-name-of-hotspot>/api</code> are as follows:
Walled-garden menu for the IP requests (Winbox, SSH, Telnet, SIP, etc.)


* '''action''' (accept '''/''' drop '''/''' reject; default: accept) : action to perform, when packet matches the rule
{
** accept - allow access to the resource without authorization
    "captive": $(if logged-in == 'yes')false$(else)true$(endif),
** deny - the authorization is required to access the resource
    "user-portal-url": "$(link-login-only)",
** reject - the authorization is required to access the resource, ICMP reject message will be sent to client, when packet will match the rule
$(if session-timeout-secs != 0)
* '''server''' (name) : name of the HotSpot server, rule is applied to
    "seconds-remaining": $(session-timeout-secs),
* '''src-address''' (IP address) : source address of the user, usually IP address of the HotSpot client  
  $(endif)
* '''dst-address''' (IP address) : destination IP address, IP address of the WEB-server
$(if remain-bytes-total)
* '''protocol''' (integer, protocol name) : IP protocol name
    "bytes-remaining": $(remain-bytes-total),
* '''dst-port''' (integer; default: "") : TCP port number, client sends request to
$(endif)
* '''dst-host''' (wildcard; default: "") : domain name of the destination web-server
    "can-extend-session": true
  }


==ip hotspot cookie==
Menu contains all cookies sent to the HotSpot clients, who are authorized by cookie method, all the values are read-only.


* '''domain''' (read-only; text) : domain name (if split from username)
{{cont}}
* '''expires-in''' (read-only; time) : how long the cookie is valid
* '''mac-address''' (read-only; MAC address) : client's MAC-address
* '''user''' (read-only-name) : HotSpot username


[[Category:Manual|Hotspot]]
[[Category:Manual|Hotspot]]
[[Category:Hotspot|H]]
[[Category:AAA|Hotspot]]
[[Category:AAA|Hotspot]]

Latest revision as of 10:16, 22 February 2021

HotSpot

The MikroTik HotSpot Gateway provides authentication for clients before access to public networks .

HotSpot Gateway features:

  • different authentication methods of clients using local client database on the router, or remote RADIUS server;
  • users accounting in local database on the router, or on remote RADIUS server;
  • walled-garden system, access to some web pages without authorization;
  • login page modification, where you can put information about the company;
  • automatic and transparent change any IP address of a client to a valid address;
  • starting from v6.48 HotSpot can inform DHCP clients that they are behind a captive portal (RFC7710);

Hotspot can work reliably only when IPv4 is used. Hotspot relies on Firewall NAT rules which currently are not supported for IPv6.

Sub Categories

List of reference sub-pages

Case studies

List of examples

HotSpot Setup

The simplest way to setup HotSpot server on a router is by /ip hotspot setup command. Router will ask to enter parameters required to successfully set up HotSpot. When finished, default configuration will be added for HotSpot server. 

[admin@MikroTik] /ip hotspot> setup 
Select interface to run HotSpot on 

hotspot interface: ether3
Set HotSpot address for interface 

local address of network: 10.5.50.1/24
masquerade network: yes
Set pool for HotSpot addresses 

address pool of network: 10.5.50.2-10.5.50.254
Select hotspot SSL certificate 

select certificate: none
Select SMTP server 

ip address of smtp server: 0.0.0.0
Setup DNS configuration 

dns servers: 10.1.101.1
DNS name of local hotspot server 

dns name: myhotspot
Create local hotspot user 

name of local hotspot user: admin
password for the user: 
[admin@MikroTik] /ip hotspot>

What was created: 

[admin@MikroTik] /ip hotspot> print 
Flags: X - disabled, I - invalid, S - HTTPS 
 #   NAME        INTERFACE       ADDRESS-POOL       PROFILE       IDLE-TIMEOUT
 0   hotspot1    ether3          hs-pool-3          hsprof1       5m 
[admin@MikroTik] /ip hotspot> 
[admin@MikroTik] /ip pool> print 
 # NAME                                        RANGES                         
 0 hs-pool-3                                   10.5.50.2-10.5.50.254          
[admin@MikroTik] /ip pool> /ip dhcp-server 
[admin@MikroTik] /ip dhcp-server> print 
Flags: X - disabled, I - invalid 
 #   NAME      INTERFACE    RELAY           ADDRESS-POOL    LEASE-TIME ADD-ARP
 0   dhcp1     ether3                       hs-pool-3       1h        
[admin@MikroTik] /ip dhcp-server> /ip firewall nat 
[admin@MikroTik] /ip firewall nat> print 
Flags: X - disabled, I - invalid, D - dynamic 
 0 X ;;; place hotspot rules here
     chain=unused-hs-chain action=passthrough 

 1   ;;; masquerade hotspot network
     chain=srcnat action=masquerade src-address=10.5.50.0/24 
[admin@MikroTik] /ip firewall nat>

Parameters asked during setup process

Parameter Description
hotspot interface (string; Default: allow) Interface name on which to run HotSpot. To run HotSpot on a bridge interface, make sure public interfaces are not included to the bridge ports.
local address of network (IP; Default: 10.5.50.1/24) HotSpot gateway address
masquerade network (yes | no; Default: yes) Whether to masquerade HotSpot network, when yes rule is added to /ip firewall nat with action=masquerade
address pool of network (string; Default: yes) Address pool for HotSpot network, which is used to change user IP address to a valid address. Useful if providing network access to mobile clients that are not willing to change their networking settings.
select certificate (none | import-other-certificate; Default: ) Choose SSL certificate, when HTTPS authorization method is required.
ip address of smtp server (IP; Default: 0.0.0.0) IP address of the SMTP server, where to redirect HotSpot's network SMTP requests (25 TCP port)
dns servers (IP; Default: 0.0.0.0) DNS server addresses used for HotSpot clients, configuration taken from /ip dns menu of the HotSpot gateway
dns name (string; Default: "") domain name of the HotSpot server, full quality domain name is required, for example www.example.com
name of local hotspot user (string; Default: "admin") username of one automatically created HotSpot user, added to /ip hotspot user
password for the user' (string; Default: ) Password for automatically created HotSpot user

ip hotspot

Menu is designed to manage HotSpot servers of the router. It is possible to run HotSpot on Ethernet, wireless, VLAN and bridge interfaces. One HotSpot server is allowed per interface. When HotSpot is configured on bridge interface, set HotSpot interface as bridge interface not as bridge port, do not add public interfaces to bridge ports. You can add HotSpot servers manually to /ip hotspot menu, but it is advised to run /ip hotspot setup, that adds all necessary settings.

  • name (text) : HotSpot server's name or identifier
  • address-pool (name / none; default: none) : address space used to change HotSpot client any IP address to a valid address. Useful for providing public network access to mobile clients that are not willing to change their networking settings
  • idle-timeout (time / none; default: 5m) : period of inactivity for unauthorized clients. When there is no traffic from this client (literally client computer should be switched off), once the timeout is reached, user is dropped from the HotSpot host list, its used address becomes available
  • keepalive-timeout (time / none; default: none) : Value of how long host can stay out of reach to be removed from the HotSpot.
  • login-timeout (time / none; default: none) : period of time after which if host hasn't been authorized it self with system the host entry gets deleted from host table. Loop repeats until host logs in the system. Enable if there are situations where host cannot login after being to long in host table unauthorized.
  • interface (name of interface) : interface to run HotSpot on
  • addresses-per-mac (integer / unlimited; default: 2) : number of IP addresses allowed to be bind with the MAC address, when multiple HotSpot clients connected with one MAC-address
  • profile (name; default: default) - HotSpot server default HotSpot profile, which is located in /ip hotspot profile

keepalive-timeout (read-only; time) : the exact value of the keepalive-timeout, that is applied for user. Value shows how long host can stay out of reach to be removed from the HotSpot

ip hotspot active

HotSpot active menu shows all clients authenticated in HotSpot, menu is informational it is not possible to change anything here.

  • server (read-only; name) : HotSpot server name client is logged in
  • user (read-only; name) : name of the HotSpot user
  • domain (read-only; text) : domain of the user (if split from username), parameter is used only with RADIUS authentication
  • address (read-only; IP address) : IP address of the HotSpot user
  • mac-address (read-only; MAC-address) : MAC-address of the HotSpot user
  • login-by (read-only; multiple choice: cookie / http-chap / http-pap / https / mac / mac-cookie / trial) : authentication method used by HotSpot client
  • uptime (read-only; time) : current session time of the user, it is showing how long user has been logged in
  • idle-time (read-only; time) : the amount of time user has been idle
  • session-time-left (read-only; time) : the exact value of session-time, that is applied for user. Value shows how long user is allowed to be online to be logged of automatically by uptime reached
  • idle-timeout (read-only; time) : the exact value of the user's idle-timeout
  • keepalive-timeout (read-only; time) : the exact value of the keepalive-timeout, that is applied for user. Value shows how long host can stay out of reach to be removed from the HotSpot
  • limit-bytes-in (read-only; integer) : value shows how many bytes received from the client, option is active when the appropriate parameter is configured for HotSpot user
  • limit-bytes-out (read-only; integer) : value shows how many bytes send to the client, option is active when the appropriate parameter is configured for HotSpot user
  • limit-bytes-total (read-only; integer) : value shows how many bytes total were send/received from client, option is active when the appropriate parameter is configured for HotSpot user

ip hotspot host

Host table lists all computers connected to the HotSpot server. Host table is informational and it is not possible to change any value there

  • mac-address (read-only; MAC-address) : HotSpot user MAC-address
  • address (read-only; IP address) : HotSpot client original IP address
  • to-address (read-only; IP address) : New client address assigned by HotSpot, it might be the same as original address
  • server (read-only; name) : HotSpot server name client is connected to
  • bridge-port (read-only; name) : /interface bridge port client connected to, value is unknown when HotSpot is not configured on the bridge
  • uptime (read-only; time) : value shows how long user is online (connected to the HotSpot)
  • idle-time (read-only; time) : time user has been idle
  • idle-timeout (read-only; time) : value of the client idle-timeout (unauthorized client)
  • keeaplive-timeout (read-only; time) : keepalive-timeout value of the unauthorized client
  • bytes-in (read-only; integer) : amount of bytes received from unauthorized client
  • packet-in (read-only; integer) : amount of packets received from unauthorized client
  • bytes-out (read-only; integer) : amount of bytes send to unauthorized client
  • packet-out (read-only; integer) : amount of packets send to unauthorized client

IP Bindings

Sub-menu: /ip hotspot ip-binding


IP-Binding HotSpot menu allows to setup static One-to-One NAT translations, allows to bypass specific HotSpot clients without any authentication, and also allows to block specific hosts and subnets from HotSpot network


Property Description
address (IP Range; Default: "") The original IP address of the client
mac-address (MAC; Default: "") MAC address of the client
server (string | all; Default: "all") Name of the HotSpot server.
  • all - will be applied to all hotspot servers
to-address (IP; Default: "") New IP address of the client, translation occurs on the router (client does not know anything about the translation)
type (blocked | bypassed | regular; Default: "") Type of the IP-binding action
  • regular - performs One-to-One NAT according to the rule, translates address to to-address
  • bypassed - performs the translation, but excludes client from login to the HotSpot
  • blocked - translation is not performed and packets from host are dropped

Cookies

Sub-menu: /ip hotspot cookie


Menu contains all cookies sent to the HotSpot clients, which are authorized by cookie method, all the entries are read-only.


Property Description
domain (string) Domain name (if split from username)
expires-in (time) How long the cookie is valid
mac-address (MAC) Client's MAC-address
user (string) HotSpot username

Using DHCP option to advertise HotSpot URL

Most devices, such as modern smartphones, do some kind of background checking to see if they are behind a captive portal. They do this by requesting a known webpage and comparing the contents of that page, to what they should be. If contents are different, the device assumes there is a login page, and creates a popup with this login page.

This does not always happen, as this "known webpage" could be blocked, whitelisted, or not accessible in internal networks. To improve on this mechanism, RFC 7710 was created, allowing the HotSpot to inform all DHCP clients that they are behind a captive-portal device and that they will need to authenticate to get Internet access, regardless of what webpages they do or do not request.

This DHCP option field ir enabled automatically, but only if the router has a DNS name configured and has a valid SSL certificate (so that the login page can be accessed over https). When these requirements are met, a special DHCP option will be sent, containing a link to https://<dns-name-of-hotspot>/api. This link contains information in JSON format, instructing the client device of the captive portal status, and the location of the login page.

Contents of https://<dns-name-of-hotspot>/api are as follows: 

{
   "captive": $(if logged-in == 'yes')false$(else)true$(endif),
   "user-portal-url": "$(link-login-only)",
$(if session-timeout-secs != 0)
   "seconds-remaining": $(session-timeout-secs),
$(endif)
$(if remain-bytes-total)
   "bytes-remaining": $(remain-bytes-total),
$(endif)
   "can-extend-session": true
 }


[ Top | Back to Content ]

Retrieved from "https://wiki.mikrotik.com/index.php?title=Manual:IP/Hotspot&oldid=34335"