Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_user_manager.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2021 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_SHA256_SALT = 3,
143  OPEN_ENCRYPT_TYPE_SHA512_SALT = 4,
144  OPEN_ENCRYPT_TYPE_LAST = 5
145 } OPEN_ENCRYPT_TYPE_t;
146 
147 #define OPEN_LOGIN_SIZE 65
148 #define OPEN_PASSWORD_SIZE 65
150 /*****************************************************************/
176 open_error_t openapiUserSet(openapiClientHandle_t *client_handle,
177  open_buffdesc *userName,
178  open_buffdesc *password);
179 
180 /*****************************************************************/
197 open_error_t openapiUserFirstGet(openapiClientHandle_t *client_handle,
198  open_buffdesc *username);
199 
200 /*****************************************************************/
219 open_error_t openapiUserNextGet(openapiClientHandle_t *client_handle,
220  open_buffdesc *prevUserName,
221  open_buffdesc *nextUserName);
222 
223 /*****************************************************************/
240 open_error_t openapiSessionIDNextValidGet(openapiClientHandle_t *client_handle,
241  OPEN_LOGIN_TYPE_t sessionType,
242  uint32_t *prevSessionID);
243 
244 /*****************************************************************/
258 open_error_t openapiSessionLogout(openapiClientHandle_t *client_handle,
259  uint32_t sessionID);
260 
261 /*****************************************************************/
275 open_error_t openapiMaxUsersSupportedGet(openapiClientHandle_t *client_handle,
276  uint32_t *maxUsers);
277 
278 /*****************************************************************/
300 open_error_t openapiUserLevelSet(openapiClientHandle_t *client_handle,
301  open_buffdesc *userName,
302  OPEN_LOGIN_ACCESS_LEVELS_t level);
303 
304 /*****************************************************************/
324 open_error_t openapiUserLevelGet(openapiClientHandle_t *client_handle,
325  open_buffdesc *userName,
326  OPEN_LOGIN_ACCESS_LEVELS_t *level);
327 
328 /*****************************************************************/
341 open_error_t openapiUserNameSizeGet(openapiClientHandle_t *client_handle,
342  uint32_t *userNameSize);
343 
344 /*****************************************************************/
362 open_error_t openapiUserNameValidate(openapiClientHandle_t *client_handle,
363  open_buffdesc *userName);
364 
365 /*****************************************************************/
380 open_error_t openapiPasswordSizeGet(openapiClientHandle_t *client_handle,
381  uint32_t *passwordMinSize,
382  uint32_t *passwordMaxSize);
383 
384 /*****************************************************************/
405 open_error_t openapiUserDelete(openapiClientHandle_t *client_handle,
406  open_buffdesc *userName);
407 
408 /*****************************************************************/
431 open_error_t openapiAuthenticationListCreate(openapiClientHandle_t *client_handle,
432  OPEN_ACCESS_LEVEL_t accessLevel,
433  open_buffdesc *authListName);
434 
435 /*****************************************************************/
469 open_error_t openapiAuthenticationMethodsAdd(openapiClientHandle_t *client_handle,
470  OPEN_ACCESS_LEVEL_t accessLevel,
471  open_buffdesc *authListName,
472  open_buffdesc *authMethod);
473 
474 /*****************************************************************/
497 open_error_t openapiAuthenticationMethodListGet(openapiClientHandle_t *client_handle,
498  OPEN_ACCESS_LEVEL_t authLevel,
499  open_buffdesc *authListName,
500  open_buffdesc *methodList);
501 
502 /*****************************************************************/
520 open_error_t openapiAuthenticationListFirstGet(openapiClientHandle_t *client_handle,
521  OPEN_ACCESS_LEVEL_t authLevel,
522  open_buffdesc *authListName);
523 
524 /*****************************************************************/
544 open_error_t openapiAuthenticationListNextGet(openapiClientHandle_t *client_handle,
545  OPEN_ACCESS_LEVEL_t authLevel,
546  open_buffdesc *prevAuthListName,
547  open_buffdesc *nextAuthListName);
548 /*****************************************************************/
569 open_error_t openapiAuthenticationListDelete(openapiClientHandle_t *client_handle,
570  OPEN_ACCESS_LEVEL_t accessLevel,
571  open_buffdesc *authListName);
572 
573 /*****************************************************************/
596 open_error_t openapiAuthenticationListLineSet(openapiClientHandle_t *client_handle,
597  OPEN_ACCESS_LINE_t accessLine,
598  OPEN_ACCESS_LEVEL_t accessLevel,
599  open_buffdesc *authListName);
600 
601 /*****************************************************************/
620 open_error_t openapiAuthenticationListLineGet(openapiClientHandle_t *client_handle,
621  OPEN_ACCESS_LINE_t accessLine,
622  OPEN_ACCESS_LEVEL_t accessLevel,
623  open_buffdesc *authListName);
624 
625 /*****************************************************************/
643 open_error_t openapiAuthenticationListLineDelete(openapiClientHandle_t *client_handle,
644  OPEN_ACCESS_LINE_t accessLine,
645  OPEN_ACCESS_LEVEL_t accessLevel);
646 
647 /*****************************************************************/
663 open_error_t openapiAuthenticationListNameSizeGet(openapiClientHandle_t *client_handle,
664  uint32_t *authListNameSize);
665 
666 /*****************************************************************/
684 open_error_t openapiAuthenticationMethodsMaxGet(openapiClientHandle_t *client_handle,
685  uint32_t *maxAuthMethods);
686 
687 
688 /*****************************************************************/
706 open_error_t openapiAuthenticationListNameValidate(openapiClientHandle_t *client_handle,
707  open_buffdesc *authListName);
708 
709 /*****************************************************************/
727 open_error_t openapiAccountingListNameValidate(openapiClientHandle_t *client_handle,
728  open_buffdesc *acctListName);
729 
730 /*****************************************************************/
748 open_error_t openapiAuthorizationListNameValidate(openapiClientHandle_t *client_handle,
749  open_buffdesc *authorListName);
750 
751 /*****************************************************************/
773 open_error_t openapiAuthorizationListCreate(openapiClientHandle_t *client_handle,
774  OPEN_USER_MGR_AUTHOR_TYPES_t type,
775  open_buffdesc *authorListName);
776 
777 /*****************************************************************/
806 open_error_t openapiAuthorizationMethodsAdd(openapiClientHandle_t *client_handle,
807  OPEN_USER_MGR_AUTHOR_TYPES_t type,
808  open_buffdesc *authorListName,
809  open_buffdesc *authorMethod);
810 
811 /*****************************************************************/
827 open_error_t openapiAuthorizationListNameSizeGet(openapiClientHandle_t *client_handle,
828  uint32_t *authorListNameSize);
829 
830 /*****************************************************************/
847 open_error_t openapiAuthorizationMethodsMaxGet(openapiClientHandle_t *client_handle,
848  uint32_t *maxAuthorMethods);
849 
850 /*****************************************************************/
872 open_error_t openapiAuthorizationListDelete(openapiClientHandle_t *client_handle,
873  OPEN_USER_MGR_AUTHOR_TYPES_t type,
874  open_buffdesc *authorListName);
875 
876 /*****************************************************************/
895 open_error_t openapiAuthorizationListFirstGet(openapiClientHandle_t *client_handle,
896  OPEN_USER_MGR_AUTHOR_TYPES_t type,
897  open_buffdesc *authorListName);
898 
899 /*****************************************************************/
922 open_error_t openapiAuthorizationListNextGet(openapiClientHandle_t *client_handle,
923  OPEN_USER_MGR_AUTHOR_TYPES_t type,
924  open_buffdesc *prevAuthorListName,
925  open_buffdesc *nextAuthorListName);
926 
927 /*****************************************************************/
951 open_error_t openapiAuthorizationMethodListGet(openapiClientHandle_t *client_handle,
952  OPEN_USER_MGR_AUTHOR_TYPES_t type,
953  open_buffdesc *authorListName,
954  open_buffdesc *authorMethodList);
955 
956 /*****************************************************************/
975 open_error_t openapiAuthorizationListLineSet(openapiClientHandle_t *client_handle,
976  OPEN_ACCESS_LINE_t accessLine,
977  OPEN_USER_MGR_AUTHOR_TYPES_t type,
978  open_buffdesc *authorListName);
979 
980 /*****************************************************************/
999 open_error_t openapiAuthorizationListLineGet(openapiClientHandle_t *client_handle,
1000  OPEN_ACCESS_LINE_t accessLine,
1001  OPEN_USER_MGR_AUTHOR_TYPES_t type,
1002  open_buffdesc *authorListName);
1003 
1004 /*****************************************************************/
1023 open_error_t openapiAuthorizationListLineDelete(openapiClientHandle_t *client_handle,
1024  OPEN_ACCESS_LINE_t accessLine,
1025  OPEN_USER_MGR_AUTHOR_TYPES_t type);
1026 
1027 /*****************************************************************/
1050 open_error_t openapiAccountingListCreate(openapiClientHandle_t *client_handle,
1051  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1052  OPEN_USER_MGR_RECORD_TYPES_t recordType,
1053  open_buffdesc *acctListName);
1054 
1055 /*****************************************************************/
1085 open_error_t openapiAccountingMethodsAdd(openapiClientHandle_t *client_handle,
1086  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1087  open_buffdesc *acctListName,
1088  open_buffdesc *acctMethod);
1089 
1090 /*****************************************************************/
1111 open_error_t openapiAccountingMethodListGet(openapiClientHandle_t *client_handle,
1112  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1113  open_buffdesc *acctListName,
1114  open_buffdesc *methodList);
1115 
1116 /*****************************************************************/
1135 open_error_t openapiAccountingListRecordTypeGet(openapiClientHandle_t *client_handle,
1136  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1137  open_buffdesc *acctListName,
1138  OPEN_USER_MGR_RECORD_TYPES_t *recordType);
1139 
1140 /*****************************************************************/
1157 open_error_t openapiAccountingListFirstGet(openapiClientHandle_t *client_handle,
1158  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1159  open_buffdesc *acctListName);
1160 
1161 /*****************************************************************/
1183 open_error_t openapiAccountingListNextGet(openapiClientHandle_t *client_handle,
1184  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1185  open_buffdesc *prevAcctListName,
1186  open_buffdesc *nextAcctListName);
1187 
1188 /*****************************************************************/
1211 open_error_t openapiAccountingListDelete(openapiClientHandle_t *client_handle,
1212  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1213  open_buffdesc *acctListName);
1214 
1215 /*****************************************************************/
1234 open_error_t openapiAccountingListLineSet(openapiClientHandle_t *client_handle,
1235  OPEN_ACCESS_LINE_t accessLine,
1236  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1237  open_buffdesc *acctListName);
1238 
1239 /*****************************************************************/
1257 open_error_t openapiAccountingListLineGet(openapiClientHandle_t *client_handle,
1258  OPEN_ACCESS_LINE_t accessLine,
1259  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1260  open_buffdesc *acctListName);
1261 
1262 /*****************************************************************/
1278 open_error_t openapiAccountingListLineDelete(openapiClientHandle_t *client_handle,
1279  OPEN_ACCESS_LINE_t accessLine,
1280  OPEN_USER_MGR_ACCT_TYPES_t acctType);
1281 
1282 /*****************************************************************/
1298 open_error_t openapiAccountingMethodsMaxGet(openapiClientHandle_t *client_handle,
1299  uint32_t *maxAcctMethods);
1300 
1301 /*****************************************************************/
1316 open_error_t openapiAccountingListNameSizeGet(openapiClientHandle_t *client_handle,
1317  uint32_t *acctListNameSize);
1318 
1319 /*****************************************************************/
1337 open_error_t openapiEnablePasswordSet(openapiClientHandle_t *client_handle,
1338  open_buffdesc *enablePswd);
1339 
1340 /*****************************************************************/
1355 open_error_t openapiEnablePasswordRemove(openapiClientHandle_t *client_handle);
1356 
1357 /*****************************************************************/
1382 open_error_t openapiAuthenticateUser(openapiClientHandle_t *client_handle,
1383  open_buffdesc *userName,
1384  open_buffdesc *password,
1385  OPEN_LOGIN_ACCESS_LEVELS_t *accessLevel);
1386 
1387 /*****************************************************************/
1411 open_error_t openapiWebSessionUserLogin(openapiClientHandle_t *client_handle,
1412  open_buffdesc *userName,
1413  open_buffdesc *password,
1414  open_buffdesc *logintype,
1415  open_buffdesc *inetaddr,
1416  uint32_t *accessLevel,
1417  open_buffdesc *sessionId);
1418 
1419 
1420 /************************************************************************/
1436 open_error_t openapiWebSessionValidate(openapiClientHandle_t *client_handle,
1437  open_buffdesc *sessionId,
1438  open_buffdesc *logintype,
1439  open_buffdesc *inetaddr,
1440  uint32_t *accessLevel);
1441 
1442 /************************************************************************/
1455 open_error_t openapiWebSessionLogout(openapiClientHandle_t *client_handle,
1456  open_buffdesc *sessionId);
1457 
1458 /*****************************************************************/
1476 open_error_t openapiIsAuthenticationRequiredGet(openapiClientHandle_t *client_handle,
1477  OPEN_ACCESS_LINE_t accessLine,
1478  OPEN_ACCESS_LEVEL_t accessLevel,
1479  OPEN_BOOL_t *authStatus);
1480 
1481 /*****************************************************************/
1497 open_error_t openapiUserPasswordGet(openapiClientHandle_t *client_handle,
1498  open_buffdesc *userName,
1499  open_buffdesc *userPassword);
1500 
1501 /*****************************************************************/
1518 open_error_t openapiLoginSessionUserGet(openapiClientHandle_t *client_handle,
1519  uint32_t id,
1520  open_buffdesc *name);
1521 
1522 /*****************************************************************/
1537 open_error_t openapiLoginSessionRemoteIpAddrGet(openapiClientHandle_t *client_handle,
1538  uint32_t id,
1539  open_inet_addr_t *addr);
1540 
1541 /*****************************************************************/
1556 open_error_t openapiLoginSessionIdleTimeGet(openapiClientHandle_t *client_handle,
1557  uint32_t id,
1558  uint32_t *timeVal);
1559 
1560 /*****************************************************************/
1575 open_error_t openapiLoginSessionTimeGet(openapiClientHandle_t *client_handle,
1576  uint32_t id,
1577  uint32_t *timeVal);
1578 
1579 /*****************************************************************/
1594 open_error_t openapiLoginSessionTypeGet(openapiClientHandle_t *client_handle,
1595  uint32_t id,
1596  OPEN_LOGIN_TYPE_t *type);
1597 
1598 /*****************************************************************/
1627 open_error_t openapiUserPasswordEncryptTypeSet(openapiClientHandle_t *client_handle,
1628  open_buffdesc *userName,
1629  open_buffdesc *password,
1630  OPEN_ENCRYPT_TYPE_t encryptType,
1631  OPEN_BOOL_t encrypted);
1632 
1633 /*****************************************************************/
1653 open_error_t openapiUserPasswordEncryptTypeGet(openapiClientHandle_t *client_handle,
1654  open_buffdesc *userName,
1655  OPEN_ENCRYPT_TYPE_t *encryptType);
1656 
1657 /*****************************************************************/
1677 open_error_t openapiEnablePasswordEncryptTypeSet(openapiClientHandle_t *client_handle,
1678  open_buffdesc *enablePswd,
1679  OPEN_ENCRYPT_TYPE_t encryptType,
1680  OPEN_BOOL_t encrypted);
1681 
1682 /*****************************************************************/
1697 open_error_t openapiEnablePasswordEncryptTypeGet(openapiClientHandle_t *client_handle,
1698  OPEN_ENCRYPT_TYPE_t *encryptType);
1699 
1700 #endif
1701