"keyids" Initialization Data Format

W3C Editor's Draft

This version:
https://w3c.github.io/encrypted-media/format-registry/initdata/keyids.html
Latest published version:
https://www.w3.org/TR/eme-initdata-keyids/
Latest editor's draft:
https://w3c.github.io/encrypted-media/format-registry/initdata/keyids.html
Editors:
Joey Parrish (Google Inc.)
Greg Freedman (Netflix Inc.)
Former editors:
Mark Watson (Netflix Inc.) (Until September 2019)
David Dorwin (Google Inc.) (Until September 2017)
Jerry Smith (Microsoft Corporation) (Until September 2017)
Adrian Bateman (Microsoft Corporation) (Until May 2014)
Repository:
https://github.com/w3c/encrypted-media/

Abstract

This specification defines the "keyids" Initialization Data format for use with the Encrypted Media Extensions [ENCRYPTED-MEDIA].

Note

It defines a stream format-independent format for specifying a list of key ID(s). This type can be used by applications to directly provide information necessary to generate a license request without using media data or constructing container-specific formats.

Status of This Document

This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.

This document was published by the Media Working Group as an Editor's Draft.

Comments regarding this document are welcome. Please send them to public-media-wg@w3.org (archives).

Publication as an Editor's Draft does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.

This document was produced by a group operating under the W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.

This document is governed by the 1 March 2019 W3C Process Document.

1. Format

The format is a JSON object, encoded in UTF-8 as specified in the Encoding specification [encoding], containing the following member:

"kids"
An array of key ID(s). Each element of the array is the base64url encoding of the octet sequence containing the key ID value.
Note

See Using base64url.

Note

Applications may encode the JSON string using the TextEncoder interface [encoding]

2. Example

This section is non-normative.

The following example will generate a license request for two key ID(s). (Line breaks are for readability only.)

{
  "kids":
    [
     "LwVHf8JLtPrv2GUXFW2v_A",
     "0DdtU9od-Bh5L3xbv0Xf_A"
    ],
}

A. References

A.1 Normative references

[encoding]
Encoding Standard. Anne van Kesteren. WHATWG. Living Standard. URL: https://encoding.spec.whatwg.org/
[ENCRYPTED-MEDIA]
Encrypted Media Extensions. David Dorwin; Jerry Smith; Mark Watson; Adrian Bateman. W3C. 18 September 2017. W3C Recommendation. URL: https://www.w3.org/TR/encrypted-media/