eapol/eapol_framework/eapol_common/include/eap_rogue_ap_entry.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 #ifndef EAP_ROGUE_AP_ENTRY_H
       
    21 #define EAP_ROGUE_AP_ENTRY_H
       
    22 
       
    23 // INCLUDES
       
    24 #include "eap_am_tools.h"
       
    25 #include "eapol_ethernet_address.h"
       
    26 
       
    27 enum eap_rogue_ap_reason_e
       
    28 {
       
    29 	rogue_ap_none,
       
    30 	rogue_ap_association_failed,
       
    31 	rogue_ap_timeout,
       
    32 	rogue_ap_challenge_to_client_failed,
       
    33 	rogue_ap_challenge_to_ap_failed
       
    34 };
       
    35 
       
    36 // CLASS DECLARATION
       
    37 
       
    38 class EAP_EXPORT eap_rogue_ap_entry_c
       
    39 {
       
    40 	public:
       
    41 
       
    42 		// Constructors and destructor
       
    43 
       
    44 		/**
       
    45 		* Constructor
       
    46 		* @param tools Pointer to EAP tools class
       
    47 		*/        
       
    48 		EAP_FUNC_IMPORT eap_rogue_ap_entry_c(
       
    49 			abs_eap_am_tools_c * const tools);
       
    50 
       
    51 		/**
       
    52 		* Destructor
       
    53 		*/
       
    54 		EAP_FUNC_IMPORT virtual ~eap_rogue_ap_entry_c();
       
    55 
       
    56 		/**
       
    57 		* Returns a copy of this object.
       
    58 		*/
       
    59 		EAP_FUNC_IMPORT eap_rogue_ap_entry_c * copy() const;
       
    60 
       
    61 		/**
       
    62 		* Returns pointer to MAC address
       
    63 		* @return Pointer to MAC address
       
    64 		*/
       
    65 		EAP_FUNC_IMPORT u8_t * get_mac_address() const;
       
    66 
       
    67 		/**
       
    68 		* Returns pointer to MAC address and copies MAC address into given pointer
       
    69 		* @param mac_address Copies MAC address into this
       
    70 		* @return Pointer to MAC address
       
    71 		*/
       
    72 		EAP_FUNC_IMPORT u8_t * get_mac_address(u8_t * const mac_address) const;
       
    73 
       
    74 		/**
       
    75 		* Sets MAC address
       
    76 		* @param mac_address pointer to MAC address
       
    77 		*/
       
    78 		EAP_FUNC_IMPORT void set_mac_address(const u8_t * const mac_address);
       
    79 
       
    80 		/**
       
    81 		* Sets Rogue reason code
       
    82 		* @param reason Rogue reson code
       
    83 		*/
       
    84 		EAP_FUNC_IMPORT void set_rogue_reason(const eap_rogue_ap_reason_e reason);
       
    85 
       
    86 		/**
       
    87 		* Returns reson code of Rogue AP entry
       
    88 		* @return Rogue reson code
       
    89 		*/
       
    90 		EAP_FUNC_IMPORT eap_rogue_ap_reason_e get_rogue_reason() const;
       
    91 
       
    92 	private: // Data
       
    93 
       
    94 		/// Pointer to EAP tools
       
    95 		abs_eap_am_tools_c * const m_am_tools;
       
    96 
       
    97 		eap_rogue_ap_reason_e m_rogue_ap_reason;
       
    98 
       
    99 		u8_t m_rogue_ap_mac_address[EAPOL_ETHERNET_ADDRESS_LENGTH];
       
   100 
       
   101 }; // class eap_rogue_ap_entry_c
       
   102 
       
   103 #endif // EAP_ROGUE_AP_ENTRY_H
       
   104 
       
   105 // End of File