Source release 17.1.0

oemcrypto/include/OEMCryptoCENCCommon.h

@@ -1,5 +1,5 @@
 // Copyright 2019 Google LLC. All rights reserved. This file and proprietary
-// source code may only be used and distributed under the Widevine Master
+// source code may only be used and distributed under the Widevine
 // License Agreement.
 
 /*********************************************************************
@@ -61,7 +61,7 @@ typedef enum OEMCryptoResult {
   OEMCrypto_ERROR_INVALID_NONCE                = 32,
   OEMCrypto_ERROR_TOO_MANY_KEYS                = 33,
   OEMCrypto_ERROR_DEVICE_NOT_RSA_PROVISIONED   = 34,
-  OEMCrypto_ERROR_INVALID_RSA_KEY              = 35,
+  OEMCrypto_ERROR_INVALID_RSA_KEY              = 35,  /* deprecated */
   OEMCrypto_ERROR_KEY_EXPIRED                  = 36,
   OEMCrypto_ERROR_INSUFFICIENT_RESOURCES       = 37,
   OEMCrypto_ERROR_INSUFFICIENT_HDCP            = 38,
@@ -87,6 +87,12 @@ typedef enum OEMCryptoResult {
   OEMCrypto_ERROR_LICENSE_RELOAD               = 57,
   OEMCrypto_ERROR_MULTIPLE_USAGE_ENTRIES       = 58,
   OEMCrypto_WARNING_MIXED_OUTPUT_PROTECTION    = 59,
+  OEMCrypto_ERROR_INVALID_ENTITLED_KEY_SESSION = 60,
+  OEMCrypto_ERROR_NEEDS_KEYBOX_PROVISIONING    = 61,
+  OEMCrypto_ERROR_UNSUPPORTED_CIPHER           = 62,
+  OEMCrypto_ERROR_DVR_FORBIDDEN                = 63,
+  OEMCrypto_ERROR_INSUFFICIENT_PRIVILEGE       = 64,
+  OEMCrypto_ERROR_INVALID_KEY                  = 65,
   /* ODK return values */
   ODK_ERROR_BASE                               = 1000,
   ODK_ERROR_CORE_MESSAGE                       = ODK_ERROR_BASE,
@@ -95,6 +101,11 @@ typedef enum OEMCryptoResult {
   ODK_TIMER_EXPIRED                            = ODK_ERROR_BASE + 3,
   ODK_UNSUPPORTED_API                          = ODK_ERROR_BASE + 4,
   ODK_STALE_RENEWAL                            = ODK_ERROR_BASE + 5,
+  /* OPK return values */
+  OPK_ERROR_BASE                               = 2000,
+  OPK_ERROR_REMOTE_CALL                        = OPK_ERROR_BASE,
+  OPK_ERROR_INCOMPATIBLE_VERSION               = OPK_ERROR_BASE + 1,
+  OPK_ERROR_NO_PERSISTENT_DATA                 = OPK_ERROR_BASE + 2,
 } OEMCryptoResult;
 /* clang-format on */
 
@@ -109,6 +120,11 @@ typedef enum OEMCrypto_Usage_Entry_Status {
   kInactiveUnused = 4,
 } OEMCrypto_Usage_Entry_Status;
 
+typedef enum OEMCrypto_ProvisioningRenewalType {
+  OEMCrypto_NoRenewal = 0,
+  OEMCrypto_RenewalACert = 1,
+} OEMCrypto_ProvisioningRenewalType;
+
 /**
  *  OEMCrypto_LicenseType is used in the license message to indicate if the key
  *  objects are for content keys, or for entitlement keys.
@@ -116,7 +132,7 @@ typedef enum OEMCrypto_Usage_Entry_Status {
 typedef enum OEMCrypto_LicenseType {
   OEMCrypto_ContentLicense = 0,
   OEMCrypto_EntitlementLicense = 1,
-  OEMCrypto_LicenstType_MaxValue = OEMCrypto_EntitlementLicense,
+  OEMCrypto_LicenseType_MaxValue = OEMCrypto_EntitlementLicense,
 } OEMCrypto_LicenseType;
 
 /* Private key type used in the provisioning response. */
@@ -135,6 +151,62 @@ typedef struct {
   size_t length;
 } OEMCrypto_Substring;
 
+/**
+ * Used to specify information about CMI Descriptor 0.
+ * @param id: ID value of CMI Descriptor assigned by DTLA.
+ * @param length: byte length of the usage rules field.
+ * @param data: usage rules data.
+ */
+typedef struct {
+  uint8_t id;         // 0x00
+  uint8_t extension;  // 0x00
+  uint16_t length;    // 0x01
+  uint8_t data;
+} OEMCrypto_DTCP2_CMI_Descriptor_0;
+
+/**
+ * Used to specify information about CMI Descriptor 1.
+ * @param id: ID value of CMI Descriptor assigned by DTLA.
+ * @param extension: specified by the CMI descriptor
+ * @param length: byte length of the usage rules field.
+ * @param data: usage rules data.
+ */
+typedef struct {
+  uint8_t id;         // 0x01
+  uint8_t extension;  // 0x00
+  uint16_t length;    // 0x03
+  uint8_t data[3];
+} OEMCrypto_DTCP2_CMI_Descriptor_1;
+
+/**
+ * Used to specify information about CMI Descriptor 2.
+ * @param id: ID value of CMI Descriptor assigned by DTLA.
+ * @param extension: specified by the CMI descriptor
+ * @param length: byte length of the usage rules field.
+ * @param data: usage rules data.
+ */
+typedef struct {
+  uint8_t id;         // 0x02
+  uint8_t extension;  // 0x00
+  uint16_t length;    // 0x03
+  uint8_t data[3];
+} OEMCrypto_DTCP2_CMI_Descriptor_2;
+
+/**
+ *  Used to specify the required DTCP2 level. If dtcp2_required is 0, there are
+ *  no requirements on any of the keys. If dtcp2_required is 1, any key with the
+ *  kControlHDCPRequired bit set requires DTCP2 in its output.
+ * @param dtcp2_required: specifies whether dtcp2 is required. 0 = not required,
+ *        1 = DTCP2 required.
+ * @param cmi_descriptor_1: three bytes of CMI descriptor 1
+ */
+typedef struct {
+  uint8_t dtcp2_required;  // 0 = not required. 1 = DTCP2 v1 required.
+  OEMCrypto_DTCP2_CMI_Descriptor_0 cmi_descriptor_0;
+  OEMCrypto_DTCP2_CMI_Descriptor_1 cmi_descriptor_1;
+  OEMCrypto_DTCP2_CMI_Descriptor_2 cmi_descriptor_2;
+} OEMCrypto_DTCP2_CMI_Packet;
+
 /**
  *  Points to the relevant fields for a content key. The fields are extracted
  *  from the License Response message offered to OEMCrypto_LoadKeys(). Each