blob: 57f53174c55dac6844057cb56a4947e0d7bd4139 [file] [log] [blame]
Richard Marian Thomaiyar4654d992018-04-19 05:38:37 +05301/*
2// Copyright (c) 2018 Intel Corporation
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8// http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15*/
16#pragma once
William A. Kennington III194375f2018-12-14 02:14:33 -080017#include <ipmid/api.h>
Richard Marian Thomaiyar4654d992018-04-19 05:38:37 +053018
19#include <string>
20
21namespace ipmi
22{
Richard Marian Thomaiyar5a6b6362018-03-12 23:42:34 +053023
24// TODO: Has to be replaced with proper channel number assignment logic
Richard Marian Thomaiyar6e1ba9e2018-11-29 06:29:21 +053025/**
26 * @enum Channel Id
27 */
Richard Marian Thomaiyar5a6b6362018-03-12 23:42:34 +053028enum class EChannelID : uint8_t
29{
30 chanLan1 = 0x01
31};
32
33static constexpr uint8_t invalidUserId = 0xFF;
34static constexpr uint8_t reservedUserId = 0x0;
35static constexpr uint8_t ipmiMaxUserName = 16;
36static constexpr uint8_t ipmiMaxUsers = 15;
37static constexpr uint8_t ipmiMaxChannels = 16;
Suryakanth Sekar90b00c72019-01-16 10:37:57 +053038static constexpr uint8_t maxIpmi20PasswordSize = 20;
39static constexpr uint8_t maxIpmi15PasswordSize = 16;
Richard Marian Thomaiyar5a6b6362018-03-12 23:42:34 +053040
Richard Marian Thomaiyar6e1ba9e2018-11-29 06:29:21 +053041/** @struct PrivAccess
42 *
43 * User privilege related access data as per IPMI specification.(refer spec
44 * sec 22.26)
45 */
Richard Marian Thomaiyar5a6b6362018-03-12 23:42:34 +053046struct PrivAccess
47{
48#if BYTE_ORDER == LITTLE_ENDIAN
49 uint8_t privilege : 4;
50 uint8_t ipmiEnabled : 1;
51 uint8_t linkAuthEnabled : 1;
52 uint8_t accessCallback : 1;
53 uint8_t reserved : 1;
54#endif
55#if BYTE_ORDER == BIG_ENDIAN
56 uint8_t reserved : 1;
57 uint8_t accessCallback : 1;
58 uint8_t linkAuthEnabled : 1;
59 uint8_t ipmiEnabled : 1;
60 uint8_t privilege : 4;
61#endif
62} __attribute__((packed));
63
64/** @brief initializes user management
65 *
66 * @return IPMI_CC_OK for success, others for failure.
67 */
68ipmi_ret_t ipmiUserInit();
69
Richard Marian Thomaiyar4654d992018-04-19 05:38:37 +053070/** @brief The ipmi get user password layer call
71 *
Richard Marian Thomaiyar5a6b6362018-03-12 23:42:34 +053072 * @param[in] userName - user name
Richard Marian Thomaiyar4654d992018-04-19 05:38:37 +053073 *
74 * @return password or empty string
75 */
76std::string ipmiUserGetPassword(const std::string& userName);
77
AppaRao Pulib29b5ab2018-05-17 10:28:48 +053078/** @brief The IPMI call to clear password entry associated with specified
79 * username
80 *
Richard Marian Thomaiyar5a6b6362018-03-12 23:42:34 +053081 * @param[in] userName - user name to be removed
AppaRao Pulib29b5ab2018-05-17 10:28:48 +053082 *
83 * @return 0 on success, non-zero otherwise.
84 */
Richard Marian Thomaiyar42bed642018-09-21 12:28:57 +053085ipmi_ret_t ipmiClearUserEntryPassword(const std::string& userName);
86
87/** @brief The IPMI call to reuse password entry for the renamed user
88 * to another one
89 *
Richard Marian Thomaiyar5a6b6362018-03-12 23:42:34 +053090 * @param[in] userName - user name which has to be renamed
91 * @param[in] newUserName - new user name
Richard Marian Thomaiyar42bed642018-09-21 12:28:57 +053092 *
93 * @return 0 on success, non-zero otherwise.
94 */
95ipmi_ret_t ipmiRenameUserEntryPassword(const std::string& userName,
96 const std::string& newUserName);
AppaRao Pulib29b5ab2018-05-17 10:28:48 +053097
Richard Marian Thomaiyar5a6b6362018-03-12 23:42:34 +053098/** @brief determines valid userId
99 *
100 * @param[in] userId - user id
101 *
102 * @return true if valid, false otherwise
103 */
Richard Marian Thomaiyara45cb342018-12-03 15:08:59 +0530104bool ipmiUserIsValidUserId(const uint8_t userId);
Richard Marian Thomaiyar5a6b6362018-03-12 23:42:34 +0530105
Richard Marian Thomaiyar5a6b6362018-03-12 23:42:34 +0530106/** @brief determines valid privilege level
107 *
108 * @param[in] priv - privilege level
109 *
110 * @return true if valid, false otherwise
111 */
Richard Marian Thomaiyara45cb342018-12-03 15:08:59 +0530112bool ipmiUserIsValidPrivilege(const uint8_t priv);
Richard Marian Thomaiyar5a6b6362018-03-12 23:42:34 +0530113
114/** @brief get user id corresponding to the user name
115 *
116 * @param[in] userName - user name
117 *
118 * @return userid. Will return 0xff if no user id found
119 */
120uint8_t ipmiUserGetUserId(const std::string& userName);
121
122/** @brief set's user name
123 *
124 * @param[in] userId - user id
125 * @param[in] userName - user name
126 *
127 * @return IPMI_CC_OK for success, others for failure.
128 */
Richard Marian Thomaiyara45cb342018-12-03 15:08:59 +0530129ipmi_ret_t ipmiUserSetUserName(const uint8_t userId, const char* userName);
Richard Marian Thomaiyar5a6b6362018-03-12 23:42:34 +0530130
Suryakanth Sekar90b00c72019-01-16 10:37:57 +0530131/** @brief set user password
132 *
133 * @param[in] userId - user id
134 * @param[in] userPassword - New Password
135 *
136 * @return IPMI_CC_OK for success, others for failure.
137 */
138ipmi_ret_t ipmiUserSetUserPassword(const uint8_t userId,
139 const char* userPassword);
140
Richard Marian Thomaiyar788362c2019-04-14 15:12:47 +0530141/** @brief set special user password (non-ipmi accounts)
142 *
143 * @param[in] userName - user name
144 * @param[in] userPassword - New Password
145 *
146 * @return IPMI_CC_OK for success, others for failure.
147 */
148ipmi_ret_t ipmiSetSpecialUserPassword(const std::string& userName,
149 const std::string& userPassword);
150
Richard Marian Thomaiyar5a6b6362018-03-12 23:42:34 +0530151/** @brief get user name
152 *
153 * @param[in] userId - user id
154 * @param[out] userName - user name
155 *
156 * @return IPMI_CC_OK for success, others for failure.
157 */
Richard Marian Thomaiyara45cb342018-12-03 15:08:59 +0530158ipmi_ret_t ipmiUserGetUserName(const uint8_t userId, std::string& userName);
Richard Marian Thomaiyar5a6b6362018-03-12 23:42:34 +0530159
160/** @brief provides available fixed, max, and enabled user counts
161 *
162 * @param[out] maxChUsers - max channel users
163 * @param[out] enabledUsers - enabled user count
164 * @param[out] fixedUsers - fixed user count
165 *
166 * @return IPMI_CC_OK for success, others for failure.
167 */
168ipmi_ret_t ipmiUserGetAllCounts(uint8_t& maxChUsers, uint8_t& enabledUsers,
169 uint8_t& fixedUsers);
170
Richard Marian Thomaiyar282e79b2018-11-13 19:00:58 +0530171/** @brief function to update user enabled state
172 *
173 * @param[in] userId - user id
174 *..@param[in] state - state of the user to be updated, true - user enabled.
175 *
176 * @return IPMI_CC_OK for success, others for failure.
177 */
Richard Marian Thomaiyara45cb342018-12-03 15:08:59 +0530178ipmi_ret_t ipmiUserUpdateEnabledState(const uint8_t userId, const bool& state);
Richard Marian Thomaiyar282e79b2018-11-13 19:00:58 +0530179
Richard Marian Thomaiyar5a6b6362018-03-12 23:42:34 +0530180/** @brief determines whether user is enabled
181 *
182 * @param[in] userId - user id
183 *..@param[out] state - state of the user
184 *
185 * @return IPMI_CC_OK for success, others for failure.
186 */
Richard Marian Thomaiyara45cb342018-12-03 15:08:59 +0530187ipmi_ret_t ipmiUserCheckEnabled(const uint8_t userId, bool& state);
Richard Marian Thomaiyar5a6b6362018-03-12 23:42:34 +0530188
189/** @brief provides user privilege access data
190 *
191 * @param[in] userId - user id
192 * @param[in] chNum - channel number
193 * @param[out] privAccess - privilege access data
194 *
195 * @return IPMI_CC_OK for success, others for failure.
196 */
Richard Marian Thomaiyara45cb342018-12-03 15:08:59 +0530197ipmi_ret_t ipmiUserGetPrivilegeAccess(const uint8_t userId, const uint8_t chNum,
Richard Marian Thomaiyar5a6b6362018-03-12 23:42:34 +0530198 PrivAccess& privAccess);
199
200/** @brief sets user privilege access data
201 *
202 * @param[in] userId - user id
203 * @param[in] chNum - channel number
204 * @param[in] privAccess - privilege access data
205 * @param[in] otherPrivUpdate - flags to indicate other fields update
206 *
207 * @return IPMI_CC_OK for success, others for failure.
208 */
Richard Marian Thomaiyara45cb342018-12-03 15:08:59 +0530209ipmi_ret_t ipmiUserSetPrivilegeAccess(const uint8_t userId, const uint8_t chNum,
Richard Marian Thomaiyar5a6b6362018-03-12 23:42:34 +0530210 const PrivAccess& privAccess,
211 const bool& otherPrivUpdate);
212
Richard Marian Thomaiyar4654d992018-04-19 05:38:37 +0530213} // namespace ipmi