38 #ifndef OPENAPI_USER_MGR_H_INCLUDED
39 #define OPENAPI_USER_MGR_H_INCLUDED
124 OPEN_LOGIN_TYPE_UNKNWN = 0,
125 OPEN_LOGIN_TYPE_SERIAL = 1,
126 OPEN_LOGIN_TYPE_TELNET = 2,
127 OPEN_LOGIN_TYPE_SSH = 3,
128 OPEN_LOGIN_TYPE_HTTP = 4,
129 OPEN_LOGIN_TYPE_HTTPS = 5,
130 OPEN_LOGIN_TYPE_SNMP = 6,
131 OPEN_LOGIN_TYPE_PING = 7,
132 OPEN_LOGIN_TYPE_UDS = 8,
133 OPEN_LOGIN_TYPE_LAST = 9
136 #define OPEN_LOGIN_SIZE 65
164 open_error_t openapiUserSet(openapiClientHandle_t *client_handle,
230 uint32_t *prevSessionID);
330 uint32_t *userNameSize);
369 uint32_t *passwordMinSize,
370 uint32_t *passwordMaxSize);
652 uint32_t *authListNameSize);
673 uint32_t *maxAuthMethods);
816 uint32_t *authorListNameSize);
836 uint32_t *maxAuthorMethods);
1287 uint32_t *maxAcctMethods);
1305 uint32_t *acctListNameSize);
1404 uint32_t *accessLevel,
1428 uint32_t *accessLevel);
open_error_t openapiUserPasswordGet(openapiClientHandle_t *client_handle, open_buffdesc *userName, open_buffdesc *userPassword)
Get the password for specified user.
open_error_t openapiAuthenticateUser(openapiClientHandle_t *client_handle, open_buffdesc *userName, open_buffdesc *password, OPEN_LOGIN_ACCESS_LEVELS_t *accessLevel)
Authenticate Login User.
OPEN_USER_MGR_AUTHOR_TYPES_t
OpEN uses this enumeration to define Authorization types.
open_error_t openapiAccountingListFirstGet(openapiClientHandle_t *client_handle, OPEN_USER_MGR_ACCT_TYPES_t acctType, open_buffdesc *acctListName)
Get the first Accounting List name.
open_error_t openapiUserLevelGet(openapiClientHandle_t *client_handle, open_buffdesc *userName, OPEN_LOGIN_ACCESS_LEVELS_t *level)
Get the access level of a user.
open_error_t openapiAuthorizationListFirstGet(openapiClientHandle_t *client_handle, OPEN_USER_MGR_AUTHOR_TYPES_t type, open_buffdesc *authorListName)
Get the first Authorization List name.
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.
open_error_t openapiUserNameSizeGet(openapiClientHandle_t *client_handle, uint32_t *userNameSize)
Get the maximum supported size of username.
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.
No Authentication Method.
Line Authentication Method.
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.
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.
RADIUS Accounting Method.
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.
Authorization method local.
open_error_t openapiSessionIDNextValidGet(openapiClientHandle_t *client_handle, OPEN_LOGIN_TYPE_t sessionType, uint32_t *prevSessionID)
Search the next valid ID of SSH session.
Authorization method radius.
open_error_t openapiAuthorizationListNameSizeGet(openapiClientHandle_t *client_handle, uint32_t *authorListNameSize)
Get the maximum and minimum size of Authorization List name.
open_error_t openapiAuthorizationListCreate(openapiClientHandle_t *client_handle, OPEN_USER_MGR_AUTHOR_TYPES_t type, open_buffdesc *authorListName)
Create an Authorization List.
open_error_t openapiAuthenticationListCreate(openapiClientHandle_t *client_handle, OPEN_ACCESS_LEVEL_t accessLevel, open_buffdesc *authListName)
Create an Authentication List.
OPEN_LOGIN_TYPE_t
OpEN Session ID list which use to specify the login type.
open_error_t openapiEnablePasswordRemove(openapiClientHandle_t *client_handle)
Delete enable password.
open_error_t openapiAuthorizationListDelete(openapiClientHandle_t *client_handle, OPEN_USER_MGR_AUTHOR_TYPES_t type, open_buffdesc *authorListName)
Delete an Authorization List.
open_error_t
OPEN uses these enumerators to indicate the error codes.
Enable Authentication Method.
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.
open_error_t openapiLoginSessionTypeGet(openapiClientHandle_t *client_handle, uint32_t id, OPEN_LOGIN_TYPE_t *type)
Get the login session type.
open_error_t openapiPasswordSizeGet(openapiClientHandle_t *client_handle, uint32_t *passwordMinSize, uint32_t *passwordMaxSize)
Get the minimum and maximum supported sizes of password.
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.
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.
RADIUS Authentication Method.
open_error_t openapiUserNextGet(openapiClientHandle_t *client_handle, open_buffdesc *prevUserName, open_buffdesc *nextUserName)
Get next user name.
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.
OPEN_USER_MGR_ACCT_TYPES_t
OpEN uses this enumeration to define Accounting Types.
Undefined Accounting Type.
open_error_t openapiAccountingMethodsMaxGet(openapiClientHandle_t *client_handle, uint32_t *maxAcctMethods)
Get the maximum Accounting Methods supported.
OPEN_USER_MGR_ACCT_METHOD_t
OpEN uses this enumeration to define Accounting Methods.
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.
open_error_t openapiUserFirstGet(openapiClientHandle_t *client_handle, open_buffdesc *username)
Get the first user.
open_error_t openapiAuthenticationListDelete(openapiClientHandle_t *client_handle, OPEN_ACCESS_LEVEL_t accessLevel, open_buffdesc *authListName)
Delete an Authentication List.
TACACS Authentication Method.
open_error_t openapiWebSessionLogout(openapiClientHandle_t *client_handle, open_buffdesc *sessionId)
End session for an existing user.
Unknown Authorization type.
open_error_t openapiLoginSessionIdleTimeGet(openapiClientHandle_t *client_handle, uint32_t id, uint32_t *timeVal)
Get the login session idle time.
open_error_t openapiAuthenticationListNameSizeGet(openapiClientHandle_t *client_handle, uint32_t *authListNameSize)
Get the maximum size of Authentication List name.
open_error_t openapiAuthenticationListNameValidate(openapiClientHandle_t *client_handle, open_buffdesc *authListName)
Validate Authentication list name.
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.
Useful to check maximum Authorization types.
open_error_t openapiMaxUsersSupportedGet(openapiClientHandle_t *client_handle, uint32_t *maxUsers)
Get the maximum number of users supported.
Useful to identify maximum Accounting Methods.
open_error_t openapiAuthenticationListFirstGet(openapiClientHandle_t *client_handle, OPEN_ACCESS_LEVEL_t authLevel, open_buffdesc *authListName)
Get the first Authentication List name.
OPEN_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
Useful to identify maximum record types supported.
open_error_t openapiAuthorizationListNameValidate(openapiClientHandle_t *client_handle, open_buffdesc *authorListName)
Validate Authorization list name.
Enum to track maximum Authorization methods.
Useful to identify maximum Accounting types supported.
Authorization method undefined.
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.
Undefined Authentication Method.
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.
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.
open_error_t openapiAccountingListNameSizeGet(openapiClientHandle_t *client_handle, uint32_t *acctListNameSize)
Get the maximum size of Accounting List name.
open_error_t openapiLoginSessionUserGet(openapiClientHandle_t *client_handle, uint32_t id, open_buffdesc *name)
Get the login session username.
open_error_t openapiSessionLogout(openapiClientHandle_t *client_handle, uint32_t sessionID)
Closes the session by ID.
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.
OPEN_AUTHOR_METHOD_t
OpEN uses this enumeration to define Authorization methods.
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.
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.
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.
Authorization method none.
Accounting Methods Undefined.
open_error_t openapiLoginSessionTimeGet(openapiClientHandle_t *client_handle, uint32_t id, uint32_t *timeVal)
Get the login session time.
open_error_t openapiUserDelete(openapiClientHandle_t *client_handle, open_buffdesc *userName)
Delete user.
OPEN_ACCESS_LEVEL_t
OpEN uses this enumeration to define access levels.
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.
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.
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.
open_error_t openapiAuthenticationMethodsMaxGet(openapiClientHandle_t *client_handle, uint32_t *maxAuthMethods)
Get the maximum Authentication Methods supported.
OPEN_USER_MGR_AUTH_METHOD_t
OpEN uses this enumeration to define Authentication method types.
OPEN_LOGIN_ACCESS_LEVELS_t
OpEN uses this enumeration to define Login Access Permissions.
open_error_t openapiAccountingListNameValidate(openapiClientHandle_t *client_handle, open_buffdesc *acctListName)
Validate Accounting list name.
open_error_t openapiEnablePasswordSet(openapiClientHandle_t *client_handle, open_buffdesc *enablePswd)
Set enable password.
TACACS Accounting Method.
Local Authentication Method.
open_error_t openapiUserNameValidate(openapiClientHandle_t *client_handle, open_buffdesc *userName)
Validate the username string.
open_error_t openapiLoginSessionRemoteIpAddrGet(openapiClientHandle_t *client_handle, uint32_t id, open_inet_addr_t *addr)
Get the login session remote IP address.
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.
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.
open_error_t openapiAccountingListDelete(openapiClientHandle_t *client_handle, OPEN_USER_MGR_ACCT_TYPES_t acctType, open_buffdesc *acctListName)
Delete an Accounting List.
OPEN_USER_MGR_RECORD_TYPES_t
OpEN uses this enumeration to define Accounting Record types.
open_error_t openapiAuthorizationMethodsMaxGet(openapiClientHandle_t *client_handle, uint32_t *maxAuthorMethods)
Get maximum Authorization Methods supported.
Authorization method TACACS.
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.