Multiformats
draft-snell-multihash-00

Document Type Active Internet-Draft (individual)
Last updated 2020-02-24
Stream (None)
Intended RFC status (None)
Formats plain text xml pdf htmlized bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Individual Submission                                      J. Snell, Ed.
Internet-Draft                                         NearForm Research
Intended status: Standards Track                                N. Greco
Expires: August 27, 2020                                        J. Benet
                                                            D. Dalrymple
                                                                 D. Dias
                                                               L. Gierth
                                                           Protocol Labs
                                                       February 24, 2020

                              Multiformats
                        draft-snell-multihash-00

Abstract

   Defines Multiformats, a collection of data formats that aim to
   future-proof systems by adding self-description to format values; and
   defines the Multihash and Multibase Multiformat data formats.

Status of This Memo

   This Internet-Draft is submitted to IETF 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 August 27, 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.

Snell, et al.            Expires August 27, 2020                [Page 1]
Internet-Draft                Multiformats                 February 2020

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Unsigned Variable Length Integer  . . . . . . . . . . . . . .   3
     2.1.  ABNF Definition . . . . . . . . . . . . . . . . . . . . .   4
   3.  Multibase . . . . . . . . . . . . . . . . . . . . . . . . . .   4
     3.1.  Examples  . . . . . . . . . . . . . . . . . . . . . . . .   4
     3.2.  Multibase ABNF  . . . . . . . . . . . . . . . . . . . . .   4
   4.  Multihash . . . . . . . . . . . . . . . . . . . . . . . . . .   5
     4.1.  Example Multihashes . . . . . . . . . . . . . . . . . . .   5
     4.2.  Multihash ABNF  . . . . . . . . . . . . . . . . . . . . .   5
   5.  Security Considerations . . . . . . . . . . . . . . . . . . .   5
   6.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   6
     6.1.  The Codec Registry  . . . . . . . . . . . . . . . . . . .   6
       6.1.1.  Codec Registration  . . . . . . . . . . . . . . . . .   6
       6.1.2.  Initial Contents  . . . . . . . . . . . . . . . . . .   7
     6.2.  The Multibase Registry  . . . . . . . . . . . . . . . . .  15
       6.2.1.  Base-Encoding Registration  . . . . . . . . . . . . .  15
       6.2.2.  Initial Contents  . . . . . . . . . . . . . . . . . .  16
   7.  Normative References  . . . . . . . . . . . . . . . . . . . .  17
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  18

1.  Introduction

   Multiformats are a collection of data formats that aim to future-
   proof systems by adding self-description to format values; allowing
   interoperability and protocol agility while avoiding lock in.

   The self-describing aspects of the Multiformat values have a few
   stipulations:

   o  They MUST be in-band (encoded within and carried with the value).

   o  They MUST avoid lock-in and promote extensibility.

   o  They MUST be compact and have a binary-packed representation.

   o  They MUST have a human-readable representation.

   This specification defines the Multihash and Multibase formats.

   This specification also defines extensible registries for codec and
   base-encoding identifiers.

   New Multiformat data formats SHOULD be registered within the Codec
   Registry using the "multiformat" type identifier.

Snell, et al.            Expires August 27, 2020                [Page 2]
Internet-Draft                Multiformats                 February 2020

   In this document, the key words "MUST", "MUST NOT", "REQUIRED",
   "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
   and "OPTIONAL" are to be interpreted as described in [RFC2119].

   This specification uses the Augmented Backus-Naur Form (ABNF)
Show full document text