Captive Portal API
draft-ietf-capport-api-07
The information below is for an old version of the document | |||
---|---|---|---|
Document | Type | Active Internet-Draft (capport WG) | |
Authors | Tommy Pauly , Darshak Thakore | ||
Last updated | 2020-06-11 (latest revision 2020-04-27) | ||
Stream | IETF | ||
Intended RFC status | Proposed Standard | ||
Formats | pdf htmlized (tools) htmlized bibtex | ||
Reviews | |||
Stream | WG state | Submitted to IESG for Publication | |
Document shepherd | Martin Thomson | ||
Shepherd write-up | Show (last changed 2020-04-20) | ||
IESG | IESG state | IESG Evaluation::Revised I-D Needed | |
Consensus Boilerplate | Yes | ||
Telechat date |
Has enough positions to pass. |
||
Responsible AD | Barry Leiba | ||
Send notices to | Martin Thomson <mt@lowentropy.net> | ||
IANA | IANA review state | IANA OK - Actions Needed |
Captive Portal Interaction T. Pauly, Ed. Internet-Draft Apple Inc. Intended status: Standards Track D. Thakore, Ed. Expires: 29 October 2020 CableLabs 27 April 2020 Captive Portal API draft-ietf-capport-api-07 Abstract This document describes an HTTP API that allows clients to interact with a Captive Portal system. With this API, clients can discover how to get out of captivity and fetch state about their Captive Portal sessions. Status of This Memo This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at https://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." This Internet-Draft will expire on 29 October 2020. Copyright Notice Copyright (c) 2020 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/ license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Pauly & Thakore Expires 29 October 2020 [Page 1] Internet-Draft Captive Portal API April 2020 Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 2 3. Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . 3 4. API Connection Details . . . . . . . . . . . . . . . . . . . 3 4.1. Server Authentication . . . . . . . . . . . . . . . . . . 4 5. API State Structure . . . . . . . . . . . . . . . . . . . . . 5 6. Example Interaction . . . . . . . . . . . . . . . . . . . . . 6 7. Security Considerations . . . . . . . . . . . . . . . . . . . 7 7.1. Privacy Considerations . . . . . . . . . . . . . . . . . 8 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8 8.1. Captive Portal API JSON Media Type Registration . . . . . 8 8.2. Captive Portal API Keys Registry . . . . . . . . . . . . 9 9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 10 10. References . . . . . . . . . . . . . . . . . . . . . . . . . 10 10.1. Normative References . . . . . . . . . . . . . . . . . . 10 10.2. Informative References . . . . . . . . . . . . . . . . . 11 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 11 1. Introduction This document describes a HyperText Transfer Protocol (HTTP) Application Program Interface (API) that allows clients to interact with a Captive Portal system. The API defined in this document has been designed to meet the requirements in the Captive Portal Architecture [I-D.ietf-capport-architecture]. Specifically, the API provides: * The state of captivity (whether or not the client has access to the Internet) * A URI that a client browser can present to a user to get out of captivity * An encrypted connection (using TLS for connections to both the API and user portal) 2. Terminology This document leverages the terminology and components described in [I-D.ietf-capport-architecture] and additionally defines the following terms: * Captive Portal Client: The client that interacts with the Captive Portal API is typically some application running on the User Equipment that is connected to the Captive Network. This is also referred to as the "client" in this document. Pauly & Thakore Expires 29 October 2020 [Page 2] Internet-Draft Captive Portal API April 2020 * Captive Portal API Server: The server exposing the APIs defined in this document to the client. This is also referred to as the "API server" in this document. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",Show full document text