/*

* 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_AM_CRYPTO_OPENSSL_H_ )

#define _EAP_AM_CRYPTO_OPENSSL_H_

#include "eap_am_types.h"

#include "eap_variable_data.h"

#include "eap_am_export.h"

#include "eap_am_tools.h"

#include "eap_array.h"

#include "abs_eap_am_crypto.h"

#if defined(USE_EAP_RANDOM_TEST)

#include "eap_am_random_test.h"

#endif //#if defined(USE_EAP_RANDOM_TEST)

#if defined(des_set_key)

// OpenSSL defines this.

#undef des_set_key

#endif //#if defined(des_set_key)

class abs_eap_am_tools_c;

class eap_variable_data_c;

const u32_t EAP_HW_TICKS_SEED_BUFFER_SIZE = 8u;

/// Class eap_am_crypto_openssl_c offers services to authenticate data,

/// encrypt data, decrypt data, generate keys and generate cryptographically

/// strong random data.

class EAP_EXPORT eap_am_crypto_openssl_c 

: public abs_eap_am_crypto_c

{

private:

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

	/// This is pointer to the tools class.

	abs_eap_am_tools_c * const m_am_tools;

#if defined(USE_EAP_RANDOM_TEST)

	/// This is used because of the random generator of OpenSSL does some

	/// memory violations that valgrind founds.

	eap_am_random_test_c m_test_random;

#endif //#if defined(USE_EAP_RANDOM_TEST)

	bool m_use_test_random;

	/// This indicates whether this object was generated successfully.

	bool m_is_valid;

	u8_t m_hw_ticks_seed_buffer[EAP_HW_TICKS_SEED_BUFFER_SIZE];

	u32_t m_hw_ticks_seed_index;

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

public:

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

	static abs_eap_am_tools_c * g_tools;

	/**

	 * Destructor does nothing special.

	 */

	EAP_FUNC_IMPORT virtual ~eap_am_crypto_openssl_c();

	/**

	 * Constructor initializes the member attributes.

	 */

	EAP_FUNC_IMPORT eap_am_crypto_openssl_c(abs_eap_am_tools_c * const tools);

	/**

	 * The configure() function is called after the constructor of the 

	 * object is successfully executed. During the function call the object 

	 * could query the configuration. Each derived class must define this

	 * function. Needed configuration depends on the implementation.

	 */

	EAP_FUNC_IMPORT eap_status_e configure();

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

	EAP_FUNC_IMPORT bool get_is_valid() const

	{

		return m_is_valid;

	}

	EAP_FUNC_IMPORT void set_is_valid()

	{

		m_is_valid = true;

	}

	/**

	 * This function activates random generator for test use.

	 * It does generate predictive pseudorandom data.

	 */

	EAP_FUNC_IMPORT void use_test_random(

		const u8_t * const seed,

		const u32_t seed_length,

		const bool does_continuous_seeding_when_true);

	/**

	 * The get_rand_bytes() function fills count random bytes to buffer.

	 */

	EAP_FUNC_IMPORT eap_status_e get_rand_bytes(

		u8_t * const buffer,

		const u32_t count);

	/**

	 * The add_rand_seed() function seeds count bytes from buffer to the

	 * random data pool. The seed bytes could be any data that increases

	 * entropy of the random data pool. For example time stamps of send

	 * and received messages, likewise addresses, cookies and nonces

	 * included in messages.

	 */

	EAP_FUNC_IMPORT eap_status_e add_rand_seed(

		const u8_t * const buffer,

		const u32_t count);

	/**

	 * The add_rand_seed_hw_ticks() function adds hardware ticks read with 

	 * the abs_eap_am_tools::get_hardware_ticks()  function. This could be

	 * used to seed the random data pool with time stamps.

	 */

	EAP_FUNC_IMPORT eap_status_e add_rand_seed_hw_ticks();

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

	/**

	 * The generate_diffie_hellman_keys() function generates private and

	 * public Diffie-Hellman keys. 

	 * @param dh_context Saves context here. It is private key in OpenSSL

	 * and CDHKey in Symbian.

	 */

	EAP_FUNC_IMPORT eap_status_e generate_diffie_hellman_keys(

		eap_variable_data_c * const dh_context,

		eap_variable_data_c * const own_public_dh_key,

		const u8_t * const prime,

		const u32_t prime_length,

		const u8_t * const group_generator,

		const u32_t group_generator_length);

	/**

	 * The generate_g_power_to_xy() function generates shared secret 

	 * Diffie-Hellman key from own_private_dh_key and peer_public_dh_key.

	 * @param dh_context Gets context. Is private key in OpenSSL and

	 * CDHKey in Symbian.

	 */

	EAP_FUNC_IMPORT eap_status_e generate_g_power_to_xy(

		const eap_variable_data_c * const dh_context,

		const eap_variable_data_c * const peer_public_dh_key,

		eap_variable_data_c * const shared_dh_key,

		const u8_t * const prime,

		const u32_t prime_length,

		const u8_t * const group_generator,

		const u32_t group_generator_length);

	/**

	 * This functions cleans up the diffie-hellman context.

	 */

	EAP_FUNC_IMPORT eap_status_e dh_cleanup(

		const eap_variable_data_c * const dh_context);

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

	/**

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

	 */

	 EAP_FUNC_IMPORT u32_t get_sha_256_digest_length(

		eap_variable_data_c * const sha_256_context);

	/**

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

	 */

	 EAP_FUNC_IMPORT u32_t get_sha_256_block_size(

		eap_variable_data_c * const sha_256_context);

	/**

	 * The sha_256_init() function initializes SHA1.

	 * Internal context of SHA1 is stored to sha_256_context.

	 */

	 EAP_FUNC_IMPORT eap_status_e sha_256_init(

		eap_variable_data_c * const sha_256_context);

	/**

	 * The sha_256_update() function updates the context of 

	 * sha_256_context with data_length bytes of data.

	 */

	 EAP_FUNC_IMPORT eap_status_e sha_256_update(

		eap_variable_data_c * const sha_256_context,

		const u8_t * const data,

		const u32_t data_length);

	/**

	 * The sha_256_final() function writes the message authentication code 

	 * (MAC) to buffer pointed by message_digest. The length of MAC is stored 

	 * to buffer pointed by md_length_or_null, If md_length_or_null is non NULL.

	 */

	 EAP_FUNC_IMPORT eap_status_e sha_256_final(

		eap_variable_data_c * const sha_256_context,

		u8_t * const message_digest,

		u32_t *md_length_or_null);

	/**

	 * The hmac_sha_256_cleanup() cleanups the SHA1 context.

	 */

	 EAP_FUNC_IMPORT eap_status_e sha_256_cleanup(

		eap_variable_data_c * const sha_256_context);

	/**

	 * The sha_256_copy_context() copies the SHA1 context.

	 */

	 EAP_FUNC_IMPORT eap_status_e sha_256_copy_context(

		eap_variable_data_c * const copied_sha_256_context,

		const eap_variable_data_c * const original_sha_256_context);

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

	/**

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

	 */

	EAP_FUNC_IMPORT u32_t get_sha1_digest_length(

		eap_variable_data_c * const sha1_context);

	/**

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

	 */

	EAP_FUNC_IMPORT u32_t get_sha1_block_size(

		eap_variable_data_c * const sha1_context);

	/**

	 * The sha1_init() function initializes SHA1.

	 * Internal context of SHA1 is stored to sha1_context.

	 */

	EAP_FUNC_IMPORT eap_status_e sha1_init(

		eap_variable_data_c * const sha1_context);

	/**

	 * The sha1_update() function updates the context of 

	 * sha1_context with data_length bytes of data.

	 */

	EAP_FUNC_IMPORT eap_status_e sha1_update(

		eap_variable_data_c * const sha1_context,

		const u8_t * const data,

		const u32_t data_length);

	/**

	 * The sha1_final() function writes the message authentication code 

	 * (MAC) to buffer pointed by message_digest. The length of MAC is stored 

	 * to buffer pointed by md_length_or_null, If md_length_or_null is non

	 * NULL.

	 */

	EAP_FUNC_IMPORT eap_status_e sha1_final(

		eap_variable_data_c * const sha1_context,

		u8_t * const message_digest,

		u32_t *md_length_or_null);

	/**

	 * The hmac_sha1_cleanup() cleanups the SHA1 context.

	 */

	EAP_FUNC_IMPORT eap_status_e sha1_cleanup(

		eap_variable_data_c * const sha1_context);

	/**

	 * The sha1_copy_context() copies the SHA1 context.

	 */

	EAP_FUNC_IMPORT eap_status_e sha1_copy_context(

		eap_variable_data_c * const copied_sha1_context,

		const eap_variable_data_c * const original_sha1_context);

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

	/**

	 * The aes_key_length() function returns the length of key AES-algorithm. 

	 * This will be constant 16 bytes (128 bits). Still it is better use

	 * function to help changes if the length of key is changed in future. 

	 */

	EAP_FUNC_IMPORT u32_t aes_key_length();

	/**

	 * The aes_block_size() function returns the block size of AES-algorithm. 

	 * This will be constant 16 bytes (128 bits). Still it is better use

	 * function to help changes if the size is changed in future.

	 */

	EAP_FUNC_IMPORT u32_t aes_block_size();

	/**

	 * The aes_set_encryption_key() function initializes the encryption 

	 * context of AES-algorithm to the aes_context using key_length bytes

	 * from buffer key. 

	 */

	EAP_FUNC_IMPORT eap_status_e aes_set_encryption_key(

		eap_variable_data_c * const aes_context,

		const u8_t * const key,

		const u32_t key_length);

	/**

	 * The aes_set_decryption_key() function initializes the decryption

	 * context of 

	 * AES-algorithm to the aes_context using key_length bytes from buffer key.

	 */

	EAP_FUNC_IMPORT eap_status_e aes_set_decryption_key(

		eap_variable_data_c * const aes_context,

		const u8_t * const key,

		const u32_t key_length);

	EAP_FUNC_IMPORT eap_status_e aes_cleanup(

		eap_variable_data_c * const aes_context);

	/**

	 * The aes_encrypt_block() function encrypts data of data_length bytes 

	 * using encryption_IV initialization vector. NOTE the length of data must 

	 * be aligned to block size of AES-algorithm.

	 * 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. 

	 */

	EAP_FUNC_IMPORT eap_status_e aes_encrypt_block(

		eap_variable_data_c * const aes_context,

		const u8_t * const data_in,

		u8_t * const data_out,

		const u32_t data_length);

	/**

	 * The aes_decrypt_block() function decrypts data of data_length bytes 

	 * using decryption_IV initialization vector. NOTE the length of data must 

	 * be aligned to block size of AES-algorithm.

	 * 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.

	 */

	EAP_FUNC_IMPORT eap_status_e aes_decrypt_block(

		eap_variable_data_c * const aes_context,

		const u8_t * const data_in,

		u8_t * const data_out,

		const u32_t data_length);

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

	/**

	 * The key_length() function returns the length of key 3DES-EDE-algorithm. 

	 * This will be constant 16 bytes (128 bits). Still it is better use

	 * function to help changes if the length of key is changed in future. 

	 */

	EAP_FUNC_IMPORT u32_t key_length_3des_ede();

	/**

	 * The block_size() function returns the block size of 3DES-EDE-algorithm. 

	 * This will be constant 16 bytes (128 bits). Still it is better use

	 * function to help changes if the size is changed in future.

	 */

	EAP_FUNC_IMPORT u32_t block_size_3des_ede();

	/**

	 * The cbc_set_encryption_key() function initializes the encryption 

	 * context of 3DES-EDE-algorithm to the context using key_length bytes

	 * from buffer key. 

	 */

	EAP_FUNC_IMPORT eap_status_e set_encryption_key_3des_ede(

		eap_variable_data_c * const context,

		const u8_t * const key,

		const u32_t key_length);

	/**

	 * The cbc_set_decryption_key() function initializes the decryption

	 * context of 3DES-EDE-algorithm to the context using key_length bytes

	 * from buffer key.

	 */

	EAP_FUNC_IMPORT eap_status_e set_decryption_key_3des_ede(

		eap_variable_data_c * const context,

		const u8_t * const key,

		const u32_t key_length);

	EAP_FUNC_IMPORT eap_status_e cleanup_3des_ede(

		eap_variable_data_c * const context);

	/**

	 * The cbc_encrypt_data() function encrypts data of data_length bytes 

	 * using encryption_IV initialization vector. NOTE the length of data must 

	 * be aligned to block size of 3DES-EDE-algorithm.

	 * 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. 

	 */

	EAP_FUNC_IMPORT eap_status_e encrypt_block_3des_ede(

		eap_variable_data_c * const context,

		const u8_t * const data_in,

		u8_t * const data_out,

		const u32_t data_length);

	/**

	 * The cbc_decrypt_data() function decrypts data of data_length bytes 

	 * using decryption_IV initialization vector. NOTE the length of data must 

	 * be aligned to block size of 3DES-EDE-algorithm.

	 * 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.

	 */

	EAP_FUNC_IMPORT eap_status_e decrypt_block_3des_ede(

		eap_variable_data_c * const context,

		const u8_t * const data_in,

		u8_t * const data_out,

		const u32_t data_length);

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

	/**

	 * Key derivation is based on the random number generation specified in

	 * NIST Federal Information Processing Standards (FIPS) Publication

	 * 186-2 [9]. The random number generator is specified in the change

	 * notice 1 (2001 October 5) of [9] (Algorithm 1). As specified in the

	 * change notice (page 74), when Algorithm 1 is used as a general-

	 * purpose random number generator, the "mod q" term in step 3.3 is

	 * omitted. The function G used in the algorithm is constructed via

	 * Secure Hash Standard as specified in Appendix 3.3 of the standard.

	 * 160-bit XKEY and XVAL values are used, so b = 160. The initial

	 * secret seed value XKEY is computed from the n GSM Kc keys and the

	 * NONCE_MT with the following formula:

	 * @code

	 * XKEY = SHA1(n*Kc| NONCE_MT)

	 * 

	 * Random generator becomes as follows:

	 * Step 1. Choose a new, secret value for the seed-key, XKEY.

	 * Step 2. In hexadecimal notation let

	 *         t = 67452301 EFCDAB89 98BADCFE 10325476 C3D2E1F0.

	 *         This is the initial value for H0 || H1 || H2 || H3 || H4

	 *         in the SHS.

	 * Step 3. For j = 0 to m - 1 do

	 *             c. xj = G(t,XKEY).

	 *             d. XKEY = (1 + XKEY + xj) mod 2^b.

	 * @endcode

	 */

	EAP_FUNC_IMPORT eap_status_e dss_pseudo_random(

		u8_t *out,

		u32_t out_length,

		u8_t *xkey,

		u32_t xkey_length);

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

	/**

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

	 */

	EAP_FUNC_IMPORT u32_t get_md5_digest_length(

		eap_variable_data_c * const md5_context);

	/**

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

	 */

	EAP_FUNC_IMPORT u32_t get_md5_block_size(

		eap_variable_data_c * const md5_context);

	/**

	 * The sha1_init() function initializes MD5.

	 * Internal context of MD5 is stored to sha1_context.

	 */

	EAP_FUNC_IMPORT eap_status_e md5_init(

		eap_variable_data_c * const md5_context);

	/**

	 * The md5_update() function updates the context of 

	 * md5_context with data_length bytes of data.

	 */

	EAP_FUNC_IMPORT eap_status_e md5_update(

		eap_variable_data_c * const md5_context,

		const u8_t * const data,

		const u32_t data_length);

	/**

	 * The md5_final() function writes the message authentication code 

	 * (MAC) to buffer pointed by message_digest. The length of MAC is stored 

	 * to buffer pointed by md_length_or_null, If md_length_or_null is non

	 * NULL.

	 */

	EAP_FUNC_IMPORT eap_status_e md5_final(

		eap_variable_data_c * const md5_context,

		u8_t * const message_digest,

		u32_t *md_length_or_null);

	/**

	 * The hmac_md5_cleanup() cleanups the MD5 context.

	 */

	EAP_FUNC_IMPORT eap_status_e md5_cleanup(

		eap_variable_data_c * const md5_context);

	/**

	 * The md5_copy_context() copies the MD5 context.

	 */

	 EAP_FUNC_IMPORT eap_status_e md5_copy_context(

		eap_variable_data_c * const copied_md5_context,

		const eap_variable_data_c * const original_md5_context);

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

	/**

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

	 */

	EAP_FUNC_IMPORT u32_t get_md4_digest_length(

		eap_variable_data_c * const md4_context);

	/**

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

	 */

	EAP_FUNC_IMPORT u32_t get_md4_block_size(

		eap_variable_data_c * const md4_context);

	/**

	 * The sha1_init() function initializes MD4.

	 * Internal context of MD4 is stored to sha1_context.

	 */

	EAP_FUNC_IMPORT eap_status_e md4_init(

		eap_variable_data_c * const md4_context);