Skip to main content

The IETF Profile URI Registry
draft-lanthaler-profile-registry-01

The information below is for an old version of the document.
Document Type
This is an older version of an Internet-Draft that was ultimately published as RFC 7284.
Author Markus Lanthaler
Last updated 2013-04-17
RFC stream (None)
Formats
IETF conflict review conflict-review-lanthaler-profile-registry, conflict-review-lanthaler-profile-registry, conflict-review-lanthaler-profile-registry, conflict-review-lanthaler-profile-registry, conflict-review-lanthaler-profile-registry, conflict-review-lanthaler-profile-registry, conflict-review-lanthaler-profile-registry
Additional resources
Stream Stream state (No stream defined)
Consensus boilerplate Unknown
RFC Editor Note (None)
IESG IESG state Became RFC 7284 (Informational)
Telechat date (None)
Responsible AD (None)
Send notices to (None)
draft-lanthaler-profile-registry-01
Network Working Group                                       M. Lanthaler
Internet-Draft                                            April 17, 2013
Intended status: Informational
Expires: October 19, 2013

                     The IETF Profile URI Registry
                  draft-lanthaler-profile-registry-01

Abstract

   This document defines a registry for profile URIs and establishes an
   IETF URN Sub-namespace to be used in specifications standardizing
   profiles.

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 http://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 October 19, 2013.

