openapi_authmgr.h

Go to the documentation of this file.

/*********************************************************************
*
*  Copyright 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_authmgr.h
*
* @purpose   Authentication manager Configuration and Status
*
* @component OPEN
*
* @create    02/23/2023
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_AUTHMGR_H_INCLUDED
#define OPENAPI_AUTHMGR_H_INCLUDED

#include "openapi_common.h"

#define OPEN_AUTHMGR_USER_NAME_LEN 65

#define OPEN_AUTHMGR_AUTH_HISTORY_TABLE_ENTRY_INDEX_MAX 0xFFFFFFFF

typedef enum
{
  OPEN_AUTHMGR_INITIALIZE = 0,    
  OPEN_AUTHMGR_AUTHENTICATING,    
  OPEN_AUTHMGR_AUTHENTICATED,     
  OPEN_AUTHMGR_HELD,              
  OPEN_AUTHMGR_UNAUTHENTICATED,   
  OPEN_AUTHMGR_STATES             
} OPEN_AUTHMGR_STATES_t;          
typedef enum
{
  OPEN_AUTHMGR_TYPE_ORDER = 1,  
  OPEN_AUTHMGR_TYPE_PRIORITY,   
} OPEN_AUTHMGR_METHOD_TYPE_t;

typedef enum
{
  OPEN_AUTHMGR_METHOD_NONE = 0,  
  OPEN_AUTHMGR_METHOD_8021X,     
  OPEN_AUTHMGR_METHOD_MAB,       
  OPEN_AUTHMGR_METHOD_CP         
} OPEN_AUTHMGR_METHOD_t;

typedef enum
{
  OPEN_AUTHMGR_PORT_STATUS_NA = 0,        
  OPEN_AUTHMGR_PORT_STATUS_AUTHORIZED,    
  OPEN_AUTHMGR_PORT_STATUS_UNAUTHORIZED   
} OPEN_AUTHMGR_PORT_STATUS_t;

typedef enum
{
  OPEN_AUTHMGR_NOT_ASSIGNED = 0,         
  OPEN_AUTHMGR_DEFAULT_ASSIGNED_VLAN,    
  OPEN_AUTHMGR_RADIUS_ASSIGNED_VLAN,     
  OPEN_AUTHMGR_UNAUTHENTICATED_VLAN,     
  OPEN_AUTHMGR_GUEST_VLAN,               
  OPEN_AUTHMGR_VOICE_VLAN,               
  OPEN_AUTHMGR_MONITOR_MODE_VLAN,        
  OPEN_AUTHMGR_CRITICAL_VLAN             
} OPEN_AUTHMGR_VLAN_ASSIGNED_MODE_t;

typedef enum
{
  OPEN_AUTHMGR_TERMINATION_ACTION_DEFAULT = 1,   
  OPEN_AUTHMGR_TERMINATION_ACTION_RADIUS         
} OPEN_AUTHMGR_TERMINATION_ACTION_t;      

typedef enum
{
  OPEN_AUTHMGR_PORT_FORCE_UNAUTHORIZED = 1,      
  OPEN_AUTHMGR_PORT_AUTO               = 2,      
  OPEN_AUTHMGR_PORT_FORCE_AUTHORIZED   = 3,      
  OPEN_AUTHMGR_PORT_NA                 = 4,      
} OPEN_AUTHMGR_PORT_CONTROL_t;

typedef enum
{
  OPEN_AUTHMGR_INVALID_HOST_MODE = 0,        
  OPEN_AUTHMGR_SINGLE_AUTH_MODE = 1,         
  OPEN_AUTHMGR_MULTI_HOST_MODE = 2,          
  OPEN_AUTHMGR_MULTI_DOMAIN_AUTH_MODE = 3,   
  OPEN_AUTHMGR_MULTI_AUTH_MODE = 4,          
  OPEN_AUTHMGR_MULTI_DOMAIN_HOST_MODE = 5,   
} OPEN_AUTHMGR_HOST_CONTROL_t;

typedef enum
{
  OPEN_AUTHMGR_PORT_DIRECTION_INVALID = 0,      
  OPEN_AUTHMGR_PORT_DIRECTION_BOTH,             
  OPEN_AUTHMGR_PORT_DIRECTION_IN                
} OPEN_AUTHMGR_PORT_DIRECTION_t;

/*************************************************************************/
open_error_t openapiAuthMgrDynamicVlanCreationModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t dynamicVlanMode);

