Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Enumerations | Functions
openapi_user_manager.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

Macros

#define OPEN_LOGIN_SIZE   65 /** Login session username buffer size */
 

Enumerations

enum  OPEN_ACCESS_LEVEL_t { OPEN_ACCESS_LEVEL_UNKNOWN = 0, OPEN_ACCESS_LEVEL_LOGIN = 1, OPEN_ACCESS_LEVEL_ENABLE = 2 }
 OpEN uses this enumeration to define access levels. More...
 
enum  OPEN_AUTHOR_METHOD_t {
  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 uses this enumeration to define Authorization methods. More...
 
enum  OPEN_LOGIN_ACCESS_LEVELS_t { OPEN_LOGIN_ACCESS_NONE = 0, OPEN_LOGIN_ACCESS_READ_ONLY = 1, OPEN_LOGIN_ACCESS_READ_WRITE = 2 }
 OpEN uses this enumeration to define Login Access Permissions. More...
 
enum  OPEN_LOGIN_TYPE_t {
  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 Session ID list which use to specify the login type. More...
 
enum  OPEN_USER_MGR_ACCT_METHOD_t { OPEN_ACCT_METHOD_UNDEFINED = 0, OPEN_ACCT_METHOD_TACACS = 1, OPEN_ACCT_METHOD_RADIUS = 2, OPEN_ACCT_METHOD_MAX = 3 }
 OpEN uses this enumeration to define Accounting Methods. More...
 
enum  OPEN_USER_MGR_ACCT_TYPES_t { OPEN_ACCT_TYPE_UNDEFINED = 0, OPEN_ACCT_TYPE_EXEC_SESSION = 1, OPEN_ACCT_TYPE_COMMANDS = 2, OPEN_ACCT_TYPE_MAX = 3 }
 OpEN uses this enumeration to define Accounting Types. More...
 
enum  OPEN_USER_MGR_AUTH_METHOD_t {
  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 uses this enumeration to define Authentication method types. More...
 
enum  OPEN_USER_MGR_AUTHOR_TYPES_t { OPEN_AUTHOR_TYPE_UNKNOWN = 0, OPEN_AUTHOR_TYPE_COMMANDS = 1, OPEN_AUTHOR_TYPE_EXEC = 2, OPEN_AUTHOR_TYPE_MAX = 3 }
 OpEN uses this enumeration to define Authorization types. More...
 
enum  OPEN_USER_MGR_RECORD_TYPES_t {
  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 uses this enumeration to define Accounting Record types. More...
 

Functions

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)
 Create an Accounting List. More...
 
open_error_t openapiAccountingListDelete (openapiClientHandle_t *client_handle, OPEN_USER_MGR_ACCT_TYPES_t acctType, open_buffdesc *acctListName)
 Delete an Accounting List. More...
 
open_error_t openapiAccountingListFirstGet (openapiClientHandle_t *client_handle, OPEN_USER_MGR_ACCT_TYPES_t acctType, open_buffdesc *acctListName)
 Get the first Accounting List name. More...
 
open_error_t openapiAccountingListLineDelete (openapiClientHandle_t *client_handle, OPEN_ACCESS_LINE_t accessLine, OPEN_USER_MGR_ACCT_TYPES_t acctType)
 Delete Accounting List from an access line. More...
 
open_error_t openapiAccountingListLineGet (openapiClientHandle_t *client_handle, OPEN_ACCESS_LINE_t accessLine, OPEN_USER_MGR_ACCT_TYPES_t acctType, open_buffdesc *acctListName)
 Get the Accounting list assigned to an access line. More...
 
open_error_t openapiAccountingListLineSet (openapiClientHandle_t *client_handle, OPEN_ACCESS_LINE_t accessLine, OPEN_USER_MGR_ACCT_TYPES_t acctType, open_buffdesc *acctListName)
 Set Accounting List to an access line. More...
 
open_error_t openapiAccountingListNameSizeGet (openapiClientHandle_t *client_handle, uint32_t *acctListNameSize)
 Get the maximum size of Accounting List name. More...
 
open_error_t openapiAccountingListNameValidate (openapiClientHandle_t *client_handle, open_buffdesc *acctListName)
 Validate Accounting list name. More...
 
open_error_t openapiAccountingListNextGet (openapiClientHandle_t *client_handle, OPEN_USER_MGR_ACCT_TYPES_t acctType, open_buffdesc *prevAcctListName, open_buffdesc *nextAcctListName)
 Get the next Accounting List name. More...
 
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)
 Get the record type assigned to the Accounting List. More...
 
open_error_t openapiAccountingMethodListGet (openapiClientHandle_t *client_handle, OPEN_USER_MGR_ACCT_TYPES_t acctType, open_buffdesc *acctListName, open_buffdesc *methodList)
 Get the method(s) assigned to the Accounting List. More...
 
open_error_t openapiAccountingMethodsAdd (openapiClientHandle_t *client_handle, OPEN_USER_MGR_ACCT_TYPES_t acctType, open_buffdesc *acctListName, open_buffdesc *acctMethod)
 Add methods to Accounting List. More...
 
open_error_t openapiAccountingMethodsMaxGet (openapiClientHandle_t *client_handle, uint32_t *maxAcctMethods)
 Get the maximum Accounting Methods supported. More...
 
open_error_t openapiAuthenticateUser (openapiClientHandle_t *client_handle, open_buffdesc *userName, open_buffdesc *password, OPEN_LOGIN_ACCESS_LEVELS_t *accessLevel)
 Authenticate Login User. More...
 
open_error_t openapiAuthenticationListCreate (openapiClientHandle_t *client_handle, OPEN_ACCESS_LEVEL_t accessLevel, open_buffdesc *authListName)
 Create an Authentication List. More...
 
open_error_t openapiAuthenticationListDelete (openapiClientHandle_t *client_handle, OPEN_ACCESS_LEVEL_t accessLevel, open_buffdesc *authListName)
 Delete an Authentication List. More...
 
open_error_t openapiAuthenticationListFirstGet (openapiClientHandle_t *client_handle, OPEN_ACCESS_LEVEL_t authLevel, open_buffdesc *authListName)
 Get the first Authentication List name. More...
 
open_error_t openapiAuthenticationListLineDelete (openapiClientHandle_t *client_handle, OPEN_ACCESS_LINE_t accessLine, OPEN_ACCESS_LEVEL_t accessLevel)
 Delete Authentication List from an access line. More...
 
open_error_t openapiAuthenticationListLineGet (openapiClientHandle_t *client_handle, OPEN_ACCESS_LINE_t accessLine, OPEN_ACCESS_LEVEL_t accessLevel, open_buffdesc *authListName)
 Get Authentication List assigned to an access line. More...
 
open_error_t openapiAuthenticationListLineSet (openapiClientHandle_t *client_handle, OPEN_ACCESS_LINE_t accessLine, OPEN_ACCESS_LEVEL_t accessLevel, open_buffdesc *authListName)
 Set Authentication List to an access line. More...
 
open_error_t openapiAuthenticationListNameSizeGet (openapiClientHandle_t *client_handle, uint32_t *authListNameSize)
 Get the maximum size of Authentication List name. More...
 
open_error_t openapiAuthenticationListNameValidate (openapiClientHandle_t *client_handle, open_buffdesc *authListName)
 Validate Authentication list name. More...
 
open_error_t openapiAuthenticationListNextGet (openapiClientHandle_t *client_handle, OPEN_ACCESS_LEVEL_t authLevel, open_buffdesc *prevAuthListName, open_buffdesc *nextAuthListName)
 Get the next Authentication List name. More...
 
open_error_t openapiAuthenticationMethodListGet (openapiClientHandle_t *client_handle, OPEN_ACCESS_LEVEL_t authLevel, open_buffdesc *authListName, open_buffdesc *methodList)
 Get the method(s) assigned to Authentication List. More...
 
open_error_t openapiAuthenticationMethodsAdd (openapiClientHandle_t *client_handle, OPEN_ACCESS_LEVEL_t accessLevel, open_buffdesc *authListName, open_buffdesc *authMethod)
 Add methods to the Authentication list. More...
 
open_error_t openapiAuthenticationMethodsMaxGet (openapiClientHandle_t *client_handle, uint32_t *maxAuthMethods)
 Get the maximum Authentication Methods supported. More...
 
open_error_t openapiAuthorizationListCreate (openapiClientHandle_t *client_handle, OPEN_USER_MGR_AUTHOR_TYPES_t type, open_buffdesc *authorListName)
 Create an Authorization List. More...
 
open_error_t openapiAuthorizationListDelete (openapiClientHandle_t *client_handle, OPEN_USER_MGR_AUTHOR_TYPES_t type, open_buffdesc *authorListName)
 Delete an Authorization List. More...
 
open_error_t openapiAuthorizationListFirstGet (openapiClientHandle_t *client_handle, OPEN_USER_MGR_AUTHOR_TYPES_t type, open_buffdesc *authorListName)
 Get the first Authorization List name. More...
 
open_error_t openapiAuthorizationListLineDelete (openapiClientHandle_t *client_handle, OPEN_ACCESS_LINE_t accessLine, OPEN_USER_MGR_AUTHOR_TYPES_t type)
 Delete Authorization List from an access line. More...
 
open_error_t openapiAuthorizationListLineGet (openapiClientHandle_t *client_handle, OPEN_ACCESS_LINE_t accessLine, OPEN_USER_MGR_AUTHOR_TYPES_t type, open_buffdesc *authorListName)
 Get the Authorization List name assigned to an access level. More...
 
open_error_t openapiAuthorizationListLineSet (openapiClientHandle_t *client_handle, OPEN_ACCESS_LINE_t accessLine, OPEN_USER_MGR_AUTHOR_TYPES_t type, open_buffdesc *authorListName)
 Set Authorization List to an access line. More...
 
open_error_t openapiAuthorizationListNameSizeGet (openapiClientHandle_t *client_handle, uint32_t *authorListNameSize)
 Get the maximum and minimum size of Authorization List name. More...
 
open_error_t openapiAuthorizationListNameValidate (openapiClientHandle_t *client_handle, open_buffdesc *authorListName)
 Validate Authorization list name. More...
 
open_error_t openapiAuthorizationListNextGet (openapiClientHandle_t *client_handle, OPEN_USER_MGR_AUTHOR_TYPES_t type, open_buffdesc *prevAuthorListName, open_buffdesc *nextAuthorListName)
 Get the next Authorization List name. More...
 
open_error_t openapiAuthorizationMethodListGet (openapiClientHandle_t *client_handle, OPEN_USER_MGR_AUTHOR_TYPES_t type, open_buffdesc *authorListName, open_buffdesc *authorMethodList)
 Get the method(s) assigned to Authorization List. More...
 
open_error_t openapiAuthorizationMethodsAdd (openapiClientHandle_t *client_handle, OPEN_USER_MGR_AUTHOR_TYPES_t type, open_buffdesc *authorListName, open_buffdesc *authorMethod)
 Add methods to Authorization List. More...
 
open_error_t openapiAuthorizationMethodsMaxGet (openapiClientHandle_t *client_handle, uint32_t *maxAuthorMethods)
 Get maximum Authorization Methods supported. More...
 
open_error_t openapiEnablePasswordRemove (openapiClientHandle_t *client_handle)
 Delete enable password. More...
 
open_error_t openapiEnablePasswordSet (openapiClientHandle_t *client_handle, open_buffdesc *enablePswd)
 Set enable password. More...
 
open_error_t openapiIsAuthenticationRequiredGet (openapiClientHandle_t *client_handle, OPEN_ACCESS_LINE_t accessLine, OPEN_ACCESS_LEVEL_t accessLevel, OPEN_BOOL_t *authStatus)
 Get whether Authentication is required. More...
 
open_error_t openapiLoginSessionIdleTimeGet (openapiClientHandle_t *client_handle, uint32_t id, uint32_t *timeVal)
 Get the login session idle time. More...
 
open_error_t openapiLoginSessionRemoteIpAddrGet (openapiClientHandle_t *client_handle, uint32_t id, open_inet_addr_t *addr)
 Get the login session remote IP address. More...
 
open_error_t openapiLoginSessionTimeGet (openapiClientHandle_t *client_handle, uint32_t id, uint32_t *timeVal)
 Get the login session time. More...
 
open_error_t openapiLoginSessionTypeGet (openapiClientHandle_t *client_handle, uint32_t id, OPEN_LOGIN_TYPE_t *type)
 Get the login session type. More...
 
open_error_t openapiLoginSessionUserGet (openapiClientHandle_t *client_handle, uint32_t id, open_buffdesc *name)
 Get the login session username. More...
 
open_error_t openapiMaxUsersSupportedGet (openapiClientHandle_t *client_handle, uint32_t *maxUsers)
 Get the maximum number of users supported. More...
 
open_error_t openapiPasswordSizeGet (openapiClientHandle_t *client_handle, uint32_t *passwordMinSize, uint32_t *passwordMaxSize)
 Get the minimum and maximum supported sizes of password. More...
 
open_error_t openapiSessionIDNextValidGet (openapiClientHandle_t *client_handle, OPEN_LOGIN_TYPE_t sessionType, uint32_t *prevSessionID)
 Search the next valid ID of SSH session. More...
 
open_error_t openapiSessionLogout (openapiClientHandle_t *client_handle, uint32_t sessionID)
 Closes the session by ID. More...
 
open_error_t openapiUserDelete (openapiClientHandle_t *client_handle, open_buffdesc *userName)
 Delete user. More...
 
open_error_t openapiUserFirstGet (openapiClientHandle_t *client_handle, open_buffdesc *username)
 Get the first user. More...
 
open_error_t openapiUserLevelGet (openapiClientHandle_t *client_handle, open_buffdesc *userName, OPEN_LOGIN_ACCESS_LEVELS_t *level)
 Get the access level of a user. More...
 
open_error_t openapiUserLevelSet (openapiClientHandle_t *client_handle, open_buffdesc *userName, OPEN_LOGIN_ACCESS_LEVELS_t level)
 Set the access level for an existing user. More...
 
open_error_t openapiUserNameSizeGet (openapiClientHandle_t *client_handle, uint32_t *userNameSize)
 Get the maximum supported size of username. More...
 
open_error_t openapiUserNameValidate (openapiClientHandle_t *client_handle, open_buffdesc *userName)
 Validate the username string. More...
 
open_error_t openapiUserNextGet (openapiClientHandle_t *client_handle, open_buffdesc *prevUserName, open_buffdesc *nextUserName)
 Get next user name. More...
 
open_error_t openapiUserPasswordGet (openapiClientHandle_t *client_handle, open_buffdesc *userName, open_buffdesc *userPassword)
 Get the password for specified user. More...
 
open_error_t openapiUserSet (openapiClientHandle_t *client_handle, open_buffdesc *userName, open_buffdesc *password)
 Set the user name and password. More...
 
open_error_t openapiWebSessionLogout (openapiClientHandle_t *client_handle, open_buffdesc *sessionId)
 End session for an existing user. More...
 
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)
 Create session for an existing user. More...
 
open_error_t openapiWebSessionValidate (openapiClientHandle_t *client_handle, open_buffdesc *sessionId, open_buffdesc *logintype, open_buffdesc *inetaddr, uint32_t *accessLevel)
 validate session for an existing user. More...