eapol/eapol_framework/eapol_common/type/simple_config/simple_config/include/simple_config_credential.h
author hgs
Thu, 16 Sep 2010 13:07:04 +0300
changeset 49 43351a4f2da3
parent 26 9abfd4f00d37
permissions -rw-r--r--
201037
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     1
/*
26
hgs
parents: 2
diff changeset
     2
* Copyright (c) 2001-2010 Nokia Corporation and/or its subsidiary(-ies).
0
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     3
* All rights reserved.
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     4
* This component and the accompanying materials are made available
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     5
* under the terms of the License "Eclipse Public License v1.0"
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     6
* which accompanies this distribution, and is available
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     8
*
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     9
* Initial Contributors:
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    11
*
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    12
* Contributors:
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    13
*
26
hgs
parents: 2
diff changeset
    14
* Description:  This class defines Credential attributes for protected setup (previously known as simple config).
0
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    15
*
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    16
*/
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    17
2
1c7bc153c08e Revision: 201001
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 0
diff changeset
    18
/*
26
hgs
parents: 2
diff changeset
    19
* %version: 9 %
2
1c7bc153c08e Revision: 201001
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents: 0
diff changeset
    20
*/
0
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    21
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    22
#if !defined(_SIMPLE_CONFIG_CREDENTIAL_H_)
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    23
#define _SIMPLE_CONFIG_CREDENTIAL_H_
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    24
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    25
#include "eap_tools.h"
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    26
#include "simple_config_attribute_type.h"
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    27
#include "simple_config_types.h"
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    28
#include "eap_array_algorithms.h"
49
hgs
parents: 26
diff changeset
    29
#include "eap_am_export.h"
hgs
parents: 26
diff changeset
    30
// Start: added by script change_export_macros.sh.
hgs
parents: 26
diff changeset
    31
#if defined(EAP_NO_EXPORT_SIMPLE_CONFIG_CREDENTIAL_H)
hgs
parents: 26
diff changeset
    32
	#define EAP_CLASS_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H EAP_NONSHARABLE 
hgs
parents: 26
diff changeset
    33
	#define EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H 
hgs
parents: 26
diff changeset
    34
	#define EAP_C_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H 
hgs
parents: 26
diff changeset
    35
	#define EAP_FUNC_EXPORT_SIMPLE_CONFIG_CREDENTIAL_H 
hgs
parents: 26
diff changeset
    36
	#define EAP_C_FUNC_EXPORT_SIMPLE_CONFIG_CREDENTIAL_H 
hgs
parents: 26
diff changeset
    37
#elif defined(EAP_EXPORT_SIMPLE_CONFIG_CREDENTIAL_H)
hgs
parents: 26
diff changeset
    38
	#define EAP_CLASS_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H EAP_EXPORT 
hgs
parents: 26
diff changeset
    39
	#define EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H EAP_FUNC_EXPORT 
hgs
parents: 26
diff changeset
    40
	#define EAP_C_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H EAP_C_FUNC_EXPORT 
hgs
parents: 26
diff changeset
    41
	#define EAP_FUNC_EXPORT_SIMPLE_CONFIG_CREDENTIAL_H EAP_FUNC_EXPORT 
hgs
parents: 26
diff changeset
    42
	#define EAP_C_FUNC_EXPORT_SIMPLE_CONFIG_CREDENTIAL_H EAP_C_FUNC_EXPORT 
hgs
parents: 26
diff changeset
    43
#else
hgs
parents: 26
diff changeset
    44
	#define EAP_CLASS_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H EAP_IMPORT 
hgs
parents: 26
diff changeset
    45
	#define EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H EAP_FUNC_IMPORT 
hgs
parents: 26
diff changeset
    46
	#define EAP_C_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H EAP_C_FUNC_IMPORT 
hgs
parents: 26
diff changeset
    47
	#define EAP_FUNC_EXPORT_SIMPLE_CONFIG_CREDENTIAL_H 
hgs
parents: 26
diff changeset
    48
	#define EAP_C_FUNC_EXPORT_SIMPLE_CONFIG_CREDENTIAL_H 
hgs
parents: 26
diff changeset
    49