/*************************************************************************/
open_error_t openapiAuthMgrDynamicVlanCreationModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *dynamicVlanMode);

/*************************************************************************/
open_error_t openapiAuthMgrVlanAssignmentModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t vlanAssignmentMode);

/*************************************************************************/
open_error_t openapiAuthMgrVlanAssignmentModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *vlanAssignmentMode);

/*************************************************************************/
open_error_t openapiAuthMgrPortAuthMethodOrderSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t index, OPEN_AUTHMGR_METHOD_t method);

/*************************************************************************/
open_error_t openapiAuthMgrPortAuthMethodOrderGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t index, OPEN_AUTHMGR_METHOD_t *method);

/*************************************************************************/
open_error_t openapiAuthMgrPortAuthMethodPrioritySet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t index, OPEN_AUTHMGR_METHOD_t method);

/*************************************************************************/
open_error_t openapiAuthMgrPortAuthMethodPriorityGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t index, OPEN_AUTHMGR_METHOD_t *method);

/*************************************************************************/
open_error_t openapiAuthMgrPortMaxUsersSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t maxUsers);

/*************************************************************************/
open_error_t openapiAuthMgrPortMaxUsersGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *maxUsers);

/*************************************************************************/
open_error_t openapiAuthMgrPortUnauthenticatedVlanSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t vlanId);

/*************************************************************************/
open_error_t openapiAuthMgrPortUnauthenticatedVlanGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *vlanId);

/*************************************************************************/
open_error_t openapiAuthMgrPortMaxAuthAttemptsSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t maxAuthAttempts);

/*************************************************************************/
open_error_t openapiAuthMgrPortMaxAuthAttemptsGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *maxAuthAttempts);

/*************************************************************************/
open_error_t openapiAuthMgrEnabledMethodGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t index, OPEN_AUTHMGR_METHOD_t *method);

/*************************************************************************/
open_error_t openapiAuthMgrEnabledPriorityGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t index, OPEN_AUTHMGR_METHOD_t *method);

/*************************************************************************/
open_error_t openapiAuthMgrNumClientsGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *clientsCount);

/*************************************************************************/
open_error_t openapiAuthMgrLogicalPortClientMacAddrGet(openapiClientHandle_t *client_handle, uint32_t lIntIfNum, open_buffdesc *macAddrBuffDesc);

/*************************************************************************/
open_error_t openapiAuthMgrLogicalPortClientAuthStatusGet(openapiClientHandle_t *client_handle, uint32_t lIntIfNum, OPEN_AUTHMGR_PORT_STATUS_t *authStatus);

/*************************************************************************/
open_error_t openapiAuthMgrLogicalPortClientAuthStateGet(openapiClientHandle_t *client_handle, uint32_t lIntIfNum, OPEN_AUTHMGR_STATES_t *authState);

/*************************************************************************/
open_error_t openapiAuthMgrLogicalPortClientReauthStateGet(openapiClientHandle_t *client_handle, uint32_t lIntIfNum, OPEN_CONTROL_t *reauthState);

/*************************************************************************/
open_error_t openapiAuthMgrLogicalPortUserNameGet(openapiClientHandle_t *client_handle, uint32_t lIntIfNum, open_buffdesc *userName);

/*************************************************************************/
open_error_t openapiAuthMgrLogicalPortClientAuthenticatedMethodGet(openapiClientHandle_t *client_handle, uint32_t lIntIfNum, OPEN_AUTHMGR_METHOD_t *method);

/*************************************************************************/
open_error_t openapiAuthMgrLogicalPortClientVlanTypeGet(openapiClientHandle_t *client_handle, uint32_t lIntIfNum, uint32_t *vlanType);

/*************************************************************************/
open_error_t openapiAuthMgrLogicalPortSessionTimeGet(openapiClientHandle_t *client_handle, uint32_t lIntIfNum, uint32_t *sessionTime);

/*************************************************************************/
open_error_t openapiAuthMgrLogicalPortSessionTimeoutGet(openapiClientHandle_t *client_handle, uint32_t lIntIfNum, uint32_t *sessionTimeout);

/*************************************************************************/
open_error_t openapiAuthmgrLogicalPortTimeLeftForTerminateActionGet(openapiClientHandle_t *client_handle, uint32_t lIntIfNum, uint32_t *timeLeft);

