openapi_user_manager.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_user_manager.h
*
* @purpose   User Manager Configuration and Status 
*
* @component OpEN
*
* @create    18/01/2013
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_USER_MGR_H_INCLUDED
#define OPENAPI_USER_MGR_H_INCLUDED

#include "openapi_common.h"

typedef enum  
{
  OPEN_LOGIN_ACCESS_NONE        = 0, 
  OPEN_LOGIN_ACCESS_READ_ONLY   = 1, 
  OPEN_LOGIN_ACCESS_READ_WRITE  = 2  
} OPEN_LOGIN_ACCESS_LEVELS_t;

typedef enum
{ 
  OPEN_ACCESS_LEVEL_UNKNOWN = 0, 
  OPEN_ACCESS_LEVEL_LOGIN   = 1, 
  OPEN_ACCESS_LEVEL_ENABLE  = 2  
} OPEN_ACCESS_LEVEL_t;

typedef enum
{
  OPEN_AUTH_METHOD_UNDEFINED = 0, 
  OPEN_AUTH_METHOD_ENABLE    = 1, 
  OPEN_AUTH_METHOD_LINE      = 2, 
  OPEN_AUTH_METHOD_LOCAL     = 3, 
  OPEN_AUTH_METHOD_NONE      = 4, 
  OPEN_AUTH_METHOD_RADIUS    = 5, 
  OPEN_AUTH_METHOD_TACACS    = 6, 
  OPEN_AUTH_METHOD_REJECT    = 7, 
  OPEN_AUTH_METHOD_IAS       = 8  
} OPEN_USER_MGR_AUTH_METHOD_t;

typedef enum
{
  OPEN_AUTHOR_TYPE_UNKNOWN  = 0, 
  OPEN_AUTHOR_TYPE_COMMANDS = 1, 
  OPEN_AUTHOR_TYPE_EXEC     = 2, 
  OPEN_AUTHOR_TYPE_MAX      = 3  
} OPEN_USER_MGR_AUTHOR_TYPES_t;

typedef enum
{ 
  OPEN_AUTHOR_METHOD_UNDEFINED  = 0, 
  OPEN_AUTHOR_METHOD_TACACS     = 1, 
  OPEN_AUTHOR_METHOD_RADIUS     = 2, 
  OPEN_AUTHOR_METHOD_LOCAL      = 3, 
  OPEN_AUTHOR_METHOD_NONE       = 4, 
  OPEN_AUTHOR_METHOD_MAX        = 5  
} OPEN_AUTHOR_METHOD_t;

typedef enum
{
  OPEN_ACCT_TYPE_UNDEFINED      = 0, 
  OPEN_ACCT_TYPE_EXEC_SESSION   = 1, 
  OPEN_ACCT_TYPE_COMMANDS       = 2, 
  OPEN_ACCT_TYPE_MAX            = 3  
} OPEN_USER_MGR_ACCT_TYPES_t;

typedef enum
{
  OPEN_ACCT_RECORD_TYPE_UNDEFINED  = 0, 
  OPEN_ACCT_RECORD_TYPE_START_STOP = 1, 
  OPEN_ACCT_RECORD_TYPE_STOP_ONLY  = 2, 
  OPEN_ACCT_RECORD_TYPE_NONE       = 3, 
  OPEN_ACCT_RECORD_TYPE_MAX        = 4  
} OPEN_USER_MGR_RECORD_TYPES_t;

typedef enum
{       
  OPEN_ACCT_METHOD_UNDEFINED    = 0, 
  OPEN_ACCT_METHOD_TACACS       = 1, 
  OPEN_ACCT_METHOD_RADIUS       = 2, 
  OPEN_ACCT_METHOD_MAX          = 3  
} OPEN_USER_MGR_ACCT_METHOD_t;

typedef enum
{
  OPEN_LOGIN_TYPE_UNKNWN = 0,
  OPEN_LOGIN_TYPE_SERIAL = 1,
  OPEN_LOGIN_TYPE_TELNET = 2,
  OPEN_LOGIN_TYPE_SSH    = 3,
  OPEN_LOGIN_TYPE_HTTP   = 4,
  OPEN_LOGIN_TYPE_HTTPS  = 5,
  OPEN_LOGIN_TYPE_SNMP   = 6,
  OPEN_LOGIN_TYPE_PING   = 7,
  OPEN_LOGIN_TYPE_UDS    = 8,
  OPEN_LOGIN_TYPE_LAST   = 9
} OPEN_LOGIN_TYPE_t;

