openapi_dot1x.h

Go to the documentation of this file.

/*********************************************************************
*
*  Copyright 2016-2023 Broadcom
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
**********************************************************************
*
* @filename  openapi_dot1x.h
*
* @purpose   IEEE 802.1x Configuration and Status
*
* @component OpEN
*
* @create    11/16/2016
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_DOT1X_H_INCLUDED
#define OPENAPI_DOT1X_H_INCLUDED

#include "openapi_common.h"
#include "openapi_user_manager.h"

/* Port authorization mode */
typedef enum
{
  OPEN_DOT1X_PORT_FORCE_UNAUTHORIZED = 1,
  OPEN_DOT1X_PORT_AUTO               = 2,
  OPEN_DOT1X_PORT_FORCE_AUTHORIZED   = 3,
  OPEN_DOT1X_PORT_NA                 = 4,
} OPEN_DOT1X_PORT_CONTROL_t;

/* Port authorization status */
typedef enum
{
  OPEN_DOT1X_PORT_STATUS_AUTHORIZED   = 1,
  OPEN_DOT1X_PORT_STATUS_UNAUTHORIZED = 2,
  OPEN_DOT1X_PORT_STATUS_NA           = 3,
} OPEN_DOT1X_PORT_STATUS_t;

/*  PAE State Machine (APM) states */
typedef enum
{
  OPEN_DOT1X_APM_INITIALIZE     = 1,
  OPEN_DOT1X_APM_DISCONNECTED   = 2,
  OPEN_DOT1X_APM_CONNECTING     = 3,
  OPEN_DOT1X_APM_AUTHENTICATING = 4,
  OPEN_DOT1X_APM_AUTHENTICATED  = 5,
  OPEN_DOT1X_APM_ABORTING       = 6,
  OPEN_DOT1X_APM_HELD           = 7,
  OPEN_DOT1X_APM_FORCE_AUTH     = 8,
  OPEN_DOT1X_APM_FORCE_UNAUTH   = 9,
} OPEN_DOT1X_APM_STATES_t;

/* Backend  State Machine (BAM) states */
typedef enum
{
  OPEN_DOT1X_BAM_REQUEST    = 1,
  OPEN_DOT1X_BAM_RESPONSE   = 2,
  OPEN_DOT1X_BAM_SUCCESS    = 3,
  OPEN_DOT1X_BAM_FAIL       = 4,
  OPEN_DOT1X_BAM_TIMEOUT    = 5,
  OPEN_DOT1X_BAM_IDLE       = 6,
  OPEN_DOT1X_BAM_INITIALIZE = 7,
} OPEN_DOT1X_BAM_STATES_t;

/* Vlan Assignment Mode */
typedef enum
{
  OPEN_DOT1X_DEFAULT_ASSIGNED_VLAN = 1,
  OPEN_DOT1X_RADIUS_ASSIGNED_VLAN  = 2,
  OPEN_DOT1X_UNAUTHENTICATED_VLAN  = 3,
  OPEN_DOT1X_GUEST_VLAN            = 4,
  OPEN_DOT1X_VOICE_VLAN            = 5,
  OPEN_DOT1X_MONITOR_MODE_VLAN     = 6,
  OPEN_DOT1X_NOT_ASSIGNED          = 7,
} OPEN_DOT1X_VLAN_ASSIGNED_MODE_t;

typedef enum
{
  OPEN_DOT1X_PAE_PORT_PROTOCOL_VERSION_1 = 1,   
  OPEN_DOT1X_PAE_PORT_PROTOCOL_VERSION_2 = 2,   
  OPEN_DOT1X_PAE_PORT_PROTOCOL_VERSION_3 = 3    
} OPEN_DOT1X_PAE_PORT_PROTOCOL_VERSION_t;

typedef enum
{
  OPEN_DOT1X_PAE_PORT_NONE_CAPABLE = 0,         
  OPEN_DOT1X_PAE_PORT_AUTH_CAPABLE              
} OPEN_DOT1X_PAE_PORT_CAPABILITY;

/*****************************************************************/
open_error_t openapiDot1xSystemAuthControlModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode);

/*****************************************************************/
open_error_t openapiDot1xSystemAuthControlModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode);

/*****************************************************************/
open_error_t openapiDot1xDefaultAuthenMethodGet(openapiClientHandle_t *client_handle, OPEN_USER_MGR_AUTH_METHOD_t *method);

/*****************************************************************/
open_error_t openapiDot1xDefaultAuthenMethodSet(openapiClientHandle_t *client_handle, OPEN_USER_MGR_AUTH_METHOD_t method);

/*****************************************************************/
open_error_t openapiDot1xPortControlModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1X_PORT_CONTROL_t *mode);

/*****************************************************************/
open_error_t openapiDot1xPortControlModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DOT1X_PORT_CONTROL_t mode);

/*****************************************************************/
open_error_t openapiDot1xPortGuestVlanGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *vlanId);

/*****************************************************************/
open_error_t openapiDot1xPortGuestVlanSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t vlanId);

/*****************************************************************/
open_error_t openapiDot1xPortMabEnabledGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *mabEnabled);

/*****************************************************************/
open_error_t openapiDot1xPortMabEnabledSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t mabEnabled);

/*****************************************************************/
open_error_t openapiDot1xPortOperatingControlModeGet(openapiClientHandle_t *client_handle,
                                                     uint32_t ifNum, OPEN_DOT1X_PORT_CONTROL_t *mode);

/*****************************************************************/
open_error_t openapiDot1xPortStatusGet(openapiClientHandle_t *client_handle,
                                       uint32_t ifNum, OPEN_DOT1X_PORT_STATUS_t *status);