/*************************************************************************/
open_error_t openapiAuthMgrLogicalPortTerminationActionGet(openapiClientHandle_t *client_handle, uint32_t lIntIfNum, uint32_t *terminationAction);

/*************************************************************************/
open_error_t openapiAuthMgrLogicalPortFilterIdGet(openapiClientHandle_t *client_handle, uint32_t lIntIfNum, open_buffdesc *filterId);

/*************************************************************************/
open_error_t openapiAuthMgrAuthenticationReAuthPeriodFromSeverGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *reAuthPeriod);

/*************************************************************************/
open_error_t openapiDbAuthMgrAuthenticationReAuthPeriodGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *reAuthPeriod);

/*************************************************************************/
open_error_t openapiAuthMgrLogicalPortFirstGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *firstlIntIfNum);

/*************************************************************************/
open_error_t openapiAuthMgrLogicalPortNextGet(openapiClientHandle_t *client_handle, uint32_t lIntIfNum, uint32_t *nextlIntIfNum);

/*****************************************************************/
open_error_t openapiAuthMgrPortControlModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_AUTHMGR_PORT_CONTROL_t *mode);

/*****************************************************************/
open_error_t openapiAuthMgrPortControlModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_AUTHMGR_PORT_CONTROL_t mode);

/*****************************************************************/
open_error_t openapiAuthMgrPortStatusGet(openapiClientHandle_t *client_handle,
                                       uint32_t ifNum, OPEN_AUTHMGR_PORT_STATUS_t *status);

/*****************************************************************/
open_error_t openapiAuthMgrPortOperatingControlModeGet(openapiClientHandle_t *client_handle,
                                                     uint32_t ifNum, OPEN_AUTHMGR_PORT_CONTROL_t *mode);
/*****************************************************************/
open_error_t openapiAuthMgrAdminModeSet(openapiClientHandle_t *client_handle, 
                                        OPEN_CONTROL_t mode);

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

/*****************************************************************/
open_error_t openapiAuthMgrAuthenticationHostModeSet(openapiClientHandle_t *client_handle,
                                                     uint32_t ifNum,                                    
                                                     OPEN_AUTHMGR_HOST_CONTROL_t mode);

/*****************************************************************/
open_error_t openapiAuthMgrAuthenticationHostModeGet(openapiClientHandle_t *client_handle,
                                                     uint32_t ifNum,
                                                     OPEN_AUTHMGR_HOST_CONTROL_t *mode);

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

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


/*****************************************************************/
open_error_t openapiAuthMgrAuthenticationPeriodicSet(openapiClientHandle_t *client_handle,
                                                     uint32_t ifNum,
                                                     OPEN_BOOL_t val);

/*****************************************************************/
open_error_t openapiAuthMgrAuthenticationPeriodicGet(openapiClientHandle_t *client_handle,
                                                     uint32_t ifNum,
                                                     OPEN_BOOL_t *val);
/*****************************************************************/
open_error_t openapiAuthMgrAuthenticationReAuthPeriodFromServerSet(openapiClientHandle_t *client_handle,
                                                                   uint32_t ifNum,
                                                                   OPEN_BOOL_t val);

/*****************************************************************/
open_error_t openapiAuthMgrAuthenticationReAuthPeriodServerGet(openapiClientHandle_t *client_handle,
                                                               uint32_t ifNum,
                                                               OPEN_BOOL_t *val);
/*****************************************************************/
open_error_t
openapiAuthMgrLogicalPortVlanAssignmentGet(openapiClientHandle_t *client_handle,
                                           uint32_t logicalIfNum, 
                                           uint32_t *vlan,
                                           OPEN_AUTHMGR_VLAN_ASSIGNED_MODE_t *reason);

/*****************************************************************/
open_error_t openapiAuthMgrAuthenticationReAuthPeriodSet(openapiClientHandle_t *client_handle,
                                                         uint32_t ifNum,
                                                         uint32_t val);

/*****************************************************************/
open_error_t openapiAuthMgrAuthenticationReAuthPeriodGet(openapiClientHandle_t *client_handle,
                                                         uint32_t ifNum,
                                                         uint32_t *val);

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

