Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.7.0.4
openapi_user_manager.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2020 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_user_manager.h
28 *
29 * @purpose User Manager Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 18/01/2013
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_USER_MGR_H_INCLUDED
39 #define OPENAPI_USER_MGR_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
44 typedef enum
45 {
46  OPEN_LOGIN_ACCESS_NONE = 0,
47  OPEN_LOGIN_ACCESS_READ_ONLY = 1,
48  OPEN_LOGIN_ACCESS_READ_WRITE = 2
49 } OPEN_LOGIN_ACCESS_LEVELS_t;
50 
52 typedef enum
53 {
54  OPEN_ACCESS_LEVEL_UNKNOWN = 0,
55  OPEN_ACCESS_LEVEL_LOGIN = 1,
56  OPEN_ACCESS_LEVEL_ENABLE = 2
57 } OPEN_ACCESS_LEVEL_t;
58 
60 typedef enum
61 {
62  OPEN_AUTH_METHOD_UNDEFINED = 0,
63  OPEN_AUTH_METHOD_ENABLE = 1,
64  OPEN_AUTH_METHOD_LINE = 2,
65  OPEN_AUTH_METHOD_LOCAL = 3,
66  OPEN_AUTH_METHOD_NONE = 4,
67  OPEN_AUTH_METHOD_RADIUS = 5,
68  OPEN_AUTH_METHOD_TACACS = 6,
69  OPEN_AUTH_METHOD_REJECT = 7,
70  OPEN_AUTH_METHOD_IAS = 8
71 } OPEN_USER_MGR_AUTH_METHOD_t;
72 
74 typedef enum
75 {
76  OPEN_AUTHOR_TYPE_UNKNOWN = 0,
77  OPEN_AUTHOR_TYPE_COMMANDS = 1,
78  OPEN_AUTHOR_TYPE_EXEC = 2,
79  OPEN_AUTHOR_TYPE_MAX = 3
80 } OPEN_USER_MGR_AUTHOR_TYPES_t;
81 
83 typedef enum
84 {
85  OPEN_AUTHOR_METHOD_UNDEFINED = 0,
86  OPEN_AUTHOR_METHOD_TACACS = 1,
87  OPEN_AUTHOR_METHOD_RADIUS = 2,
88  OPEN_AUTHOR_METHOD_LOCAL = 3,
89  OPEN_AUTHOR_METHOD_NONE = 4,
90  OPEN_AUTHOR_METHOD_MAX = 5
91 } OPEN_AUTHOR_METHOD_t;
92 
94 typedef enum
95 {
96  OPEN_ACCT_TYPE_UNDEFINED = 0,
97  OPEN_ACCT_TYPE_EXEC_SESSION = 1,
98  OPEN_ACCT_TYPE_COMMANDS = 2,
99  OPEN_ACCT_TYPE_MAX = 3
100 } OPEN_USER_MGR_ACCT_TYPES_t;
101 
103 typedef enum
104 {
105  OPEN_ACCT_RECORD_TYPE_UNDEFINED = 0,
106  OPEN_ACCT_RECORD_TYPE_START_STOP = 1,
107  OPEN_ACCT_RECORD_TYPE_STOP_ONLY = 2,
108  OPEN_ACCT_RECORD_TYPE_NONE = 3,
109  OPEN_ACCT_RECORD_TYPE_MAX = 4
110 } OPEN_USER_MGR_RECORD_TYPES_t;
111 
113 typedef enum
114 {
115  OPEN_ACCT_METHOD_UNDEFINED = 0,
116  OPEN_ACCT_METHOD_TACACS = 1,
117  OPEN_ACCT_METHOD_RADIUS = 2,
118  OPEN_ACCT_METHOD_MAX = 3
119 } OPEN_USER_MGR_ACCT_METHOD_t;
120 
122 typedef enum
123 {
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
134 } OPEN_LOGIN_TYPE_t;
135 
137 typedef enum
138 {
139  OPEN_ENCRYPT_TYPE_NONE = 0,
140  OPEN_ENCRYPT_TYPE_AES = 1,
141  OPEN_ENCRYPT_TYPE_MD5_SALT = 2,
142  OPEN_ENCRYPT_TYPE_LAST = 3
143 } OPEN_ENCRYPT_TYPE_t;
144 
145 #define OPEN_LOGIN_SIZE 65
146 #define OPEN_PASSWORD_SIZE 65
148 /*****************************************************************/
174 open_error_t openapiUserSet(openapiClientHandle_t *client_handle,
175  open_buffdesc *userName,
176  open_buffdesc *password);
177 
178 /*****************************************************************/
195 open_error_t openapiUserFirstGet(openapiClientHandle_t *client_handle,
196  open_buffdesc *username);
197 
198 /*****************************************************************/
217 open_error_t openapiUserNextGet(openapiClientHandle_t *client_handle,
218  open_buffdesc *prevUserName,
219  open_buffdesc *nextUserName);
220 
221 /*****************************************************************/
238 open_error_t openapiSessionIDNextValidGet(openapiClientHandle_t *client_handle,
239  OPEN_LOGIN_TYPE_t sessionType,
240  uint32_t *prevSessionID);
241 
242 /*****************************************************************/
256 open_error_t openapiSessionLogout(openapiClientHandle_t *client_handle,
257  uint32_t sessionID);
258 
259 /*****************************************************************/
273 open_error_t openapiMaxUsersSupportedGet(openapiClientHandle_t *client_handle,
274  uint32_t *maxUsers);
275 
276 /*****************************************************************/
298 open_error_t openapiUserLevelSet(openapiClientHandle_t *client_handle,
299  open_buffdesc *userName,
300  OPEN_LOGIN_ACCESS_LEVELS_t level);
301 
302 /*****************************************************************/
322 open_error_t openapiUserLevelGet(openapiClientHandle_t *client_handle,
323  open_buffdesc *userName,
324  OPEN_LOGIN_ACCESS_LEVELS_t *level);
325 
326 /*****************************************************************/
339 open_error_t openapiUserNameSizeGet(openapiClientHandle_t *client_handle,
340  uint32_t *userNameSize);
341 
342 /*****************************************************************/
360 open_error_t openapiUserNameValidate(openapiClientHandle_t *client_handle,
361  open_buffdesc *userName);
362 
363 /*****************************************************************/
378 open_error_t openapiPasswordSizeGet(openapiClientHandle_t *client_handle,
379  uint32_t *passwordMinSize,
380  uint32_t *passwordMaxSize);
381 
382 /*****************************************************************/
403 open_error_t openapiUserDelete(openapiClientHandle_t *client_handle,
404  open_buffdesc *userName);
405 
406 /*****************************************************************/
429 open_error_t openapiAuthenticationListCreate(openapiClientHandle_t *client_handle,
430  OPEN_ACCESS_LEVEL_t accessLevel,
431  open_buffdesc *authListName);
432 
433 /*****************************************************************/
467 open_error_t openapiAuthenticationMethodsAdd(openapiClientHandle_t *client_handle,
468  OPEN_ACCESS_LEVEL_t accessLevel,
469  open_buffdesc *authListName,
470  open_buffdesc *authMethod);
471 
472 /*****************************************************************/
495 open_error_t openapiAuthenticationMethodListGet(openapiClientHandle_t *client_handle,
496  OPEN_ACCESS_LEVEL_t authLevel,
497  open_buffdesc *authListName,
498  open_buffdesc *methodList);
499 
500 /*****************************************************************/
518 open_error_t openapiAuthenticationListFirstGet(openapiClientHandle_t *client_handle,
519  OPEN_ACCESS_LEVEL_t authLevel,
520  open_buffdesc *authListName);
521 
522 /*****************************************************************/
542 open_error_t openapiAuthenticationListNextGet(openapiClientHandle_t *client_handle,
543  OPEN_ACCESS_LEVEL_t authLevel,
544  open_buffdesc *prevAuthListName,
545  open_buffdesc *nextAuthListName);
546 /*****************************************************************/
567 open_error_t openapiAuthenticationListDelete(openapiClientHandle_t *client_handle,
568  OPEN_ACCESS_LEVEL_t accessLevel,
569  open_buffdesc *authListName);
570 
571 /*****************************************************************/
594 open_error_t openapiAuthenticationListLineSet(openapiClientHandle_t *client_handle,
595  OPEN_ACCESS_LINE_t accessLine,
596  OPEN_ACCESS_LEVEL_t accessLevel,
597  open_buffdesc *authListName);
598 
599 /*****************************************************************/
618 open_error_t openapiAuthenticationListLineGet(openapiClientHandle_t *client_handle,
619  OPEN_ACCESS_LINE_t accessLine,
620  OPEN_ACCESS_LEVEL_t accessLevel,
621  open_buffdesc *authListName);
622 
623 /*****************************************************************/
641 open_error_t openapiAuthenticationListLineDelete(openapiClientHandle_t *client_handle,
642  OPEN_ACCESS_LINE_t accessLine,
643  OPEN_ACCESS_LEVEL_t accessLevel);
644 
645 /*****************************************************************/
661 open_error_t openapiAuthenticationListNameSizeGet(openapiClientHandle_t *client_handle,
662  uint32_t *authListNameSize);
663 
664 /*****************************************************************/
682 open_error_t openapiAuthenticationMethodsMaxGet(openapiClientHandle_t *client_handle,
683  uint32_t *maxAuthMethods);
684 
685 
686 /*****************************************************************/
704 open_error_t openapiAuthenticationListNameValidate(openapiClientHandle_t *client_handle,
705  open_buffdesc *authListName);
706 
707 /*****************************************************************/
725 open_error_t openapiAccountingListNameValidate(openapiClientHandle_t *client_handle,
726  open_buffdesc *acctListName);
727 
728 /*****************************************************************/
746 open_error_t openapiAuthorizationListNameValidate(openapiClientHandle_t *client_handle,
747  open_buffdesc *authorListName);
748 
749 /*****************************************************************/
771 open_error_t openapiAuthorizationListCreate(openapiClientHandle_t *client_handle,
772  OPEN_USER_MGR_AUTHOR_TYPES_t type,
773  open_buffdesc *authorListName);
774 
775 /*****************************************************************/
804 open_error_t openapiAuthorizationMethodsAdd(openapiClientHandle_t *client_handle,
805  OPEN_USER_MGR_AUTHOR_TYPES_t type,
806  open_buffdesc *authorListName,
807  open_buffdesc *authorMethod);
808 
809 /*****************************************************************/
825 open_error_t openapiAuthorizationListNameSizeGet(openapiClientHandle_t *client_handle,
826  uint32_t *authorListNameSize);
827 
828 /*****************************************************************/
845 open_error_t openapiAuthorizationMethodsMaxGet(openapiClientHandle_t *client_handle,
846  uint32_t *maxAuthorMethods);
847 
848 /*****************************************************************/
870 open_error_t openapiAuthorizationListDelete(openapiClientHandle_t *client_handle,
871  OPEN_USER_MGR_AUTHOR_TYPES_t type,
872  open_buffdesc *authorListName);
873 
874 /*****************************************************************/
893 open_error_t openapiAuthorizationListFirstGet(openapiClientHandle_t *client_handle,
894  OPEN_USER_MGR_AUTHOR_TYPES_t type,
895  open_buffdesc *authorListName);
896 
897 /*****************************************************************/
920 open_error_t openapiAuthorizationListNextGet(openapiClientHandle_t *client_handle,
921  OPEN_USER_MGR_AUTHOR_TYPES_t type,
922  open_buffdesc *prevAuthorListName,
923  open_buffdesc *nextAuthorListName);
924 
925 /*****************************************************************/
949 open_error_t openapiAuthorizationMethodListGet(openapiClientHandle_t *client_handle,
950  OPEN_USER_MGR_AUTHOR_TYPES_t type,
951  open_buffdesc *authorListName,
952  open_buffdesc *authorMethodList);
953 
954 /*****************************************************************/
973 open_error_t openapiAuthorizationListLineSet(openapiClientHandle_t *client_handle,
974  OPEN_ACCESS_LINE_t accessLine,
975  OPEN_USER_MGR_AUTHOR_TYPES_t type,
976  open_buffdesc *authorListName);
977 
978 /*****************************************************************/
997 open_error_t openapiAuthorizationListLineGet(openapiClientHandle_t *client_handle,
998  OPEN_ACCESS_LINE_t accessLine,
999  OPEN_USER_MGR_AUTHOR_TYPES_t type,
1000  open_buffdesc *authorListName);
1001 
1002 /*****************************************************************/
1021 open_error_t openapiAuthorizationListLineDelete(openapiClientHandle_t *client_handle,
1022  OPEN_ACCESS_LINE_t accessLine,
1023  OPEN_USER_MGR_AUTHOR_TYPES_t type);
1024 
1025 /*****************************************************************/
1048 open_error_t openapiAccountingListCreate(openapiClientHandle_t *client_handle,
1049  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1050  OPEN_USER_MGR_RECORD_TYPES_t recordType,
1051  open_buffdesc *acctListName);
1052 
1053 /*****************************************************************/
1083 open_error_t openapiAccountingMethodsAdd(openapiClientHandle_t *client_handle,
1084  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1085  open_buffdesc *acctListName,
1086  open_buffdesc *acctMethod);
1087 
1088 /*****************************************************************/
1109 open_error_t openapiAccountingMethodListGet(openapiClientHandle_t *client_handle,
1110  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1111  open_buffdesc *acctListName,
1112  open_buffdesc *methodList);
1113 
1114 /*****************************************************************/
1133 open_error_t openapiAccountingListRecordTypeGet(openapiClientHandle_t *client_handle,
1134  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1135  open_buffdesc *acctListName,
1136  OPEN_USER_MGR_RECORD_TYPES_t *recordType);
1137 
1138 /*****************************************************************/
1155 open_error_t openapiAccountingListFirstGet(openapiClientHandle_t *client_handle,
1156  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1157  open_buffdesc *acctListName);
1158 
1159 /*****************************************************************/
1181 open_error_t openapiAccountingListNextGet(openapiClientHandle_t *client_handle,
1182  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1183  open_buffdesc *prevAcctListName,
1184  open_buffdesc *nextAcctListName);
1185 
1186 /*****************************************************************/
1209 open_error_t openapiAccountingListDelete(openapiClientHandle_t *client_handle,
1210  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1211  open_buffdesc *acctListName);
1212 
1213 /*****************************************************************/
1232 open_error_t openapiAccountingListLineSet(openapiClientHandle_t *client_handle,
1233  OPEN_ACCESS_LINE_t accessLine,
1234  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1235  open_buffdesc *acctListName);
1236 
1237 /*****************************************************************/
1255 open_error_t openapiAccountingListLineGet(openapiClientHandle_t *client_handle,
1256  OPEN_ACCESS_LINE_t accessLine,
1257  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1258  open_buffdesc *acctListName);
1259 
1260 /*****************************************************************/
1276 open_error_t openapiAccountingListLineDelete(openapiClientHandle_t *client_handle,
1277  OPEN_ACCESS_LINE_t accessLine,
1278  OPEN_USER_MGR_ACCT_TYPES_t acctType);
1279 
1280 /*****************************************************************/
1296 open_error_t openapiAccountingMethodsMaxGet(openapiClientHandle_t *client_handle,
1297  uint32_t *maxAcctMethods);
1298 
1299 /*****************************************************************/
1314 open_error_t openapiAccountingListNameSizeGet(openapiClientHandle_t *client_handle,
1315  uint32_t *acctListNameSize);
1316 
1317 /*****************************************************************/
1335 open_error_t openapiEnablePasswordSet(openapiClientHandle_t *client_handle,
1336  open_buffdesc *enablePswd);
1337 
1338 /*****************************************************************/
1353 open_error_t openapiEnablePasswordRemove(openapiClientHandle_t *client_handle);
1354 
1355 /*****************************************************************/
1380 open_error_t openapiAuthenticateUser(openapiClientHandle_t *client_handle,
1381  open_buffdesc *userName,
1382  open_buffdesc *password,
1383  OPEN_LOGIN_ACCESS_LEVELS_t *accessLevel);
1384 
1385 /*****************************************************************/
1409 open_error_t openapiWebSessionUserLogin(openapiClientHandle_t *client_handle,
1410  open_buffdesc *userName,
1411  open_buffdesc *password,
1412  open_buffdesc *logintype,
1413  open_buffdesc *inetaddr,
1414  uint32_t *accessLevel,
1415  open_buffdesc *sessionId);
1416 
1417 
1418 /************************************************************************/
1434 open_error_t openapiWebSessionValidate(openapiClientHandle_t *client_handle,
1435  open_buffdesc *sessionId,
1436  open_buffdesc *logintype,
1437  open_buffdesc *inetaddr,
1438  uint32_t *accessLevel);
1439 
1440 /************************************************************************/
1453 open_error_t openapiWebSessionLogout(openapiClientHandle_t *client_handle,
1454  open_buffdesc *sessionId);
1455 
1456 /*****************************************************************/
1474 open_error_t openapiIsAuthenticationRequiredGet(openapiClientHandle_t *client_handle,
1475  OPEN_ACCESS_LINE_t accessLine,
1476  OPEN_ACCESS_LEVEL_t accessLevel,
1477  OPEN_BOOL_t *authStatus);
1478 
1479 /*****************************************************************/
1495 open_error_t openapiUserPasswordGet(openapiClientHandle_t *client_handle,
1496  open_buffdesc *userName,
1497  open_buffdesc *userPassword);
1498 
1499 /*****************************************************************/
1516 open_error_t openapiLoginSessionUserGet(openapiClientHandle_t *client_handle,
1517  uint32_t id,
1518  open_buffdesc *name);
1519 
1520 /*****************************************************************/
1535 open_error_t openapiLoginSessionRemoteIpAddrGet(openapiClientHandle_t *client_handle,
1536  uint32_t id,
1537  open_inet_addr_t *addr);
1538 
1539 /*****************************************************************/
1554 open_error_t openapiLoginSessionIdleTimeGet(openapiClientHandle_t *client_handle,
1555  uint32_t id,
1556  uint32_t *timeVal);
1557 
1558 /*****************************************************************/
1573 open_error_t openapiLoginSessionTimeGet(openapiClientHandle_t *client_handle,
1574  uint32_t id,
1575  uint32_t *timeVal);
1576 
1577 /*****************************************************************/
1592 open_error_t openapiLoginSessionTypeGet(openapiClientHandle_t *client_handle,
1593  uint32_t id,
1594  OPEN_LOGIN_TYPE_t *type);
1595 
1596 /*****************************************************************/
1625 open_error_t openapiUserPasswordEncryptTypeSet(openapiClientHandle_t *client_handle,
1626  open_buffdesc *userName,
1627  open_buffdesc *password,
1628  OPEN_ENCRYPT_TYPE_t encryptType,
1629  OPEN_BOOL_t encrypted);
1630 
1631 /*****************************************************************/
1651 open_error_t openapiUserPasswordEncryptTypeGet(openapiClientHandle_t *client_handle,
1652  open_buffdesc *userName,
1653  OPEN_ENCRYPT_TYPE_t *encryptType);
1654 
1655 /*****************************************************************/
1675 open_error_t openapiEnablePasswordEncryptTypeSet(openapiClientHandle_t *client_handle,
1676  open_buffdesc *enablePswd,
1677  OPEN_ENCRYPT_TYPE_t encryptType,
1678  OPEN_BOOL_t encrypted);
1679 
1680 /*****************************************************************/
1695 open_error_t openapiEnablePasswordEncryptTypeGet(openapiClientHandle_t *client_handle,
1696  OPEN_ENCRYPT_TYPE_t *encryptType);
1697 
1698 #endif
1699