Gjsify LogoGjsify Logo

Interface SettingWirelessSecurity_ConstructProps

Hierarchy

Index

Properties

auth_alg?: string

When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.

fils?: number

Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of %NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (use global default value), %NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (disable FILS), %NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (enable FILS if the supplicant and the access point support it) or %NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (enable FILS and fail if not supported). When set to %NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT and no global default is set, FILS will be optionally enabled.

group?: string[]

A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".

key_mgmt?: string

Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only).

This property must be set for any Wi-Fi connection that uses security.

leap_password?: string

The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").

leap_password_flags?: NM.SettingSecretFlags

Flags indicating how to handle the #NMSettingWirelessSecurity:leap-password property.

leap_username?: string

The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").

pairwise?: string[]

A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "tkip" or "ccmp".

pmf?: number

Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of %NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (use global default value), %NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE (disable PMF), %NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL (enable PMF if the supplicant and the access point support it) or %NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED (enable PMF and fail if not supported). When set to %NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT and no global default is set, PMF will be optionally enabled.

proto?: string[]

List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.

psk?: string

Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication.

Flags indicating how to handle the #NMSettingWirelessSecurity:psk property.

wep_key0?: string

Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted.

wep_key1?: string

Index 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.

wep_key2?: string

Index 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.

wep_key3?: string

Index 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.

wep_key_flags?: NM.SettingSecretFlags

Flags indicating how to handle the #NMSettingWirelessSecurity:wep-key0, #NMSettingWirelessSecurity:wep-key1, #NMSettingWirelessSecurity:wep-key2, and #NMSettingWirelessSecurity:wep-key3 properties.

wep_key_type?: NM.WepKeyType

Controls the interpretation of WEP keys. Allowed values are %NM_WEP_KEY_TYPE_KEY, in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or %NM_WEP_KEY_TYPE_PASSPHRASE, in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.

wep_tx_keyidx?: number

When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.

wps_method?: number

Flags indicating which mode of WPS is to be used if any.

There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities.

WPS can be disabled by setting this property to a value of 1.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method