Copyright Notice

   Copyright (c) 2013 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
   (http://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.

Lanthaler               Expires October 19, 2013                [Page 1]
Internet-Draft              Profile registry                  April 2013

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . . . 3
   2.  Registration Process  . . . . . . . . . . . . . . . . . . . . . 3
   3.  Example Registration Request  . . . . . . . . . . . . . . . . . 3
   4.  IANA Considerations . . . . . . . . . . . . . . . . . . . . . . 4
     4.1.  Profile URI Registry  . . . . . . . . . . . . . . . . . . . 4
     4.2.  Initial Registry Contents . . . . . . . . . . . . . . . . . 5
     4.3.  IETF URN Sub-Namespace Registration
           urn:ietf:params:profile . . . . . . . . . . . . . . . . . . 5
   5.  Security Considerations . . . . . . . . . . . . . . . . . . . . 5
   6.  Change Log  . . . . . . . . . . . . . . . . . . . . . . . . . . 5
     6.1.  From -00 to -01 . . . . . . . . . . . . . . . . . . . . . . 5
   7.  Acknowledgements  . . . . . . . . . . . . . . . . . . . . . . . 6
   8.  Normative References  . . . . . . . . . . . . . . . . . . . . . 6
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . . 6

Lanthaler               Expires October 19, 2013                [Page 2]
Internet-Draft              Profile registry                  April 2013

1.  Introduction

   Profiles, as defined by [RFC6906], can be used to signal support for
   additional semantics, such as constraints, conventions, extensions,
   or any other aspects that do not alter the basic media type
   semantics.  Profiles are identified by a URI and can thus be created
   without central coordination.

   Similarly to media types and link relation types it is, in some
   cases, beneficial to centrally manage profile URIs to ensure
   interoperability and decrease the coupling between clients and
   servers.  This allows the independent evolution of clients and
   servers as both are coupled to these central contracts instead of
   being coupled to each other.  Therefore, this document establishes an
   IANA registry of such profile URIs.  Furthermore, this document
   creates and registers an IETF URN Sub-namespace, as documented in
   [RFC3553], to be used for specifications standardizing profiles.  The
   new "profile" Sub-namespace is urn:ietf:params:profile and concrete
   profiles will be established underneath it.

2.  Registration Process

   All elements in this registry will require a URI in order to be
   registered.  If the registrant wishes to have a URI assigned, then a
   URN of the form

      urn:ietf:params:profile:<value>

   will be assigned where <value> is a suitable representation of the
   semantics being registered.

   The registration request for the urn:ietf:params:profile URN Sub-
   namespace can be found in Section 4.3.

3.  Example Registration Request

   The following is an example registration request for the profile URI
   http://example.com/profiles/example.

   This is a request to IANA to please register the profile URI
   "http://example.com/profiles/example" in the Profile URI Registry
   according [this document].

Lanthaler               Expires October 19, 2013                [Page 3]
Internet-Draft              Profile registry                  April 2013

   o  Profile URI: http://example.com/profiles/example

   o  Common Name: Exemplary Profile URI

   o  Description: An exemplary profile URI registration.

   o  Specification Document: [this document]

4.  IANA Considerations

   This document makes two requests two IANA:

   o  Establishment of a new registry for profile URIs.  Instructions
      for a registrant to request the registration of such a URI are in
      Section 2.  The registration request can be found in Section 4.1
      below.

   o  Registration of a new IANA URN sub-namespace,
      urn:ietf:params:profile, per [RFC3553].  The registration request
      can be found in Section 4.3 below.

4.1.  Profile URI Registry

   This document establishes the Profile URI registry.  The registration
   procedure for new entries requires a request in the form of the
   following template and is "Specification Required" per [RFC5226].

   The underlying registry data (e.g., the XML file) must include
   Simplified BSD License text as described in Section 4.e of the Trust
   Legal Provisions (<http://trustee.ietf.org/license-info>).

   The registration template is:

   o  Profile URI: The URI that identifies the registered profile.

   o  Common Name: The name by which the profile being registered is
      generally known.

   o  Description: A short description of the profile

   o  Specification Document: Reference to the document that specifies
      the URI, preferably including a URI that can be used to retrieve a
      copy of the document.  An indication of the relevant sections may
      also be included but is not required.

   o  Notes: [optional]

Lanthaler               Expires October 19, 2013                [Page 4]
Internet-Draft              Profile registry                  April 2013

4.2.  Initial Registry Contents

   The Profile URI registry's initial contents are:

   o  Profile URI: urn:ietf:params:profile:example
   o  Common Name: Exemplary Profile
   o  Description: A profile to be used in examples.
   o  Specification Document: [this document]

4.3.  IETF URN Sub-Namespace Registration urn:ietf:params:profile

   Per [RFC3553], this document IANA registers the new URN Sub-
   namespace, urn:ietf:params:profile.

   o  Registry name: profile

   o  Specification: [this document]

   o  Repository: The registry established in Section 4.1

   o  Index value: values subordinate to urn:ietf:params:profile are of
      the form urn:ietf:params:profile:<value> with <value> as the index
      value.  When practical, it is suggested that <value> includes both
      a "class" and an "identifier-within-class" component, with the two
      components being separated by a colon (":"); other compositions of
      the <value> may also be used.

5.  Security Considerations

   There are no additional security considerations beyond those already
   inherent to using URNs.  Security considerations for URNs in general
   can be found in [RFC2141].

6.  Change Log

   Note to RFC Editor: Please remove this section before publication.

6.1.  From -00 to -01

   o  Use HTTP URI instead of URN in example registration request to
      make it clearer that not only URNs can be registered.

   o  Move security considerations to the end.

Lanthaler               Expires October 19, 2013                [Page 5]
Internet-Draft              Profile registry                  April 2013

7.  Acknowledgements

   Thanks to Dave Cridland for valuable comments and suggestions.

8.  Normative References

   [RFC2141]  Moats, R., "URN Syntax", RFC 2141, May 1997.

   [RFC3553]  Mealling, M., Masinter, L., Hardie, T., and G. Klyne, "An
              IETF URN Sub-namespace for Registered Protocol
              Parameters", BCP 73, RFC 3553, June 2003.

   [RFC5226]  Narten, T. and H. Alvestrand, "Guidelines for Writing an
              IANA Considerations Section in RFCs", BCP 26, RFC 5226,
              May 2008.

   [RFC6906]  Wilde, E., "The 'profile' Link Relation Type", RFC 6906,
              March 2013.

Author's Address

   Markus Lanthaler

   Email: mail@markus-lanthaler.com
   URI:   http://www.markus-lanthaler.com/

Lanthaler               Expires October 19, 2013                [Page 6]