DVS 042 cipher block chaining mode. More...

Inheritance diagram for ts::DVS042< CIPHER >:

[legend]

Collaboration diagram for ts::DVS042< CIPHER >:

[legend]

Public Member Functions
	DVS042 ()
	Constructor.

virtual size_t	blockSize () const override
	Size in bytes of the block used by the algorithm. More...

int	cipherId () const
	Get the "cipher id" value, as previously stored by the application. More...

bool	decrypt (const void cipher, size_t cipher_length, void plain, size_t plain_maxsize, size_t *plain_length=nullptr)
	Decrypt one block of data. More...

bool	decryptInPlace (void data, size_t data_length, size_t max_actual_length=nullptr)
	Decrypt one block of data in place. More...

size_t	decryptionCount () const
	Get the number of times the current key was used for decryption. More...

size_t	decryptionMax () const
	Get the maximum number of times a key should be used for decryption. More...

virtual size_t	defaultRounds () const override
	Default number of rounds for the algorithm. More...

bool	encrypt (const void plain, size_t plain_length, void cipher, size_t cipher_maxsize, size_t *cipher_length=nullptr)
	Encrypt one block of data. More...

bool	encryptInPlace (void data, size_t data_length, size_t max_actual_length=nullptr)
	Encrypt one block of data in place. More...

size_t	encryptionCount () const
	Get the number of times the current key was used for encryption. More...

size_t	encryptionMax () const
	Get the maximum number of times a key should be used for encryption. More...

bool	getKey (ByteBlock &key) const
	Get the current key. More...

virtual bool	isValidKeySize (size_t size) const override
	Check if a size in bytes is a valid key size. More...

virtual size_t	maxIVSize () const
	Get the maximum IV sizes in bytes. More...

virtual size_t	maxKeySize () const override
	Maximum key sizes in bytes. More...

virtual size_t	maxRounds () const override
	Maximum number of rounds for the algorithm. More...

virtual size_t	minIVSize () const
	Get the minimum IV sizes in bytes. More...

virtual size_t	minKeySize () const override
	Minimum key sizes in bytes. More...

virtual size_t	minMessageSize () const override
	Get the minimum message size. More...

virtual size_t	minRounds () const override
	Minimum number of rounds for the algorithm. More...

virtual UString	name () const override
	Algorithm name (informational only). More...

virtual bool	residueAllowed () const override
	Check if the chaining mode can process residue after the last multiple of the block size. More...

void	setAlertHandler (BlockCipherAlertInterface *handler)
	Set the handler to be notified on alert. More...

void	setCipherId (int id)
	Set some arbitrary "cipher id" value. More...

void	setDecryptionMax (size_t count)
	Set the maximum number of times a key should be used for decryption. More...

void	setEncryptionMax (size_t count)
	Set the maximum number of times a key should be used for encryption. More...

virtual bool	setIV (const void *iv_data, size_t iv_length) override
	Set a new initialization vector. More...

bool	setKey (const void *key, size_t key_length, size_t rounds=0)
	Schedule a new key. More...

virtual bool	setShortIV (const void *iv_data, size_t iv_length)
	Set a new initialization vector for short blocks. More...

Static Public Attributes
static constexpr size_t	UNLIMITED = std::numeric_limits<size_t>::max()
	A constant meaning "may use a key an unlimited number of times".

Protected Member Functions
virtual bool	decryptImpl (const void cipher, size_t cipher_length, void plain, size_t plain_maxsize, size_t *plain_length) override
	Decrypt one block of data (implementation of algorithm-specific part). More...

virtual bool	decryptInPlaceImpl (void data, size_t data_length, size_t max_actual_length)
	Decrypt one block of data in place (implementation of algorithm-specific part). More...

virtual bool	encryptImpl (const void plain, size_t plain_length, void cipher, size_t cipher_maxsize, size_t *cipher_length) override
	Encrypt one block of data (implementation of algorithm-specific part). More...

virtual bool	encryptInPlaceImpl (void data, size_t data_length, size_t max_actual_length)
	Encrypt one block of data in place (implementation of algorithm-specific part). More...

