carview!

contentInfo validPeriod usageRights copyRights transferRights

source

<xs:element name="clientInfo">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="param" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>
</xs:element>

The <param> element

The param element is borrowed from [XHTML] XHTML 1.0 and is used to define name value pairs to convey implement specific parameters to the trusted system.

diagram

namespace

https://namespaces.xmcl.org/xmcl

used by

element

clientInfo

attributes

Name	Type	Use	Default	Fixed
id	xs:ID
name	xs:string
value	xs:string
valuetype	xs:NMTOKEN
type	xs:string

source

<xs:element name="param">
  <xs:complexType>
    <xs:attribute name="id" type="xs:ID"/>
    <xs:attribute name="name" type="xs:string"/>
    <xs:attribute name="value" type="xs:string"/>
    <xs:attribute name="valuetype" type="xs:NMTOKEN"/>
    <xs:attribute name="type" type="xs:string"/>
  </xs:complexType>
</xs:element>

The <license> element

The license element contains the business rules that the trusted system should use to generate the implementation specific license.

diagram

namespace

https://namespaces.xmcl.org/xmcl

children

used by

element

attributes

Name	Type	Use	Default	Fixed
numCopies	xs:decimal
allowTransfer	xs:boolean

source

<xs:element name="license">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="contentInfo"/>
      <xs:element ref="validPeriod"/>
      <xs:element ref="usageRights"/>
      <xs:element ref="copyRights" minOccurs="0"/>
      <xs:element ref="transferRights" minOccurs="0"/>
    </xs:sequence>
    <xs:attribute name="numCopies" type="xs:decimal"/>
    <xs:attribute name="allowTransfer" type="xs:boolean"/>
  </xs:complexType>
</xs:element>

The <contentInfo> element

The contentInfo element identifies and contains information specific to the piece of content being licensed.

diagram

namespace

https://namespaces.xmcl.org/xmcl

children

contentID key

used by

element

attributes

Name	Type	Use	Default	Fixed
creatorID	xs:string	required
licensorID	xs:string	required

source

<xs:element name="contentInfo">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="contentID" minOccurs="0"/>
      <xs:element ref="key" minOccurs="0"/>
      <xs:any namespace="dublin core meta element" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="creatorID" type="xs:string" use="required"/>
    <xs:attribute name="licensorID" type="xs:string" use="required"/>
  </xs:complexType>
</xs:element>

The <contentID> element

Contains an identifier for the content. It contains no other elements. The type attribute specifies the type of data contained by the element.

diagram

namespace

https://namespaces.xmcl.org/xmcl

type

xs:string

used by

element

contentInfo

source

<xs:element name="contentID" type="xs:string"/>

The <ds:KeyInfo> element

This element is taken from XML Digital Signatures [XMLDSIG] and is used to communicate cryptographic keys from system to system. See XML Digital Signatures [XMLDSIG] for further explanation of the elements semantics.

The <key> element

This spec extends the <ds:KeyValue> [XMLDSIG] element with the key element. The key element opens the algorithm list by providing a container for the key data and the algorithm attribute to identify the algorithm. The algorithm attribute uses the algorithm URI's from XML Encryption [ALGORITHMS].

diagram

namespace

https://namespaces.xmcl.org/xmcl

type

xs:string

used by

element

contentInfo

source

<xs:element name="key" type="xs:string"/>

The <validPeriod> element

The validPeriod element describes the dates during which the license is valid. It takes a start and end attribute. The start and end attributes define the calendar dates and times in the format described in [XSCHEMA-DATATYPES]. The enforcement system should only honor the rights expressed in the license after the date-time specified with the start attribute and until the date specified in the end attribute.

diagram

namespace

https://namespaces.xmcl.org/xmcl

used by

element

attributes

Name	Type	Use	Default	Fixed
start	xs:dateTime	required
end	xs:dateTime	required

source

<xs:element name="validPeriod">
  <xs:complexType>
    <xs:attribute name="start" type="xs:dateTime" use="required"/>
    <xs:attribute name="end" type="xs:dateTime" use="required"/>
  </xs:complexType>
</xs:element>

The <usageRights> element

The usageRights element describes the rights that are granted in the license.

diagram

namespace

https://namespaces.xmcl.org/xmcl

type

useDuration useCount userInteraction require allowedUse impRight

children

used by

element

source

<xs:element name="usageRights" type="rights"/>

The <copyRights> element

The copyRights element describes the rights that are granted in the copy license. If the element is empty, all the rights described in the <usageRights> are copied.

diagram

namespace

https://namespaces.xmcl.org/xmcl

type

useDuration useCount userInteraction require allowedUse impRight

children

used by

element

source

<xs:element name="copyRights" type="rights"/>

The <transferRights> element

The transferRights element describes the rights that are granted in the transfer license. If the element is empty, all the rights described in the <usageRights> are transferred.

diagram

namespace

https://namespaces.xmcl.org/xmcl

type

useDuration useCount userInteraction require allowedUse impRight

children

used by

element

useDuration useCount userInteraction require allowedUse impRight

source

<xs:element name="transferRights" type="rights"/>

The Rights elements