/*****************************************************************/
open_error_t openapiAuthMgrPortVlanAssignedReasonGet(openapiClientHandle_t *client_handle,
                                                   uint32_t ifNum, OPEN_AUTHMGR_VLAN_ASSIGNED_MODE_t *reason);

/*************************************************************************/
open_error_t openapiAuthMgrHistoryLogIndexNextGet(openapiClientHandle_t *client_handle,
                                                  uint32_t *intIfNum,
                                                  uint32_t *entryIndex);

/*************************************************************************/
open_error_t openapiAuthMgrHistoryLogReverseIndexNextGet(openapiClientHandle_t *client_handle,
                                                         uint32_t *intIfNum,
                                                         uint32_t *entryIndex);

/*************************************************************************/
open_error_t openapiAuthMgrHistoryLogEntryIsValid(openapiClientHandle_t *client_handle,
                                                  uint32_t intIfNum,
                                                  uint32_t entryIndex);

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

/*************************************************************************/
open_error_t openapiAuthMgrHistoryLogPurgeAll(openapiClientHandle_t *client_handle);

/*************************************************************************/
open_error_t openapiAuthMgrHistoryLogTimestampGet(openapiClientHandle_t *client_handle,
                                                  uint32_t intIfNum,
                                                  uint32_t entryIndex,
                                                  open_buffdesc *timeStamp);

/*************************************************************************/
open_error_t openapiAuthMgrHistoryLogMethodGet(openapiClientHandle_t *client_handle,
                                               uint32_t intIfNum,
                                               uint32_t entryIndex,
                                               OPEN_AUTHMGR_METHOD_t *method);

/*****************************************************************/
open_error_t openapiAuthMgrHistoryLogReasonCodeGet(openapiClientHandle_t *client_handle,
                                                   uint32_t intIfNum,
                                                   uint32_t entryIndex,
                                                   uint32_t *reasonCode);

/*****************************************************************/
open_error_t openapiAuthMgrHistoryLogReasonStringGet(openapiClientHandle_t *client_handle,
                                                     uint32_t intIfNum,
                                                     uint32_t entryIndex,
                                                     uint32_t reasonCode,
                                                     open_buffdesc *reason);

/*************************************************************************/
open_error_t openapiAuthMgrHistoryLogAuthStatusGet(openapiClientHandle_t *client_handle,
                                                   uint32_t intIfNum,
                                                   uint32_t entryIndex,
                                                   OPEN_AUTHMGR_PORT_STATUS_t *authStatus);

/*************************************************************************/
open_error_t openapiAuthMgrHistoryLogClientMacAddressGet(openapiClientHandle_t *client_handle,
                                                         uint32_t intIfNum,
                                                         uint32_t entryIndex,
                                                         open_buffdesc *macAddress);

/*****************************************************************/
open_error_t openapiAuthMgrHistoryLogVlanIdGet(openapiClientHandle_t *client_handle,
                                               uint32_t intIfNum,
                                               uint32_t entryIndex,
                                               uint32_t *vlanId);

/*****************************************************************/
open_error_t openapiAuthMgrHistoryLogVlanAssignedTypeGet(openapiClientHandle_t *client_handle,
                                                         uint32_t intIfNum,
                                                         uint32_t entryIndex,
                                                         OPEN_AUTHMGR_VLAN_ASSIGNED_MODE_t *vlanAssignedType);

/*************************************************************************/
open_error_t openapiAuthMgrHistoryLogFilterIdGet(openapiClientHandle_t *client_handle,
                                                 uint32_t intIfNum,
                                                 uint32_t entryIndex,
                                                 open_buffdesc *filterId);

/*************************************************************************/
open_error_t
openapiAuthMgrPortInitializeSet(openapiClientHandle_t *client_handle,
                                uint32_t intIfNum, OPEN_BOOL_t initialize);

/*************************************************************************/
open_error_t
openapiAuthMgrPortAdminControlledDirectionsSet(openapiClientHandle_t *client_handle,
                                               uint32_t intIfNum,
                                               OPEN_AUTHMGR_PORT_DIRECTION_t cntrlDir);

/*************************************************************************/
open_error_t
openapiAuthMgrPortAdminControlledDirectionsGet(openapiClientHandle_t *client_handle,
                                               uint32_t intIfNum,
                                               OPEN_AUTHMGR_PORT_DIRECTION_t *pCntrlDir);

#endif /* OPENAPI_AUTHMGR_H_INCLUDED */