1 /*

     2 * Copyright (c) 2005-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:  Class for parsing WPA IEs.

    15 *

    16 */

    17 

    18 

    19 #include "core_frame_wpa_ie.h"

    20 #include "core_tools.h"

    21 #include "core_tools_parser.h"

    22 #include "am_debug.h"

    23 

    24 /** Defining this enables IE parsing related traces. */

    25 //#define WLAN_CORE_DEEP_DEBUG 1

    26 

    27 const u8_t CORE_FRAME_WPA_IE_LENGTH = 24;

    28 const u8_t CORE_FRAME_WPA_IE_GROUP_SUITE_OFFSET = 8;

    29 const u8_t CORE_FRAME_WPA_IE_PAIRWISE_SUITE_COUNT_OFFSET = 12;

    30 const u8_t CORE_FRAME_WPA_IE_PAIRWISE_SUITE_OFFSET = 14;

    31 const u8_t CORE_FRAME_WPA_IE_CIPHER_OUI_LENGTH = 4;

    32 const u8_t CORE_FRAME_WPA_IE_KEY_MANAGEMENT_COUNT_SIZE = 2;

    33 const u8_t CORE_FRAME_WPA_IE_KEY_MANAGEMENT_OUI_LENGTH = 4;

    34 

    35 /** IDs for different cipher suites in RSN IE. */

    36 const u8_t CORE_FRAME_WPA_IE_CIPHER_ID_NONE    = 0x00;

    37 const u8_t CORE_FRAME_WPA_IE_CIPHER_ID_WEP40   = 0x01;

    38 const u8_t CORE_FRAME_WPA_IE_CIPHER_ID_WEP104  = 0x05;

    39 const u8_t CORE_FRAME_WPA_IE_CIPHER_ID_TKIP    = 0x02;

    40 const u8_t CORE_FRAME_WPA_IE_CIPHER_ID_CCMP    = 0x04;

    41 

    42 /** IDs for different key management suites. */

    43 const u8_t CORE_FRAME_WPA_IE_KEY_MANAGEMENT_ID_NONE = 0x00;

    44 const u8_t CORE_FRAME_WPA_IE_KEY_MANAGEMENT_ID_EAP  = 0x01;

    45 const u8_t CORE_FRAME_WPA_IE_KEY_MANAGEMENT_ID_PSK  = 0x02;

    46 

    47 const u8_t CORE_FRAME_WPA_IE_OUI_OFFSET = 2;

    48 const u8_t CORE_FRAME_WPA_IE_OUI_LENGTH = 4;

    49 const u8_t CORE_FRAME_WPA_IE_OUI[] = { 0x00, 0x50, 0xF2, 0x01 };

    50 

    51 const u8_t CORE_FRAME_WPA_IE_OUI_PREFIX_LENGTH = 3;

    52 const u8_t CORE_FRAME_WPA_IE_OUI_PREFIX[] = { 0x00, 0x50, 0xF2 };

    53 

    54 const u16_t CORE_FRAME_WPA_IE_VERSION = 1;

    55 const u16_t CORE_FRAME_WPA_IE_PAIRWISE_SUITE_COUNT = 1;

    56 const u16_t CORE_FRAME_WPA_IE_KEY_MANAGEMENT_COUNT = 1;

    57 

    58 // ---------------------------------------------------------------------------

    59 // ---------------------------------------------------------------------------

    60 //

    61 core_frame_wpa_ie_c* core_frame_wpa_ie_c::instance(

    62     abs_core_wpx_adaptation_c& wpx_adaptation,

    63     const core_frame_dot11_ie_c& ie )

    64     {

    65     if ( ie.data_length() < CORE_FRAME_WPA_IE_LENGTH )

    66         {

    67 #ifdef WLAN_CORE_DEEP_DEBUG          

    68         DEBUG( "core_frame_wpa_ie_c::instance() - not a valid IE, too short" );

    69 #endif // WLAN_CORE_DEEP_DEBUG

    70 

    71         return NULL;

    72         }

    73 

    74     if ( core_tools_c::compare(

    75         &ie.data()[CORE_FRAME_WPA_IE_OUI_OFFSET],

    76         CORE_FRAME_WPA_IE_OUI_LENGTH,

    77         &CORE_FRAME_WPA_IE_OUI[0],

    78         CORE_FRAME_WPA_IE_OUI_LENGTH ) )

    79         {

    80 #ifdef WLAN_CORE_DEEP_DEBUG        

    81         DEBUG( "core_frame_wpa_ie_c::instance() - not a valid IE, WPA OUI missing" );

    82 #endif // WLAN_CORE_DEEP_DEBUG

    83 

    84         return NULL;       

    85         }

    86 

    87     core_frame_wpa_ie_c* instance = new core_frame_wpa_ie_c(

    88         wpx_adaptation,

    89         ie.data_length(),

    90         ie.data(),

    91         0 );

    92     if ( !instance )

    93         {

    94         DEBUG( "core_frame_wpa_ie_c::instance() - unable to create an instance" );

    95 

    96         return NULL;

    97         }

    98     

    99     return instance;

   100     }

   101 

   102 // ---------------------------------------------------------------------------

   103 // ---------------------------------------------------------------------------

   104 //

   105 core_frame_wpa_ie_c* core_frame_wpa_ie_c::instance(

   106     abs_core_wpx_adaptation_c& wpx_adaptation,

   107     core_cipher_suite_e group_cipher,

   108     core_cipher_suite_e pairwise_cipher,

   109     core_key_management_e key_management )

   110     {

   111     const u8_t max_length = CORE_FRAME_WPA_IE_LENGTH;

   112     

   113     u8_t* buffer = new u8_t[max_length];

   114     if ( !buffer )

   115         {

   116         DEBUG( "core_frame_wpa_ie_c::instance() - unable create the internal buffer" );

   117         return NULL;

   118         }

   119 

   120     core_frame_wpa_ie_c* instance =

   121         new core_frame_wpa_ie_c( wpx_adaptation, 0, buffer, max_length );

   122     if ( !instance )

   123         {

   124         DEBUG( "core_frame_wpa_ie_c::instance() - unable to create an instance" );

   125         delete[] buffer;

   126 

   127         return NULL;

   128         }

   129 

   130     instance->generate(

   131         group_cipher,

   132         pairwise_cipher,

   133         key_management );

   134 

   135     return instance;

   136     }

   137 

   138 // ---------------------------------------------------------------------------

   139 // ---------------------------------------------------------------------------

   140 //       

   141 core_frame_wpa_ie_c::~core_frame_wpa_ie_c()

   142     {

   143     DEBUG( "core_frame_wpa_ie_c::~core_frame_wpa_ie_c()" );   

   144     }

   145 

   146 // ---------------------------------------------------------------------------

   147 // ---------------------------------------------------------------------------

   148 //

   149 u8_t core_frame_wpa_ie_c::group_cipher_suite() const

   150     {

   151     return cipher_oui_to_enum( data_m + CORE_FRAME_WPA_IE_GROUP_SUITE_OFFSET );

   152     }

   153 

   154 // ---------------------------------------------------------------------------

   155 // ---------------------------------------------------------------------------

   156 //

   157 u8_t core_frame_wpa_ie_c::pairwise_cipher_suites() const

   158     {

   159     u16_t num_of_suites = core_tools_c::get_u16(

   160         data_m, CORE_FRAME_WPA_IE_PAIRWISE_SUITE_COUNT_OFFSET );    

   161     u8_t suites( 0 );

   162 

   163     DEBUG1( "core_frame_wpa_ie_c::pairwise_cipher_suites() - num_of_suites = %u",

   164         num_of_suites );

   165 

   166     u32_t offset_end(

   167         CORE_FRAME_WPA_IE_PAIRWISE_SUITE_OFFSET +

   168         ( num_of_suites * CORE_FRAME_WPA_IE_CIPHER_OUI_LENGTH ) );

   169     if ( offset_end > data_length() )

   170         {

   171         DEBUG( "core_frame_wpa_ie_c::pairwise_cipher_suites() - num_of_suites points past the end of IE, ignoring" );

   172 

   173         return suites;

   174         }

   175 

   176     while ( num_of_suites-- )

   177         {

   178         suites += cipher_oui_to_enum( data_m + CORE_FRAME_WPA_IE_PAIRWISE_SUITE_OFFSET +

   179             ( num_of_suites * CORE_FRAME_WPA_IE_CIPHER_OUI_LENGTH ) );

   180         }

   181 

   182     return suites;

   183     }

   184 

   185 // ---------------------------------------------------------------------------

   186 // ---------------------------------------------------------------------------

   187 //

   188 u8_t core_frame_wpa_ie_c::key_management_suites() const

   189     {

   190     u8_t suites( 0 );

   191     u16_t pairwise_num_of_suites = core_tools_c::get_u16(

   192         data_m, CORE_FRAME_WPA_IE_PAIRWISE_SUITE_COUNT_OFFSET );

   193     u32_t pairwise_offset_end(

   194         CORE_FRAME_WPA_IE_PAIRWISE_SUITE_OFFSET +

   195         ( pairwise_num_of_suites * CORE_FRAME_WPA_IE_CIPHER_OUI_LENGTH ) );

   196     if ( pairwise_offset_end > data_length() )

   197         {

   198         DEBUG( "core_frame_wpa_ie_c::key_management_suites() - pairwise_num_of_suites points past the end of IE, ignoring" );

   199 

   200         return suites;

   201         }

   202 

   203     u8_t pairwise_length( pairwise_num_of_suites * CORE_FRAME_WPA_IE_CIPHER_OUI_LENGTH );

   204     u16_t num_of_suites = core_tools_c::get_u16(

   205         data_m, CORE_FRAME_WPA_IE_PAIRWISE_SUITE_OFFSET + pairwise_length );

   206     u32_t offset_end(

   207         CORE_FRAME_WPA_IE_PAIRWISE_SUITE_OFFSET +

   208         pairwise_length +

   209         CORE_FRAME_WPA_IE_KEY_MANAGEMENT_COUNT_SIZE +

   210         ( num_of_suites * CORE_FRAME_WPA_IE_KEY_MANAGEMENT_OUI_LENGTH ) );

   211     if ( offset_end > data_length() )

   212         {

   213         DEBUG( "core_frame_wpa_ie_c::key_management_suites() - num_of_suites points past the end of IE, ignoring" );

   214 

   215         return suites;

   216         }

   217 

   218     DEBUG1( "core_frame_wpa_ie_c::key_management_suites() - num_of_suites = %u",

   219         num_of_suites );

   220         

   221     while ( num_of_suites-- )

   222         {

   223         suites += key_management_oui_to_enum(

   224             data_m + CORE_FRAME_WPA_IE_PAIRWISE_SUITE_OFFSET

   225             + pairwise_length

   226             + CORE_FRAME_WPA_IE_KEY_MANAGEMENT_COUNT_SIZE

   227             + ( num_of_suites * CORE_FRAME_WPA_IE_KEY_MANAGEMENT_OUI_LENGTH ) );

   228         }

   229 

   230     return suites;

   231     }

   232 

   233 // -----------------------------------------------------------------------------

   234 // -----------------------------------------------------------------------------

   235 //

   236 core_cipher_suite_e core_frame_wpa_ie_c::cipher_oui_to_enum(

   237     const u8_t* oui ) const

   238     {

   239     if ( core_tools_c::compare(

   240         oui,

   241         CORE_FRAME_WPA_IE_OUI_PREFIX_LENGTH,

   242         &CORE_FRAME_WPA_IE_OUI_PREFIX[0],

   243         CORE_FRAME_WPA_IE_OUI_PREFIX_LENGTH ) )

   244         {

   245         DEBUG( "core_frame_wpa_ie_c::cipher_oui_to_enum() - unknown cipher suite" );

   246         return core_cipher_suite_none;

   247         }

   248 

   249     switch ( *(oui + CORE_FRAME_WPA_IE_OUI_PREFIX_LENGTH) )

   250         {

   251         case CORE_FRAME_WPA_IE_CIPHER_ID_WEP40:

   252             return core_cipher_suite_wep40;

   253         case CORE_FRAME_WPA_IE_CIPHER_ID_WEP104:

   254             return core_cipher_suite_wep104;

   255         case CORE_FRAME_WPA_IE_CIPHER_ID_TKIP:

   256             return core_cipher_suite_tkip;

   257         case CORE_FRAME_WPA_IE_CIPHER_ID_CCMP:

   258             return core_cipher_suite_ccmp;

   259         default:

   260             return core_cipher_suite_none;

   261         }

   262     }

   263 

   264 // -----------------------------------------------------------------------------

   265 // -----------------------------------------------------------------------------

   266 //    

   267 core_key_management_e core_frame_wpa_ie_c::key_management_oui_to_enum(

   268     const u8_t* oui ) const

   269     {

   270     if ( !core_tools_c::compare(

   271         oui,

   272         CORE_FRAME_WPA_IE_OUI_PREFIX_LENGTH,

   273         &CORE_FRAME_WPA_IE_OUI_PREFIX[0],

   274         CORE_FRAME_WPA_IE_OUI_PREFIX_LENGTH ) )

   275         {

   276         switch ( *(oui + CORE_FRAME_WPA_IE_OUI_PREFIX_LENGTH) )

   277             {

   278             case CORE_FRAME_WPA_IE_KEY_MANAGEMENT_ID_EAP:

   279                 DEBUG( "core_frame_wpa_ie_c::key_management_oui_to_enum() - core_key_management_eap" );

   280                 return core_key_management_eap;

   281             case CORE_FRAME_WPA_IE_KEY_MANAGEMENT_ID_PSK:

   282                 DEBUG( "core_frame_wpa_ie_c::key_management_oui_to_enum() - core_key_management_preshared" );

   283                 return core_key_management_preshared;

   284             default:

   285                 DEBUG( "core_frame_wpa_ie_c::key_management_oui_to_enum() - core_key_management_none" );

   286                 return core_key_management_none;

   287             }

   288         }

   289 

   290     return wpx_adaptation_m.wpx_key_management_suite( oui );

   291     }

   292 

   293 // -----------------------------------------------------------------------------

   294 // -----------------------------------------------------------------------------

   295 //

   296 u8_t core_frame_wpa_ie_c::get_raw_group_cipher(

   297     core_cipher_suite_e cipher ) const

   298     {

   299     switch( cipher )

   300         {        

   301         case core_cipher_suite_wep40:

   302             DEBUG( "core_frame_wpa_ie_c::get_raw_group_cipher() - core_cipher_suite_wep40" );

   303             return CORE_FRAME_WPA_IE_CIPHER_ID_WEP40;

   304         case core_cipher_suite_wep104:

   305             DEBUG( "core_frame_wpa_ie_c::get_raw_group_cipher() - core_cipher_suite_wep104" );

   306             return CORE_FRAME_WPA_IE_CIPHER_ID_WEP104;

   307         case core_cipher_suite_tkip:

   308             DEBUG( "core_frame_wpa_ie_c::get_raw_group_cipher() - core_cipher_suite_tkip" );

   309             return CORE_FRAME_WPA_IE_CIPHER_ID_TKIP;

   310         case core_cipher_suite_ccmp:

   311             DEBUG( "core_frame_wpa_ie_c::get_raw_group_cipher() - core_cipher_suite_ccmp" );

   312             return CORE_FRAME_WPA_IE_CIPHER_ID_CCMP;

   313         default:

   314             DEBUG( "core_frame_wpa_ie_c::get_raw_group_cipher() - core_cipher_suite_none" );

   315             return CORE_FRAME_WPA_IE_CIPHER_ID_NONE;

   316         }

   317     }

   318 

   319 // -----------------------------------------------------------------------------

   320 // -----------------------------------------------------------------------------

   321 //

   322 u8_t core_frame_wpa_ie_c::get_raw_pairwise_cipher(

   323     core_cipher_suite_e cipher ) const

   324     {

   325     switch( cipher )

   326         {        

   327         case core_cipher_suite_wep40:

   328             DEBUG( "core_frame_wpa_ie_c::get_raw_pairwise_cipher() - core_cipher_suite_wep40" );

   329             return CORE_FRAME_WPA_IE_CIPHER_ID_WEP40;

   330         case core_cipher_suite_wep104:

   331             DEBUG( "core_frame_wpa_ie_c::get_raw_pairwise_cipher() - core_cipher_suite_wep104" );

   332             return CORE_FRAME_WPA_IE_CIPHER_ID_WEP104;

   333         case core_cipher_suite_tkip:

   334             DEBUG( "core_frame_wpa_ie_c::get_raw_pairwise_cipher() - core_cipher_suite_tkip" );

   335             return CORE_FRAME_WPA_IE_CIPHER_ID_TKIP;

   336         case core_cipher_suite_ccmp:

   337             DEBUG( "core_frame_wpa_ie_c::get_raw_pairwise_cipher() - core_cipher_suite_ccmp" );

   338             return CORE_FRAME_WPA_IE_CIPHER_ID_CCMP;

   339         default:

   340             DEBUG( "core_frame_wpa_ie_c::get_raw_pairwise_cipher() - core_cipher_suite_none" );

   341             return CORE_FRAME_WPA_IE_CIPHER_ID_NONE;

   342         }

   343     }

   344 

   345 // -----------------------------------------------------------------------------

   346 // -----------------------------------------------------------------------------

   347 //

   348 u8_t core_frame_wpa_ie_c::get_raw_key_management(

   349     core_key_management_e key_management ) const

   350     {

   351     switch( key_management )

   352         {        

   353         case core_key_management_eap:

   354             DEBUG( "core_frame_wpa_ie_c::get_raw_key_management() - core_key_management_eap" );

   355             return CORE_FRAME_WPA_IE_KEY_MANAGEMENT_ID_EAP;

   356         case core_key_management_preshared:

   357             DEBUG( "core_frame_wpa_ie_c::get_raw_key_management() - core_key_management_preshared" );

   358             return CORE_FRAME_WPA_IE_KEY_MANAGEMENT_ID_PSK;

   359         default:

   360             DEBUG( "core_frame_wpa_ie_c::get_raw_key_management() - core_key_management_none" );

   361             return CORE_FRAME_WPA_IE_KEY_MANAGEMENT_ID_NONE;

   362         }

   363     }

   364 

   365 // ---------------------------------------------------------------------------

   366 // ---------------------------------------------------------------------------

   367 //

   368 void core_frame_wpa_ie_c::generate(

   369     core_cipher_suite_e group_cipher,

   370     core_cipher_suite_e pairwise_cipher,

   371     core_key_management_e key_management )

   372     {

   373     ASSERT( !data_length_m );

   374     ASSERT( max_data_length_m );   

   375 

   376     core_frame_dot11_ie_c::generate(

   377         core_frame_dot11_ie_element_id_wpa );

   378 

   379     // WPA OUI field

   380     core_tools_c::copy(

   381         &data_m[data_length_m],

   382         &CORE_FRAME_WPA_IE_OUI[0],

   383         CORE_FRAME_WPA_IE_OUI_LENGTH );

   384     data_length_m += CORE_FRAME_WPA_IE_OUI_LENGTH;

   385 

   386     // Version field

   387     u16_t value( CORE_FRAME_WPA_IE_VERSION ); 

   388     core_tools_c::copy(

   389         &data_m[data_length_m],

   390         reinterpret_cast<u8_t*>(&value),

   391         sizeof( value ) );

   392     data_length_m += sizeof( value );

   393 

   394     // Group Cipher Suite field

   395     core_tools_c::copy(

   396         &data_m[data_length_m],

   397         &CORE_FRAME_WPA_IE_OUI_PREFIX[0],

   398         CORE_FRAME_WPA_IE_OUI_PREFIX_LENGTH );

   399     data_length_m += CORE_FRAME_WPA_IE_OUI_PREFIX_LENGTH;

   400     data_m[data_length_m++] = get_raw_group_cipher( group_cipher );

   401 

   402     // Pairwise Cipher Suite Count field

   403     value = CORE_FRAME_WPA_IE_PAIRWISE_SUITE_COUNT; 

   404     core_tools_c::copy(

   405         &data_m[data_length_m],

   406         reinterpret_cast<u8_t*>(&value),

   407         sizeof( value ) );

   408     data_length_m += sizeof( value );

   409 

   410     // Pairwise Cipher Suite List field

   411     core_tools_c::copy(

   412         &data_m[data_length_m],

   413         &CORE_FRAME_WPA_IE_OUI_PREFIX[0],

   414         CORE_FRAME_WPA_IE_OUI_PREFIX_LENGTH );

   415     data_length_m += CORE_FRAME_WPA_IE_OUI_PREFIX_LENGTH;

   416     data_m[data_length_m++] = get_raw_pairwise_cipher( pairwise_cipher );

   417 

   418     // Key Management Suite Count field

   419     value = CORE_FRAME_WPA_IE_KEY_MANAGEMENT_COUNT;

   420     core_tools_c::copy(

   421         &data_m[data_length_m],

   422         reinterpret_cast<u8_t*>(&value),

   423         sizeof( value ) );

   424     data_length_m += sizeof( value );

   425 

   426     // Key Management Suite List field

   427     u8_t wpx_oui_length( 0 );

   428     if ( wpx_adaptation_m.get_wpx_key_management_oui(

   429         key_management,

   430         wpx_oui_length,

   431         &data_m[data_length_m] ) == core_error_ok )

   432         {

   433         data_length_m = static_cast<u8_t>( data_length_m + wpx_oui_length );

   434         }

   435     else

   436         {

   437         core_tools_c::copy(

   438             &data_m[data_length_m],

   439             &CORE_FRAME_WPA_IE_OUI_PREFIX[0],

   440             CORE_FRAME_WPA_IE_OUI_PREFIX_LENGTH );

   441         data_length_m += CORE_FRAME_WPA_IE_OUI_PREFIX_LENGTH;

   442         data_m[data_length_m++] = get_raw_key_management( key_management );

   443         }

   444 

   445     set_length( data_length_m );

   446     }

   447 

   448 // ---------------------------------------------------------------------------

   449 // ---------------------------------------------------------------------------

   450 //

   451 core_frame_wpa_ie_c::core_frame_wpa_ie_c(

   452     abs_core_wpx_adaptation_c& wpx_adaptation,

   453     u16_t data_length,

   454     const u8_t* data,

   455     u16_t max_data_length ) :

   456     core_frame_dot11_ie_c( data_length, data, max_data_length ),

   457     wpx_adaptation_m( wpx_adaptation )    

   458     {

   459     DEBUG( "core_frame_wpa_ie_c::core_frame_wpa_ie_c()" );   

   460     }