virtual bool	setKeyImpl (const void *key, size_t key_length, size_t rounds) override
	Schedule a new key (implementation of algorithm-specific part). More...

Protected Attributes
BlockCipher *	algo
	An instance of the block cipher.

const size_t	block_size
	Shortcut for algo->blockSize().

ByteBlock	iv
	Current initialization vector.

const size_t	iv_max_size
	IV max size in bytes.

const size_t	iv_min_size
	IV min size in bytes.

ByteBlock	shortIV
	Current initialization vector for short blocks.

ByteBlock	work
	Temporary working buffer.

Detailed Description

template<class CIPHER>
class ts::DVS042< CIPHER >

DVS 042 cipher block chaining mode.

DVS 042 has been renamed as "ANSI/SCTE 52 2003". It used to be available at http://www.scte.org/documents/pdf/ANSISCTE522003DVS042.pdf This file is no longer online. The next iteration of this standard is now "ANSI/SCTE 52 2008", available at http://www.scte.org/documents/pdf/Standards/ANSI_SCTE%2052%202008.pdf

The only noticeable difference between the two versions is the handling of messages shorter than the block size. In the 2003 (DVS 042) version, the same IV (called "whitener" in the standard) is used for long and short messages. In the 2008 version, a different "whitener2" must be used for messages shorter than the block size.

The ATIS-0800006 standard (IDSA) uses the same chaining mode and residue processing as DVS-042 but is based on AES instead of DES.

Template Parameters

CIPHER A subclass of ts::BlockCipher, the underlying block cipher.

Member Function Documentation

◆ setShortIV()

template<class CIPHER >

virtual bool ts::DVS042< CIPHER >::setShortIV	(	const void *	iv_data,
		size_t	iv_length
	)

virtual

Set a new initialization vector for short blocks.

The method setIV() sets the IV for long blocks (longer than the block size) and short blocks (shorter than the block size). The latter can then be overwritten using setShortIV().

Parameters

[in]	iv_data	Address of IV.
[in]	iv_length	IV length in bytes.

Returns: True on success, false on error.

◆ minMessageSize()

template<class CIPHER >

virtual size_t ts::DVS042< CIPHER >::minMessageSize ( ) const

overridevirtual

Get the minimum message size.

Shorter data cannot be ciphered in this mode.

Returns: The minimum message size.

Implements ts::CipherChaining.

◆ residueAllowed()

template<class CIPHER >

virtual bool ts::DVS042< CIPHER >::residueAllowed ( ) const

overridevirtual

Check if the chaining mode can process residue after the last multiple of the block size.

Returns: True if the chaining mode can process residue after the last multiple of the block size.

Implements ts::CipherChaining.

◆ setIV()

template<class CIPHER >

virtual bool ts::DVS042< CIPHER >::setIV	(	const void *	iv_data,
		size_t	iv_length
	)

overridevirtual

Set a new initialization vector.

Parameters

[in]	iv_data	Address of IV.
[in]	iv_length	IV length in bytes.

Returns: True on success, false on error.

Reimplemented from ts::CipherChaining.

◆ name()

template<class CIPHER >

virtual UString ts::DVS042< CIPHER >::name ( ) const

overridevirtual

Algorithm name (informational only).

Returns: The algorithm name.

Implements ts::BlockCipher.

◆ encryptImpl()

template<class CIPHER >

virtual bool ts::DVS042< CIPHER >::encryptImpl	(	const void *	plain,
		size_t	plain_length,
		void *	cipher,
		size_t	cipher_maxsize,
		size_t *	cipher_length
	)

overrideprotectedvirtual

Encrypt one block of data (implementation of algorithm-specific part).

Parameters

[in]	plain	Address of plain text.
[in]	plain_length	Plain text length in bytes.
[out]	cipher	Address of buffer for cipher text.
[in]	cipher_maxsize	Size of cipher buffer.
[out]	cipher_length	Returned actual size of cipher text. Ignored if zero.

Returns: True on success, false on error.

Implements ts::BlockCipher.

◆ decryptImpl()

template<class CIPHER >

virtual bool ts::DVS042< CIPHER >::decryptImpl	(	const void *	cipher,
		size_t	cipher_length,
		void *	plain,
		size_t	plain_maxsize,
		size_t *	plain_length
	)

