Internet Assigned Numbers Authority
  • Domains
  • Protocols
  • Numbers
  • About

                                                                   Captive Portals

Created
        2020-07-07

Last Updated
        2024-08-28

Available Formats
        [IMG]
        XML [IMG]
        HTML [IMG]
        TXT

Registry Included Below

  • Captive Portal API Keys

Captive Portal API Keys

Registration Procedure(s)

             Specification Required


Expert(s)

             Tommy Pauly, Darshak Thakore, Martin Thomson


Reference
        [RFC 8908]

Available Formats
        [IMG]
        CSV

           Key             Type                               Description                                                 Reference
                                  Indicates whether the client is in a state of captivity, i.e it has
                                  not satisfied the conditions to access the external network. If the
captive                   boolean client is captive (i.e. captive=true), it will still be allowed      [RFC 8908]
                                  enough access for it to perform server authentication [RFC 8908,
                                  Section 4.1].
user-portal-url           string  Provides the URL of a web portal that MUST be accessed over TLS with [RFC 8908]
                                  which a user can interact.
                                  Provides the URL of a webpage or site that SHOULD be accessed over
venue-info-url            string  TLS on which the operator of the network has information that it     [RFC 8908]
                                  wishes to share with the user (e.g., store info, maps, flight
                                  status, or entertainment).
                                  Indicates that the URL specified as "user-portal-url" allows the
                                  user to extend a session once the client is no longer in a state of
can-extend-session        boolean captivity. This provides a hint that a client system can suggest     [RFC 8908]
                                  accessing the portal URL to the user when the session is near its
                                  limit in terms of time or bytes.
                                  An integer that indicates the number of seconds remaining, after
                                  which the client will be placed into a captive state. The API server
seconds-remaining         number  SHOULD include this value if the client is not captive (i.e.         [RFC 8908]
                                  captive=false) and the client session is time-limited, and SHOULD
                                  omit this value for captive clients (i.e. captive=true) or when the
                                  session is not time-limited.
                                  An integer that indicates the number of bytes remaining, after which
                                  the client will be in placed into a captive state. The byte count
                                  represents the sum of the total number of IP packet (layer 3) bytes
                                  sent and received by the client, including IP headers. Captive
bytes-remaining           number  portal systems might not count traffic to whitelisted servers, such  [RFC 8908]
                                  as the API server, but clients cannot rely on such behavior. The API
                                  server SHOULD include this value if the client is not captive (i.e.
                                  captive=false) and the client session is byte-limited, and SHOULD
                                  omit this value for captive clients (i.e. captive=true) or when the
                                  session is not byte-limited.
                                  Provides the URL of the authentication server that MUST be accessed
                                  over TLS with which the client is authenticated without user
                                  interaction. Authentication Server authenticates clients using the
client-authentication-url string  HTTP authentication framework specified in [RFC 9110]. The server    [draft-sawant-capport-api-state-enhancement-02]
                                  MUST NOT require user interaction on the client device. The client
                                  MUST have a credential to perform the authentication without user
                                  interaction.

Licensing Terms