typedef enum  
{ 
  OPEN_ENCRYPT_TYPE_NONE     = 0,     
  OPEN_ENCRYPT_TYPE_AES      = 1,     
  OPEN_ENCRYPT_TYPE_MD5_SALT = 2,     
  OPEN_ENCRYPT_TYPE_SHA256_SALT = 3,  
  OPEN_ENCRYPT_TYPE_SHA512_SALT = 4,  
  OPEN_ENCRYPT_TYPE_LAST     = 5      
} OPEN_ENCRYPT_TYPE_t;

#define OPEN_LOGIN_SIZE 65   
#define OPEN_PASSWORD_SIZE  65 
/*****************************************************************/
open_error_t openapiUserSet(openapiClientHandle_t *client_handle,
                            open_buffdesc *userName,
                            open_buffdesc *password);

/*****************************************************************/
open_error_t openapiUserFirstGet(openapiClientHandle_t *client_handle,
                                 open_buffdesc *username);

/*****************************************************************/
open_error_t openapiUserNextGet(openapiClientHandle_t *client_handle,
                                open_buffdesc *prevUserName,
                                open_buffdesc *nextUserName);

/*****************************************************************/
open_error_t openapiSessionIDNextValidGet(openapiClientHandle_t *client_handle,
                                          OPEN_LOGIN_TYPE_t sessionType,
                                          uint32_t *prevSessionID);

/*****************************************************************/
open_error_t openapiSessionLogout(openapiClientHandle_t *client_handle,
                                  uint32_t sessionID);

/*****************************************************************/
open_error_t openapiMaxUsersSupportedGet(openapiClientHandle_t *client_handle,
                                         uint32_t *maxUsers);

/*****************************************************************/
open_error_t openapiUserLevelSet(openapiClientHandle_t *client_handle,
                                 open_buffdesc *userName,
                                 OPEN_LOGIN_ACCESS_LEVELS_t level);

/*****************************************************************/
open_error_t openapiUserLevelGet(openapiClientHandle_t *client_handle,
                                 open_buffdesc *userName,
                                 OPEN_LOGIN_ACCESS_LEVELS_t *level);

/*****************************************************************/
open_error_t openapiUserNameSizeGet(openapiClientHandle_t *client_handle,
                                    uint32_t *userNameSize);

/*****************************************************************/
open_error_t openapiUserNameValidate(openapiClientHandle_t *client_handle,
                                     open_buffdesc *userName);

/*****************************************************************/
open_error_t openapiPasswordSizeGet(openapiClientHandle_t *client_handle,
                                    uint32_t *passwordMinSize,
                                    uint32_t *passwordMaxSize);

/*****************************************************************/
open_error_t openapiUserPasswordSizeGet(openapiClientHandle_t *pClientHandle,
                                        OPEN_BOOL_t isEncrypPswd,
                                        uint32_t *pPasswordMinSize,
                                        uint32_t *pPasswordMaxSize);

/*****************************************************************/
open_error_t openapiUserDelete(openapiClientHandle_t *client_handle,
                               open_buffdesc *userName);

/*****************************************************************/
open_error_t openapiAuthenticationListCreate(openapiClientHandle_t *client_handle,
                                             OPEN_ACCESS_LEVEL_t accessLevel,
                                             open_buffdesc *authListName);

/*****************************************************************/
open_error_t openapiAuthenticationMethodsAdd(openapiClientHandle_t *client_handle,
                                             OPEN_ACCESS_LEVEL_t accessLevel,
                                             open_buffdesc *authListName,
                                             open_buffdesc *authMethod);

/*****************************************************************/
open_error_t openapiAuthenticationMethodListGet(openapiClientHandle_t *client_handle,
                                                OPEN_ACCESS_LEVEL_t authLevel,
                                                open_buffdesc *authListName,
                                                open_buffdesc *methodList);

/*****************************************************************/
open_error_t openapiAuthenticationListFirstGet(openapiClientHandle_t *client_handle,
                                               OPEN_ACCESS_LEVEL_t authLevel,
                                               open_buffdesc *authListName);

/*****************************************************************/
open_error_t openapiAuthenticationListNextGet(openapiClientHandle_t *client_handle,
                                              OPEN_ACCESS_LEVEL_t authLevel,
                                              open_buffdesc *prevAuthListName,
                                              open_buffdesc *nextAuthListName);