overrideprotectedvirtual

Decrypt one block of data (implementation of algorithm-specific part).

Parameters

[in]	cipher	Address of cipher text.
[in]	cipher_length	Cipher text length in bytes.
[out]	plain	Address of buffer for plain text.
[in]	plain_maxsize	Size of plain buffer.
[out]	plain_length	Returned actual size of plain text. Ignored if zero.

Returns: True on success, false on error.

Implements ts::BlockCipher.

◆ blockSize()

virtual size_t ts::CipherChaining::blockSize ( ) const

overridevirtualinherited

Size in bytes of the block used by the algorithm.

Returns: The size in bytes of the block used by the algorithm.

Implements ts::BlockCipher.

Reimplemented in ts::DVBCSA2.

◆ minKeySize()

virtual size_t ts::CipherChaining::minKeySize ( ) const

overridevirtualinherited

Minimum key sizes in bytes.

Returns: The minimum key sizes in bytes.

Implements ts::BlockCipher.

Reimplemented in ts::DVBCSA2.

◆ maxKeySize()

virtual size_t ts::CipherChaining::maxKeySize ( ) const

overridevirtualinherited

Maximum key sizes in bytes.

Returns: The maximum key sizes in bytes.

Implements ts::BlockCipher.

Reimplemented in ts::DVBCSA2.

◆ isValidKeySize()

virtual bool ts::CipherChaining::isValidKeySize ( size_t size ) const

overridevirtualinherited

Check if a size in bytes is a valid key size.

Parameters

[in] size Suggested key size in bytes.

Returns: True if size is a valid key size for the algorithm.

Implements ts::BlockCipher.

Reimplemented in ts::DVBCSA2.

◆ minRounds()

virtual size_t ts::CipherChaining::minRounds ( ) const

overridevirtualinherited

Minimum number of rounds for the algorithm.

Returns: The minimum number of rounds for the algorithm.

Implements ts::BlockCipher.

Reimplemented in ts::DVBCSA2.

◆ maxRounds()

virtual size_t ts::CipherChaining::maxRounds ( ) const

overridevirtualinherited

Maximum number of rounds for the algorithm.

Returns: The maximum number of rounds for the algorithm.

Implements ts::BlockCipher.

Reimplemented in ts::DVBCSA2.

◆ defaultRounds()

virtual size_t ts::CipherChaining::defaultRounds ( ) const

overridevirtualinherited

Default number of rounds for the algorithm.

Returns: The default number of rounds for the algorithm.

Implements ts::BlockCipher.

Reimplemented in ts::DVBCSA2.

◆ minIVSize()

virtual size_t ts::CipherChaining::minIVSize ( ) const

virtualinherited

Get the minimum IV sizes in bytes.

Returns: The minimum IV sizes in bytes.

Reimplemented in ts::DVBCSA2.

◆ maxIVSize()

virtual size_t ts::CipherChaining::maxIVSize ( ) const

virtualinherited

Get the maximum IV sizes in bytes.

Returns: The maximum IV sizes in bytes.

Reimplemented in ts::DVBCSA2.

◆ setKeyImpl()

virtual bool ts::CipherChaining::setKeyImpl	(	const void *	key,
		size_t	key_length,
		size_t	rounds
	)

overrideprotectedvirtualinherited

Schedule a new key (implementation of algorithm-specific part).

Parameters

[in]	key	Address of key value.
[in]	key_length	Key length in bytes.
[in]	rounds	Requested number of rounds. If zero, the default is used.

Returns: True on success, false on error.

Implements ts::BlockCipher.

Reimplemented in ts::DVBCSA2.

◆ setKey()

bool ts::BlockCipher::setKey	(	const void *	key,
		size_t	key_length,
		size_t	rounds = `0`
	)

inherited

Schedule a new key.

Parameters

[in]	key	Address of key value.
[in]	key_length	Key length in bytes.
[in]	rounds	Requested number of rounds. If zero, the default is used.

Returns: True on success, false on error.

◆ getKey()

bool ts::BlockCipher::getKey ( ByteBlock & key ) const

