/*

* Copyright (c) 2001-2006 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the License "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  EAP and WLAN authentication protocols.

*

*/

/*

*/

#if !defined( _EAP_CRYPTO_API_H_ )

#define _EAP_CRYPTO_API_H_

#include "eap_am_types.h"

#include "eap_variable_data.h"

#include "eap_am_export.h"

#include "abs_eap_am_crypto.h"

#include "eap_array.h"

#if defined(des_set_key)

// OpenSSL defines this.

#undef des_set_key

#endif //#if defined(des_set_key)

const u32_t HMAC_SHA1_SIZE = 20u; // bytes = 160 bits

const u32_t HMAC_SHA1_128_SIZE = 16u; // bytes = 128 bits

const u32_t HMAC_MD5_SIZE = 20u; // bytes = 160 bits

const u32_t HMAC_MD5_128_SIZE = 16u; // bytes = 128 bits

const u32_t WPA_PSK_LENGTH = 32;

/// The abs_crypto_block_algorithm_c class describes interface of CBC block encryption algorithm.

class EAP_EXPORT abs_crypto_cbc_block_algorithm_c

{

	// - - - - - - - - - - - - - - - - - - - - - - - -

private:

	// - - - - - - - - - - - - - - - - - - - - - - - -

	// - - - - - - - - - - - - - - - - - - - - - - - -

public:

	// - - - - - - - - - - - - - - - - - - - - - - - -

	EAP_FUNC_IMPORT virtual ~abs_crypto_cbc_block_algorithm_c();

	/**

	 * The set_is_valid() function sets the state of the

	 * abs_crypto_block_algorithm_c object valid. The abs_crypto_block_algorithm_c object 

	 * calls this function after it is initialized.

	 */

	virtual void set_is_valid() = 0;

	/**

	 * The get_is_valid() function returns the status of the abs_crypto_block_algorithm_c object.

	 * True indicates the object is initialized.

	 */

	virtual bool get_is_valid() = 0;

	// - - - - - - - - - - - - - - - - - - - - - - - -

	/**

	 * The get_encrypts() function returns true when encryption is initialized.

	 * It returns false when decryption is initialized.

	 */

	virtual bool get_encrypts() = 0;

	/**

	 * This function returns the length of AES key in bytes.

	 */

	virtual u32_t get_key_length() = 0;

	/**

	 * This function returns the length of AES block size in bytes.

	 */

	virtual u32_t get_block_size() = 0;

	/**

	 * Calculates the data length aligned to block size.

	 */

	virtual u32_t aligned_data_length(

		u32_t data_length) = 0;

	/**

	 * This function returns the internally stored initialization vector.

	 * The last encrypted and decrypted block is stored to this buffer 

	 * between subsequent encryption and decryption calls. 

	 * User of crypto_cbc_c object could get the last stored block calling this function.

	 */

	virtual const eap_variable_data_c * get_tmp_IV() = 0;

	/**

	 * This function adds count padding bytes to buffer. All padding bytes are zero (0x00).

	 */

	virtual eap_status_e add_padding_bytes(

		void * const buffer,

		const u32_t buffer_length,

		const u8_t padding_byte) = 0;

	/**

	 * This function checks the count padding bytes of buffer are zero (0x00).

	 */

	virtual eap_status_e check_padding_bytes(

		const void * const buffer,

		const u32_t buffer_length,

		const u8_t padding_byte) = 0;

	/**

	 * This function sets the mode to encryption, 

	 * sets the initialization vector and the encryption key.

	 */

	virtual eap_status_e set_encryption_key(

		const void * const encryption_IV,

		const u32_t encryption_IV_length,

		const void * const key,

		const u32_t key_length) = 0;

	/**

	 * This function sets the mode to decryption, 

	 * sets the initialization vector and the decryption key.

	 */

	virtual eap_status_e set_decryption_key(

		const void * const encryption_IV,

		const u32_t encryption_IV_length,

		const void * const key,

		const u32_t key_length) = 0;

