|Internet-Draft||DRIP Registry HTTP Interface||September 2022|
|Wiethuechter, et al.||Expires 31 March 2023||[Page]|
- drip Working Group
- Intended Status:
- Standards Track
DRIP Registry HTTP Interface
This document defines an HTTP based interface using either JSON or CBOR for object encodings for the DRIP Registry from a DRIP Provisioning Agent (DPA) to support DRIP Entity Tag (DET) and its additional information registration into a DRIP Identity Management Entity (DIME). The Registry is a logically required component of a DIME that handles the various DNS functions for DRIP registration and lookup using DETs.¶
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 31 March 2023.¶
Copyright (c) 2022 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 Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
The Registry is one of the required components in a DIME for it to fulfill the role of registration of DRIP Entity Tags (DETs) of clients. A standardized interface is needed for this to avoid interoperability issues between vendors supporting DRIP and the various logical components of the DIME.¶
Per [drip-detim] the Registry MUST:¶
- provided an interface for interactions with the DPA. This interface MAY be over HTTPS using JSON/CBOR encoding ...¶
This document is the definition of this interface and its behavior; specifically between the Registry and a DPA. A snapshot of the OpenAPI specification is in Appendix A at the time of this documents publishing; with a URI to access an updated specification.¶
2.1. Required Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
3. Endpoint Definitions & Behavior
All endpoints that send DRIP Endorsements use the JSON/CBOR forms as specified in [drip-detim].¶
If there is any failure during validation in any endpoint a HTTP 400 code MUST be sent to the client with a detailed reason for the error.¶
3.1. Serial Number
3.4. Session ID
3.5. Child DIME
4. Normative References
- Wiethuechter, A., Card, S. W., Moskowitz, R., and J. Reid, "DRIP Entity Tag (DET) Identity Management Architecture", Work in Progress, Internet-Draft, draft-wiethuechter-drip-detim-arch-00, , <https://www.ietf.org/archive/id/draft-wiethuechter-drip-detim-arch-00.txt>.
- Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, , <https://www.rfc-editor.org/info/rfc2119>.
- Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, , <https://www.rfc-editor.org/info/rfc8174>.
- Card, S., Ed., Wiethuechter, A., Moskowitz, R., and A. Gurtov, "Drone Remote Identification Protocol (DRIP) Requirements and Terminology", RFC 9153, DOI 10.17487/RFC9153, , <https://www.rfc-editor.org/info/rfc9153>.