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 802.11i (RSN) IEs.

    15 *

    16 */

    17 

    18 

    19 #include "core_frame_rsn_ie.h"

    20 #include "core_tools.h"

    21 #include "core_tools_parser.h"

    22 #include "am_debug.h"

    23 

    24 const u8_t CORE_FRAME_RSN_IE_MIN_LENGTH = 22;

    25 const u8_t CORE_FRAME_RSN_IE_PMKID_COUNT_SIZE = 2;

    26 const u8_t CORE_FRAME_RSN_IE_GROUP_SUITE_OFFSET = 4;

    27 const u8_t CORE_FRAME_RSN_IE_PAIRWISE_SUITE_COUNT_OFFSET = 8;

    28 const u8_t CORE_FRAME_RSN_IE_PAIRWISE_SUITE_OFFSET = 10;

    29 const u8_t CORE_FRAME_RSN_IE_CIPHER_OUI_LENGTH = 4;

    30 const u8_t CORE_FRAME_RSN_IE_KEY_MANAGEMENT_COUNT_SIZE = 2;

    31 const u8_t CORE_FRAME_RSN_IE_KEY_MANAGEMENT_OUI_LENGTH = 4;

    32 

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

    34 const u8_t CORE_FRAME_RSN_IE_CIPHER_ID_NONE    = 0x00;

    35 const u8_t CORE_FRAME_RSN_IE_CIPHER_ID_WEP40   = 0x01;

    36 const u8_t CORE_FRAME_RSN_IE_CIPHER_ID_WEP104  = 0x05;

    37 const u8_t CORE_FRAME_RSN_IE_CIPHER_ID_TKIP    = 0x02;

    38 const u8_t CORE_FRAME_RSN_IE_CIPHER_ID_CCMP    = 0x04;

    39 

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

    41 const u8_t CORE_FRAME_RSN_IE_KEY_MANAGEMENT_ID_NONE = 0x00;

    42 const u8_t CORE_FRAME_RSN_IE_KEY_MANAGEMENT_ID_EAP  = 0x01;

    43 const u8_t CORE_FRAME_RSN_IE_KEY_MANAGEMENT_ID_PSK  = 0x02;

    44 

    45 const u8_t CORE_FRAME_RSN_IE_OUI_PREFIX_LENGTH = 3;

    46 const u8_t CORE_FRAME_RSN_IE_OUI_PREFIX[] = { 0x00, 0x0F, 0xAC };

    47 

    48 const u16_t CORE_FRAME_RSN_IE_VERSION = 1;

    49 const u16_t CORE_FRAME_RSN_IE_PAIRWISE_SUITE_COUNT = 1;

    50 const u16_t CORE_FRAME_RSN_IE_KEY_MANAGEMENT_COUNT = 1;

    51 const u16_t CORE_FRAME_RSN_IE_CAPABILITIES = 0;

    52 const u16_t CORE_FRAME_RSN_IE_PMKID_COUNT = 1;

    53 const u16_t CORE_FRAME_RSN_IE_PMKID_LENGTH = 16;

    54 

    55 // ---------------------------------------------------------------------------

    56 // ---------------------------------------------------------------------------

    57 //

    58 core_frame_rsn_ie_c* core_frame_rsn_ie_c::instance(

    59     abs_core_wpx_adaptation_c& wpx_adaptation,

    60     const core_frame_dot11_ie_c& ie )

    61     {

    62     if ( ie.data_length() < CORE_FRAME_RSN_IE_MIN_LENGTH )

    63         {

    64         DEBUG( "core_frame_rsn_ie_c::instance() - not a valid IE, too short" );

    65 

    66         return NULL;

    67         }

    68 

    69     core_frame_rsn_ie_c* instance = new core_frame_rsn_ie_c(

    70         wpx_adaptation,

    71         ie.data_length(),

    72         ie.data(),

    73         0 );

    74     if ( !instance )

    75         {

    76         DEBUG( "core_frame_rsn_ie_c::instance() - unable to create an instance" );

    77 

    78         return NULL;

    79         }

    80     

    81     return instance;

    82     }

    83 

    84 // ---------------------------------------------------------------------------

    85 // ---------------------------------------------------------------------------

    86 //

    87 core_frame_rsn_ie_c* core_frame_rsn_ie_c::instance(

    88     abs_core_wpx_adaptation_c& wpx_adaptation,

    89     core_cipher_suite_e group_cipher,

    90     core_cipher_suite_e pairwise_cipher,

    91     core_key_management_e key_management,

    92     u16_t pmkid_length,

    93     const u8_t* pmkid_data )

    94     {

    95     const u8_t max_length = CORE_FRAME_RSN_IE_MIN_LENGTH + CORE_FRAME_RSN_IE_PMKID_COUNT_SIZE + pmkid_length;

    96     

    97     u8_t* buffer = new u8_t[max_length];

    98     if ( !buffer )

    99         {

   100         DEBUG( "core_frame_rsn_ie_c::instance() - unable create the internal buffer" );

   101         return NULL;

   102         }

   103 

   104     core_frame_rsn_ie_c* instance =

   105         new core_frame_rsn_ie_c( wpx_adaptation, 0, buffer, max_length );

   106     if ( !instance )

   107         {

   108         DEBUG( "core_frame_rsn_ie_c::instance() - unable to create an instance" );

   109         delete[] buffer;

   110 

   111         return NULL;

   112         }

   113 

   114     instance->generate(

   115         group_cipher,

   116         pairwise_cipher,

   117         key_management,

   118         pmkid_length,

   119         pmkid_data );

   120 

   121     return instance;

   122     }

   123 

   124 // ---------------------------------------------------------------------------

   125 // ---------------------------------------------------------------------------

   126 //       

   127 core_frame_rsn_ie_c::~core_frame_rsn_ie_c()

   128     {

   129     DEBUG( "core_frame_rsn_ie_c::~core_frame_rsn_ie_c()" );   

   130     }

   131 

   132 // ---------------------------------------------------------------------------

   133 // ---------------------------------------------------------------------------

   134 //

   135 u8_t core_frame_rsn_ie_c::group_cipher_suite() const

   136     {

   137     return cipher_oui_to_enum( data_m + CORE_FRAME_RSN_IE_GROUP_SUITE_OFFSET );

   138     }

   139 

   140 // ---------------------------------------------------------------------------

   141 // ---------------------------------------------------------------------------

   142 //

   143 u8_t core_frame_rsn_ie_c::pairwise_cipher_suites() const

   144     {

   145     u16_t num_of_suites = core_tools_c::get_u16(

   146         data_m, CORE_FRAME_RSN_IE_PAIRWISE_SUITE_COUNT_OFFSET );    

   147     u8_t suites( 0 );

   148 

   149     DEBUG1( "core_frame_rsn_ie_c::pairwise_cipher_suites() - num_of_suites = %u",

   150         num_of_suites );

   151 

   152     u32_t offset_end(

   153         CORE_FRAME_RSN_IE_PAIRWISE_SUITE_OFFSET +

   154         ( num_of_suites * CORE_FRAME_RSN_IE_CIPHER_OUI_LENGTH ) );

   155     if ( offset_end > data_length() )

   156         {

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

   158 

   159         return suites;

   160         }

   161 

   162     while ( num_of_suites-- )

   163         {

   164         suites += cipher_oui_to_enum( data_m + CORE_FRAME_RSN_IE_PAIRWISE_SUITE_OFFSET +

   165             ( num_of_suites * CORE_FRAME_RSN_IE_CIPHER_OUI_LENGTH ) );

   166         }

   167 

   168     return suites;

   169     }

   170 

   171 // ---------------------------------------------------------------------------

   172 // ---------------------------------------------------------------------------

   173 //

   174 u8_t core_frame_rsn_ie_c::key_management_suites() const

   175     {

   176     u8_t suites( 0 );

   177     u16_t pairwise_num_of_suites = core_tools_c::get_u16(

   178         data_m, CORE_FRAME_RSN_IE_PAIRWISE_SUITE_COUNT_OFFSET );

   179     u32_t pairwise_offset_end(

   180         CORE_FRAME_RSN_IE_PAIRWISE_SUITE_COUNT_OFFSET +

   181         ( pairwise_num_of_suites * CORE_FRAME_RSN_IE_CIPHER_OUI_LENGTH ) );

   182     if ( pairwise_offset_end > data_length() )

   183         {

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

   185 

   186         return suites;

   187         }

   188 

   189     u8_t pairwise_length( pairwise_num_of_suites * CORE_FRAME_RSN_IE_CIPHER_OUI_LENGTH );

   190     u16_t num_of_suites = core_tools_c::get_u16(

   191         data_m, CORE_FRAME_RSN_IE_PAIRWISE_SUITE_OFFSET + pairwise_length );

   192     u32_t offset_end(

   193         CORE_FRAME_RSN_IE_PAIRWISE_SUITE_OFFSET +

   194         pairwise_length +

   195         CORE_FRAME_RSN_IE_KEY_MANAGEMENT_COUNT_SIZE +

   196         ( num_of_suites * CORE_FRAME_RSN_IE_KEY_MANAGEMENT_OUI_LENGTH ) );

   197     if ( offset_end > data_length() )

   198         {

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

   200 

   201         return suites;

   202         }

   203 

   204     DEBUG1( "core_frame_rsn_ie_c::key_management_suites() - num_of_suites = %u",

   205         num_of_suites );

   206         

   207     while ( num_of_suites-- )

   208         {

   209         suites += key_management_oui_to_enum(

   210             data_m + CORE_FRAME_RSN_IE_PAIRWISE_SUITE_OFFSET

   211             + pairwise_length

   212             + CORE_FRAME_RSN_IE_KEY_MANAGEMENT_COUNT_SIZE

   213             + ( num_of_suites * CORE_FRAME_RSN_IE_KEY_MANAGEMENT_OUI_LENGTH ) );

   214         }

   215 

   216     return suites;

   217     }

   218 

   219 // -----------------------------------------------------------------------------

   220 // -----------------------------------------------------------------------------

   221 //

   222 core_cipher_suite_e core_frame_rsn_ie_c::cipher_oui_to_enum(

   223     const u8_t* oui ) const

   224     {

   225     if ( core_tools_c::compare(

   226         oui,

   227         CORE_FRAME_RSN_IE_OUI_PREFIX_LENGTH,

   228         &CORE_FRAME_RSN_IE_OUI_PREFIX[0],

   229         CORE_FRAME_RSN_IE_OUI_PREFIX_LENGTH ) )

   230         {

   231         DEBUG( "core_frame_rsn_ie_c::cipher_oui_to_enum() - unknown cipher suite" );

   232         return core_cipher_suite_none;

   233         }

   234 

   235     switch ( *(oui + CORE_FRAME_RSN_IE_OUI_PREFIX_LENGTH) )

   236         {

   237         case CORE_FRAME_RSN_IE_CIPHER_ID_WEP40:

   238             return core_cipher_suite_wep40;

   239         case CORE_FRAME_RSN_IE_CIPHER_ID_WEP104:

   240             return core_cipher_suite_wep104;

   241         case CORE_FRAME_RSN_IE_CIPHER_ID_TKIP:

   242             return core_cipher_suite_tkip;

   243         case CORE_FRAME_RSN_IE_CIPHER_ID_CCMP:

   244             return core_cipher_suite_ccmp;

   245         default:

   246             return core_cipher_suite_none;

   247         }

   248     }

   249 

   250 // -----------------------------------------------------------------------------

   251 // -----------------------------------------------------------------------------

   252 //    

   253 core_key_management_e core_frame_rsn_ie_c::key_management_oui_to_enum(

   254     const u8_t* oui ) const

   255     {

   256     if ( !core_tools_c::compare(

   257         oui,

   258         CORE_FRAME_RSN_IE_OUI_PREFIX_LENGTH,

   259         &CORE_FRAME_RSN_IE_OUI_PREFIX[0],

   260         CORE_FRAME_RSN_IE_OUI_PREFIX_LENGTH ) )

   261         {

   262         switch ( *(oui + CORE_FRAME_RSN_IE_OUI_PREFIX_LENGTH) )

   263             {

   264             case CORE_FRAME_RSN_IE_KEY_MANAGEMENT_ID_EAP:

   265                 DEBUG( "core_frame_rsn_ie_c::key_management_oui_to_enum() - core_key_management_eap" );

   266                 return core_key_management_eap;

   267             case CORE_FRAME_RSN_IE_KEY_MANAGEMENT_ID_PSK:

   268                 DEBUG( "core_frame_rsn_ie_c::key_management_oui_to_enum() - core_key_management_preshared" );

   269                 return core_key_management_preshared;

   270             default:

   271                 DEBUG( "core_frame_rsn_ie_c::key_management_oui_to_enum() - core_key_management_none" );

   272                 return core_key_management_none;

   273             }

   274         }

   275 

   276     return wpx_adaptation_m.wpx_key_management_suite( oui );

   277     }

   278 

   279 // -----------------------------------------------------------------------------

   280 // -----------------------------------------------------------------------------

   281 //

   282 u8_t core_frame_rsn_ie_c::get_raw_group_cipher(

   283     core_cipher_suite_e cipher ) const

   284     {

   285     switch( cipher )

   286         {        

   287         case core_cipher_suite_wep40:

   288             DEBUG( "core_frame_rsn_ie_c::get_raw_group_cipher() - core_cipher_suite_wep40" );

   289             return CORE_FRAME_RSN_IE_CIPHER_ID_WEP40;

   290         case core_cipher_suite_wep104:

   291             DEBUG( "core_frame_rsn_ie_c::get_raw_group_cipher() - core_cipher_suite_wep104" );

   292             return CORE_FRAME_RSN_IE_CIPHER_ID_WEP104;

   293         case core_cipher_suite_tkip:

   294             DEBUG( "core_frame_rsn_ie_c::get_raw_group_cipher() - core_cipher_suite_tkip" );

   295             return CORE_FRAME_RSN_IE_CIPHER_ID_TKIP;

   296         case core_cipher_suite_ccmp:

   297             DEBUG( "core_frame_rsn_ie_c::get_raw_group_cipher() - core_cipher_suite_ccmp" );

   298             return CORE_FRAME_RSN_IE_CIPHER_ID_CCMP;

   299         default:

   300             DEBUG( "core_frame_rsn_ie_c::get_raw_group_cipher() - core_cipher_suite_none" );

   301             return CORE_FRAME_RSN_IE_CIPHER_ID_NONE;

   302         }

   303     }

   304 

   305 // -----------------------------------------------------------------------------

   306 // -----------------------------------------------------------------------------

   307 //

   308 u8_t core_frame_rsn_ie_c::get_raw_pairwise_cipher(

   309     core_cipher_suite_e cipher ) const

   310     {

   311     switch( cipher )

   312         {        

   313         case core_cipher_suite_wep40:

   314             DEBUG( "core_frame_rsn_ie_c::get_raw_pairwise_cipher() - core_cipher_suite_wep40" );

   315             return CORE_FRAME_RSN_IE_CIPHER_ID_WEP40;

   316         case core_cipher_suite_wep104:

   317             DEBUG( "core_frame_rsn_ie_c::get_raw_pairwise_cipher() - core_cipher_suite_wep104" );

   318             return CORE_FRAME_RSN_IE_CIPHER_ID_WEP104;

   319         case core_cipher_suite_tkip:

   320             DEBUG( "core_frame_rsn_ie_c::get_raw_pairwise_cipher() - core_cipher_suite_tkip" );

   321             return CORE_FRAME_RSN_IE_CIPHER_ID_TKIP;

   322         case core_cipher_suite_ccmp:

   323             DEBUG( "core_frame_rsn_ie_c::get_raw_pairwise_cipher() - core_cipher_suite_ccmp" );

   324             return CORE_FRAME_RSN_IE_CIPHER_ID_CCMP;

   325         default:

   326             DEBUG( "core_frame_rsn_ie_c::get_raw_pairwise_cipher() - core_cipher_suite_none" );

   327             return CORE_FRAME_RSN_IE_CIPHER_ID_NONE;

   328         }

   329     }

   330 

   331 // -----------------------------------------------------------------------------

   332 // -----------------------------------------------------------------------------

   333 //

   334 u8_t core_frame_rsn_ie_c::get_raw_key_management(

   335     core_key_management_e key_management ) const

   336     {

   337     switch( key_management )

   338         {        

   339         case core_key_management_eap:

   340             DEBUG( "core_frame_rsn_ie_c::get_raw_key_management() - core_key_management_eap" );

   341             return CORE_FRAME_RSN_IE_KEY_MANAGEMENT_ID_EAP;

   342         case core_key_management_preshared:

   343             DEBUG( "core_frame_rsn_ie_c::get_raw_key_management() - core_key_management_preshared" );

   344             return CORE_FRAME_RSN_IE_KEY_MANAGEMENT_ID_PSK;

   345         default:

   346             DEBUG( "core_frame_rsn_ie_c::get_raw_key_management() - core_key_management_none" );

   347             return CORE_FRAME_RSN_IE_KEY_MANAGEMENT_ID_NONE;

   348         }

   349     }

   350 

   351 // ---------------------------------------------------------------------------

   352 // ---------------------------------------------------------------------------

   353 //

   354 void core_frame_rsn_ie_c::generate(

   355     core_cipher_suite_e group_cipher,

   356     core_cipher_suite_e pairwise_cipher,

   357     core_key_management_e key_management,

   358     u16_t pmkid_length,

   359     const u8_t* pmkid_data)

   360     {

   361     ASSERT( !data_length_m );

   362     ASSERT( max_data_length_m );   

   363 

   364     core_frame_dot11_ie_c::generate(

   365         core_frame_dot11_ie_element_id_rsn );

   366 

   367     // Version field

   368     u16_t value( CORE_FRAME_RSN_IE_VERSION ); 

   369     core_tools_c::copy(

   370         &data_m[data_length_m],

   371         reinterpret_cast<u8_t*>(&value),

   372         sizeof( value ) );

   373     data_length_m += sizeof( value );

   374 

   375     // Group Cipher Suite field

   376     core_tools_c::copy(

   377         &data_m[data_length_m],

   378         &CORE_FRAME_RSN_IE_OUI_PREFIX[0],

   379         CORE_FRAME_RSN_IE_OUI_PREFIX_LENGTH );

   380     data_length_m += CORE_FRAME_RSN_IE_OUI_PREFIX_LENGTH;

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

   382 

   383     // Pairwise Cipher Suite Count field

   384     value = CORE_FRAME_RSN_IE_PAIRWISE_SUITE_COUNT; 

   385     core_tools_c::copy(

   386         &data_m[data_length_m],

   387         reinterpret_cast<u8_t*>(&value),

   388         sizeof( value ) );

   389     data_length_m += sizeof( value );

   390 

   391     // Pairwise Cipher Suite List field

   392     core_tools_c::copy(

   393         &data_m[data_length_m],

   394         &CORE_FRAME_RSN_IE_OUI_PREFIX[0],

   395         CORE_FRAME_RSN_IE_OUI_PREFIX_LENGTH );

   396     data_length_m += CORE_FRAME_RSN_IE_OUI_PREFIX_LENGTH;

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

   398 

   399     // Key Management Suite Count field

   400     value = CORE_FRAME_RSN_IE_KEY_MANAGEMENT_COUNT;

   401     core_tools_c::copy(

   402         &data_m[data_length_m],

   403         reinterpret_cast<u8_t*>(&value),

   404         sizeof( value ) );

   405     data_length_m += sizeof( value );

   406 

   407     // Key Management Suite List field

   408     u8_t wpx_oui_length( 0 );

   409     if ( wpx_adaptation_m.get_wpx_key_management_oui(

   410         key_management,

   411         wpx_oui_length,

   412         &data_m[data_length_m] ) == core_error_ok )

   413         {

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

   415         }

   416     else

   417         {

   418         core_tools_c::copy(

   419             &data_m[data_length_m],

   420             &CORE_FRAME_RSN_IE_OUI_PREFIX[0],

   421             CORE_FRAME_RSN_IE_OUI_PREFIX_LENGTH );

   422         data_length_m += CORE_FRAME_RSN_IE_OUI_PREFIX_LENGTH;

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

   424         }

   425 

   426     // RSN Capabilities field

   427     value = CORE_FRAME_RSN_IE_CAPABILITIES;    

   428     core_tools_c::copy(

   429         &data_m[data_length_m],

   430         reinterpret_cast<u8_t*>(&value),

   431         sizeof( value ) );

   432     data_length_m += sizeof( value );

   433 

   434     if ( pmkid_data &&

   435          pmkid_length == CORE_FRAME_RSN_IE_PMKID_LENGTH )

   436         {

   437         DEBUG( "core_frame_rsn_ie_c::core_frame_rsn_ie_c() - adding PMKID" );

   438         

   439         // PMKID Count field

   440         value = CORE_FRAME_RSN_IE_PMKID_COUNT;

   441         core_tools_c::copy(

   442             &data_m[data_length_m],

   443             reinterpret_cast<u8_t*>(&value),

   444             sizeof( value ) );

   445         data_length_m += sizeof( value );

   446 

   447         // PMKID List field

   448         core_tools_c::copy(

   449             &data_m[data_length_m],

   450             &pmkid_data[0],

   451             CORE_FRAME_RSN_IE_PMKID_LENGTH );

   452         data_length_m += CORE_FRAME_RSN_IE_PMKID_LENGTH;

   453         }

   454 

   455     set_length( data_length_m );

   456     }

   457 

   458 // ---------------------------------------------------------------------------

   459 // ---------------------------------------------------------------------------

   460 //

   461 core_frame_rsn_ie_c::core_frame_rsn_ie_c(

   462     abs_core_wpx_adaptation_c& wpx_adaptation,

   463     u16_t data_length,

   464     const u8_t* data,

   465     u16_t max_data_length ) :    

   466     core_frame_dot11_ie_c( data_length, data, max_data_length ),

   467     wpx_adaptation_m( wpx_adaptation )

   468     {

   469     DEBUG( "core_frame_rsn_ie_c::core_frame_rsn_ie_c()" );   

   470     }