ONEX_AUTH_PARAMS structure

The ONEX_AUTH_PARAMS structure contains 802.1X authentication parameters used for 802.1X authentication.

Syntax


typedef struct _ONEX_AUTH_PARAMS {
  BOOL               fUpdatePending;
  ONEX_VARIABLE_BLOB oneXConnProfile;
  ONEX_AUTH_IDENTITY authIdentity;
  DWORD              dwQuarantineState;
  DWORD              fSessionId  :1;
  DWORD              fhUserToken  :1;
  DWORD              fOnexUserProfile  :1;
  DWORD              fIdentity  :1;
  DWORD              fUserName  :1;
  DWORD              fDomain  :1;
  DWORD              dwSessionId;
  DWORD              hUserToken;
  ONEX_VARIABLE_BLOB OneXUserProfile;
  ONEX_VARIABLE_BLOB Identity;
  ONEX_VARIABLE_BLOB UserName;
  ONEX_VARIABLE_BLOB Domain;
} ONEX_AUTH_PARAMS, *PONEX_AUTH_PARAMS;

Members

fUpdatePending

Indicates if a status update is pending for 802.X authentication.

oneXConnProfile

The 802.1X authentication connection profile. This member contains an embedded ONEX_CONNECTION_PROFILE structure starting at the dwOffset member of the ONEX_VARIABLE_BLOB.

authIdentity

The identity used for 802.1X authentication status. This member is a value from the ONEX_AUTH_IDENTITY enumeration.

dwQuarantineState

The quarantine isolation state value of the local computer. The isolation state determines its network connectivity. This member corresponds to a value from the EAPHost ISOLATION_STATE enumeration.

fSessionId

Indicates if the ONEX_AUTH_PARAMS structure contains a session ID in the dwSessionId member.

fhUserToken

Indicates if the ONEX_AUTH_PARAMS structure contains a user token handle in the hUserToken member.

For security reasons, the hUserToken member of the ONEX_AUTH_PARAMS structure returned in the authParams member of the ONEX_RESULT_UPDATE_DATA structure is always set to NULL.

fOnexUserProfile

Indicates if the ONEX_AUTH_PARAMS structure contains an 802.1X user profile in the OneXUserProfile member.

For security reasons, the OneXUserProfile member of the ONEX_AUTH_PARAMS structure returned in the authParams member of the ONEX_RESULT_UPDATE_DATA structure is always set to NULL.

fIdentity

Indicates if the ONEX_AUTH_PARAMS structure contains an 802.1X identity in the Identity member.

fUserName

Indicates if the ONEX_AUTH_PARAMS structure contains a user name used for 802.1X authentication in the UserName member.

fDomain

Indicates if the ONEX_AUTH_PARAMS structure contains a domain used for 802.1X authentication in the Domain member.

dwSessionId

The session ID of the user currently logged on to the console. This member corresponds to the value returned by the WTSGetActiveConsoleSessionId function. This member contains a session ID if the fSessionId bitfield member is set.

hUserToken

The user token handle used for 802.1X authentication. This member contains a user token handle if the fhUserToken bitfield member is set.

For security reasons, the hUserToken member of the ONEX_AUTH_PARAMS structure returned in the authParams member of the ONEX_RESULT_UPDATE_DATA structure is always set to NULL.

OneXUserProfile

The 802.1X user profile used for 802.1X authentication. This member contains an embedded user profile starting at the dwOffset member of the ONEX_VARIABLE_BLOB if the fOneXUserProfile bitfield member is set.

For security reasons, the OneXUserProfile member of the ONEX_AUTH_PARAMS structure returned in the authParams member of the ONEX_RESULT_UPDATE_DATA structure is always set to NULL.

Identity

The 802.1X identity used for 802.1X authentication. This member contains a NULL-terminated Unicode string with the identity starting at the dwOffset member of the ONEX_VARIABLE_BLOB if the fIdentity bitfield member is set.

UserName

The user name used for 802.1X authentication. This member contains a NULL-terminated Unicode string with the user name starting at the dwOffset member of the ONEX_VARIABLE_BLOB if the fUserName bitfield member is set.

Domain

The domain used for 802.1X authentication. This member contains a NULL-terminated Unicode string with the domain starting at the dwOffset member of the ONEX_VARIABLE_BLOB if the fDomain bitfield member is set.

Remarks

The ONEX_AUTH_PARAMS structure is used by the 802.1X module, a new wireless configuration component supported on Windows Vista and later.

The ONEX_RESULT_UPDATE_DATA contains information on a status change to 802.1X authentication. The ONEX_RESULT_UPDATE_DATA structure is returned when the NotificationSource member of the WLAN_NOTIFICATION_DATA structure is WLAN_NOTIFICATION_SOURCE_ONEX and the NotificationCode member of the WLAN_NOTIFICATION_DATA structure for received notification is OneXNotificationTypeResultUpdate. For this notification, the pData member of the WLAN_NOTIFICATION_DATA structure points to an ONEX_RESULT_UPDATE_DATA structure that contains information on the 802.1X authentication status change.

If the fOneXAuthParams member in the ONEX_RESULT_UPDATE_DATA structure is set, then the authParams member of the ONEX_RESULT_UPDATE_DATA structure contains an ONEX_VARIABLE_BLOB structure with an ONEX_AUTH_PARAMS structure embedded starting at the dwOffset member of the ONEX_VARIABLE_BLOB.

For security reasons, the hUserToken and OneXUserProfile members of the ONEX_AUTH_PARAMS structure returned in the authParams member are always set to NULL.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Dot1x.h

See also

About the ACM Architecture
ISOLATION_STATE
ONEX_EAP_ERROR
ONEX_AUTH_IDENTITY
ONEX_NOTIFICATION_TYPE
ONEX_RESULT_UPDATE_DATA
ONEX_VARIABLE_BLOB
WLAN_NOTIFICATION_DATA
WlanRegisterNotification
WTSGetActiveConsoleSessionId

 

 

Show: