/*

* 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(_TLS_RECORD_H_)

#define _TLS_RECORD_H_

#include "abs_tls_am_services.h"

#include "tls_base_record.h"

#include "eap_array_algorithms.h"

#include "tls_message.h"

#include "tls_peap_types.h"

#include "abs_tls_message_hash.h"

#include "tls_completion.h"

#include "abs_tls_change_cipher_spec.h"

#include "abs_tls_base_application.h"

#include "tls_base_application.h"

#include "eap_protocol_layer.h"

#include "eap_am_network_id.h"

#include "eap_automatic_variable.h"

#include "eap_master_session_key.h"

class abs_tls_base_record_c;

class abs_eap_am_tools_c;

class eap_am_network_id_c;

class tls_record_header_c;

class tls_am_services_c;

class tls_handshake_header_c;

class tls_record_message_c;

class tls_handshake_message_c;

class abs_crypto_cbc_block_algorithm_c;

class abs_crypto_block_algorithm_c;

class abs_crypto_stream_algorithm_c;

#if defined(USE_FAST_EAP_TYPE)

#if !defined(USE_EAP_TLS_SESSION_TICKET)

#error ERROR: With USE_FAST_EAP_TYPE you must use USE_EAP_TLS_SESSION_TICKET flag too.

#endif //#if !defined(USE_EAP_TLS_SESSION_TICKET)

#endif //#if defined(USE_FAST_EAP_TYPE)

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

/**

 * The tls_record_c class implements tls_base_record_c.

 * See more detailed design and architecture document <a href="../../type/tls_peap/documentation/EAP_TLS_PEAP.doc">EAP_TLS_PEAP.doc</a>

 * and <a href="../../type/tls_peap/documentation/rfc2246.txt">RFC 2246</a>.

 */

class EAP_EXPORT tls_record_c

: public tls_base_record_c

, public abs_tls_am_services_c

, public abs_tls_message_hash_c

, public abs_tls_change_cipher_spec_c

, public abs_tls_apply_cipher_spec_c

, public abs_tls_base_application_c