/*****************************************************************/
open_error_t openapiAuthenticationListDelete(openapiClientHandle_t *client_handle,
                                             OPEN_ACCESS_LEVEL_t accessLevel,
                                             open_buffdesc *authListName);

/*****************************************************************/
open_error_t openapiAuthenticationListLineSet(openapiClientHandle_t *client_handle,
                                              OPEN_ACCESS_LINE_t  accessLine,
                                              OPEN_ACCESS_LEVEL_t accessLevel,
                                              open_buffdesc *authListName);

/*****************************************************************/
open_error_t openapiAuthenticationListLineGet(openapiClientHandle_t *client_handle,
                                              OPEN_ACCESS_LINE_t  accessLine,
                                              OPEN_ACCESS_LEVEL_t accessLevel,
                                              open_buffdesc *authListName);

/*****************************************************************/
open_error_t openapiAuthenticationListLineDelete(openapiClientHandle_t *client_handle,
                                                 OPEN_ACCESS_LINE_t  accessLine,
                                                 OPEN_ACCESS_LEVEL_t accessLevel);

/*****************************************************************/
open_error_t openapiAuthenticationListNameSizeGet(openapiClientHandle_t *client_handle,
                                                  uint32_t *authListNameSize);

/*****************************************************************/
open_error_t openapiAuthenticationMethodsMaxGet(openapiClientHandle_t *client_handle,
                                                uint32_t *maxAuthMethods);


/*****************************************************************/
open_error_t openapiAuthenticationListNameValidate(openapiClientHandle_t *client_handle,
                                                   open_buffdesc *authListName);

/*****************************************************************/
open_error_t openapiAccountingListNameValidate(openapiClientHandle_t *client_handle,
                                               open_buffdesc *acctListName);

/*****************************************************************/
open_error_t openapiAuthorizationListNameValidate(openapiClientHandle_t *client_handle,
                                                  open_buffdesc *authorListName);

/*****************************************************************/
open_error_t openapiAuthorizationListCreate(openapiClientHandle_t *client_handle,
                                            OPEN_USER_MGR_AUTHOR_TYPES_t type,
                                            open_buffdesc *authorListName);

/*****************************************************************/
open_error_t openapiAuthorizationMethodsAdd(openapiClientHandle_t *client_handle,
                                            OPEN_USER_MGR_AUTHOR_TYPES_t type,
                                            open_buffdesc *authorListName,
                                            open_buffdesc *authorMethod);

/*****************************************************************/
open_error_t openapiAuthorizationListNameSizeGet(openapiClientHandle_t *client_handle,
                                                 uint32_t *authorListNameSize);

/*****************************************************************/
open_error_t openapiAuthorizationMethodsMaxGet(openapiClientHandle_t *client_handle,
                                               uint32_t *maxAuthorMethods);

/*****************************************************************/
open_error_t openapiAuthorizationListDelete(openapiClientHandle_t *client_handle,
                                            OPEN_USER_MGR_AUTHOR_TYPES_t type,
                                            open_buffdesc *authorListName);

/*****************************************************************/
open_error_t openapiAuthorizationListFirstGet(openapiClientHandle_t *client_handle,
                                              OPEN_USER_MGR_AUTHOR_TYPES_t type,
                                              open_buffdesc *authorListName);

/*****************************************************************/
open_error_t openapiAuthorizationListNextGet(openapiClientHandle_t *client_handle,
                                             OPEN_USER_MGR_AUTHOR_TYPES_t type,
                                             open_buffdesc *prevAuthorListName,
                                             open_buffdesc *nextAuthorListName);

/*****************************************************************/
open_error_t openapiAuthorizationMethodListGet(openapiClientHandle_t *client_handle,
                                               OPEN_USER_MGR_AUTHOR_TYPES_t type,
                                               open_buffdesc *authorListName,
                                               open_buffdesc *authorMethodList);

/*****************************************************************/
open_error_t openapiAuthorizationListLineSet(openapiClientHandle_t *client_handle,
                                             OPEN_ACCESS_LINE_t  accessLine,
                                             OPEN_USER_MGR_AUTHOR_TYPES_t type,
                                             open_buffdesc *authorListName);

/*****************************************************************/
open_error_t openapiAuthorizationListLineGet(openapiClientHandle_t *client_handle,
                                             OPEN_ACCESS_LINE_t accessLine,
                                             OPEN_USER_MGR_AUTHOR_TYPES_t type,
                                             open_buffdesc *authorListName);