	/**

	 * This function encrypts continuous data bytes from data_in to data_out buffer. 

	 * Note the length of the data must be aligned to block size of the cipher.

	 */

	virtual eap_status_e encrypt_data(

		const void * const data_in,

		void * const data_out,

		const u32_t data_length) = 0;

	/**

	 * This function encrypts continuous data bytes in data_in_out buffer. 

	 * Note the length of the data must be aligned to block size of the cipher.

	 */

	virtual eap_status_e encrypt_data(

		void * const data_in_out,

		const u32_t data_length) = 0;

	/**

	 * This function decrypts continuous data bytes from data_in to data_out buffer. 

	 * Note the length of the data must be aligned to block size of the cipher.

	 */

	virtual eap_status_e decrypt_data(

		const void * const data_in,

		void * const data_out,

		const u32_t data_length) = 0;

	/**

	 * This function decrypts continuous data bytes in data_in_out buffer. 

	 * Note the length of the data must be aligned to block size of the cipher.

	 */

	virtual eap_status_e decrypt_data(

		void * const data_in_out,

		const u32_t data_length) = 0;

	// - - - - - - - - - - - - - - - - - - - - - - - -

	/**

	 * The update_non_aligned() function updates the context of 

	 * AES-algorithm with data bytes. The direction (encryption/decryption) 

	 * depends of the initialized context. NOTE the length of data feed in 

	 * separate calls of update_non_aligned() does not need to be 

	 * aligned to AES-block size. Only the sum of whole data must be aligned to AES-block size.

	 * This version takes pointers to input and output buffers as a parameter. 

	 * Those buffers must be fully separated. Some optimizations are used 

	 * taking advance from separate buffers. 

	 */

	virtual eap_status_e update_non_aligned(

		const void * const msg_in,

		void * const msg_out,

		const u32_t msg_size) = 0;

	// - - - - - - - - - - - - - - - - - - - - - - - -

	/**

	 * The update_non_aligned() function updates the context of 

	 * AES-algorithm with data bytes. The direction (encryption/decryption) 

	 * depends of the initialized context. NOTE the length of data feed in 

	 * separate calls of update_non_aligned() does not need to be 

	 * aligned to AES-block size. Only the sum of whole data must be aligned to AES-block size.

	 * This version takes one pointer to buffer. The buffer is used for input and output data. 

	 */

	virtual eap_status_e update_non_aligned(

		void * const msg_in_out,

		const u32_t msg_size) = 0;

	// - - - - - - - - - - - - - - - - - - - - - - - -

	/**

	 * The finalize_non_aligned() finalizes the AES-context. 

	 * The sum of length of feed data must be aligned to AES-block size 

	 * before this function is called.

	 */

	virtual eap_status_e finalize_non_aligned() = 0;

	// - - - - - - - - - - - - - - - - - - - - - - - -

};

/// The abs_crypto_block_algorithm_c class describes interface of block encryption algorithm.

class EAP_EXPORT abs_crypto_block_algorithm_c

{

	// - - - - - - - - - - - - - - - - - - - - - - - -

private:

	// - - - - - - - - - - - - - - - - - - - - - - - -

	// - - - - - - - - - - - - - - - - - - - - - - - -

public:

	// - - - - - - - - - - - - - - - - - - - - - - - -

	EAP_FUNC_IMPORT virtual ~abs_crypto_block_algorithm_c();

	/**

	 * The set_is_valid() function sets the state of the

	 * abs_crypto_block_algorithm_c object valid. The abs_crypto_block_algorithm_c object 

	 * calls this function after it is initialized.

	 */

	virtual void set_is_valid() = 0;

	/**

	 * The get_is_valid() function returns the status of the abs_crypto_block_algorithm_c object.

	 * True indicates the object is initialized.

	 */

	virtual bool get_is_valid() = 0;

	// - - - - - - - - - - - - - - - - - - - - - - - -

	/**

	 * The get_encrypts() function returns true when encryption is initialized.

	 * It returns false when decryption is initialized.

	 */

	virtual bool get_encrypts() = 0;

