Captive Portal Attributes Overview

The UE-IP and UE-MAC address parameters are decrypted at the beginning of each user online control request. This is because the Captive Portal (CP) encrypts the IP and MAC address parameters in each redirection to the subscriber portal.

The controller decrypts the UE-IP and UE-MAC address before returning the response, by using the Encrypt and Decrypt API.

Note: Apple CNA only works for HTTP redirect. It does not work if the external portal is in HTTPS.

Apple CNA does not support IPv6 addresses.

Redirection Attributes

The table lists these parameters provided by controller's captive portal redirection.

Note: See WISPr Support for ZoneDirector Login for login and logout details.

Redirection attributes

Attributes Description
apip AP IP address which can be used as WISPr backup login
client_mac Encrypted UE Mac address.
Note: The format of the MAC Address is defined at the Hotspot (WISPr) Portal configuration.
dn The domain name.
lid AP application identifier. For example: isocc=us, cc=1,ac=408,network=ACMEWISP_Newark_Airport
loc AP location name. For example: ACMEWISP,Gate_14_Terminal_C_of_Newark_Airport
mac AP Mac address.
nbiIP The IPv4 of controller's Northbound Interface.
nbiIPv6 The IPv6 of controller's Northbound Interface.
proxy The UE browser if it is set to the Web proxy.
reason Reason for redirecting the WLAN. The value could either be:
  • Un-Auth-Captive – Regular unauthenticated UE redirected to Login Portal
or
  • Un-Auth-SSL-Captive – In case of HTTPS, Captive Portal is performing a “double redirect”. Adding this value to identify this flow
sip The value could either be the:
  • FQDN of the uploaded controller Web UI certificate if the uploaded certificate’s common name is FQDN.
  • Concatenation of the controller cluster name with the common name value after the wild card, if the uploaded certificate’s common name is not FQDN (meaning if it includes wild card). For example, if the common name is “*.ruckuswireless.com” and the cluster name is “Cluster_Node1”, then the sip will be “cluster_node1.ruckuswireless.com.”
  • “scg.ruckuswireless.com”, which is the FQDN of the self-signed certificate which controller is packaged with, if the certificate was not uploaded at all.
ssid The broadcasted SSID name.
startUrl The URL as per the hotspot configuration, which is to be redirected after successful login.
sshTunnelStatus SSH tunnel status between AP and SZ. If sshTunnelStatus is 0, it means AP cannot reach SZ. If sshTunnelStatus is 1, then AP/SZ SSH tunnel is fine. The portal can check this value and decide whether to use AP IP or SZ IP to login.
uip Encrypted UE IP address.
url Original URL which the customer tries browsing.
vlan VLAN which the customer is set to.
wlan WLAN ID of the UE's associated the WLAN.
wlanName SSIDs configured WLAN Name.
zoneId In case of 3rd party AP, this attribute will be included instead of WLAN and will include the zone ID where the SSID is configured to in the controller.
zoneName AP zone name of the UE's associated to the WLAN. The zone name is configured using the WLANs. The zone name is used for Kumo. The value is encrypted based on a special key.
Parent topic: Captive Portal Attributes