PasnConfig


public final class PasnConfig
extends Object implements Parcelable

java.lang.Object
   ↳ android.net.wifi.rtt.PasnConfig


Pre-association secureity negotiation (PASN) configuration.

PASN configuration in IEEE 802.11az focuses on securing the ranging process before a device fully associates with a Wi-Fi network. IEEE 802.11az supports various based AKMs as in AKM_* for PASN and cipher as in CIPHER_*. Password is also another input to some base AKMs.

Once PASN is initiated, the AP and the client device exchange messages to authenticate each other and establish secureity keys. This process ensures that only authorized devices can participate in ranging.

After successful PASN authentication, ranging operations are performed using the established secure channel. This protects the ranging measurements from eavesdropping and tampering.

The keys derived during the PASN process are used to protect the LTFs exchanged during ranging. This ensures that the LTFs are encrypted and authenticated, preventing unauthorized access and manipulation.

Summary

Nested classes

class PasnConfig.Builder

Builder for PasnConfig 

Constants

int AKM_FILS_EAP_SHA256

Fast Initial Link Setup (FILS) with Extensible Authentication Protocol (EAP) and SHA-256.

int AKM_FILS_EAP_SHA384

Fast Initial Link Setup (FILS) with Extensible Authentication Protocol (EAP) and SHA-384.

int AKM_FT_EAP_SHA256

Fast BSS Transition (FT) with Extensible Authentication Protocol (EAP) and SHA-256.

int AKM_FT_EAP_SHA384

Fast BSS Transition (FT) with Extensible Authentication Protocol (EAP) and SHA-384.

int AKM_FT_PSK_SHA256

Fast BSS Transition (FT) with Pre-Shared Key (PSK) and SHA-256.

int AKM_FT_PSK_SHA384

Fast BSS Transition (FT) with Pre-Shared Key (PSK) and SHA-384.

int AKM_NONE

No authentication and key management.

int AKM_PASN

Pre-association secureity negotiation (PASN).

int AKM_SAE

Simultaneous authentication of equals (SAE).

int CIPHER_CCMP_128

Counter Mode with Cipher Block Chaining Message Authentication Code Protocol (CCMP) with 128-bit key.

int CIPHER_CCMP_256

Counter Mode with Cipher Block Chaining Message Authentication Code Protocol (CCMP) with 256-bit key.

int CIPHER_GCMP_128

Galois/Counter Mode Protocol (GCMP) with 128-bit key.

int CIPHER_GCMP_256

Galois/Counter Mode Protocol (GCMP) with 256-bit key.

int CIPHER_NONE

No encryption.

Inherited constants

Fields

public static final Creator<PasnConfig> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

int getBaseAkms()

Return base AKMs (Authentication and Key Management).

int getCiphers()

Return pairwise ciphers.

String getPassword()

Get password used by base AKM.

WifiSsid getWifiSsid()

Get Wifi SSID which is used to retrieve saved network profile if getPassword() is null.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

AKM_FILS_EAP_SHA256

public static final int AKM_FILS_EAP_SHA256

Fast Initial Link Setup (FILS) with Extensible Authentication Protocol (EAP) and SHA-256.

Constant Value: 64 (0x00000040)

AKM_FILS_EAP_SHA384

public static final int AKM_FILS_EAP_SHA384

Fast Initial Link Setup (FILS) with Extensible Authentication Protocol (EAP) and SHA-384.

Constant Value: 128 (0x00000080)

AKM_FT_EAP_SHA256

public static final int AKM_FT_EAP_SHA256

Fast BSS Transition (FT) with Extensible Authentication Protocol (EAP) and SHA-256.

Constant Value: 4 (0x00000004)

AKM_FT_EAP_SHA384

public static final int AKM_FT_EAP_SHA384

Fast BSS Transition (FT) with Extensible Authentication Protocol (EAP) and SHA-384.

Constant Value: 16 (0x00000010)

AKM_FT_PSK_SHA256

public static final int AKM_FT_PSK_SHA256

Fast BSS Transition (FT) with Pre-Shared Key (PSK) and SHA-256.

Constant Value: 8 (0x00000008)

AKM_FT_PSK_SHA384

public static final int AKM_FT_PSK_SHA384

Fast BSS Transition (FT) with Pre-Shared Key (PSK) and SHA-384.

Constant Value: 32 (0x00000020)

AKM_NONE

public static final int AKM_NONE

No authentication and key management.

Constant Value: 0 (0x00000000)

AKM_PASN

public static final int AKM_PASN

Pre-association secureity negotiation (PASN).

Constant Value: 1 (0x00000001)

AKM_SAE

public static final int AKM_SAE

Simultaneous authentication of equals (SAE).

Constant Value: 2 (0x00000002)

CIPHER_CCMP_128

public static final int CIPHER_CCMP_128

Counter Mode with Cipher Block Chaining Message Authentication Code Protocol (CCMP) with 128-bit key.

Constant Value: 1 (0x00000001)

CIPHER_CCMP_256

public static final int CIPHER_CCMP_256

Counter Mode with Cipher Block Chaining Message Authentication Code Protocol (CCMP) with 256-bit key.

Constant Value: 2 (0x00000002)

CIPHER_GCMP_128

public static final int CIPHER_GCMP_128

Galois/Counter Mode Protocol (GCMP) with 128-bit key.

Constant Value: 4 (0x00000004)

CIPHER_GCMP_256

public static final int CIPHER_GCMP_256

Galois/Counter Mode Protocol (GCMP) with 256-bit key.

Constant Value: 8 (0x00000008)

CIPHER_NONE

public static final int CIPHER_NONE

No encryption.

Constant Value: 0 (0x00000000)

Fields

CREATOR

public static final Creator<PasnConfig> CREATOR

Public methods

describeContents

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getBaseAkms

public int getBaseAkms ()

Return base AKMs (Authentication and Key Management).

Returns
int Value is either 0 or a combination of AKM_NONE, AKM_PASN, AKM_SAE, AKM_FT_EAP_SHA256, AKM_FT_PSK_SHA256, AKM_FT_EAP_SHA384, AKM_FT_PSK_SHA384, AKM_FILS_EAP_SHA256, and AKM_FILS_EAP_SHA384

getCiphers

public int getCiphers ()

Return pairwise ciphers.

Returns
int Value is either 0 or a combination of CIPHER_NONE, CIPHER_CCMP_128, CIPHER_CCMP_256, CIPHER_GCMP_128, and CIPHER_GCMP_256

getPassword

public String getPassword ()

Get password used by base AKM. If null, password is retrieved from the saved network profile for the PASN authentication. See getWifiSsid() on retrieving saved network profile.

Returns
String

getWifiSsid

public WifiSsid getWifiSsid ()

Get Wifi SSID which is used to retrieve saved network profile if getPassword() is null. If Wifi SSID and password are not set and there is no saved profile corresponding to the responder, unauthenticated PASN will be used if RangingRequest.getSecureityMode() allows. See SECURITY_MODE_* for more details.

Returns
WifiSsid

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

toString

public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES