NetworkPkg/WifiConnectionManagerDxe/WifiConnectionManagerDxe.vfr

   1 /** @file
   2   Vfr files used in WiFi Connection Manager.
   3
   4   Copyright (c) 2019 - 2022, Intel Corporation. All rights reserved.<BR>
   5
   6   SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #include "WifiConnectionMgrConfigNVDataStruct.h"
  11
  12 #define EFI_NETWORK_DEVICE_CLASS  0x04
  13
  14 formset
  15   guid     = WIFI_CONNECTION_MANAGER_CONFIG_GUID,
  16   title    = STRING_TOKEN(STR_WIFI_MGR_FORM_TITLE),
  17   help     = STRING_TOKEN(STR_WIFI_MGR_FORM_HELP),
  18   class    = EFI_NETWORK_DEVICE_CLASS,
  19   subclass = 0x03,
  20
  21   varstore WIFI_MANAGER_IFR_NVDATA,
  22     varid = MANAGER_VARSTORE_ID,
  23     name  = WIFI_MANAGER_IFR_NVDATA,
  24     guid  = WIFI_CONNECTION_MANAGER_CONFIG_GUID;
  25
  26   form formid = FORMID_MAC_SELECTION,
  27     title = STRING_TOKEN(STR_WIFI_MAC_FORM_TITLE);
  28
  29     suppressif TRUE;
  30       text
  31         help   = STRING_TOKEN(STR_NULL_STRING),
  32         text   = STRING_TOKEN(STR_NULL_STRING),
  33         flags  = INTERACTIVE,
  34         key    = KEY_MAC_LIST;
  35       endif;
  36
  37     label LABEL_MAC_ENTRY;
  38     label LABEL_END;
  39   endform;
  40
  41   form formid = FORMID_WIFI_MAINPAGE,
  42     title = STRING_TOKEN(STR_NETWORK_MANAGEMENT_TITLE);
  43
  44     text
  45       help   = STRING_TOKEN(STR_MAC_ADDRESS_HELP),      // Help string
  46       text   = STRING_TOKEN(STR_MAC_ADDRESS_TITLE),     // Prompt string
  47         text   = STRING_TOKEN(STR_MAC_ADDRESS);         // TextTwo
  48
  49     text
  50       help   = STRING_TOKEN(STR_NULL_STRING),           // Help string
  51       text   = STRING_TOKEN(STR_CONNECTION_INFO),       // Prompt string
  52         text   = STRING_TOKEN(STR_CONNECTED_SSID);      // TextTwo;
  53
  54     subtitle text = STRING_TOKEN(STR_NULL_STRING);
  55     subtitle text = STRING_TOKEN(STR_NULL_STRING);
  56
  57     goto FORMID_NETWORK_LIST,
  58          prompt = STRING_TOKEN(STR_NETWORK_LIST),
  59          help   = STRING_TOKEN(STR_NETWORK_LIST_HELP),
  60          flags  = INTERACTIVE,
  61          key    = KEY_NETWORK_LIST;
  62
  63     goto FORMID_WIFI_SETTINGS,
  64          prompt = STRING_TOKEN(STR_WIFI_SETTINGS),
  65          help   = STRING_TOKEN(STR_WIFI_SETTINGS_HELP),
  66          flags  = INTERACTIVE,
  67          key    = KEY_WIFI_SETTINGS;
  68
  69     action
  70          questionid  = KEY_REFRESH_TITLE_CONNECTION_STATUS,
  71          prompt      = STRING_TOKEN(STR_NULL_STRING),
  72          help        = STRING_TOKEN(STR_NULL_STRING),
  73          flags       = INTERACTIVE,
  74          config      = STRING_TOKEN(STR_NULL_STRING),
  75          refreshguid = WIFI_CONFIG_MAIN_FORM_REFRESH_GUID,
  76     endaction;
  77
  78   endform;
  79
  80   form formid = FORMID_NETWORK_LIST,
  81     title = STRING_TOKEN(STR_NETWORK_LIST);
  82
  83     numeric varid   = WIFI_MANAGER_IFR_NVDATA.ProfileCount,
  84             prompt  = STRING_TOKEN(STR_REFRESH_NETWORK_COUNT),
  85             help    = STRING_TOKEN(STR_REFRESH_NETWORK_COUNT_HELP),
  86             flags   = INTERACTIVE | READ_ONLY,
  87             key     = KEY_REFRESH_NETWORK_LIST,
  88             minimum = 0,
  89             maximum = 0xffffffff,
  90             step    = 0,
  91             default = 0,
  92             refreshguid = WIFI_CONFIG_NETWORK_LIST_REFRESH_GUID,
  93     endnumeric;
  94
  95     subtitle text = STRING_TOKEN(STR_NULL_STRING);
  96
  97     label LABEL_NETWORK_LIST_ENTRY;
  98     label LABEL_END;
  99   endform;
 100
 101   form formid = FORMID_CONNECT_NETWORK,
 102     title = STRING_TOKEN(STR_NETWORK_CONFIGURATION);
 103
 104     subtitle text = STRING_TOKEN(STR_NULL_STRING);
 105
 106     text
 107       help   = STRING_TOKEN(STR_CONNECT_STATUS_TITLE_HELP), // Help string
 108       text   = STRING_TOKEN(STR_CONNECT_STATUS_TITLE),      // Prompt string
 109         text   = STRING_TOKEN(STR_CONNECT_STATUS);          // TextTwo
 110
 111     subtitle text = STRING_TOKEN(STR_NULL_STRING);
 112
 113     text
 114       help   = STRING_TOKEN(STR_SSID_HELP),     // Help string
 115       text   = STRING_TOKEN(STR_SSID_TITLE),    // Prompt string
 116         text   = STRING_TOKEN(STR_SSID);        // TextTwo
 117
 118     text
 119       help   = STRING_TOKEN(STR_SECURITY_TYPE_HELP),       // Help string
 120       text   = STRING_TOKEN(STR_SECURITY_TYPE_TITLE),      // Prompt string
 121         text   = STRING_TOKEN(STR_SECURITY_TYPE);          // TextTwo
 122
 123
 124     suppressif NOT ideqval WIFI_MANAGER_IFR_NVDATA.SecurityType == SECURITY_TYPE_WPA2_PERSONAL
 125       AND NOT ideqval WIFI_MANAGER_IFR_NVDATA.SecurityType == SECURITY_TYPE_WPA3_PERSONAL;
 126       password  varid    = WIFI_MANAGER_IFR_NVDATA.Password,
 127                 prompt   = STRING_TOKEN(STR_PASSWORD),
 128                 help     = STRING_TOKEN(STR_PASSWORD_HELP),
 129                 flags    = INTERACTIVE,
 130                 key      = KEY_PASSWORD_CONNECT_NETWORK,
 131                 minsize  = PASSWORD_MIN_LEN,
 132                 maxsize  = PASSWORD_MAX_LEN,
 133       endpassword;
 134     endif;
 135
 136     suppressif NOT ideqval WIFI_MANAGER_IFR_NVDATA.SecurityType == SECURITY_TYPE_WPA2_ENTERPRISE
 137       AND NOT ideqval WIFI_MANAGER_IFR_NVDATA.SecurityType == SECURITY_TYPE_WPA3_ENTERPRISE;
 138
 139       oneof varid       = WIFI_MANAGER_IFR_NVDATA.EapAuthMethod,
 140             questionid  = KEY_EAP_AUTH_METHOD_CONNECT_NETWORK,
 141             prompt      = STRING_TOKEN(STR_EAP_AUTH_METHOD),
 142             help        = STRING_TOKEN(STR_EAP_AUTH_METHOD_HELP),
 143             flags       = INTERACTIVE,
 144             option text = STRING_TOKEN(STR_EAP_AUTH_METHOD_TTLS), value = EAP_AUTH_METHOD_TTLS, flags = DEFAULT;
 145             option text = STRING_TOKEN(STR_EAP_AUTH_METHOD_PEAP), value = EAP_AUTH_METHOD_PEAP, flags = 0;
 146             option text = STRING_TOKEN(STR_EAP_AUTH_METHOD_TLS),  value = EAP_AUTH_METHOD_TLS,  flags = 0;
 147       endoneof;
 148
 149       suppressif NOT ideqvallist WIFI_MANAGER_IFR_NVDATA.EapAuthMethod == EAP_AUTH_METHOD_TLS
 150                                                                           EAP_AUTH_METHOD_TTLS
 151                                                                           EAP_AUTH_METHOD_PEAP;
 152
 153         goto FORMID_ENROLL_CERT,
 154            prompt = STRING_TOKEN(STR_EAP_ENROLL_CA_CERT),
 155            help   = STRING_TOKEN(STR_EAP_ENROLL_CA_CERT_HELP),
 156            flags  = INTERACTIVE,
 157            key    = KEY_ENROLL_CA_CERT_CONNECT_NETWORK;
 158
 159         suppressif NOT ideqval WIFI_MANAGER_IFR_NVDATA.EapAuthMethod == EAP_AUTH_METHOD_TLS;
 160
 161             goto FORMID_ENROLL_CERT,
 162                prompt = STRING_TOKEN(STR_EAP_ENROLL_CLIENT_CERT),
 163                help   = STRING_TOKEN(STR_EAP_ENROLL_CLIENT_CERT_HELP),
 164                flags  = INTERACTIVE,
 165                key    = KEY_ENROLL_CLIENT_CERT_CONNECT_NETWORK;
 166
 167             goto FORMID_ENROLL_PRIVATE_KEY,
 168                prompt = STRING_TOKEN(STR_EAP_ENROLL_CLIENT_KEY),
 169                help   = STRING_TOKEN(STR_EAP_ENROLL_CLIENT_KEY_HELP),
 170                flags  = INTERACTIVE,
 171                key    = KEY_ENROLL_PRIVATE_KEY_CONNECT_NETWORK;
 172
 173         endif;
 174
 175         suppressif NOT ideqvallist WIFI_MANAGER_IFR_NVDATA.EapAuthMethod == EAP_AUTH_METHOD_TTLS
 176                                                                             EAP_AUTH_METHOD_PEAP;
 177
 178             oneof varid       = WIFI_MANAGER_IFR_NVDATA.EapSecondAuthMethod,
 179                   questionid  = KEY_EAP_SEAUTH_METHOD_CONNECT_NETWORK,
 180                   prompt      = STRING_TOKEN(STR_EAP_SEAUTH_METHOD),
 181                   help        = STRING_TOKEN(STR_EAP_SEAUTH_METHOD_HELP),
 182                   flags       = INTERACTIVE,
 183                   option text = STRING_TOKEN(STR_EAP_SEAUTH_METHOD_MSCHAPV2), value = EAP_SEAUTH_METHOD_MSCHAPV2, flags = DEFAULT;
 184             endoneof;
 185         endif;
 186
 187         string  varid  = WIFI_MANAGER_IFR_NVDATA.EapIdentity,
 188                 prompt  = STRING_TOKEN(STR_EAP_IDENTITY),
 189                 help    = STRING_TOKEN(STR_EAP_IDENTITY_HELP),
 190                 flags   = INTERACTIVE,
 191                 key     = KEY_EAP_IDENTITY_CONNECT_NETWORK,
 192                 minsize = 6,
 193                 maxsize = EAP_IDENTITY_LEN,
 194         endstring;
 195
 196         suppressif NOT ideqvallist WIFI_MANAGER_IFR_NVDATA.EapAuthMethod == EAP_AUTH_METHOD_TTLS
 197                                                                             EAP_AUTH_METHOD_PEAP;
 198
 199             password  varid    = WIFI_MANAGER_IFR_NVDATA.EapPassword,
 200                       prompt   = STRING_TOKEN(STR_EAP_PASSWORD),
 201                       help     = STRING_TOKEN(STR_EAP_PASSWORD_HELP),
 202                       flags    = INTERACTIVE,
 203                       key      = KEY_EAP_PASSWORD_CONNECT_NETWORK,
 204                       minsize  = 0,
 205                       maxsize  = PASSWORD_MAX_LEN,
 206             endpassword;
 207         endif;
 208       endif;
 209     endif;
 210
 211     subtitle text = STRING_TOKEN(STR_NULL_STRING);
 212
 213     text
 214       help   = STRING_TOKEN(STR_CONNECT_NOW_HELP),
 215       text   = STRING_TOKEN(STR_CONNECT_NOW),
 216       flags  = INTERACTIVE,
 217       key    = KEY_CONNECT_ACTION;
 218
 219     action
 220       questionid  = KEY_REFRESH_CONNECT_CONFIGURATION,
 221       prompt      = STRING_TOKEN(STR_NULL_STRING),
 222       help        = STRING_TOKEN(STR_NULL_STRING),
 223       flags       = INTERACTIVE,
 224       config      = STRING_TOKEN(STR_NULL_STRING),
 225       refreshguid = WIFI_CONFIG_CONNECT_FORM_REFRESH_GUID,
 226     endaction;
 227
 228   endform;
 229
 230   form formid = FORMID_ENROLL_CERT,
 231     title = STRING_TOKEN(STR_EAP_ENROLL_CERT);
 232
 233     goto FORMID_ENROLL_CERT,
 234          prompt = STRING_TOKEN(STR_EAP_ENROLL_CERT_FROM_FILE),
 235          help   = STRING_TOKEN(STR_EAP_ENROLL_CERT_FROM_FILE_HELP),
 236          flags  = INTERACTIVE,
 237          key    = KEY_EAP_ENROLL_CERT_FROM_FILE;
 238
 239     text
 240       help   = STRING_TOKEN(STR_NULL_STRING),
 241       text   = STRING_TOKEN(STR_EAP_ENROLLED_CERT_NAME),
 242       flags  = INTERACTIVE,
 243       key    = KEY_ENROLLED_CERT_NAME;
 244
 245     subtitle text = STRING_TOKEN(STR_NULL_STRING);
 246
 247     text
 248       help   = STRING_TOKEN(STR_SAVE_EXIT_HELP),
 249       text   = STRING_TOKEN(STR_SAVE_EXIT),
 250       flags  = INTERACTIVE,
 251       key    = KEY_SAVE_CERT_TO_MEM;
 252
 253     text
 254       help   = STRING_TOKEN(STR_NO_SAVE_EXIT_HELP),
 255       text   = STRING_TOKEN(STR_NO_SAVE_EXIT),
 256       flags  = INTERACTIVE,
 257       key    = KEY_NO_SAVE_CERT_TO_MEM;
 258
 259   endform;
 260
 261   form formid = FORMID_ENROLL_PRIVATE_KEY,
 262     title = STRING_TOKEN(STR_EAP_ENROLL_CLIENT_KEY);
 263
 264     goto FORMID_ENROLL_PRIVATE_KEY,
 265          prompt = STRING_TOKEN(STR_EAP_ENROLL_KEY_FROM_FILE),
 266          help   = STRING_TOKEN(STR_EAP_ENROLL_KEY_FROM_FILE_HELP),
 267          flags  = INTERACTIVE,
 268          key    = KEY_EAP_ENROLL_PRIVATE_KEY_FROM_FILE;
 269
 270     text
 271       help   = STRING_TOKEN(STR_NULL_STRING),
 272       text   = STRING_TOKEN(STR_EAP_ENROLLED_PRIVATE_KEY_NAME),
 273       flags  = INTERACTIVE,
 274       key    = KEY_ENROLLED_PRIVATE_KEY_NAME;
 275
 276     subtitle text = STRING_TOKEN(STR_NULL_STRING);
 277
 278     password  varid    = WIFI_MANAGER_IFR_NVDATA.PrivateKeyPassword,
 279               prompt   = STRING_TOKEN(STR_EAP_CLIENT_KEY_PASSWORD),
 280               help     = STRING_TOKEN(STR_NULL_STRING),
 281               flags    = INTERACTIVE,
 282               key      = KEY_PRIVATE_KEY_PASSWORD,
 283               minsize  = 0,
 284               maxsize  = PASSWORD_MAX_LEN,
 285     endpassword;
 286
 287     subtitle text = STRING_TOKEN(STR_NULL_STRING);
 288     subtitle text = STRING_TOKEN(STR_NULL_STRING);
 289
 290     text
 291       help   = STRING_TOKEN(STR_SAVE_EXIT_HELP),
 292       text   = STRING_TOKEN(STR_SAVE_EXIT),
 293       flags  = INTERACTIVE,
 294       key    = KEY_SAVE_PRIVATE_KEY_TO_MEM;
 295
 296     text
 297       help   = STRING_TOKEN(STR_NO_SAVE_EXIT_HELP),
 298       text   = STRING_TOKEN(STR_NO_SAVE_EXIT),
 299       flags  = INTERACTIVE,
 300       key    = KEY_NO_SAVE_PRIVATE_KEY_TO_MEM;
 301
 302   endform;
 303
 304   form formid = FORMID_WIFI_SETTINGS,
 305     title = STRING_TOKEN(STR_WIFI_SETTINGS_FORM_TITLE);
 306
 307     subtitle text = STRING_TOKEN(STR_NULL_STRING);
 308
 309     goto FORMID_HIDDEN_NETWORK_LIST,
 310          prompt = STRING_TOKEN(STR_HIDDEN_NETWORK),
 311          help   = STRING_TOKEN(STR_HIDDEN_NETWORK_HELP),
 312          flags  = INTERACTIVE,
 313          key    = KEY_HIDDEN_NETWORK;
 314
 315   endform;
 316
 317   form formid = FORMID_HIDDEN_NETWORK_LIST,
 318     title = STRING_TOKEN(STR_HIDDEN_NETWORK_FORM_TITLE);
 319
 320     string
 321       varid   = WIFI_MANAGER_IFR_NVDATA.SSId,
 322       prompt  = STRING_TOKEN(STR_SSID_TITLE),
 323       help    = STRING_TOKEN(STR_SSID_HELP),
 324       flags   = INTERACTIVE,
 325       minsize = SSID_MIN_LEN,
 326       maxsize = SSID_MAX_LEN,
 327     endstring;
 328
 329     text
 330       help   = STRING_TOKEN(STR_ADD_HIDDEN_NETWORK_HELP),
 331       text   = STRING_TOKEN(STR_ADD_HIDDEN_NETWORK),
 332       flags  = INTERACTIVE,
 333       key    = KEY_ADD_HIDDEN_NETWORK;
 334
 335     subtitle text = STRING_TOKEN(STR_NULL_STRING);
 336     subtitle text = STRING_TOKEN(STR_HIDDEN_NETWORK_LIST);
 337
 338     label LABEL_HIDDEN_NETWORK_ENTRY;
 339     label LABEL_END;
 340
 341     text
 342       help   = STRING_TOKEN(STR_REMOVE_HIDDEN_NETWORK_HELP),
 343       text   = STRING_TOKEN(STR_REMOVE_HIDDEN_NETWORK),
 344       flags  = INTERACTIVE,
 345       key    = KEY_REMOVE_HIDDEN_NETWORK;
 346
 347   endform;
 348
 349 endformset;