Enum wlan_common::security::wpa::Wpa

pub enum Wpa<C = ()>
where
    C: CredentialData,
{
    Wpa1 {
        credentials: <C::Personal as PersonalData>::Wpa1,
    },
    Wpa2 {
        cipher: Option<Wpa2Cipher>,
        authentication: Authentication<<C::Personal as PersonalData>::Wpa2, <C::Enterprise as EnterpriseData>::Wpa2>,
    },
    Wpa3 {
        cipher: Option<Wpa3Cipher>,
        authentication: Authentication<<C::Personal as PersonalData>::Wpa3, <C::Enterprise as EnterpriseData>::Wpa3>,
    },
}

General description of WPA and its authentication.

This type is typically used via the WpaAuthenticator and WpaDescriptor type definitions, which represent WPA authenticators and descriptors, respectively. It is not generally necessary to interact with this type directly.

This type constructor describes the configuration of a WPA security protocol and additionally contains authentication (credential) data defined by its type parameter. For authenticators, this data represents credentials, such as a PSK or passphrase. For descriptors, this data is the unit type (), and so no authentication data is available. See the data module and CredentialData trait for more.

Variants

Wpa1

Fields

credentials: <C::Personal as PersonalData>::Wpa1

Wpa2

Fields

cipher: Option<Wpa2Cipher>

authentication: Authentication<<C::Personal as PersonalData>::Wpa2, <C::Enterprise as EnterpriseData>::Wpa2>

Wpa3

Fields

cipher: Option<Wpa3Cipher>

authentication: Authentication<<C::Personal as PersonalData>::Wpa3, <C::Enterprise as EnterpriseData>::Wpa3>

Implementations

impl<C> Wpa<C>

where C: CredentialData,

pub fn into_descriptor(self) -> Wpa<()>

Converts a Wpa into a descriptor with no payload (the unit type ()). Any payload (i.e., credentials) are dropped.

pub fn cipher(&self) -> Option<Cipher>

Gets the configured cipher.

This function coalesces the ciphers supported by various versions of WPA and returns the generalized Cipher type.

Note that WPA1 is not configurable in this way and always uses TKIP (and so this function will always return Some(Cipher::TKIP) for WPA1). For other versions of WPA, the configured cipher may not be known and this function returns None in that case. Importantly, this does not mean that no cipher is used, but rather that the specific cipher is unspecified or unknown.

impl Wpa

pub fn bind( self, credentials: BareCredentials, ) -> Result<WpaAuthenticator, SecurityError>

impl Wpa<AuthenticatorData>

pub fn into_credentials(self) -> Credentials

Converts a WPA authenticator into its credentials.

The output of this function is general and describes all versions of WPA. This means it cannot be used to determine which version of WPA has been specified. Note that WPA1 specifies its credentials as WPA1 Personal via Authentication::Personal even though WPA1 has no Enterprise suite.

pub fn to_credentials(&self) -> Credentials

Trait Implementations

impl<C> Clone for Wpa<C>

where C: CredentialData,

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C> Debug for Wpa<C>

where C: CredentialData,

fn fmt(&self, __f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Wpa<AuthenticatorData>> for SecurityAuthenticator

fn from(authenticator: WpaAuthenticator) -> Self

Converts to this type from the input type.

impl<C> From<Wpa<C>> for Protocol

where C: CredentialData,

fn from(wpa: Wpa<C>) -> Self

Converts to this type from the input type.

impl From<Wpa> for SecurityDescriptor

fn from(descriptor: WpaDescriptor) -> Self

Converts to this type from the input type.

impl<C> PartialEq for Wpa<C>

where C: CredentialData,

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<C> Copy for Wpa<C>

where C: CredentialData, <C::Personal as PersonalData>::Wpa1: Copy, <C::Personal as PersonalData>::Wpa2: Copy, <C::Personal as PersonalData>::Wpa3: Copy, <C::Enterprise as EnterpriseData>::Wpa2: Copy, <C::Enterprise as EnterpriseData>::Wpa3: Copy,

impl<C> Eq for Wpa<C>

where C: CredentialData,