inherited

Get the current key.

Parameters

[out] key Current key value.

Returns: True on success, false if the key is unset or invalid.

◆ encrypt()

bool ts::BlockCipher::encrypt	(	const void *	plain,
		size_t	plain_length,
		void *	cipher,
		size_t	cipher_maxsize,
		size_t *	cipher_length = `nullptr`
	)

inherited

Encrypt one block of data.

For pure block ciphers such as AES or DES, the plain text and cipher text must have the block size of the algorithm. For cipher chainings, the acceptable message sizes depend on the chaining mode.

Parameters

[in]	plain	Address of plain text.
[in]	plain_length	Plain text length in bytes.
[out]	cipher	Address of buffer for cipher text.
[in]	cipher_maxsize	Size of cipher buffer.
[out]	cipher_length	Returned actual size of cipher text. Ignored if zero.

Returns: True on success, false on error.

◆ decrypt()

bool ts::BlockCipher::decrypt	(	const void *	cipher,
		size_t	cipher_length,
		void *	plain,
		size_t	plain_maxsize,
		size_t *	plain_length = `nullptr`
	)

inherited

Decrypt one block of data.

For pure block ciphers such as AES or DES, the plain text and cipher text must have the block size of the algorithm. For cipher chainings, the acceptable message sizes depend on the chaining mode.

Parameters

[in]	cipher	Address of cipher text.
[in]	cipher_length	Cipher text length in bytes.
[out]	plain	Address of buffer for plain text.
[in]	plain_maxsize	Size of plain buffer.
[out]	plain_length	Returned actual size of plain text. Ignored if zero.

Returns: True on success, false on error.

◆ encryptInPlace()

bool ts::BlockCipher::encryptInPlace	(	void *	data,
		size_t	data_length,
		size_t *	max_actual_length = `nullptr`
	)

inherited

Encrypt one block of data in place.

For pure block ciphers such as AES or DES, the plain text and cipher text must have the block size of the algorithm. For cipher chainings, the acceptable message sizes depend on the chaining mode.

Parameters

[in,out]	data	Address of data buffer to encrypt.
[in]	data_length	Input plain text length in bytes.
[in,out]	max_actual_length	Optional, ignored if zero. On input, contain the maximum size of the data buffer, which can be larger than data_length. On output, receive the actual size of the encrypted data. For pure block ciphers, this is the same as data_length. For cipher chainings with padding, this can be larger.

Returns: True on success, false on error.

◆ decryptInPlace()

bool ts::BlockCipher::decryptInPlace	(	void *	data,
		size_t	data_length,
		size_t *	max_actual_length = `nullptr`
	)

inherited

Decrypt one block of data in place.

For pure block ciphers such as AES or DES, the plain text and cipher text must have the block size of the algorithm. For cipher chainings, the acceptable message sizes depend on the chaining mode.

Parameters

[in,out]	data	Address of data buffer to decrypt.
[in]	data_length	Input cipher text length in bytes.
[in,out]	max_actual_length	Optional, ignored if zero. On input, contain the maximum size of the data buffer, which can be larger than data_length. On output, receive the actual size of the decrypted data. For pure block ciphers, this is the same as data_length. For cipher chainings with padding, this can be smaller.

Returns: True on success, false on error.

◆ encryptionCount()

size_t ts::BlockCipher::encryptionCount ( ) const

inlineinherited

Get the number of times the current key was used for encryption.

Returns: The number of times the current key was used for encryption.

◆ decryptionCount()

size_t ts::BlockCipher::decryptionCount ( ) const

inlineinherited

Get the number of times the current key was used for decryption.

Returns: The number of times the current key was used for decryption.

◆ setEncryptionMax()

void ts::BlockCipher::setEncryptionMax ( size_t count )

inlineinherited

Set the maximum number of times a key should be used for encryption.

The default initial value is UNLIMITED.

Parameters

[in] count The maximum number of times a key should be used for encryption.

◆ setDecryptionMax()

void ts::BlockCipher::setDecryptionMax ( size_t count )

inlineinherited

Set the maximum number of times a key should be used for decryption.

The default initial value is UNLIMITED.

Parameters

