Web Page Setup

This section gives details about URL parameters, UAM login URLs, and user login pages.

URL Parameters

Following are the URL parameters provided to set up a web page.

URL Parameter Description
sip Domain name of the Smart Zone
apip IP address of the Ruckus AP
mac AP MAC address
uip Encrypted client's IP address
client_mac Encrypted client's MAC address
sshTunnelStatus SSH tunnel status between AP and SZ. If sshTunnelStatus is 0, it means AP cannot reach SZ.
url Original URL which the customer tries browsing.
startUrl The URL as per the hotspot configuration, which is to be redirected after successful login.

For details about the attributes, refer to Captive Portal Attributes Overview.

UAM login URLs

SmartZone provides the following URLs for user login:

If the authentication is successful, SmartZone redirects the user to the start page else the user is redirected to the login page.

When the Ruckus AP's SSH tunnel is up, it can use the following URLs provided by Ruckus AP for user login:

User Login page

A hotspot user uses the login page to log in to the hotspot service. The login page is provided by the hotspot service provider and is hosted on an HTTP server. A typical login page contains a form to enter the username and password. The hotspot user submits the form data to the UAM Login URL for authentication.

For example, the figure shows the HTML page with JavaScript code to generate the Smart Zone login form or Ruckus AP login form by the sshTunnelStatus.

Generating Login Form - SmartZone/Ruckus AP Login

Source Code

<html>
<head><title>Wireless Internet Service</title>
<script type="text/javascript">
function get_param(name) {
    if (location.href.indexOf("?") >= 0)      { 
        var query=location.href.split("?")[1];
        var params=query.split("&");
        for (var i = 0; i < params.length; i ++) {
            value_pair=params[i].split("=");
            if (value_pair[0] == name)
                return unescape(value_pair[1]);
        }
    }
    return "";
}
</script></head>
<body>
<center>
<h2>Wireless Internet Service</h2>
<script>
if (get_param("sshTunnelStatus") == "1") {
    document.write('<p>SZ ZD-Style</p>');
    document.write('<form method=POST action="https://'+get_param("sip") + ':9998/SubscriberPortal/hotspotlogin">');
} else {
    document.write('<p>AP ZD-Style</p>');
    document.write('<form method=POST action="https://'+get_param("apip") + ':9998/SubscriberPortal/hotspotlogin">');
}
document.write('<input type="hidden" name="url" value="'+get_param("url")+'" />');
document.write('<input type="hidden" name="proxy" value="'+get_param("proxy")+'" />');
document.write('<input type="hidden" name="uip" value="'+get_param("uip")+'" />');
document.write('<input type="hidden" name="client_mac" value="'+get_param("client_mac")+'" />');
</script>
Username:<input type="text" name="username">
Password:<input type="password" name="password" >
<input type="submit" value="Login">
</form>
</center>
</body>
</html>