Ts2Iec62455.h

Go to the documentation of this file.

/*****************************************************************
|
|   MPEG2 Transport Stream - IEC 62455
|
|   $Id: Ts2Iec62455.h 296 2014-06-25 11:20:09Z jebaseelir $
|   Original author:  Julien Boeuf
|
|   This software is provided to you pursuant to your agreement 
|   with Intertrust Technologies Corporation ("Intertrust"). 
|   This software may be used only in accordance with the terms 
|   of the agreement.
|      
|   Copyright (c) 2010-2014 by Intertrust. All rights reserved. 
|
****************************************************************/

#ifndef _TS2_IEC_62455_H_
#define _TS2_IEC_62455_H_

/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "Ts2Tables.h"

/*----------------------------------------------------------------------
|   constants
+---------------------------------------------------------------------*/
#define TS2_KSM_TABLE80_ID 0x80
#define TS2_KSM_TABLE81_ID 0x81

#define TS2_KSM_PROTOCOL_VERSION_1 0x01

#define TS2_KSM_ENCRYPTED_PEK_SIZE  16
#define TS2_KSM_MAC_SIZE            12
#define TS2_KSM_CID_EXTENSION_SIZE  4

#define TS2_KSM_ALGO_IPSEC          0
#define TS2_KSM_ALGO_SRTP           1
#define TS2_KSM_ALGO_ISMACRYPT      2
#define TS2_KSM_ALGO_MPEG2_TS_CRYPT 7

#define TS2_KSM_FLAG_EVEN 0
#define TS2_KSM_FLAG_ODD  1

#define TS2_KSM_CONTENT_KEY_INDEX_DVB_CSA_64  0x00
#define TS2_KSM_CONTENT_KEY_INDEX_DES_56      0x01
#define TS2_KSM_CONTENT_KEY_INDEX_3DES_168    0x02
#define TS2_KSM_CONTENT_KEY_INDEX_3DES_112    0x03
#define TS2_KSM_CONTENT_KEY_INDEX_3DES_56     0x04
#define TS2_KSM_CONTENT_KEY_INDEX_AES_128     0x05 /* BBTS 1.0/1.1 */
#define TS2_KSM_CONTENT_KEY_INDEX_M2_64       0x06
#define TS2_KSM_CONTENT_KEY_INDEX_AES_128_KDF 0x0F /* BBTS 2.0, Key Derivation Function */

#define TS2_KSM_CIPHER_MODE_ECB 0x00
#define TS2_KSM_CIPHER_MODE_CBC 0x01
#define TS2_KSM_CIPHER_MODE_CSA 0x02

#define TS2_KSM_FLAG_EVEN 0
#define TS2_KSM_FLAG_ODD  1

/*----------------------------------------------------------------------
|   types
+---------------------------------------------------------------------*/
typedef struct {
    ATX_Byte  reserved_byte;
    ATX_List* descriptors;
} TS2_KSM_AccessCriteria;

typedef struct {
    ATX_UInt8  permission_flag;
    ATX_UInt8  permissions;
    ATX_Byte   encrypted_pek[TS2_KSM_ENCRYPTED_PEK_SIZE];
    ATX_Byte   cid_extension[TS2_KSM_CID_EXTENSION_SIZE];
    ATX_Size   signed_payload_size;
    ATX_Byte   mac[TS2_KSM_MAC_SIZE];
} TS2_KSM_Programme;

typedef struct {
    ATX_Byte   cid_extension[TS2_KSM_CID_EXTENSION_SIZE];
    ATX_Size   signed_payload_size;
    ATX_Byte   mac[TS2_KSM_MAC_SIZE];
} TS2_KSM_Service;

typedef struct TS2_KSM TS2_KSM;
struct TS2_KSM {
    ATX_UInt16              flags; /* use with TS2_KSM_Flags_XXXX */
    ATX_Byte*               signed_payload;
    ATX_Byte*               enc_key_material;
    ATX_UInt8               enc_key_material_size;
    ATX_Byte*               next_enc_key_material;
    ATX_UInt8               key_lifetime; /* use TS2_GetKeyLifetimeInSecs to get the value in secs */
    ATX_UInt64              timestamp;
    TS2_KSM_AccessCriteria* access_criteria;
    TS2_KSM_Programme*      programme;
    TS2_KSM_Service*        service;
    
    /* internal */ 
    ATX_Byte*               mac_key;
    ATX_Size                mac_key_size;
    void (*Destroy)(TS2_KSM* self);
};

