SKM API Documentation

SKM - Simple Key Management

The SKM API is a simple REST API designed to interface to local or remote key servers. It is an Open Specification that may be implemented by different software packages, like the SkeyMa Key Server , or online services, such as the ExpressPlay service. Different implementations of this API may differ slightly in the way they deal with access control, logging, and other functions, but the core SKM REST API documented here is common to all the implementations.

The purpose of the SKM API is to provide a very simple interface for software and services that need a simple and convenient way to store and/or retrieve cryptographic keys. This includes content packagers, head-end scramblers, DRM license servers, etc.

Contents:

• SKM REST API
  • Data Model
  • Encrypted vs Clear-text Key Values
  • REST API
    • Common API parameters
    • Optional API parameters and extensions
    • Special KID syntax
    • Root URL
    • API URLs
• SKM API Examples and Cookbook
  • Create a new Key, with a server-assigned value and KID
  • Get a key by KID, with server auto-creation of the key if it does not exist
  • Using KIDs generated from strings
  • Wrapping keys client-side