	/**

	 * This function returns the length of key in bytes.

	 */

	virtual u32_t get_key_length() = 0;

	/**

	 * This function returns the length of block size in bytes.

	 */

	virtual u32_t get_block_size() = 0;

	/**

	 * This function sets the mode to encryption, 

	 * sets the initialization vector and the encryption key.

	 */

	virtual eap_status_e set_encryption_key(

		const void * const key,

		const u32_t key_length) = 0;

	/**

	 * This function sets the mode to decryption, 

	 * sets the initialization vector and the decryption key.

	 */

	virtual eap_status_e set_decryption_key(

		const void * const key,

		const u32_t key_length) = 0;

	/**

	 * This function encrypts continuous data bytes from data_in to data_out buffer. 

	 * Note the length of the data must be aligned to block size of the cipher.

	 */

	virtual eap_status_e encrypt_block(

		const void * const data_in,

		void * const data_out,

		const u32_t data_length) = 0;

	/**

	 * This function decrypts continuous data bytes from data_in to data_out buffer. 

	 * Note the length of the data must be aligned to block size of the cipher.

	 */

	virtual eap_status_e decrypt_block(

		const void * const data_in,

		void * const data_out,

		const u32_t data_length) = 0;

	// - - - - - - - - - - - - - - - - - - - - - - - -

};

/// The abs_crypto_stream_algorithm_c class describes interface of stream encryption algorithm.

class EAP_EXPORT abs_crypto_stream_algorithm_c

{

	// - - - - - - - - - - - - - - - - - - - - - - - -

private:

	// - - - - - - - - - - - - - - - - - - - - - - - -

	// - - - - - - - - - - - - - - - - - - - - - - - -

public:

	// - - - - - - - - - - - - - - - - - - - - - - - -

	EAP_FUNC_IMPORT virtual ~abs_crypto_stream_algorithm_c();

	/**

	 * The set_is_valid() function sets the state of the

	 * abs_crypto_block_algorithm_c object valid. The abs_crypto_block_algorithm_c object 

	 * calls this function after it is initialized.

	 */

	virtual void set_is_valid() = 0;

	/**

	 * The get_is_valid() function returns the status of the abs_crypto_block_algorithm_c object.

	 * True indicates the object is initialized.

	 */

	virtual bool get_is_valid() = 0;

	// - - - - - - - - - - - - - - - - - - - - - - - -

	/**

	 * This function sets the key.

	 */

	virtual eap_status_e set_key(

		const eap_variable_data_c * const key) = 0;

	/**

	 * This function discards desired count of stream.

	 */

	virtual eap_status_e discard_stream(const u32_t count_of_discarded_octets) = 0;

	/**

	 * This function encrypts continuous data bytes in data_in_out buffer. 

	 */

	virtual eap_status_e encrypt_data(

		void * const data_in_out,

		const u32_t data_length) = 0;

	/**

	 * This function encrypts continuous data bytes from data_in to data_out buffer. 

	 */

	virtual eap_status_e encrypt_data(

		const void * const data_in,

		void * const data_out,

		const u32_t data_length) = 0;

	/**

	 * This function encrypts continuous data bytes in data_in_out buffer. 

	 */

	virtual eap_status_e decrypt_data(

		void * const data_in_out,

		const u32_t data_length) = 0;

	/**

	 * This function decrypts continuous data bytes from data_in to data_out buffer. 

	 */

	virtual eap_status_e decrypt_data(

		const void * const data_in,

		void * const data_out,

		const u32_t data_length) = 0;

	// - - - - - - - - - - - - - - - - - - - - - - - -

};

/// The abs_crypto_hash_algorithm_c class describes interface the MAC algorithm.

class EAP_EXPORT abs_crypto_hash_algorithm_c

{

	// - - - - - - - - - - - - - - - - - - - - - - - -

private:

	// - - - - - - - - - - - - - - - - - - - - - - - -

	// - - - - - - - - - - - - - - - - - - - - - - - -

public:

	// - - - - - - - - - - - - - - - - - - - - - - - -

