1 marek 1.1 // Copyright (c) 2009 DMTF.  All rights reserved.
  2              [Version ( "2.22.0" ), 
  3               UMLPackagePath ( "CIM::Network::Wireless" ), 
  4               Description ( 
  5                  "CIM_WiFiEndpointSettings describes setting data that can be "
  6                  "applied to an instance of CIM_WiFiEndpoint to enable it to "
  7                  "associate to a particular Wi-Fi network." )]
  8           class CIM_WiFiEndpointSettings : CIM_SettingData {
  9           
 10                 [Description ( 
 11                     "Priority shall indicate the priority of the instance "
 12                     "among all WiFiEndpointSettings instances." )]
 13              uint8 Priority;
 14           
 15                 [Description ( 
 16                     "SSID shall indicate the Service Set Identifier (SSID) "
 17                     "that shall be used when the settings are applied to a "
 18                     "WiFiEndpoint. An SSID identifies a wireless network." ), 
 19                  MappingStrings { "IEEE 802.11-2007 | 7.3.2.1" }]
 20              string SSID;
 21           
 22 marek 1.1       [Description ( 
 23                     "BSSType shall indicate the Basic Service Set (BSS) Type "
 24                     "that shall be used when the settings are applied. A "
 25                     "Basic Service Set is a set of stations controlled by a "
 26                     "single coordination function.\n"
 27                     "\t* Independent: the WiFiEndpoint is associated directly "
 28                     "to another client station.\n"
 29                     "\t* Infrastructure: the WiFiEndpoint is associated to a "
 30                     "network via an access point." ), 
 31                  ValueMap { "0", "2", "3", ".." }, 
 32                  Values { "Unknown", "Independent", "Infrastructure", 
 33                     "DMTF Reserved" }, 
 34                  MappingStrings { "IEEE 802.11-2007 | 3.16" }]
 35              uint16 BSSType;
 36           
 37                 [Description ( 
 38                     "EncryptionMethod shall specify the 802.11 encryption "
 39                     "method used when the settings are applied. \t* Other "
 40                     "(1): shall indicate that the desired encryption method "
 41                     "is not specified in the list below. If this value is "
 42                     "used, OtherEncryptionMethod should not be NULL and "
 43 marek 1.1           "should not be empty.\n"
 44                     "\t* WEP (2): shall indicate that the desired encryption "
 45                     "method is Wired Equivalency Privacy (WEP). This value "
 46                     "should be used only if AuthenticationMethod contains 2 "
 47                     "(\"Open System\") or 3 (\"Shared Key\").\n"
 48                     "\t* TKIP (3): shall indicate that the desired encryption "
 49                     "method is Temporal Key Integrity Protocol (TKIP). This "
 50                     "value should be used only if AuthenticationMethod "
 51                     "contains 4 (\"WPA PSK\"), 5 (\"WPA IEEE 802.1x\"), 6 "
 52                     "(\"WPA2 PSK\"), or 7 (\"WPA2 IEEE 802.1x\").\n"
 53                     "\t* CCMP (4): shall indicate that the desired encryption "
 54                     "method is Counter Mode with Cipher Block Chaining "
 55                     "Message Authentication Code Protocol (CCMP). This value "
 56                     "should be used only if AuthenticationMethod contains 4 "
 57                     "(\"WPA PSK\"), 5 (\"WPA IEEE 802.1x\"), 6 (\"WPA2 PSK\"), "
 58                     "or 7 (\"WPA2 IEEE 802.1x\").\n"
 59                     "\t* None (5): shall indicate that no encryption is "
 60                     "desired. This value should be used only if "
 61                     "AuthenticationMethod contains 2 (\"Open System\") or 3 "
 62                     "(\"Shared Key\")." ), 
 63                  ValueMap { "1", "2", "3", "4", "5", "6.." }, 
 64 marek 1.1        Values { "Other", "WEP", "TKIP", "CCMP", "None", 
 65                     "DMTF Reserved" }, 
 66                  MappingStrings { "IEEE 802.11-2007 | 8" }, 
 67                  ModelCorrespondence { "CIM_WiFiEndpoint.EncryptionMethod", 
 68                     "CIM_WiFiEndpointSettings.AuthenticationMethod", 
 69                     "CIM_WiFiEndpointSettings.OtherEncryptionMethod" }]
 70              uint16 EncryptionMethod;
 71           
 72                 [Description ( 
 73                     "OtherEncryptionMethod shall specify the 802.11 "
 74                     "encryption method used when the settings are applied if "
 75                     "and only if EncryptionMethod contains \"Other\". The "
 76                     "format of this string shall be vendor-specific." ), 
 77                  ModelCorrespondence { 
 78                     "CIM_WiFiEndpoint.OtherEncryptionMethod", 
 79                     "CIM_WiFiEndpointSettings.EncryptionMethod" }]
 80              string OtherEncryptionMethod;
 81           
 82                 [Description ( 
 83                     "AuthenticationMethod shall specify the 802.11 "
 84                     "authentication method used when the settings are "
 85 marek 1.1           "applied. \t* Other (1): shall indicate that the desired "
 86                     "authentication method is not specified in the list "
 87                     "below. If AuthenticationMethod contains 1, "
 88                     "OtherAuthenticationMethod should not be NULL and should "
 89                     "not be empty.\n"
 90                     "\t* Open System (2): shall indicate that the desired "
 91                     "authentication method is Open System. "
 92                     "AuthenticationMethod should contain 2 only if "
 93                     "EncryptionMethod contains 2 (\"WEP\") or 5 (\"None\").\n"
 94                     "\t* Shared Key (3): shall indicate that the desired "
 95                     "authentication method is Shared Key. "
 96                     "AuthenticationMethod should contain 3 only if "
 97                     "EncryptionMethod contains 2 (\"WEP\") or 5 (\"None\").\n"
 98                     "\t* WPA PSK (4): shall indicate that the desired "
 99                     "authentication method is WPA (Wi-Fi Protected Access) "
100                     "PSK (Pre-Shared Key). AuthenticationMethod should "
101                     "contain 4 only if EncryptionMethod contains 3 (\"TKIP\") "
102                     "or 4 (\"CCMP\").\n"
103                     "\t* WPA IEEE 802.1x (5): shall indicate that the desired "
104                     "authentication method is WPA (Wi-Fi Protected Access) "
105                     "IEEE 802.1x. AuthenticationMethod should contain 5 only "
106 marek 1.1           "if EncryptionMethod contains 3 (\"TKIP\") or 4 (\"CCMP\").\n"
107                     "\t* WPA2 PSK (6): shall indicate that the desired "
108                     "authentication method is WPA2 (Wi-Fi Protected Access "
109                     "Version 2) PSK (Pre-Shared Key). AuthenticationMethod "
110                     "should containt 6 only if EncryptionMethod contains 3 "
111                     "(\"TKIP\") or 4 (\"CCMP\").\n"
112                     "\t* WPA2 IEEE 802.1x (7): shall indicated that the "
113                     "desired authentication method is WPA2 (Wi-Fi Protected "
114                     "Access Version 2) IEEE 802.1x. AuthenticationMethod "
115                     "should contain 7 only if EncryptionMethod contains 3 "
116                     "(\"TKIP\") or 4 (\"CCMP\")." ), 
117                  ValueMap { "1", "2", "3", "4", "5", "6", "7", "8.." }, 
118                  Values { "Other", "Open System", "Shared Key", "WPA PSK", 
119                     "WPA IEEE 802.1x", "WPA2 PSK", "WPA2 IEEE 802.1x", 
120                     "DMTF Reserved" }, 
121                  MappingStrings { "IEEE 802.11-2007 | 8" }, 
122                  ModelCorrespondence { 
123                     "CIM_WiFiEndpoint.AuthenticationMethod", 
124                     "CIM_WiFiEndpointSettings.EncryptionMethod", 
125                     "CIM_WiFiEndpointSettings.OtherAuthenticationMethod" }]
126              uint16 AuthenticationMethod;
127 marek 1.1 
128                 [Description ( 
129                     "OtherAuthenticationMethod shall specify the 802.11 "
130                     "authentication method used when the settings are applied "
131                     "if and only if AuthenticationMethod contains \"Other\". "
132                     "The format of this string shall be vendor-specific." ), 
133                  ModelCorrespondence { 
134                     "CIM_WiFiEndpoint.OtherAuthenticationMethod", 
135                     "CIM_WiFiEndpointSettings.AuthenticationMethod" }]
136              string OtherAuthenticationMethod;
137           
138                 [Description ( 
139                     "Keys shall contain the default WEP encryption keys. Keys "
140                     "should be non-NULL if and only if EncryptionMethod "
141                     "contains 2 (\"WEP\")." ), 
142                  OctetString, ArrayType ( "Indexed" ), 
143                  MappingStrings { 
144                     "MIB.IETF|IEEE 802.11 MIB.dot11WEPDefaultKeys" }, 
145                  ModelCorrespondence { "CIM_WiFiEndpointSettings.KeyIndex", 
146                     "CIM_WiFiEndpointSettings.EncryptionMethod" }]
147              string Keys[];
148 marek 1.1 
149                 [Description ( 
150                     "KeyIndex shall contain the index of the active key in "
151                     "the Keys array property. KeyIndex should be non-NULL if "
152                     "and only Keys is non-NULL." ), 
153                  MappingStrings { 
154                     "MIB.IETF|IEEE 802.11 MIB.dot11WEPDefaultKeyID" }, 
155                  ModelCorrespondence { "CIM_WiFiEndpointSettings.Keys" }]
156              uint8 KeyIndex;
157           
158                 [Description ( 
159                     "The actual binary value of a PSK (pre-shared key). "
160                     "PSKValue and PSKPassPhrase should not both be non-NULL. "
161                     "PSKValue should be NULL if AuthenticationMethod does not "
162                     "contain 4 (\"WPA PSK\") or 6 (\"WPA2 PSK\")." ), 
163                  OctetString, MappingStrings { 
164                     "MIB.IETF|IEEE 802.11 MIB.dot11RSNAConfigPSKValue" }, 
165                  ModelCorrespondence { 
166                     "CIM_WiFiEndpointSettings.PSKPassPhrase", 
167                     "CIM_WiFiEndpointSettings.AuthenticationMethod" }]
168              uint8 PSKValue[];
169 marek 1.1 
170                 [Description ( 
171                     "An ASCII alphanumeric string used to generate a PSK "
172                     "(pre-shared key). PSKPassPhrase and PSKValue should not "
173                     "both be non-NULL. PSKPassPhrase should be NULL if "
174                     "AuthenticationMethod does not contain 4 (\"WPA PSK\") or "
175                     "6 (\"WPA2 PSK\")." ), 
176                  MinLen ( 8 ), 
177                  MaxLen ( 63 ), 
178                  MappingStrings { 
179                     "MIB.IETF|IEEE 802.11 MIB.dot11RSNAConfigPSKPassPhrase" }, 
180                  ModelCorrespondence { "CIM_WiFiEndpointSettings.PSKValue", 
181                     "CIM_WiFiEndpointSettings.AuthenticationMethod" }]
182              string PSKPassPhrase;
183           
184           
185           };