Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.4.4.5
openapi_user_manager.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2018 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 
136 #define OPEN_LOGIN_SIZE 65
138 /*****************************************************************/
164 open_error_t openapiUserSet(openapiClientHandle_t *client_handle,
165  open_buffdesc *userName,
166  open_buffdesc *password);
167 
168 /*****************************************************************/
185 open_error_t openapiUserFirstGet(openapiClientHandle_t *client_handle,
186  open_buffdesc *username);
187 
188 /*****************************************************************/
207 open_error_t openapiUserNextGet(openapiClientHandle_t *client_handle,
208  open_buffdesc *prevUserName,
209  open_buffdesc *nextUserName);
210 
211 /*****************************************************************/
228 open_error_t openapiSessionIDNextValidGet(openapiClientHandle_t *client_handle,
229  OPEN_LOGIN_TYPE_t sessionType,
230  uint32_t *prevSessionID);
231 
232 /*****************************************************************/
246 open_error_t openapiSessionLogout(openapiClientHandle_t *client_handle,
247  uint32_t sessionID);
248 
249 /*****************************************************************/
263 open_error_t openapiMaxUsersSupportedGet(openapiClientHandle_t *client_handle,
264  uint32_t *maxUsers);
265 
266 /*****************************************************************/
288 open_error_t openapiUserLevelSet(openapiClientHandle_t *client_handle,
289  open_buffdesc *userName,
290  OPEN_LOGIN_ACCESS_LEVELS_t level);
291 
292 /*****************************************************************/
312 open_error_t openapiUserLevelGet(openapiClientHandle_t *client_handle,
313  open_buffdesc *userName,
314  OPEN_LOGIN_ACCESS_LEVELS_t *level);
315 
316 /*****************************************************************/
329 open_error_t openapiUserNameSizeGet(openapiClientHandle_t *client_handle,
330  uint32_t *userNameSize);
331 
332 /*****************************************************************/
350 open_error_t openapiUserNameValidate(openapiClientHandle_t *client_handle,
351  open_buffdesc *userName);
352 
353 /*****************************************************************/
368 open_error_t openapiPasswordSizeGet(openapiClientHandle_t *client_handle,
369  uint32_t *passwordMinSize,
370  uint32_t *passwordMaxSize);
371 
372 /*****************************************************************/
393 open_error_t openapiUserDelete(openapiClientHandle_t *client_handle,
394  open_buffdesc *userName);
395 
396 /*****************************************************************/
419 open_error_t openapiAuthenticationListCreate(openapiClientHandle_t *client_handle,
420  OPEN_ACCESS_LEVEL_t accessLevel,
421  open_buffdesc *authListName);
422 
423 /*****************************************************************/
457 open_error_t openapiAuthenticationMethodsAdd(openapiClientHandle_t *client_handle,
458  OPEN_ACCESS_LEVEL_t accessLevel,
459  open_buffdesc *authListName,
460  open_buffdesc *authMethod);
461 
462 /*****************************************************************/
485 open_error_t openapiAuthenticationMethodListGet(openapiClientHandle_t *client_handle,
486  OPEN_ACCESS_LEVEL_t authLevel,
487  open_buffdesc *authListName,
488  open_buffdesc *methodList);
489 
490 /*****************************************************************/
508 open_error_t openapiAuthenticationListFirstGet(openapiClientHandle_t *client_handle,
509  OPEN_ACCESS_LEVEL_t authLevel,
510  open_buffdesc *authListName);
511 
512 /*****************************************************************/
532 open_error_t openapiAuthenticationListNextGet(openapiClientHandle_t *client_handle,
533  OPEN_ACCESS_LEVEL_t authLevel,
534  open_buffdesc *prevAuthListName,
535  open_buffdesc *nextAuthListName);
536 /*****************************************************************/
557 open_error_t openapiAuthenticationListDelete(openapiClientHandle_t *client_handle,
558  OPEN_ACCESS_LEVEL_t accessLevel,
559  open_buffdesc *authListName);
560 
561 /*****************************************************************/
584 open_error_t openapiAuthenticationListLineSet(openapiClientHandle_t *client_handle,
585  OPEN_ACCESS_LINE_t accessLine,
586  OPEN_ACCESS_LEVEL_t accessLevel,
587  open_buffdesc *authListName);
588 
589 /*****************************************************************/
608 open_error_t openapiAuthenticationListLineGet(openapiClientHandle_t *client_handle,
609  OPEN_ACCESS_LINE_t accessLine,
610  OPEN_ACCESS_LEVEL_t accessLevel,
611  open_buffdesc *authListName);
612 
613 /*****************************************************************/
631 open_error_t openapiAuthenticationListLineDelete(openapiClientHandle_t *client_handle,
632  OPEN_ACCESS_LINE_t accessLine,
633  OPEN_ACCESS_LEVEL_t accessLevel);
634 
635 /*****************************************************************/
651 open_error_t openapiAuthenticationListNameSizeGet(openapiClientHandle_t *client_handle,
652  uint32_t *authListNameSize);
653 
654 /*****************************************************************/
672 open_error_t openapiAuthenticationMethodsMaxGet(openapiClientHandle_t *client_handle,
673  uint32_t *maxAuthMethods);
674 
675 
676 /*****************************************************************/
694 open_error_t openapiAuthenticationListNameValidate(openapiClientHandle_t *client_handle,
695  open_buffdesc *authListName);
696 
697 /*****************************************************************/
715 open_error_t openapiAccountingListNameValidate(openapiClientHandle_t *client_handle,
716  open_buffdesc *acctListName);
717 
718 /*****************************************************************/
736 open_error_t openapiAuthorizationListNameValidate(openapiClientHandle_t *client_handle,
737  open_buffdesc *authorListName);
738 
739 /*****************************************************************/
761 open_error_t openapiAuthorizationListCreate(openapiClientHandle_t *client_handle,
762  OPEN_USER_MGR_AUTHOR_TYPES_t type,
763  open_buffdesc *authorListName);
764 
765 /*****************************************************************/
794 open_error_t openapiAuthorizationMethodsAdd(openapiClientHandle_t *client_handle,
795  OPEN_USER_MGR_AUTHOR_TYPES_t type,
796  open_buffdesc *authorListName,
797  open_buffdesc *authorMethod);
798 
799 /*****************************************************************/
815 open_error_t openapiAuthorizationListNameSizeGet(openapiClientHandle_t *client_handle,
816  uint32_t *authorListNameSize);
817 
818 /*****************************************************************/
835 open_error_t openapiAuthorizationMethodsMaxGet(openapiClientHandle_t *client_handle,
836  uint32_t *maxAuthorMethods);
837 
838 /*****************************************************************/
860 open_error_t openapiAuthorizationListDelete(openapiClientHandle_t *client_handle,
861  OPEN_USER_MGR_AUTHOR_TYPES_t type,
862  open_buffdesc *authorListName);
863 
864 /*****************************************************************/
883 open_error_t openapiAuthorizationListFirstGet(openapiClientHandle_t *client_handle,
884  OPEN_USER_MGR_AUTHOR_TYPES_t type,
885  open_buffdesc *authorListName);
886 
887 /*****************************************************************/
910 open_error_t openapiAuthorizationListNextGet(openapiClientHandle_t *client_handle,
911  OPEN_USER_MGR_AUTHOR_TYPES_t type,
912  open_buffdesc *prevAuthorListName,
913  open_buffdesc *nextAuthorListName);
914 
915 /*****************************************************************/
939 open_error_t openapiAuthorizationMethodListGet(openapiClientHandle_t *client_handle,
940  OPEN_USER_MGR_AUTHOR_TYPES_t type,
941  open_buffdesc *authorListName,
942  open_buffdesc *authorMethodList);
943 
944 /*****************************************************************/
963 open_error_t openapiAuthorizationListLineSet(openapiClientHandle_t *client_handle,
964  OPEN_ACCESS_LINE_t accessLine,
965  OPEN_USER_MGR_AUTHOR_TYPES_t type,
966  open_buffdesc *authorListName);
967 
968 /*****************************************************************/
987 open_error_t openapiAuthorizationListLineGet(openapiClientHandle_t *client_handle,
988  OPEN_ACCESS_LINE_t accessLine,
989  OPEN_USER_MGR_AUTHOR_TYPES_t type,
990  open_buffdesc *authorListName);
991 
992 /*****************************************************************/
1011 open_error_t openapiAuthorizationListLineDelete(openapiClientHandle_t *client_handle,
1012  OPEN_ACCESS_LINE_t accessLine,
1013  OPEN_USER_MGR_AUTHOR_TYPES_t type);
1014 
1015 /*****************************************************************/
1038 open_error_t openapiAccountingListCreate(openapiClientHandle_t *client_handle,
1039  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1040  OPEN_USER_MGR_RECORD_TYPES_t recordType,
1041  open_buffdesc *acctListName);
1042 
1043 /*****************************************************************/
1073 open_error_t openapiAccountingMethodsAdd(openapiClientHandle_t *client_handle,
1074  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1075  open_buffdesc *acctListName,
1076  open_buffdesc *acctMethod);
1077 
1078 /*****************************************************************/
1099 open_error_t openapiAccountingMethodListGet(openapiClientHandle_t *client_handle,
1100  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1101  open_buffdesc *acctListName,
1102  open_buffdesc *methodList);
1103 
1104 /*****************************************************************/
1123 open_error_t openapiAccountingListRecordTypeGet(openapiClientHandle_t *client_handle,
1124  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1125  open_buffdesc *acctListName,
1126  OPEN_USER_MGR_RECORD_TYPES_t *recordType);
1127 
1128 /*****************************************************************/
1145 open_error_t openapiAccountingListFirstGet(openapiClientHandle_t *client_handle,
1146  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1147  open_buffdesc *acctListName);
1148 
1149 /*****************************************************************/
1171 open_error_t openapiAccountingListNextGet(openapiClientHandle_t *client_handle,
1172  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1173  open_buffdesc *prevAcctListName,
1174  open_buffdesc *nextAcctListName);
1175 
1176 /*****************************************************************/
1199 open_error_t openapiAccountingListDelete(openapiClientHandle_t *client_handle,
1200  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1201  open_buffdesc *acctListName);
1202 
1203 /*****************************************************************/
1222 open_error_t openapiAccountingListLineSet(openapiClientHandle_t *client_handle,
1223  OPEN_ACCESS_LINE_t accessLine,
1224  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1225  open_buffdesc *acctListName);
1226 
1227 /*****************************************************************/
1245 open_error_t openapiAccountingListLineGet(openapiClientHandle_t *client_handle,
1246  OPEN_ACCESS_LINE_t accessLine,
1247  OPEN_USER_MGR_ACCT_TYPES_t acctType,
1248  open_buffdesc *acctListName);
1249 
1250 /*****************************************************************/
1266 open_error_t openapiAccountingListLineDelete(openapiClientHandle_t *client_handle,
1267  OPEN_ACCESS_LINE_t accessLine,
1268  OPEN_USER_MGR_ACCT_TYPES_t acctType);
1269 
1270 /*****************************************************************/
1286 open_error_t openapiAccountingMethodsMaxGet(openapiClientHandle_t *client_handle,
1287  uint32_t *maxAcctMethods);
1288 
1289 /*****************************************************************/
1304 open_error_t openapiAccountingListNameSizeGet(openapiClientHandle_t *client_handle,
1305  uint32_t *acctListNameSize);
1306 
1307 /*****************************************************************/
1325 open_error_t openapiEnablePasswordSet(openapiClientHandle_t *client_handle,
1326  open_buffdesc *enablePswd);
1327 
1328 /*****************************************************************/
1343 open_error_t openapiEnablePasswordRemove(openapiClientHandle_t *client_handle);
1344 
1345 /*****************************************************************/
1370 open_error_t openapiAuthenticateUser(openapiClientHandle_t *client_handle,
1371  open_buffdesc *userName,
1372  open_buffdesc *password,
1373  OPEN_LOGIN_ACCESS_LEVELS_t *accessLevel);
1374 
1375 /*****************************************************************/
1399 open_error_t openapiWebSessionUserLogin(openapiClientHandle_t *client_handle,
1400  open_buffdesc *userName,
1401  open_buffdesc *password,
1402  open_buffdesc *logintype,
1403  open_buffdesc *inetaddr,
1404  uint32_t *accessLevel,
1405  open_buffdesc *sessionId);
1406 
1407 
1408 /************************************************************************/
1424 open_error_t openapiWebSessionValidate(openapiClientHandle_t *client_handle,
1425  open_buffdesc *sessionId,
1426  open_buffdesc *logintype,
1427  open_buffdesc *inetaddr,
1428  uint32_t *accessLevel);
1429 
1430 /************************************************************************/
1443 open_error_t openapiWebSessionLogout(openapiClientHandle_t *client_handle,
1444  open_buffdesc *sessionId);
1445 
1446 /*****************************************************************/
1464 open_error_t openapiIsAuthenticationRequiredGet(openapiClientHandle_t *client_handle,
1465  OPEN_ACCESS_LINE_t accessLine,
1466  OPEN_ACCESS_LEVEL_t accessLevel,
1467  OPEN_BOOL_t *authStatus);
1468 
1469 /*****************************************************************/
1485 open_error_t openapiUserPasswordGet(openapiClientHandle_t *client_handle,
1486  open_buffdesc *userName,
1487  open_buffdesc *userPassword);
1488 
1489 /*****************************************************************/
1506 open_error_t openapiLoginSessionUserGet(openapiClientHandle_t *client_handle,
1507  uint32_t id,
1508  open_buffdesc *name);
1509 
1510 /*****************************************************************/
1525 open_error_t openapiLoginSessionRemoteIpAddrGet(openapiClientHandle_t *client_handle,
1526  uint32_t id,
1527  open_inet_addr_t *addr);
1528 
1529 /*****************************************************************/
1544 open_error_t openapiLoginSessionIdleTimeGet(openapiClientHandle_t *client_handle,
1545  uint32_t id,
1546  uint32_t *timeVal);
1547 
1548 /*****************************************************************/
1563 open_error_t openapiLoginSessionTimeGet(openapiClientHandle_t *client_handle,
1564  uint32_t id,
1565  uint32_t *timeVal);
1566 
1567 /*****************************************************************/
1582 open_error_t openapiLoginSessionTypeGet(openapiClientHandle_t *client_handle,
1583  uint32_t id,
1584  OPEN_LOGIN_TYPE_t *type);
1585 
1586 #endif
1587