/*****************************************************************/
open_error_t openapiAuthorizationListLineDelete(openapiClientHandle_t *client_handle,
                                                OPEN_ACCESS_LINE_t accessLine,
                                                OPEN_USER_MGR_AUTHOR_TYPES_t type);

/*****************************************************************/
open_error_t openapiAccountingListCreate(openapiClientHandle_t *client_handle,
                                         OPEN_USER_MGR_ACCT_TYPES_t acctType,
                                         OPEN_USER_MGR_RECORD_TYPES_t recordType,
                                         open_buffdesc *acctListName);

/*****************************************************************/
open_error_t openapiAccountingMethodsAdd(openapiClientHandle_t *client_handle,
                                         OPEN_USER_MGR_ACCT_TYPES_t acctType,
                                         open_buffdesc *acctListName,
                                         open_buffdesc *acctMethod);

/*****************************************************************/
open_error_t openapiAccountingMethodListGet(openapiClientHandle_t *client_handle,
                                            OPEN_USER_MGR_ACCT_TYPES_t acctType,
                                            open_buffdesc *acctListName,
                                            open_buffdesc *methodList);

/*****************************************************************/
open_error_t openapiAccountingListRecordTypeGet(openapiClientHandle_t *client_handle,
                                                OPEN_USER_MGR_ACCT_TYPES_t acctType,
                                                open_buffdesc *acctListName,
                                                OPEN_USER_MGR_RECORD_TYPES_t *recordType);
                                                 
/*****************************************************************/
open_error_t openapiAccountingListFirstGet(openapiClientHandle_t *client_handle,
                                           OPEN_USER_MGR_ACCT_TYPES_t acctType,
                                           open_buffdesc *acctListName);

/*****************************************************************/
open_error_t openapiAccountingListNextGet(openapiClientHandle_t *client_handle,
                                          OPEN_USER_MGR_ACCT_TYPES_t acctType,
                                          open_buffdesc *prevAcctListName,
                                          open_buffdesc *nextAcctListName);

/*****************************************************************/
open_error_t openapiAccountingListDelete(openapiClientHandle_t *client_handle,
                                         OPEN_USER_MGR_ACCT_TYPES_t acctType,
                                         open_buffdesc *acctListName);

/*****************************************************************/
open_error_t openapiAccountingListLineSet(openapiClientHandle_t *client_handle,
                                          OPEN_ACCESS_LINE_t  accessLine,
                                          OPEN_USER_MGR_ACCT_TYPES_t acctType,
                                          open_buffdesc *acctListName);

/*****************************************************************/
open_error_t openapiAccountingListLineGet(openapiClientHandle_t *client_handle,
                                          OPEN_ACCESS_LINE_t accessLine,
                                          OPEN_USER_MGR_ACCT_TYPES_t acctType,
                                          open_buffdesc *acctListName);

/*****************************************************************/
open_error_t openapiAccountingListLineDelete(openapiClientHandle_t *client_handle,
                                             OPEN_ACCESS_LINE_t accessLine,
                                             OPEN_USER_MGR_ACCT_TYPES_t acctType);

/*****************************************************************/
open_error_t openapiAccountingMethodsMaxGet(openapiClientHandle_t *client_handle,
                                            uint32_t *maxAcctMethods);
                                            
/*****************************************************************/
open_error_t openapiAccountingListNameSizeGet(openapiClientHandle_t *client_handle,
                                              uint32_t *acctListNameSize);

/*****************************************************************/
open_error_t openapiEnablePasswordSet(openapiClientHandle_t *client_handle,
                                      open_buffdesc *enablePswd);

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

/*****************************************************************/
open_error_t openapiAuthenticateUser(openapiClientHandle_t *client_handle,
                                     open_buffdesc *userName,
                                     open_buffdesc *password,
                                     OPEN_LOGIN_ACCESS_LEVELS_t *accessLevel);

/*****************************************************************/
open_error_t openapiWebSessionUserLogin(openapiClientHandle_t *client_handle,
                                        open_buffdesc *userName,
                                        open_buffdesc *password,
                                        open_buffdesc *logintype,
                                        open_buffdesc *inetaddr,
                                        uint32_t      *accessLevel,
                                        open_buffdesc *sessionId);


/************************************************************************/
open_error_t openapiWebSessionValidate(openapiClientHandle_t *client_handle,
                                       open_buffdesc *sessionId,
                                       open_buffdesc *logintype,
                                       open_buffdesc *inetaddr,
                                       uint32_t      *accessLevel);

/************************************************************************/
open_error_t openapiWebSessionLogout(openapiClientHandle_t *client_handle,
                                     open_buffdesc *sessionId);