typedef struct {
    TS2_KSM   base;
    ATX_UInt8 info;
    ATX_UInt8 iv_size;
    ATX_Byte* iv;
    ATX_Byte* next_iv;
} TS2_Mpeg2TsCryptKSM;

typedef struct {
    TS2_Table base;
    TS2_KSM*  ksm;
} TS2_KSMT;

/*----------------------------------------------------------------------
|   functions
+---------------------------------------------------------------------*/
#ifdef __cplusplus
extern "C" {
#endif

TS2_EXPORT ATX_Result 
TS2_KSMT_Construct(TS2_KSMT* self);
    
ATX_Result
TS2_KSM_Programme_Construct(TS2_KSM_Programme* self,
                            const ATX_Byte*    encrypted_pek, /* can be NULL */
                            const ATX_Byte*    cid_extension);
    
ATX_Result
TS2_KSM_Service_Construct(TS2_KSM_Service* self,
                          const ATX_Byte*  cid_extension);

ATX_Result 
TS2_Mpeg2TsCryptKSM_Create(ATX_UInt32               content_key_index,
                           ATX_UInt32               crypto_period, /* between 1 and 120 */
                           ATX_UInt8                odd_even_flag,
                           const ATX_Byte*          enc_key_material,
                           const ATX_Byte*          next_enc_key_material,
                           const ATX_Byte*          iv,
                           const ATX_Byte*          next_iv,
                           const TS2_KSM_Programme* programme,
                           const TS2_KSM_Service*   service,
                           const ATX_Byte*          mac_key,
                           ATX_Size                 mac_key_size,
                           const ATX_Byte*          access_criteria,
                           ATX_Size                 access_criteria_size,
                           TS2_KSM**                ksm);      

ATX_Result
TS2_Mpeg2TsCryptKSM_Serialize(TS2_Mpeg2TsCryptKSM*  m2ksm,
                              ATX_DataBuffer**      buffer);

ATX_Result
TS2_KSM_CreateFromBuffer(const ATX_Byte* buffer, 
                         ATX_Size        buffer_size,
                         TS2_KSM**       ksm);

void
TS2_Mpeg2TsCryptKSM_SwitchOddEvenFlag(TS2_Mpeg2TsCryptKSM* self);


ATX_Result
TS2_KSM_AccessCriteria_Parse(const ATX_Byte*          ac_data,
                             ATX_Size*                ac_size,
                             TS2_KSM_AccessCriteria** ac);

ATX_Result
TS2_KSM_AccessCriteria_Serialize(TS2_KSM_AccessCriteria* ac, ATX_Byte* buffer, ATX_Size* buffer_size);


void
TS2_KSM_AccessCriteria_Destroy(TS2_KSM_AccessCriteria* self);


#ifdef __cplusplus
}
#endif

/*----------------------------------------------------------------------
|   helpers
+---------------------------------------------------------------------*/
#define TS2_KSM_Flags_ProtocolVersion(flags)           (((flags) & 0xF000) >> 12)
#define TS2_KSM_Flags_AccessCriteriaFlag(flags)        (((flags) & 0x0100) >> 8)
#define TS2_KSM_Flags_TrafficProtectionProtocol(flags) (((flags) & 0x00E0) >> 5)
#define TS2_KSM_Flags_TrafficAuthenticationFlag(flags) (((flags) & 0x0010) >> 4)
#define TS2_KSM_Flags_NextTrafficKeyFlag(flags)        (((flags) & 0x0008) >> 3)
#define TS2_KSM_Flags_TimestampFlag(flags)             (((flags) & 0x0004) >> 2)
#define TS2_KSM_Flags_ProgrammeFlag(flags)             (((flags) & 0x0002) >> 1)
#define TS2_KSM_Flags_ServiceFlag(flags)               (((flags) & 0x0001)     )

#define TS2_Mpeg2TsCryptKSM_ContentKeyIndex(m2ksm) ((((m2ksm)->info) & 0xF0) >> 4)
#define TS2_Mpeg2TsCryptKSM_OddEvenFlag(m2ksm)     ((((m2ksm)->info) & 0x08) >> 3)
#define TS2_Mpeg2TsCryptKSM_CipherMode(m2ksm)      ((((m2ksm)->info) & 0x07)     )

#define TS2_GetKeyLifetimeInSecs(klf) (1 << (klf))

#define TS2_KSM_Destroy(KSM)                    \
do {                                            \
    TS2_KSM* __ksm = (KSM);                     \
    if (__ksm && __ksm->Destroy) {              \
        __ksm->Destroy(__ksm);                  \
    }                                           \
} while (0)

#endif /* _TS2_IEC_62455_H_ */