The following elements are used to specify rights in the <usageRights>, <copyRights>, and <transferRights> elements. They describe the interoperable right set as well as a generic right element, <impRight>, that can be used to describe rights specific to a particular implementation.

diagram

namespace

https://namespaces.xmcl.org/xmcl

children

used by

elements

copyRights transferRights usageRights

source

<xs:complexType name="rights">
  <xs:all>
    <xs:element ref="useDuration" minOccurs="0"/>
    <xs:element ref="useCount" minOccurs="0"/>
    <xs:element ref="userInteraction" minOccurs="0"/>
    <xs:element ref="require" minOccurs="0"/>
    <xs:element ref="allowedUse" minOccurs="0"/>
    <xs:element ref="impRight" minOccurs="0"/>
  </xs:all>
</xs:complexType>

The <useDuration> element

The useDuration element specifies a length of time the content can be used after a specific event. The begin attribute specifies when the duration should begin. Its values are "issue" and "firstUse". The "issue" value specifies the duration starts at the issue of the license. The "firstUse" value specifies the duration starts when the content is first used. The length attribute specifies the length of time.

diagram

namespace

https://namespaces.xmcl.org/xmcl

used by

complexType

attributes

Name	Type	Use	Default	Fixed
begin	xs:NMTOKEN
length	xs:duration	required

source

<xs:element name="useDuration">
  <xs:complexType>
    <xs:attribute name="begin" type="xs:NMTOKEN"/>
    <xs:attribute name="length" type="xs:duration" use="required"/>
  </xs:complexType>
</xs:element>

The <useCount> element

The useCount element specifies the number of times the content can be used. It takes the count attribute and the threshold attribute.

diagram

namespace

https://namespaces.xmcl.org/xmcl

used by

complexType

attributes

Name	Type	Use	Default	Fixed
count	xs:integer	required
threshold	xs:duration	optional

source

<xs:element name="useCount">
  <xs:complexType>
    <xs:attribute name="count" type="xs:integer" use="required"/>
    <xs:attribute name="threshold" type="xs:duration" use="optional"/>
  </xs:complexType>
</xs:element>

The <require> element

The intent of the require element is to describe conditions that the trusted system are to require for playback. It should include things like employment water marking technology, use of a specific decompressor implementation, etc.

diagram

namespace

https://namespaces.xmcl.org/xmcl

type

xs:string

used by

complexType

source

<xs:element name="require" type="xs:string"/>

The <userInteraction> element

The intent of the userInteraction element is to describe something that requires user interaction before use of the licensed content will be allowed. This includes things like accepting a "click-wrap" license agreement at each playback.

diagram

namespace

https://namespaces.xmcl.org/xmcl

type

xs:string

used by

complexType

source

<xs:element name="userInteraction" type="xs:string"/>

The <allowedUse> element

The intent of the allowedUse element is to describe things like the content can only be included as a whole vs. included in a larger work.

diagram

namespace

https://namespaces.xmcl.org/xmcl

type

xs:string

used by

complexType

source

<xs:element name="allowedUse" type="xs:string"/>

The <impRight> element

The impRight element is a generic extension mechanism that allows inclusion of implementation specific rights in a license. The implementation is identified by the implementationID attribute as a URI [URI].

Ed Note: Should pull in <switch> element and systemRequired element from SMIL 2.0 for this section so a XMCL doc could describe implementation specific rights for multiple implementations and the parsing application could correctly pick the right one.

diagram

namespace

https://namespaces.xmcl.org/xmcl

children

param

used by

complexType

attributes

Name	Type	Use	Default	Fixed
implementationID	xs:NMTOKEN	required

source

<xs:element name="impRight">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="param" maxOccurs="unbounded">
        <xs:complexType>
          <xs:attribute name="id" type="xs:ID"/>
          <xs:attribute name="name" type="xs:string"/>
          <xs:attribute name="value" type="xs:string"/>
          <xs:attribute name="valuetype" type="xs:NMTOKEN"/>
          <xs:attribute name="type" type="xs:string"/>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
    <xs:attribute name="implementationID" type="xs:NMTOKEN" use="required"/>
  </xs:complexType>
</xs:element>

Extension Syntax

The elements and attributes listed in this section are not considered part of the core XMCL language. Implementations SHOULD support these extensions.

The <revocationList> element

The purpose of the revocationList element is to provide a standard way to describe revocation certificates. Revocation is a key feature of DRM technology and the opportunity to standardize here seems the same as business rules. It MUST contain one or more <revokedItem> elements.

diagram

namespace

https://namespaces.xmcl.org/xmcl

children

revokedItem

used by

element

source

<xs:element name="revocationList">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="revokedItem" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>
</xs:element>

The <revokedItem> element

The revokedItem element is a non-empty element that describes an item in the trusted system to be revoked. The type attribute describes the type of the data contained in the revokedItem element.

diagram

namespace

https://namespaces.xmcl.org/xmcl

type

xs:string

used by

element

revocationList

source

<xs:element name="revokedItem" type="xs:string"/>

The <auth> element

The auth element is a is a place holder for digital signatures that can be used to authenticate the party that created the XMCL document

diagram

namespace

https://namespaces.xmcl.org/xmcl

used by

element