/*****************************************************************/
open_error_t openapiIsAuthenticationRequiredGet(openapiClientHandle_t *client_handle,
                                                OPEN_ACCESS_LINE_t  accessLine,
                                                OPEN_ACCESS_LEVEL_t accessLevel,
                                                OPEN_BOOL_t *authStatus);

/*****************************************************************/
open_error_t openapiUserPasswordGet(openapiClientHandle_t *client_handle,
                                    open_buffdesc *userName,
                                    open_buffdesc *userPassword);

/*****************************************************************/
open_error_t openapiLoginSessionUserGet(openapiClientHandle_t *client_handle,
                                        uint32_t id,
                                        open_buffdesc *name);

/*****************************************************************/
open_error_t openapiLoginSessionRemoteIpAddrGet(openapiClientHandle_t *client_handle,
                                                uint32_t id,
                                                open_inet_addr_t *addr);

/*****************************************************************/
open_error_t openapiLoginSessionIdleTimeGet(openapiClientHandle_t *client_handle,
                                            uint32_t id,
                                            uint32_t *timeVal);

/*****************************************************************/
open_error_t openapiLoginSessionTimeGet(openapiClientHandle_t *client_handle,
                                        uint32_t id,
                                        uint32_t *timeVal);

/*****************************************************************/
open_error_t openapiLoginSessionTypeGet(openapiClientHandle_t *client_handle,
                                        uint32_t id,
                                        OPEN_LOGIN_TYPE_t *type);

/*****************************************************************/
open_error_t openapiUserPasswordEncryptTypeSet(openapiClientHandle_t *client_handle,
                                               open_buffdesc *userName,
                                               open_buffdesc *password,
                                               OPEN_ENCRYPT_TYPE_t encryptType,
                                               OPEN_BOOL_t encrypted);

/*****************************************************************/
open_error_t openapiUserPasswordEncryptTypeGet(openapiClientHandle_t *client_handle,
                                               open_buffdesc *userName,
                                               OPEN_ENCRYPT_TYPE_t *encryptType);

/*****************************************************************/
open_error_t openapiEnablePasswordEncryptTypeSet(openapiClientHandle_t *client_handle,
                                                 open_buffdesc *enablePswd,
                                                 OPEN_ENCRYPT_TYPE_t encryptType,
                                                 OPEN_BOOL_t encrypted);

/*****************************************************************/
open_error_t openapiEnablePasswordEncryptTypeGet(openapiClientHandle_t *client_handle,
                                                 OPEN_ENCRYPT_TYPE_t *encryptType);

/*****************************************************************/
open_error_t openapiUserMultiFactorAuthStateGet(openapiClientHandle_t *client_handle, open_buffdesc *pUserName, OPEN_BOOL_t *pMfaPwdEnable);

/*************************************************************************/
open_error_t openapiUserMultiFactorAuthStateSet(openapiClientHandle_t *client_handle, open_buffdesc *pUserName, OPEN_BOOL_t mfaPwdEnable);

/*************************************************************************/
open_error_t openapiUserEmailIdGet(openapiClientHandle_t *client_handle, open_buffdesc *pUserName, open_buffdesc *pEmailInfo);

/*************************************************************************/
open_error_t openapiUserEmailIdSet(openapiClientHandle_t *client_handle, open_buffdesc *pUserName, open_buffdesc *pEmailInfo);

/*************************************************************************/
open_error_t openapiGlobalMultiFactorAuthGet(openapiClientHandle_t *client_handle, OPEN_BOOL_t *pMfaCnfgEnable);

/*************************************************************************/
open_error_t openapiGlobalMultiFactorAuthSet(openapiClientHandle_t *client_handle, OPEN_BOOL_t mfaCnfgEnable);
/*************************************************************************/
open_error_t openapiAuthenticationMethodSet(openapiClientHandle_t *client_handle, OPEN_ACCESS_LINE_t accessLine, OPEN_ACCESS_LEVEL_t accessLevel, open_buffdesc *apl_name, uint32_t order, OPEN_USER_MGR_AUTH_METHOD_t auth_method);

/*************************************************************************/
open_error_t openapiAuthenticationMethodGet(openapiClientHandle_t *client_handle, OPEN_ACCESS_LINE_t accessLine, OPEN_ACCESS_LEVEL_t accessLevel, open_buffdesc *apl_name, uint32_t order, OPEN_USER_MGR_AUTH_METHOD_t *auth_method);
#endif