[in] count The maximum number of times a key should be used for decryption.

◆ encryptionMax()

size_t ts::BlockCipher::encryptionMax ( ) const

inlineinherited

Get the maximum number of times a key should be used for encryption.

Returns: The maximum number of times a key should be used for encryption.

◆ decryptionMax()

size_t ts::BlockCipher::decryptionMax ( ) const

inlineinherited

Get the maximum number of times a key should be used for decryption.

Returns: The maximum number of times a key should be used for decryption.

◆ setAlertHandler()

void ts::BlockCipher::setAlertHandler ( BlockCipherAlertInterface * handler )

inlineinherited

Set the handler to be notified on alert.

Only one handler can be set at a time.

Parameters

[in] handler Handler to set. Use a null pointer to remove the handler.

◆ setCipherId()

void ts::BlockCipher::setCipherId ( int id )

inlineinherited

Set some arbitrary "cipher id" value.

This value is chosen and set by the application and can be retrieved later. The cipher id is not interpreted by the block cipher engine, it is only stored for the application. The initial value of a cipher id is zero.

Parameters

[in] id Application-defined cipher id to assign.

◆ cipherId()

int ts::BlockCipher::cipherId ( ) const

inlineinherited

Get the "cipher id" value, as previously stored by the application.

Returns: The application-defined cipher id.

◆ encryptInPlaceImpl()

virtual bool ts::BlockCipher::encryptInPlaceImpl	(	void *	data,
		size_t	data_length,
		size_t *	max_actual_length
	)

protectedvirtualinherited

Encrypt one block of data in place (implementation of algorithm-specific part).

The default implementation is to call encryptImpl() and copy the data. A subclass may provide a more efficient implementation.

Parameters

[in,out]	data	Address of data buffer to encrypt.
[in]	data_length	Input plain text length in bytes.
[in,out]	max_actual_length	Optional, ignored if zero. On input, contain the maximum size of the data buffer, which can be larger than data_length. On output, receive the actual size of the encrypted data. For pure block ciphers, this is the same as data_length. For cipher chainings with padding, this can be larger.

Returns: True on success, false on error.

Reimplemented in ts::DVBCSA2.

◆ decryptInPlaceImpl()

virtual bool ts::BlockCipher::decryptInPlaceImpl	(	void *	data,
		size_t	data_length,
		size_t *	max_actual_length
	)

protectedvirtualinherited

Decrypt one block of data in place (implementation of algorithm-specific part).

The default implementation is to call decryptImpl() and copy the data. A subclass may provide a more efficient implementation.

Parameters

[in,out]	data	Address of data buffer to decrypt.
[in]	data_length	Input cipher text length in bytes.
[in,out]	max_actual_length	Optional, ignored if zero. On input, contain the maximum size of the data buffer, which can be larger than data_length. On output, receive the actual size of the decrypted data. For pure block ciphers, this is the same as data_length. For cipher chainings with padding, this can be smaller.

Returns: True on success, false on error.

Reimplemented in ts::DVBCSA2.

The documentation for this class was generated from the following file:

tsDVS042.h

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

template<class CIPHER> class ts::DVS042< CIPHER >

Member Function Documentation

◆ setShortIV()

◆ minMessageSize()

◆ residueAllowed()

◆ setIV()

◆ name()

◆ encryptImpl()

◆ decryptImpl()

◆ blockSize()

◆ minKeySize()

◆ maxKeySize()

◆ isValidKeySize()

◆ minRounds()

◆ maxRounds()

◆ defaultRounds()

◆ minIVSize()

◆ maxIVSize()

◆ setKeyImpl()

◆ setKey()

◆ getKey()

◆ encrypt()

◆ decrypt()

◆ encryptInPlace()

◆ decryptInPlace()

◆ encryptionCount()

◆ decryptionCount()

◆ setEncryptionMax()

◆ setDecryptionMax()

◆ encryptionMax()

◆ decryptionMax()

◆ setAlertHandler()

◆ setCipherId()

◆ cipherId()

◆ encryptInPlaceImpl()

◆ decryptInPlaceImpl()

template<class CIPHER>
class ts::DVS042< CIPHER >