// ---------------------------------------------------------------------------- // license_protocol.proto // ---------------------------------------------------------------------------- // Copyright 2013 Google Inc. All Rights Reserved. // // Description: // Definitions of the protocol buffer messages used in the Widevine license // exchange protocol. syntax = "proto2"; package video_widevine; // need this if we are using libprotobuf-cpp-2.3.0-lite option optimize_for = LITE_RUNTIME; option java_package = "com.google.video.widevine.protos"; enum LicenseType { STREAMING = 1; OFFLINE = 2; } // LicenseIdentification is propagated from LicenseRequest to License, // incrementing version with each iteration. message LicenseIdentification { optional bytes request_id = 1; optional bytes session_id = 2; optional bytes purchase_id = 3; optional LicenseType type = 4; optional int32 version = 5; optional bytes provider_session_token = 6; } message License { message Policy { // Indicates that playback of the content is allowed. optional bool can_play = 1 [default = false]; // Indicates that the license may be persisted to non-volatile // storage for offline use. optional bool can_persist = 2 [default = false]; // Indicates that renewal of this license is allowed. optional bool can_renew = 3 [default = false]; // For the |*duration*| fields, playback must halt when // license_start_time (seconds since the epoch (UTC)) + // license_duration_seconds is exceeded. A value of 0 // indicates that there is no limit to the duration. // Indicates the rental window. optional int64 rental_duration_seconds = 4 [default = 0]; // Indicates the viewing window, once playback has begun. optional int64 playback_duration_seconds = 5 [default = 0]; // Indicates the time window for this specific license. optional int64 license_duration_seconds = 6 [default = 0]; // The |renewal*| fields only apply if |can_renew| is true. // The window of time, in which playback is allowed to continue while // renewal is attempted, yet unsuccessful due to backend problems with // the license server. optional int64 renewal_recovery_duration_seconds = 7 [default = 0]; // All renewal requests for this license shall be directed to the // specified URL. optional string renewal_server_url = 8; // How many seconds after license_start_time, before renewal is first // attempted. optional int64 renewal_delay_seconds = 9 [default = 0]; // Specifies the delay in seconds between subsequent license // renewal requests, in case of failure. optional int64 renewal_retry_interval_seconds = 10 [default = 0]; // Indicates that the license shall be sent for renewal when usage is // started. optional bool renew_with_usage = 11 [default = false]; // Indicates to client that license renewal and release requests ought to // include ClientIdentification (client_id). optional bool always_include_client_id = 12 [default = false]; // Duration of grace period before playback_duration_seconds (short window) // goes into effect. Optional. optional int64 play_start_grace_period_seconds = 13 [default = 0]; // Enables "soft enforcement" of playback_duration_seconds, letting the user // finish playback even if short window expires. Optional. optional bool soft_enforce_playback_duration = 14 [default = false]; } message KeyContainer { enum KeyType { // Exactly one key of this type must appear. SIGNING = 1; CONTENT = 2; KEY_CONTROL = 3; OPERATOR_SESSION = 4; } // The SecurityLevel enumeration allows the server to communicate the level // of robustness required by the client, in order to use the key. enum SecurityLevel { // Software-based whitebox crypto is required. SW_SECURE_CRYPTO = 1; // Software crypto and an obfuscated decoder is required. SW_SECURE_DECODE = 2; // The key material and crypto operations must be performed within a // hardware backed trusted execution environment. HW_SECURE_CRYPTO = 3; // The crypto and decoding of content must be performed within a hardware // backed trusted execution environment. HW_SECURE_DECODE = 4; // The crypto, decoding and all handling of the media (compressed and // uncompressed) must be handled within a hardware backed trusted // execution environment. HW_SECURE_ALL = 5; } message KeyControl { // |key_control| is documented in: // Widevine Modular DRM Security Integration Guide for CENC // If present, the key control must be communicated to the secure // environment prior to any usage. This message is automatically generated // by the Widevine License Server SDK. optional bytes key_control_block = 1; optional bytes iv = 2; } message OutputProtection { // Indicates whether HDCP is required on digital outputs, and which // version should be used. enum HDCP { HDCP_NONE = 0; HDCP_V1 = 1; HDCP_V2 = 2; HDCP_V2_1 = 3; HDCP_V2_2 = 4; HDCP_NO_DIGITAL_OUTPUT = 0xff; } optional HDCP hdcp = 1 [default = HDCP_NONE]; // Indicate the CGMS setting to be inserted on analog output. enum CGMS { CGMS_NONE = 42; COPY_FREE = 0; COPY_ONCE = 2; COPY_NEVER = 3; } optional CGMS cgms_flags = 2 [default = CGMS_NONE]; } message VideoResolutionConstraint { // Minimum and maximum video resolutions in the range (height x width). optional uint32 min_resolution_pixels = 1; optional uint32 max_resolution_pixels = 2; // Optional output protection requirements for this range. If not // specified, the OutputProtection in the KeyContainer applies. optional OutputProtection required_protection = 3; } message OperatorSessionKeyPermissions { // Permissions/key usage flags for operator service keys // (type = OPERATOR_SESSION). optional bool allow_encrypt = 1 [default = false]; optional bool allow_decrypt = 2 [default = false]; optional bool allow_sign = 3 [default = false]; optional bool allow_signature_verify = 4 [default = false]; } optional bytes id = 1; optional bytes iv = 2; optional bytes key = 3; optional KeyType type = 4; optional SecurityLevel level = 5 [default = SW_SECURE_CRYPTO]; optional OutputProtection required_protection = 6; // NOTE: Use of requested_protection is not recommended as it is only // supported on a small number of platforms. optional OutputProtection requested_protection = 7; optional KeyControl key_control = 8; optional OperatorSessionKeyPermissions operator_session_key_permissions = 9; // Optional video resolution constraints. If the video resolution of the // content being decrypted/decoded falls within one of the specified ranges, // the optional required_protections may be applied. Otherwise an error will // be reported. // NOTE: Use of this feature is not recommended, as it is only supported on // a small number of platforms. repeated VideoResolutionConstraint video_resolution_constraints = 10; // Optional flag to indicate the key must only be used if the client // supports anti rollback of the user table. Content provider can query the // client capabilities to determine if the client support this feature. optional bool anti_rollback_usage_table = 11 [default = false]; } optional LicenseIdentification id = 1; optional Policy policy = 2; repeated KeyContainer key = 3; // Time of the request in seconds (UTC) as set in // LicenseRequest.request_time. If this time is not set in the request, // the local time at the license service is used in this field. optional int64 license_start_time = 4; optional bool remote_attestation_verified = 5 [default = false]; // Client token generated by the content provider. Optional. optional bytes provider_client_token = 6; // 4cc code specifying the CENC protection scheme as defined in the CENC 3.0 // specification. Propagated from Widevine PSSH box. Optional. optional uint32 protection_scheme = 7; // 8 byte verification field "HDCPDATA" followed by unsigned 32 bit minimum // HDCP SRM version. Additional details can be found in // Widevine Modular DRM Security Integration Guide for CENC. optional bytes srm_requirement = 8; // If present this contains a signed SRM file that should be installed // on the client device. optional bytes srm_update = 9; } enum ProtocolVersion { VERSION_2_0 = 20; VERSION_2_1 = 21; } message LicenseRequest { message ContentIdentification { message CencDeprecated { repeated bytes pssh = 1; optional LicenseType license_type = 2; optional bytes request_id = 3; // Opaque, client-specified. } message WebmDeprecated { optional bytes header = 1; optional LicenseType license_type = 2; optional bytes request_id = 3; // Opaque, client-specified. } message ExistingLicense { optional LicenseIdentification license_id = 1; optional int64 seconds_since_started = 2; optional int64 seconds_since_last_played = 3; optional bytes session_usage_table_entry = 4; } message InitData { enum InitDataType { CENC = 1; WEBM = 2; } optional InitDataType init_data_type = 1 [default = CENC]; optional bytes init_data = 2; optional LicenseType license_type = 3; optional bytes request_id = 4; } //oneof content_id_variant { // Exactly one of these must be present. optional CencDeprecated cenc_id_deprecated = 1; optional WebmDeprecated webm_id_deprecated = 2; optional ExistingLicense existing_license = 3; optional InitData init_data = 4; //} } enum RequestType { NEW = 1; RENEWAL = 2; RELEASE = 3; } // The client_id provides information authenticating the calling device. It // contains the Widevine keybox token that was installed on the device at the // factory. This field or encrypted_client_id below is required for a valid // license request, but both should never be present in the same request. optional ClientIdentification client_id = 1; optional ContentIdentification content_id = 2; optional RequestType type = 3; // Time of the request in seconds (UTC) as set by the client. optional int64 request_time = 4; // Old-style decimal-encoded string key control nonce. optional bytes key_control_nonce_deprecated = 5; optional ProtocolVersion protocol_version = 6 [default = VERSION_2_0]; // New-style uint32 key control nonce, please use instead of // key_control_nonce_deprecated. optional uint32 key_control_nonce = 7; // Encrypted ClientIdentification message, used for privacy purposes. optional EncryptedClientIdentification encrypted_client_id = 8; } message LicenseError { enum Error { // The device credentials are invalid. The device must re-provision. INVALID_DRM_DEVICE_CERTIFICATE = 1; // The device credentials have been revoked. Re-provisioning is not // possible. REVOKED_DRM_DEVICE_CERTIFICATE = 2; // The service is currently unavailable due to the backend being down // or similar circumstances. SERVICE_UNAVAILABLE = 3; } optional Error error_code = 1; } message MetricData { enum MetricType { // The time spent in the 'stage', specified in microseconds. LATENCY = 1; // The UNIX epoch timestamp at which the 'stage' was first accessed in // microseconds. TIMESTAMP = 2; } message TypeValue { optional MetricType type = 1; // The value associated with 'type'. For example if type == LATENCY, the // value would be the time in microseconds spent in this 'stage'. optional int64 value = 2 [default = 0]; } // 'stage' that is currently processing the SignedMessage. Required. optional string stage_name = 1; // metric and associated value. repeated TypeValue metric_data = 2; } message RemoteAttestation { // Encrypted ClientIdentification message containing the device remote // attestation certificate. Required. optional EncryptedClientIdentification certificate = 1; // Bytes of salt which were added to the remote attestation challenge prior to // signing it. Required. optional bytes salt = 2; // Signed remote attestation challenge + salt. Required. optional bytes signature = 3; } message SignedMessage { enum MessageType { LICENSE_REQUEST = 1; LICENSE = 2; ERROR_RESPONSE = 3; SERVICE_CERTIFICATE_REQUEST = 4; SERVICE_CERTIFICATE = 5; } optional MessageType type = 1; optional bytes msg = 2; optional bytes signature = 3; optional bytes session_key = 4; // Remote attestation data which will be present in the initial license // request for ChromeOS client devices operating in verified mode. Remote // attestation challenge data is |msg| field above. Optional. optional RemoteAttestation remote_attestation = 5; repeated MetricData metric_data = 6; } message GroupKeys { enum GroupLicenseVersion { GROUP_LICENSE_VERSION_1 = 0; GROUP_LICENSE_VERSION_2 = 1; } message GroupKeyData { // Required track type. This indicates the track type to which this key // belongs. optional string track_type = 1; // A required signed message. The message body contains a serialized group // msg. optional bytes key = 2; } // Optional key container array used in group licensing V1. This is not used // in V2. repeated License.KeyContainer key = 1 [deprecated = true]; // Byte string that identifies the group to which this license material // belongs. optional bytes group_id = 2; // Required version id beginning with version 2. If not present version 1 // should be assumed. optional GroupLicenseVersion version = 3 [default = GROUP_LICENSE_VERSION_1]; // Optional key container array for group licensing V2. repeated GroupKeyData key_data = 4; } // ---------------------------------------------------------------------------- // certificate_provisioning.proto // ---------------------------------------------------------------------------- // Description: // Public protocol buffer definitions for Widevine Device Certificate // Provisioning protocol. // ProvisioningOptions specifies the type of certificate to specify and // in the case of X509 certificates, the certificate authority to use. message ProvisioningOptions { enum CertificateType { WIDEVINE_DRM = 0; // Default. The original certificate type. X509 = 1; // X.509 certificate. } optional CertificateType certificate_type = 1 [default = WIDEVINE_DRM]; // Contains the application-specific name used to identify the certificate // authority for signing the generated certificate. This is required iff the // certificate type is X509. optional string certificate_authority = 2; } // Provisioning request sent by client devices to provisioning service. message ProvisioningRequest { //oneof clear_or_encrypted_client_id { // Device root of trust and other client identification. Required. optional ClientIdentification client_id = 1; optional EncryptedClientIdentification encrypted_client_id = 5; //} // Nonce value used to prevent replay attacks. Required. optional bytes nonce = 2; // Options for type of certificate to generate. Optional. optional ProvisioningOptions options = 3; //oneof spoid_param { // Stable identifier, unique for each device + application (or origin). // To be deprecated. optional bytes stable_id = 4; // Service provider ID from the service certificate's provider_id field. // Preferred parameter. optional bytes provider_id = 6; // Client-generated stable per-origin identifier to be copied directly // to the client certificater serial number. optional bytes spoid = 7; //} } // Provisioning response sent by the provisioning server to client devices. // This message is used for both regular Widevine DRM certificates and for // application-specific X.509 certificates. message ProvisioningResponse { // AES-128 encrypted device private RSA key. PKCS#1 ASN.1 DER-encoded. // Required. For X.509 certificates, the private RSA key may also include // a prefix as specified by private_key_prefix in the X509CertificateMetadata // proto message. optional bytes device_rsa_key = 1; // Initialization vector used to encrypt device_rsa_key. Required. optional bytes device_rsa_key_iv = 2; // For Widevine DRM certificates, this contains the serialized // SignedDrmDeviceCertificate. For X.509 certificates, this contains the PEM // encoded X.509 certificate. Required. optional bytes device_certificate = 3; // Nonce value matching nonce in ProvisioningRequest. Required. optional bytes nonce = 4; // Key used to wrap device_rsa_key when DRM provisioning an OEM factory // provisioned device. Encrypted with the device OEM public key using // RSA-OAEP. optional bytes wrapping_key = 5; } // Serialized ProvisioningRequest or ProvisioningResponse signed with // The message authentication key. message SignedProvisioningMessage { enum ProtocolVersion { VERSION_2 = 2; // Keybox factory-provisioned devices. VERSION_3 = 3; // OEM certificate factory-provisioned devices. } // Serialized ProvisioningRequest or ProvisioningResponse. Required. optional bytes message = 1; // HMAC-SHA256 (Keybox) or RSASSA-PSS (OEM) signature of message. Required. optional bytes signature = 2; // Version number of provisioning protocol. optional ProtocolVersion protocol_version = 3 [default = VERSION_2]; } // ---------------------------------------------------------------------------- // client_identification.proto // ---------------------------------------------------------------------------- // Description: // ClientIdentification messages used by provisioning and license protocols. // ClientIdentification message used to authenticate the client device. message ClientIdentification { enum TokenType { KEYBOX = 0; DRM_DEVICE_CERTIFICATE = 1; REMOTE_ATTESTATION_CERTIFICATE = 2; OEM_DEVICE_CERTIFICATE = 3; } message NameValue { optional string name = 1; optional string value = 2; } // Capabilities which not all clients may support. Used for the license // exchange protocol only. message ClientCapabilities { enum HdcpVersion { HDCP_NONE = 0; HDCP_V1 = 1; HDCP_V2 = 2; HDCP_V2_1 = 3; HDCP_V2_2 = 4; HDCP_NO_DIGITAL_OUTPUT = 0xff; } enum CertificateKeyType { RSA_2048 = 0; RSA_3072 = 1; } optional bool client_token = 1 [default = false]; optional bool session_token = 2 [default = false]; optional bool video_resolution_constraints = 3 [default = false]; optional HdcpVersion max_hdcp_version = 4 [default = HDCP_NONE]; optional uint32 oem_crypto_api_version = 5; // Client has hardware support for protecting the usage table, such as // storing the generation number in secure memory. For Details, see: // Widevine Modular DRM Security Integration Guide for CENC optional bool anti_rollback_usage_table = 6 [default = false]; // The client shall report |srm_version| if available. optional uint32 srm_version = 7; // A device may have SRM data, and report a version, but may not be capable // of updating SRM data. optional bool can_update_srm = 8 [default = false]; repeated CertificateKeyType supported_certificate_key_type = 9; } // Type of factory-provisioned device root of trust. Optional. optional TokenType type = 1 [default = KEYBOX]; // Factory-provisioned device root of trust. Required. optional bytes token = 2; // Optional client information name/value pairs. repeated NameValue client_info = 3; // Client token generated by the content provider. Optional. optional bytes provider_client_token = 4; // Number of licenses received by the client to which the token above belongs. // Only present if client_token is specified. optional uint32 license_counter = 5; // List of non-baseline client capabilities. optional ClientCapabilities client_capabilities = 6; // Serialized VmpData message. Optional. optional bytes vmp_data = 7; } // EncryptedClientIdentification message used to hold ClientIdentification // messages encrypted for privacy purposes. message EncryptedClientIdentification { // Provider ID for which the ClientIdentifcation is encrypted (owner of // service certificate). optional string provider_id = 1; // Serial number for the service certificate for which ClientIdentification is // encrypted. optional bytes service_certificate_serial_number = 2; // Serialized ClientIdentification message, encrypted with the privacy key // using AES-128-CBC with PKCS#5 padding. optional bytes encrypted_client_id = 3; // Initialization vector needed to decrypt encrypted_client_id. optional bytes encrypted_client_id_iv = 4; // AES-128 privacy key, encrypted with the service public key using RSA-OAEP. optional bytes encrypted_privacy_key = 5; } // ---------------------------------------------------------------------------- // device_certificate.proto // ---------------------------------------------------------------------------- // Description: // Device certificate and certificate status list format definitions. // DRM certificate definition for user devices, intermediate, service, and root // certificates. message DrmDeviceCertificate { enum CertificateType { ROOT = 0; DRM_INTERMEDIATE = 1; DRM_USER_DEVICE = 2; SERVICE = 3; PROVISIONER = 4; } // Type of certificate. Required. optional CertificateType type = 1; // 128-bit globally unique serial number of certificate. // Value is 0 for root certificate. Required. optional bytes serial_number = 2; // POSIX time, in seconds, when the certificate was created. Required. optional uint32 creation_time_seconds = 3; // Device public key. PKCS#1 ASN.1 DER-encoded. Required. optional bytes public_key = 4; // Widevine system ID for the device. Required for intermediate and // user device certificates. optional uint32 system_id = 5; // Deprecated field, which used to indicate whether the device was a test // (non-production) device. The test_device field in ProvisionedDeviceInfo // below should be observed instead. optional bool test_device_deprecated = 6 [deprecated = true]; // Service identifier (web origin) for the provider which owns the // certificate. Required for service and provisioner certificates. optional string provider_id = 7; } // Contains DRM and OEM certificate status and device information for a // specific system ID. message DeviceCertificateStatus { enum Status { VALID = 0; REVOKED = 1; }; // Serial number of the intermediate DrmDeviceCertificate to which this // message refers. Required. optional bytes drm_serial_number = 1; // Status of the certificate. Optional. optional Status status = 2 [default = VALID]; // Device model information about the device to which the intermediate // certificate(s) correspond. optional ProvisionedDeviceInfo device_info = 4; // Serial number of the OEM X.509 intermediate certificate for this type // of device. Present only if the device is OEM-provisioned. optional bytes oem_serial_number = 5; } // List of DeviceCertificateStatus. Used to propagate certificate revocation // status and device information. message DeviceCertificateStatusList { // POSIX time, in seconds, when the list was created. Required. optional uint32 creation_time_seconds = 1; // DeviceCertificateStatus for each system ID. repeated DeviceCertificateStatus certificate_status = 2; } // Signed CertificateStatusList message SignedCertificateStatusList { // Serialized DeviceCertificateStatusList. Required. optional bytes certificate_status_list = 1; // Signature of certificate_status_list. Signed with root certificate private // key using RSASSA-PSS. Required. optional bytes signature = 2; } // ---------------------------------------------------------------------------- // provisioned_device_info.proto // ---------------------------------------------------------------------------- // Description: // Provisioned device info format definitions. // Contains device model information for a provisioned device. message ProvisionedDeviceInfo { enum WvSecurityLevel { // Defined in "Widevine Security Integration Guide for DASH on Android" LEVEL_UNSPECIFIED = 0; LEVEL_1 = 1; LEVEL_2 = 2; LEVEL_3 = 3; } // Widevine system ID for the device. Mandatory. optional uint32 system_id = 1; // Name of system-on-a-chip. Optional. optional string soc = 2; // Name of manufacturer. Optional. optional string manufacturer = 3; // Manufacturer's model name. Matches "brand" in device metadata. Optional. optional string model = 4; // Type of device (Phone, Tablet, TV, etc). optional string device_type = 5; // Device model year. Optional. optional uint32 model_year = 6; // Widevine-defined security level. Optional. optional WvSecurityLevel security_level = 7 [default = LEVEL_UNSPECIFIED]; // True if the certificate corresponds to a test (non production) device. // Optional. optional bool test_device = 8 [default = false]; } // ---------------------------------------------------------------------------- // widevine_header.proto // ---------------------------------------------------------------------------- // Description: // Public protocol buffer definitions for Widevine Cenc Header // protocol. message WidevineCencHeader { enum Algorithm { UNENCRYPTED = 0; AESCTR = 1; }; // Replaced with protection_scheme. optional Algorithm algorithm = 1 [deprecated=true]; repeated bytes key_id = 2; // Content provider name. optional string provider = 3; // A content identifier, specified by content provider. optional bytes content_id = 4; // Track type. Acceptable values are SD, HD and AUDIO. Used to differentiate // content keys used by an asset. // No longer adding track_type to the PSSH since the Widevine license server // will return keys for all allowed track types in a single license. optional string track_type_deprecated = 5; // The name of a registered policy to be used for this asset. optional string policy = 6 [deprecated=true]; // Crypto period index, for media using key rotation. optional uint32 crypto_period_index = 7; // Optional protected context for group content. The grouped_license is a // serialized SignedMessage. optional bytes grouped_license = 8; // Protection scheme identifying the encryption algorithm. Represented as one // of the following 4CC values: 'cenc' (AES-CTR), 'cbc1' (AES-CBC), // 'cens' (AES-CTR subsample), 'cbcs' (AES-CBC subsample). optional uint32 protection_scheme = 9; } // Signed device certificate definition. // DrmDeviceCertificate signed by a higher (CA) DRM certificate. message SignedDrmDeviceCertificate { // Serialized certificate. Required. optional bytes drm_certificate = 1; // Signature of certificate. Signed with root or intermediate // certificate specified below. Required. optional bytes signature = 2; // SignedDrmDeviceCertificate used to sign this certificate. optional SignedDrmDeviceCertificate signer = 3; }