	EAP_FUNC_IMPORT virtual ~abs_crypto_hash_algorithm_c();

	/**

	 * The set_is_valid() function sets the state of the

	 * abs_crypto_hash_algorithm_c object valid. The abs_crypto_hash_algorithm_c object 

	 * calls this function after it is initialized.

	 */

	virtual void set_is_valid() = 0;

	/**

	 * The get_is_valid() function returns the status of the abs_crypto_hash_algorithm_c object.

	 * True indicates the object is initialized.

	 */

	virtual bool get_is_valid() = 0;

	// - - - - - - - - - - - - - - - - - - - - - - - -

	/**

	 * This function returns the size of message digest of HASH-algorithm.

	 */

	virtual u32_t get_digest_length() = 0;

	/**

	 * This function returns the block size of HASH-algorithm.

	 */

	virtual u32_t get_block_size() = 0;

	/**

	 * This function sets the mode to encryption, 

	 * sets the initialization vector and the encryption key.

	 */

	virtual eap_status_e hash_init() = 0;

	/**

	 * This function updates the context of HASH-algorithm with data.

	 */

	virtual eap_status_e hash_update(

		const void * const data,

		const u32_t data_length) = 0;

	/**

	 * This function writes the message digest to buffer. 

	 * Length is set if md_length_or_null is non-NULL.

	 */

	virtual eap_status_e hash_final(

		void * const message_digest,

		u32_t *md_length_or_null) = 0;

	/**

	 * This function cleans up the HMAC-SHA1 context.

	 */

	virtual eap_status_e hash_cleanup() = 0;

	/**

	 * This function returns a copy of the context of HASH-algorithm.

	 * Caller must free the copy.

	 */

	virtual abs_crypto_hash_algorithm_c * copy() = 0;

	// - - - - - - - - - - - - - - - - - - - - - - - -

};

//------------------------------------------------------------

/// The abs_crypto_mac_algorithm_c class describes interface the HMAC algorithm.

class EAP_EXPORT abs_crypto_hmac_algorithm_c

{

	// - - - - - - - - - - - - - - - - - - - - - - - -

private:

	// - - - - - - - - - - - - - - - - - - - - - - - -

	// - - - - - - - - - - - - - - - - - - - - - - - -

public:

	// - - - - - - - - - - - - - - - - - - - - - - - -

	EAP_FUNC_IMPORT virtual ~abs_crypto_hmac_algorithm_c();

	/**

	 * The set_is_valid() function sets the state of the

	 * abs_crypto_mac_algorithm_c object valid. The abs_crypto_mac_algorithm_c object 

	 * calls this function after it is initialized.

	 */

	virtual void set_is_valid() = 0;

	/**

	 * The get_is_valid() function returns the status of the abs_crypto_mac_algorithm_c object.

	 * True indicates the object is initialized.

	 */

	virtual bool get_is_valid() = 0;

	// - - - - - - - - - - - - - - - - - - - - - - - -

	/**

	 * This function returns the size of message digest of HMAC-algorithm.

	 */

	virtual u32_t get_digest_length() = 0;

	/**

	 * This function sets the mode to encryption, 

	 * sets the initialization vector and the encryption key.

	 */

	virtual eap_status_e hmac_set_key(

		const eap_variable_data_c * const mac_key) = 0;

	/**

	 * This function updates the context of HMAC-algorithm with data.

	 */

	virtual eap_status_e hmac_update(

		const void * const data,

		const u32_t data_length) = 0;

	/**

	 * This function writes the message digest to buffer. 

	 * Length is set if md_length_or_null is non-NULL.

	 */

	virtual eap_status_e hmac_final(

		void * const message_digest,

		u32_t *md_length_or_null) = 0;

	/**

	 * This function cleans up the HMAC context.

	 */

	virtual eap_status_e hmac_cleanup() = 0;

	// - - - - - - - - - - - - - - - - - - - - - - - -

};

//------------------------------------------------------------

/// The crypto_hmac_c class describes HMAC algorithm.