{

private:

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

	/// This is pointer to the tools class. @see abs_eap_am_tools_c.

	abs_eap_am_tools_c * const m_am_tools;

	/// This is pointer to adaptation module of TLS.

	tls_am_services_c * m_am_tls_services;

	/// This flag tells whether the m_am_tls_services must be freed in destructor.

	const bool m_free_am_tls_services;

	/// This is pointer to application object. Mostly this is used in PEAP and the application is tls_application_eap_core_c object.

	tls_base_application_c * m_application;

	/// This flag tells whether the m_application must be freed in destructor.

	const bool m_free_application;

	/// This object includes pending asyncronous actions or it may be empty.

	/// The check_sent_tls_message() function call will check and complete pending actions.

	eap_array_c<tls_completion_c> m_completion_queue;

	/// This object includes received message in parsed tree.

	tls_message_c m_received_tls_message;

	/// This object includes the new created message in parsed tree.

	/// The send message will be generated from this.

	tls_message_c m_new_tls_message;

	/// This object includes MD5 HASH of received handshake messages.

	crypto_md5_c m_message_hash_md5;

	/// This object includes SHA1 HASH of received handshake messages.

	crypto_sha1_c m_message_hash_sha1;

	/// This object includes MD5 HASH for certificate verify message.

	eap_variable_data_c m_message_hash_md5_certificate_verify;

	/// This object includes SHA1 HASH for certificate verify message.

	eap_variable_data_c m_message_hash_sha1_certificate_verify;

	/// This object includes MD5 HASH of Finished message of client.

	eap_variable_data_c m_client_message_hash_md5_finished;

	/// This object includes SHA1 HASH of Finished message of client.

	eap_variable_data_c m_client_message_hash_sha1_finished;

	/// This object includes MD5 HASH of Finished message of server.

	eap_variable_data_c m_server_message_hash_md5_finished;

	/// This object includes SHA1 HASH of Finished message of server.

	eap_variable_data_c m_server_message_hash_sha1_finished;

	/// This object includes client random value for client handshake message.

	eap_variable_data_c m_client_handshake_random_value;

	/// This object includes server random value for server handshake message.

	eap_variable_data_c m_server_handshake_random_value;

	/// This object includes session ID.

	eap_variable_data_c m_session_id;

	/// This object includes master secret.

	eap_variable_data_c m_master_secret;

	/// This object includes EAP-TLS master session key.

	eap_master_session_key_c m_eap_master_session_key;

	/// This object includes shared secret key for MAC of send packets.

	eap_variable_data_c m_new_send_mac_key;

	/// This object includes shared secret key for MAC of received packets.

	eap_variable_data_c m_new_receive_mac_key;

	/// This object includes shared secret key for encryption of send packets.

	eap_variable_data_c m_new_send_encryption_key;

	/// This object includes shared secret key for decryption of received packets.

	eap_variable_data_c m_new_receive_encryption_key;

	/// This object includes initialization vector for block encryption of send packets.

	eap_variable_data_c m_new_send_iv;

	/// This object includes initialization vector for decryption of received packets.

	eap_variable_data_c m_new_receive_iv;

	/// This object includes shared secret key for MAC of send packets.

	eap_variable_data_c m_send_mac_key;

	/// This object includes shared secret key for MAC of received packets.

	eap_variable_data_c m_receive_mac_key;

	/// This object includes shared secret key for encryption of send packets.

	eap_variable_data_c m_send_encryption_key;

	/// This object includes shared secret key for decryption of received packets.

	eap_variable_data_c m_receive_encryption_key;

	/// This object includes initialization vector for block encryption of send packets.

	eap_variable_data_c m_send_iv;

	/// This object includes initialization vector for decryption of received packets.

	eap_variable_data_c m_receive_iv;

	/// This object includes session key seed for EAP-FAST.

	eap_variable_data_c m_session_key_seed;

	/// This object includes MsChapv2 challenges for EAP-FAST.

	eap_variable_data_c m_mschapv2_challenges;

	/// This object includes Diffie-Hellman private key of this TLS end point.

	eap_variable_data_c m_own_private_dhe_key;

	/// This object includes Diffie-Hellman public key of this TLS end point.

	eap_variable_data_c m_own_public_dhe_key;

	/// This object includes Diffie-Hellman public key of other TLS end point.

	eap_variable_data_c m_peer_public_dhe_key;

	/// This object includes Diffie-Hellman shared key of the TLS session.

	eap_variable_data_c m_shared_dh_key;

	/// This object includes Diffie-Hellman prime of the TLS session.

	eap_variable_data_c m_dhe_prime;

	/// This object includes Diffie-Hellman group generator of the TLS session.

	eap_variable_data_c m_dhe_group_generator;

	/// This object includes signed HASH. This is needed to store asyncronously completed signature creation.

	eap_variable_data_c m_signed_message_hash;

	/// This object includes the premaster secret.

	/// In RSA cipher suite client generates this and and encrypts with server public key.

	/// Server decrypts this within the client key exchange message and decrypts this with private key.

	/// In DHE cipher suite this is the shared Diffie-Hellman secret.

	eap_variable_data_c m_premaster_secret;

	/// This object includes encrypted premaster secret of this TLS end point.

	/// This is needed to store asyncronously completed result of encryption.

	eap_variable_data_c m_own_encrypted_premaster_secret;

#if defined(USE_FAST_EAP_TYPE)

	/// This object includes PAC-Key of EAP-FAST.

	/// PAC-Key is stored here before master secret can be generated.

	eap_variable_data_c m_eap_fast_pac_key;

#endif //#if defined(USE_FAST_EAP_TYPE)

	/// This object includes the proposed cipher suites.

	/// Objects are in host network order.

	/// Client creates this list and server receives the list in client hello handshake message.

	eap_array_c<u16_t> m_proposed_cipher_suites;

	/// This object includes the proposed compression methods.

	/// Client creates this list and server receives the list in client hello handshake message.

	eap_array_c<u8_t> m_proposed_compression_methods;

#if defined(USE_EAP_TLS_SESSION_TICKET)

	/// All supported TLS extensions.

	eap_array_c<tls_extension_c> m_supported_tls_extensions;

	/// All received TLS extensions.

	eap_array_c<tls_extension_c> m_received_tls_extensions;

#endif // #if defined(USE_EAP_TLS_SESSION_TICKET)

	/// This is the realm part of the NAI of the client.

	eap_variable_data_c m_NAI_realm;

	/// This is network identity of the sent packet from this authentication session.

	eap_am_network_id_c m_send_network_id;

	/// This object includes certificate chain of this TLS end point.

	/// This is needed to store asyncronously completed result of certificate chain qyery.

	eap_array_c<eap_variable_data_c> m_own_certificate_chain;

	/// This object includes certificate types required by this TLS end point.

	/// This is needed to store asyncronously completed result of certificate type qyery.

	eap_array_c<u8_t> m_own_certificate_types;

	/// This object includes certificate authorities required by this TLS end point.

	/// This is needed to store asyncronously completed result of certificate authorities qyery.

	eap_array_c<eap_variable_data_c> m_own_certificate_authorities;

	/// This object includes certificate chain of the other TLS end point.

	eap_array_c<eap_variable_data_c> m_peer_certificate_chain;

	/// This variable includes validity result of certificate chain of the other TLS end point.

	eap_status_e m_peer_certificate_chain_result;

	/// This variable includes validity result of signature verification of the received message that includes signature.

	eap_status_e m_verify_signature;

	/// This object includes certificate types of the other TLS end point.

	eap_array_c<u8_t> m_peer_certificate_types;

	/// This object includes certificate authorities of the other TLS end point.

	eap_array_c<eap_variable_data_c> m_peer_certificate_authorities;

	/// This is the resumed cipher suite from previous TLS session.

	tls_cipher_suites_e m_resumed_cipher_suite;

	/// This is the selected cipher suite for this TLS session.

	tls_cipher_suites_e m_selected_cipher_suite;

	/// This is the selected compression method for this TLS session.

	/// NOTE this is always null compression.

	tls_compression_method_e m_selected_compression_method;

	/// This is the active cipher suite of received packets for this TLS session.

	tls_cipher_suites_e m_receive_cipher_suite;

	/// This is the active compression method of received packets for this TLS session.

	/// NOTE this is always null compression.

	tls_compression_method_e m_receive_compression_method;

	/// This is the active cipher suite of send packets for this TLS session.

	tls_cipher_suites_e m_send_cipher_suite;

	/// This is the active compression method of send packets for this TLS session.

	/// NOTE this is always null compression.

	tls_compression_method_e m_send_compression_method;

	/// This is pointer to CBC block cipher algorithm of send packets when cipher suite uses block cipher.

	abs_crypto_cbc_block_algorithm_c *m_send_block_cipher;

	/// This is pointer to CBC block cipher algorithm of received packets when cipher suite uses block cipher.

	abs_crypto_cbc_block_algorithm_c *m_receive_block_cipher;

	/// This is pointer to stream cipher algorithm of send packets when cipher suite uses block cipher.

	abs_crypto_stream_algorithm_c *m_send_stream_cipher;

	/// This is pointer to stream cipher algorithm of received packets when cipher suite uses block cipher.

	abs_crypto_stream_algorithm_c *m_receive_stream_cipher;

	/// This is pointer to HMAC algorithm of send packets.

	abs_crypto_hmac_algorithm_c *m_send_hmac_algorithm;

	/// This is pointer to HMAC algorithm of received packets.

	abs_crypto_hmac_algorithm_c *m_receive_hmac_algorithm;

	/// This is the counter of send TLS-records. See chapters "6.2.3. Record payload protection"

	/// and "6.1. Connection states" from <a href="../../type/tls_peap/documentation/rfc2246.txt">RFC 2246</a>.

	/// Sequence number is initialized to zero and incrmented after each record is processed.

	u64_t m_send_record_sequence_number;

	/// This is the counter of received TLS-records. See chapters "6.2.3. Record payload protection"

	/// and "6.1. Connection states" from <a href="../../type/tls_peap/documentation/rfc2246.txt">RFC 2246</a>.

	/// Sequence number is initialized to zero and incrmented after each record is processed.

	u64_t m_receive_record_sequence_number;

	/// This variable stored the internal state of TLS-session. See tls_peap_state_e.

	tls_peap_state_e m_tls_peap_state;

	/// This flag tells which TLS session type is selected,

	/// full authentication, original session resumption or stateless session resumption (RFC 4507).

	tls_session_type_e m_tls_session_type;

	/// This is the EAP-type (TLS, PEAP or TTLS).

	eap_type_value_e m_eap_type;

	/// This separates different PEAP versions (PEAPv2, PEAPv1 or XP PEAPv0).

	peap_version_e m_peap_version;

	/// This variable stores the state of tunneled EAP-authentication.

	eap_state_variable_e m_tunneled_eap_type_authentication_state;

	/// This variable saves the EAP-identifier of the last received EAP-message.

	u8_t m_received_eap_identifier;

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

	bool m_is_valid;

	/// This indicates whether this object is client (true) or server (false).

	const bool m_is_client;

	/// This flag tells whether messages could be send in the check_sent_tls_message() function.

	bool m_allow_message_send;

	/// This flag prevents recursive calls of the completion_action_check() function.

	bool m_already_in_completion_action_check;

	/// This flag prevents recursive calls of the process_tls_records() function.

	bool m_already_in_process_tls_records;

	/// This flag tells whether this function call is pending (true value).

	/// After this function call is completed with appropriate completion function flag is set to false value.

	bool m_pending_query_certificate_authorities_and_types;

	/// This flag tells whether this function call is pending (true value).

	/// After this function call is completed with appropriate completion function flag is set to false value.

	bool m_pending_query_certificate_chain;

	/// This flag tells whether this function call is pending (true value).

	/// After this function call is completed with appropriate completion function flag is set to false value.

	bool m_pending_query_cipher_suites_and_previous_session;

	/// This flag tells whether this function call is pending (true value).

	/// After this function call is completed with appropriate completion function flag is set to false value.

	bool m_pending_query_dh_parameters;

	/// This flag tells whether this function call is pending (true value).

	/// After this function call is completed with appropriate completion function flag is set to false value.

	bool m_pending_query_realm;

	/// This flag tells whether this function call is pending (true value).

	/// After this function call is completed with appropriate completion function flag is set to false value.

	bool m_pending_select_cipher_suite_and_check_session_id;

	/// This flag tells whether this function call is pending (true value).

	/// After this function call is completed with appropriate completion function flag is set to false value.

	bool m_pending_verify_certificate_chain;

	/// This flag tells whether this function call is pending (true value).

	/// After this function call is completed with appropriate completion function flag is set to false value.

	bool m_pending_rsa_decrypt_with_private_key;

	/// This flag tells whether this function call is pending (true value).

	/// After this function call is completed with appropriate completion function flag is set to false value.

	bool m_pending_rsa_encrypt_with_public_key;

	/// This flag tells whether this function call is pending (true value).

	/// After this function call is completed with appropriate completion function flag is set to false value.

	bool m_pending_sign_with_private_key;

	/// This flag tells whether this function call is pending (true value).

	/// After this function call is completed with appropriate completion function flag is set to false value.

	bool m_pending_verify_with_public_key;

	/// This flag tells whether this function call is pending (true value).

	/// After this function call is completed with appropriate completion function flag is set to false value.

	bool m_pending_query_tunnel_PAC;

	/// This flag tells whether this instance is test version (true) or real version (false).

	/// Test version allows many subsequent TLS-sessions.

	bool m_tls_peap_test_version;

	/// The flag prevents multiple call of generate_key_material() function.

	bool m_key_material_generated;

	/// This flag tells whether the server authenticates client (true) or not (false).

	/// NOTE: Server and client read this value from it's configuration.

	/// Server acts as this flag says.

	/// Client does allow only client and server mutual authentication when this flag is true.

	/// Client does allow server authentication too when this flag is false.

	bool m_tls_peap_server_authenticates_client_policy_flag;

	/// Server reads this from configure.

	/// Server initiates mutual authentication when value is true.

	/// Server initiates server authentication when value is false.

	bool m_tls_peap_server_authenticates_client_config_server;

	/// Client and server set this flag to indicate the current function.

	/// Action is mutual authentication when value is true.

	/// Action is server authentication when value is false.

	bool m_tls_peap_server_authenticates_client_action;

	/// Client uses this flag to remember the the certificate request message.

	bool m_tls_peap_server_requested_client_certificate;

	/// This flag tells whether we could send fatal TLS-alert message (true) or not (false).

	/// This is set false after we receive one TLS-alert message.

	bool m_could_send_fatal_alert_message;

	/// This flag tells whether we could send warning TLS-alert message (true) or not (false).

	/// This is set false after we receive one TLS-alert message.

	bool m_could_send_warning_alert_message;

	/// This flag tells whether the check_sent_tls_message() must send TLS-alert message (true) or not (false).

	/// This flag is set after the TLS-alert message is generated. This flag forses send of the TLS-alert message.

	bool m_force_tls_message_send;

	/// This flag tells whether the shutdown() function was called (true) or not (false).

	bool m_shutdown_was_called;

	/// This flag tells whether TLS-messages should be set to separate TLS-records (true) or TLS-message should

	/// be packed to same TLS-record if it is possible (false).

	bool m_use_separate_tls_record;

	/// This flag tells whether extra padding of block cipher should be used.

	bool m_use_extra_padding_length;

	/// NOTE this is against the RFC 2246 The TLS Protocol Version 1.0.

	/// Look at chapter 7.4.4. Certificate request.

	bool m_client_allows_empty_certificate_authorities_list;

	/// NOTE this is against the RFC 2246 The TLS Protocol Version 1.0.

	/// Look at chapter 7.4.4. Certificate request.

	bool m_server_sends_empty_certificate_authorities_list;

	/// This configurable option selects whether the special TLS/PEAP style

	/// is used, the length field is added to all message fragments

	/// even the message fits to one fragment except EAP-TLS-start, EAP-TLS-Acknowledge and

	/// PEAP-application data. The client acknowledges tunneled EAP-Success message

	/// with empty PEAP message.

	bool m_use_tppd_tls_peap;

	/// On fast session resume server does not send tunneled EAP-Success.

	/// Instead it sends plain EAP-Success.

	/// True value of this flag allows this plain EAP-Success.

	bool m_use_tppd_peapv1_acknowledge_hack;

	/// This configuration flag tells the server will offer new session ID to client.

	bool m_server_offers_new_session_id;

	/// Client will receive a new session ticket in NewSessionTicket message.

	bool m_will_receive_new_session_ticket;

	/// True value means EAP-FAST server sends piggypacked EAP-Identity/Request.

	/// False value means EAP-FAST server does not send piggypacked EAP-Identity/Request, instead it waits empty Ack-message from client.

	bool m_send_piggypacked_eap_identity_request;

#if defined(USE_EAP_TLS_IDENTITY_PRIVACY)

	/// Flag causes TLS client to use privacy.

	bool m_tls_use_identity_privacy;

	/// Variable tells state of TLS identity privacy handshake.

	tls_identity_privacy_handshake_state_e m_tls_identity_privacy_handshake_state;

#endif //#if defined(USE_EAP_TLS_IDENTITY_PRIVACY)

#if defined(USE_FAST_EAP_TYPE)

	/// This flag allows use of dynamic provisioning of PAC in Server-Unauthenticated Mode.

	/// This is called also Authenticated Diffie-Hellman Protocol (ADHP).

	bool m_eap_fast_allow_server_unauthenticated_provisioning_mode_ADHP;

	/// This flag allows use of dynamic provisioning of PAC in Server-Authenticated Mode.