/*****************************************************************/
open_error_t openapiDot1xPortPaeStateGet(openapiClientHandle_t *client_handle,
                                         uint32_t ifNum, OPEN_DOT1X_APM_STATES_t *state);

/*****************************************************************/
open_error_t openapiDot1xPortBackendAuthStateGet(openapiClientHandle_t *client_handle,
                                                 uint32_t ifNum, OPEN_DOT1X_BAM_STATES_t *state);

/*****************************************************************/
open_error_t openapiDot1xPortOperationalMabModeGet(openapiClientHandle_t *client_handle,
                                                   uint32_t ifNum, OPEN_CONTROL_t *mode);

/*****************************************************************/
open_error_t openapiDot1xPortVlanAssignedGet(openapiClientHandle_t *client_handle,
                                             uint32_t ifNum, uint32_t *vlan);

/*****************************************************************/
open_error_t openapiDot1xPortVlanAssignedReasonGet(openapiClientHandle_t *client_handle,
                                                   uint32_t ifNum, OPEN_DOT1X_VLAN_ASSIGNED_MODE_t *reason);

/*****************************************************************/
open_error_t openapiDot1xLogicalPortFirstGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *logicalIfNum);

/*****************************************************************/
open_error_t openapiDot1xLogicalPortNextGet(openapiClientHandle_t *client_handle, uint32_t logicalIfNum, uint32_t *nextLogicalIfNum);

/*****************************************************************/
open_error_t openapiDot1xLogicalPortSupplicantMacAddrGet(openapiClientHandle_t *client_handle, uint32_t logicalIfNum, open_buffdesc *macAddr);


/*****************************************************************/
open_error_t openapiDot1xLogicalPortVlanAssignmentGet(openapiClientHandle_t *client_handle, uint32_t logicalIfNum, uint32_t *vlan, OPEN_DOT1X_VLAN_ASSIGNED_MODE_t *reason);

/*************************************************************************/
open_error_t openapiDot1xEapolFloodModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode);

/*************************************************************************/
open_error_t openapiDot1xEapolFloodModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode);

/*************************************************************************/
open_error_t openapiDot1xPortQuietPeriodSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t quietPeriod);

/*************************************************************************/
open_error_t openapiDot1xPortQuietPeriodGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *quietPeriod);

/*************************************************************************/
open_error_t openapiDot1xPortTxPeriodSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t txPeriod);

/*************************************************************************/
open_error_t openapiDot1xPortTxPeriodGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *txPeriod);

/*************************************************************************/
open_error_t openapiDot1xPortEapolFramesRxGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eapolFramesRx);

/*************************************************************************/
open_error_t openapiDot1xPortEapolFramesTxGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eapolFramesTx);

/*************************************************************************/
open_error_t openapiDot1xPortEapolStartFramesRxGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eapolStartFramesRx);

/*************************************************************************/
open_error_t openapiDot1xPortEapolLogoffFramesRxGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eapolLogoffFramesRx);

/*************************************************************************/
open_error_t openapiDot1xPortEapRespIdFramesRxGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eapRespIdFramesRx);

/*************************************************************************/
open_error_t openapiDot1xPortEapResponseFramesRxGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eapResponseFramesRx);

/*************************************************************************/
open_error_t openapiDot1xPortEapReqIdFramesTxGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eapReqIdFramesTx);

/*************************************************************************/
open_error_t openapiDot1xPortEapReqFramesTxGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eapReqFramesTx);

/*************************************************************************/
open_error_t openapiDot1xPortInvalidEapolFramesRxGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *invalidEapolFramesRx);

/*************************************************************************/
open_error_t openapiDot1xPortEapLengthErrorFramesRxGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *eapLengthErrorFramesRx);

/*************************************************************************/
open_error_t openapiDot1xPortLastEapolFrameVersionGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *lastEapolFrameVersion);

/*************************************************************************/
open_error_t openapiDot1xPortLastEapolFrameSourceGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, open_buffdesc *lastEapolFrameSource);

/*************************************************************************/
open_error_t openapiDot1xPortStatsClear(openapiClientHandle_t *client_handle, uint32_t intIfNum);

/*************************************************************************/
open_error_t
openapiDot1xPortMaxReAuthReqIdentitySet(openapiClientHandle_t *client_handle,
                                        uint32_t intIfNum,
                                        uint32_t maxReAuthReqIndentity);

/*************************************************************************/
open_error_t
openapiDot1xPortMaxReAuthReqIdentityGet(openapiClientHandle_t *client_handle, 
                                        uint32_t intIfNum,
                                        uint32_t *pMaxReAuthReqIndentity);

/*************************************************************************/
open_error_t openapiDot1xPortMaxReqSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t maxReq);

/*************************************************************************/
open_error_t openapiDot1xPortMaxReqGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *pMaxReq);

/*************************************************************************/
open_error_t openapiDot1xPortSuppTimeoutSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t suppTimeout);

/*************************************************************************/
open_error_t openapiDot1xPortSuppTimeoutGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *pSuppTimeout);

/*************************************************************************/
open_error_t openapiDot1xPortServerTimeoutSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t serverTimeout);

/*************************************************************************/
open_error_t openapiDot1xPortServerTimeoutGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *pServerTimeout);

/*************************************************************************/
open_error_t openapiDot1xPortPaeCapabilitiesSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_DOT1X_PAE_PORT_CAPABILITY paeCapability);

/*************************************************************************/
open_error_t openapiDot1xPortPaeCapabilitiesGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_DOT1X_PAE_PORT_CAPABILITY *pPaeCapability);

/*************************************************************************/
open_error_t openapiDot1xPortProtocolVersionGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_DOT1X_PAE_PORT_PROTOCOL_VERSION_t *pProtocolVersion);



#endif /* OPENAPI_DOT1X_H_INCLUDED */