eapol/eapol_framework/eapol_common/type/mschapv2/include/eap_type_mschapv2_types.h
changeset 0 c8830336c852
child 2 1c7bc153c08e
equal deleted inserted replaced
-1:000000000000 0:c8830336c852
       
     1 /*
       
     2 * Copyright (c) 2001-2006 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of the License "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  EAP and WLAN authentication protocols.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #ifndef _MSCHAPV2_TYPES_H_
       
    22 #define _MSCHAPV2_TYPES_H_
       
    23 
       
    24 #include "eap_configuration_field.h"
       
    25 
       
    26 const u32_t EAP_MSCHAPV2_USERNAME_MAX_SIZE = 512; // 256 unicode-chars
       
    27 const u32_t EAP_MSCHAPV2_PASSWORD_MAX_SIZE = 512; // 256 unicode-chars
       
    28 
       
    29 const u32_t EAP_MSCHAPV2_AUTHENTICATOR_RESPONSE_SIZE = 42;
       
    30 const u32_t EAP_MSCHAPV2_CHALLENGE_HASH_SIZE = 8;
       
    31 const u32_t EAP_MSCHAPV2_NT_RESPONSE_SIZE = 24;
       
    32 const u32_t EAP_MSCHAPV2_AUTHENTICATOR_CHALLENGE_SIZE = 16;
       
    33 const u32_t EAP_MSCHAPV2_PEER_CHALLENGE_SIZE = 16;
       
    34 const u32_t EAP_MSCHAPV2_IDENT_SIZE = 1;
       
    35 const u32_t EAP_MSCHAPV2_FLAGS_SIZE = 1;
       
    36 const u32_t EAP_MSCHAPV2_OPCODE_SIZE = 1;
       
    37 const u32_t EAP_MSCHAPV2_CHANGE_PASSWORD_FLAGS_SIZE = 2;
       
    38 const u32_t EAP_MSCHAPV2_RESERVED_RESPONSE_SIZE = 8;
       
    39 const u32_t EAP_MSCHAPV2_MD4_DIGEST_SIZE = 16;
       
    40 const u32_t EAP_MSCHAPV2_SHA1_DIGEST_SIZE = 20;
       
    41 const u32_t EAP_MSCHAPV2_DES_KEY_SIZE = 8;
       
    42 const u32_t EAP_MSCHAPV2_DES_BLOCK_SIZE = 8;
       
    43 
       
    44 const u32_t EAP_MSCHAPV2_RESPONSE_MESSAGE_SIZE
       
    45 	= EAP_MSCHAPV2_IDENT_SIZE
       
    46 	+ EAP_MSCHAPV2_FLAGS_SIZE
       
    47 	+ EAP_MSCHAPV2_PEER_CHALLENGE_SIZE
       
    48 	+ EAP_MSCHAPV2_RESERVED_RESPONSE_SIZE
       
    49 	+ EAP_MSCHAPV2_NT_RESPONSE_SIZE;
       
    50 
       
    51 const u32_t EAP_MSCHAPV2_PEER_CHALLENGE_OFFSET
       
    52 	= EAP_MSCHAPV2_IDENT_SIZE
       
    53 	+ EAP_MSCHAPV2_FLAGS_SIZE;
       
    54 
       
    55 const u32_t EAP_MSCHAPV2_NT_RESPONSE_OFFSET
       
    56 	= EAP_MSCHAPV2_PEER_CHALLENGE_OFFSET
       
    57 	+ EAP_MSCHAPV2_PEER_CHALLENGE_SIZE
       
    58 	+ EAP_MSCHAPV2_RESERVED_RESPONSE_SIZE;
       
    59 
       
    60 
       
    61 const u32_t EAP_MSCHAPV2_MASTER_KEY_SIZE = 16;
       
    62 
       
    63 const u32_t EAP_MSCHAPV2_SUCCESS_REQUEST_MESSAGE_MIN_LENGTH = 42;// "S=<40>"
       
    64 const u32_t EAP_MSCHAPV2_FAILURE_MIN_SIZE = 48;
       
    65 const u32_t EAP_MSCHAPV2_FAILURE_REQUEST_SIZE = 67; // "E=eeeeeeeeee R=r C=cccccccccccccccccccccccccccccccc V=vvvvvvvvvv M="
       
    66 const u32_t EAP_MSCHAPV2_CHANGE_PASSWORD_ENCRYPTED_PASSWORD_SIZE = 516;
       
    67 const u32_t EAP_MSCHAPV2_CHANGE_PASSWORD_ENCRYPTED_HASH_SIZE = 16;
       
    68 const u32_t EAP_MSCHAPV2_HEADER_SIZE = 4; // OpCode, MS-CHAPv2-ID and MS-Length
       
    69 
       
    70 
       
    71 const u8_t EAP_MSCHAPV2_MESSAGE_PREFIX[] = " M=";
       
    72 const u32_t EAP_MSCHAPV2_MESSAGE_PREFIX_SIZE = 3;
       
    73 
       
    74 const u8_t EAP_MSCHAPV2_IMPLICIT_CHALLENGE_HANDLE_KEY[] = "eap_type_mschapv2_c implicit challenge";
       
    75 
       
    76 const u8_t EAP_MSCHAPV2_ZERO_CHALLENGE[]
       
    77 	= { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
       
    78 		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, };
       
    79 
       
    80 typedef struct
       
    81 {
       
    82 	u8_t password[EAP_MSCHAPV2_PASSWORD_MAX_SIZE]; // 256 unicode-chars
       
    83 	u32_t password_length;
       
    84 } pw_block_s;
       
    85 
       
    86 enum eap_type_mschapv2_stored_e
       
    87 {
       
    88 	eap_type_mschapv2_stored_none,
       
    89 	eap_type_mschapv2_stored_username,
       
    90 	eap_type_mschapv2_stored_password,
       
    91 	eap_type_mschapv2_implicit_challenge,
       
    92 	eap_type_mschapv2_stored_password_expired_flag,
       
    93 };
       
    94 
       
    95 
       
    96 const u32_t TRACE_FLAGS_MSCHAPV2_ERROR = eap_am_tools_c::eap_trace_mask_error;
       
    97 
       
    98 /**
       
    99  *  This is boolean configuration option.
       
   100  *  True value of this flag causes client return random
       
   101  *  identity on EAP-Response/Identity.
       
   102  *  False value causes client return real identity
       
   103  *  (IMSI, pseudonym or re-authentication identity)
       
   104  *  in EAP-Response/Identity.
       
   105  *  Default value is false.
       
   106  */
       
   107 EAP_CONFIGURATION_FIELD(
       
   108 	cf_str_EAP_MSCHAPV2_wait_eap_success_packet,
       
   109 	"EAP_MSCHAPV2_wait_eap_success_packet",
       
   110 	eap_configure_type_boolean,
       
   111 	false);
       
   112 
       
   113 EAP_CONFIGURATION_FIELD(
       
   114 	cf_str_EAP_MSCHAPV2_password_prompt,
       
   115 	"EAP_MSCHAPV2_password_prompt",
       
   116 	eap_configure_type_boolean,
       
   117 	false);
       
   118 
       
   119 EAP_CONFIGURATION_FIELD(
       
   120 	cf_str_EAP_MSCHAPV2_username,
       
   121 	"EAP_MSCHAPV2_username",
       
   122 	eap_configure_type_hex_data,
       
   123 	false);
       
   124 
       
   125 EAP_CONFIGURATION_FIELD(
       
   126 	cf_str_EAP_MSCHAPV2_password,
       
   127 	"EAP_MSCHAPV2_password",
       
   128 	eap_configure_type_hex_data,
       
   129 	true);
       
   130 
       
   131 EAP_CONFIGURATION_FIELD(
       
   132 	cf_str_EAP_MSCHAPV2_use_implicit_challenge,
       
   133 	"EAP_MSCHAPV2_use_implicit_challenge",
       
   134 	eap_configure_type_boolean,
       
   135 	false);
       
   136 
       
   137 EAP_CONFIGURATION_FIELD(
       
   138 	cf_str_EAP_MSCHAPV2_use_EAP_FAST_challenge,
       
   139 	"EAP_MSCHAPV2_use_EAP_FAST_challenge",
       
   140 	eap_configure_type_boolean,
       
   141 	false);
       
   142 
       
   143 EAP_CONFIGURATION_FIELD(
       
   144 	cf_str_EAP_MSCHAPV2_client_EAP_FAST_challenge,
       
   145 	"EAP_MSCHAPV2_client_EAP_FAST_challenge",
       
   146 	eap_configure_type_hex_data,
       
   147 	false);
       
   148 
       
   149 EAP_CONFIGURATION_FIELD(
       
   150 	cf_str_EAP_MSCHAPV2_server_EAP_FAST_challenge,
       
   151 	"EAP_MSCHAPV2_server_EAP_FAST_challenge",
       
   152 	eap_configure_type_hex_data,
       
   153 	false);
       
   154 
       
   155 EAP_CONFIGURATION_FIELD(
       
   156 	cf_str_EAP_MSCHAPV2_use_EAP_FAST_full_key,
       
   157 	"EAP_MSCHAPV2_use_EAP_FAST_full_key",
       
   158 	eap_configure_type_boolean,
       
   159 	false);
       
   160 
       
   161 EAP_CONFIGURATION_FIELD(
       
   162 	cf_str_EAP_MSCHAPV2_use_eap_expanded_type,
       
   163 	"EAP_MSCHAPV2_use_eap_expanded_type",
       
   164 	eap_configure_type_boolean,
       
   165 	false);
       
   166 
       
   167 EAP_CONFIGURATION_FIELD(
       
   168 	cf_str_EAP_MSCHAPV2_do_password_expiration_tests,
       
   169 	"EAP_MSCHAPV2_do_password_expiration_tests",
       
   170 	eap_configure_type_boolean,
       
   171 	false);
       
   172 
       
   173 EAP_CONFIGURATION_FIELD(
       
   174 	cf_str_EAP_MSCHAPV2_do_wrong_password_tests,
       
   175 	"EAP_MSCHAPV2_do_wrong_password_tests",
       
   176 	eap_configure_type_boolean,
       
   177 	false);
       
   178 
       
   179 EAP_CONFIGURATION_FIELD(
       
   180 	cf_str_EAP_MSCHAPV2_do_asyncronous_completition,
       
   181 	"EAP_MSCHAPV2_do_asyncronous_completition",
       
   182 	eap_configure_type_boolean,
       
   183 	false);
       
   184 
       
   185 /**
       
   186  *  This u32_t configuration value specifies the maximum session validity time in seconds.
       
   187  *  Default value is 12 hours in seconds, which is 43200 seconds.
       
   188  */
       
   189 EAP_CONFIGURATION_FIELD(
       
   190 	cf_str_EAP_MSCHAPv2_max_session_validity_time,
       
   191 	"EAP_MSCHAPv2_max_session_validity_time",
       
   192 	eap_configure_type_u32_t,
       
   193 	false);
       
   194 
       
   195 /** @} */ // End of group MSCHAPV2_config_options.
       
   196 
       
   197 //--------------------------------------------------
       
   198 
       
   199 /// Macro traces payload type and data.
       
   200 #define EAP_MSCHAPV2_TRACE_PAYLOAD(prefix, payload) \
       
   201 	{ \
       
   202 		EAP_TRACE_DEBUG(m_am_tools, TRACE_FLAGS_DEFAULT|TRACE_TEST_VECTORS, (EAPL("%s (0x%08x): current payload 0x%04x=%s, data length 0x%04x.\n"), \
       
   203 			prefix, payload, payload->get_current_payload(), payload->get_payload_AT_string(), payload->get_data_length())); \
       
   204 		EAP_TRACE_DATA_DEBUG(m_am_tools, TRACE_FLAGS_DEFAULT|TRACE_TEST_VECTORS, (EAPL("payload"), \
       
   205 			payload, \
       
   206 			payload->get_payload_length())); \
       
   207 	}
       
   208 
       
   209 //--------------------------------------------------
       
   210 
       
   211 
       
   212 #endif //#if !defined(_MSCHAPV2_TYPES_H_)