#endif
hgs
parents: 26
diff changeset
    50
// End: added by script change_export_macros.sh.
hgs
parents: 26
diff changeset
    51
0
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    52
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    53
/** @file */
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    54
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    55
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    56
//----------------------------------------------------------------------------
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    57
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    58
26
hgs
parents: 2
diff changeset
    59
/// This class defines Credential attributes for protected setup (previously known as simple config).
49
hgs
parents: 26
diff changeset
    60
class EAP_CLASS_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H simple_config_credential_c
0
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    61
{
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    62
private:
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    63
	//--------------------------------------------------
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    64
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    65
	/// This is pointer to the tools class.
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    66
	abs_eap_am_tools_c * const m_am_tools;
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    67
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    68
	u8_t m_network_index;
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    69
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    70
	eap_variable_data_c m_SSID;
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    71
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    72
	simple_config_Authentication_Type_e m_Authentication_Type;
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    73
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    74
	simple_config_Encryption_Type_e m_Encryption_Type;
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    75
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    76
	eap_array_c<network_key_and_index_c> m_network_keys;
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    77
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    78
	eap_variable_data_c m_MAC_address;
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    79
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    80
	bool m_is_valid;
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    81
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    82
	//--------------------------------------------------
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    83
public:
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    84
	//--------------------------------------------------
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    85
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    86
	/**
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    87
	 * The destructor of the simple_config_credential_c class does nothing.
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    88
	 */
49
hgs
parents: 26
diff changeset
    89
	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H virtual ~simple_config_credential_c();
0
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    90
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    91
	/**
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    92
	 * The constructor of the simple_config_credential_c class simply initializes the attributes.
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    93
	 */
49
hgs
parents: 26
diff changeset
    94
	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H simple_config_credential_c(
0
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    95
		abs_eap_am_tools_c * const tools);
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    96
49
hgs
parents: 26
diff changeset
    97
	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H void set_network_index(const u8_t index);
0
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    98
49
hgs
parents: 26
diff changeset
    99
	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H u8_t get_network_index() const;
0
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   100
49
hgs
parents: 26
diff changeset
   101
	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H eap_variable_data_c * get_SSID();
0
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   102
49
hgs
parents: 26
diff changeset
   103
	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H const eap_variable_data_c * get_SSID_const() const;
26
hgs
parents: 2
diff changeset
   104
49
hgs
parents: 26
diff changeset
   105
	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H simple_config_Authentication_Type_e get_Authentication_Type();
0
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   106
49
hgs
parents: 26
diff changeset
   107
	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H void set_Authentication_Type(const simple_config_Authentication_Type_e Authentication_Type);
0
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   108
49
hgs
parents: 26
diff changeset
   109
	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H simple_config_Encryption_Type_e get_Encryption_Type();
0
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   110
49
hgs
parents: 26
diff changeset
   111
	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H void set_Encryption_Type(const simple_config_Encryption_Type_e Encryption_Type);
0
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   112
49
hgs
parents: 26
diff changeset
   113
	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H eap_array_c<network_key_and_index_c> * get_network_keys();
0
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   114
49
hgs
parents: 26
diff changeset
   115
	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H const eap_array_c<network_key_and_index_c> * get_network_keys_const() const;
26
hgs
parents: 2
diff changeset
   116
49
hgs
parents: 26
diff changeset
   117
	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H eap_variable_data_c * get_MAC_address();
0
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   118
49
hgs
parents: 26
diff changeset
   119
	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H const eap_variable_data_c * get_MAC_address_const() const;
26
hgs
parents: 2
diff changeset
   120
49
hgs
parents: 26
diff changeset
   121
	EAP_FUNC_VISIBILITY_SIMPLE_CONFIG_CREDENTIAL_H bool get_is_valid();
0
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   122
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   123
	// 
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   124
	//--------------------------------------------------
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   125
}; // class simple_config_credential_c
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   126
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   127
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   128
//--------------------------------------------------
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   129
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   130
#endif //#if !defined(_SIMPLE_CONFIG_CREDENTIAL_H_)
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   131
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   132
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   133
c8830336c852 Revision: 200949
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   134
// End.