phosphor-host-ipmid/user_channel/user_mgmt.hpp

8 //      http://www.apache.org/licenses/LICENSE-2.0
42  * @enum User update events.
57  *  Structure for user privilege access (refer spec sec 22.22)
69  *  Structure for user related information
83  *  Structure for array of user related information
88     UserInfo user[ipmiMaxUsers + 1];  member
91 /** @brief PAM User Authentication check
93  *  @param[in] username - username in string
94  *  @param[in] password	- password in string
118      *  @param[in] chNum - channel number
126      *  @param[in] userId - user id
132     /** @brief determines valid user privilege
134      *  @param[in] priv - Privilege
140     /** @brief determines sync index to be mapped with common-user-management
148      *  @param[in] value - Privilege in string
150      *  @return CommandPrivilege - IPMI privilege type
156      *  @param[in] value - IPMI privilege
162     /** @brief determines whether user name is valid
164      *  @param[in] userNameInChar - user name
176     /** @brief provides user id of the user
178      *  @param[in] userName - user name
180      *  @return user id of the user, else invalid user id (0xFF), if user not
185     /** @brief provides user information
187      *  @param[in] userId - user id
189      *  @return UserInfo for the specified user id
193     /** @brief sets user information
195      *  @param[in] userId - user id
196      *  @param[in] userInfo - user information
201     /** @brief provides user name
203      *  @param[in] userId - user id
204      *  @param[out] userName - user name
210     /** @brief to set user name
212      *  @param[in] userId - user id
213      *  @param[in] userName - user name
219     /** @brief to set user enabled state
221      *  @param[in] userId - user id
222      *  @param[in] enabledState - enabled state of the user
228     /** @brief to set user password
230      *  @param[in] userId - user id
231      *  @param[in] userPassword  - new password of the user
237     /** @brief to set special user password
239      *  @param[in] userName - user name
240      *  @param[in] userPassword  - new password of the user
247     /** @brief to set user privilege and access details
249      *  @param[in] userId - user id
250      *  @param[in] chNum - channel number
251      *  @param[in] privAccess - privilege access
252      *  @param[in] otherPrivUpdates - other privilege update flag to update ipmi
261     /** @brief to get user payload access details from userInfo entry.
263      *  @param[in] userInfo    - userInfo entry in usersTbl.
264      *  @param[out] stdPayload - stdPayloadEnables1 in a 2D-array.
265      *  @param[out] oemPayload - oemPayloadEnables1 in a 2D-array.
267      *  @details Update the given 2D-arrays using the payload access details
269      *  This 2D-array will be mapped to a JSON object (which will be written to
279     /** @brief to update user payload access details in userInfo entry.
281      *  @param[in] stdPayload - stdPayloadEnables1 in a 2D-array.
282      *  @param[in] oemPayload - oemPayloadEnables1 in a 2D-array.
283      *  @param[out] userInfo  - userInfo entry in usersTbl.
285      *  @details Update user payload access details of a given userInfo
286      *  entry (in usersTbl) with the information provided in given 2D-arrays.
287      *  This 2D-array was created out of a JSON object (which was created by
297     /** @brief to set user payload access details
299      *  @param[in] chNum - channel number
300      *  @param[in] operation - Enable / Disable
301      *  @param[in] userId - user id
302      *  @param[in] payloadAccess - payload access
310     /** @brief reads user management related data from configuration file
315     /** @brief writes user management related data to configuration file
326     /** @brief provides user details from D-Bus user property data
328      *  @param[in] properties - D-Bus user property
329      *  @param[out] usrGrps - user group details
330      *  @param[out] usrPriv - user privilege
331      *  @param[out] usrEnabled - enabled state of the user.
333      *  @return 0 for success, -errno for failure.
339     /** @brief provides user details from D-Bus user object data
341      *  @param[in] userObjs - D-Bus user object
342      *  @param[out] usrGrps - user group details
343      *  @param[out] usrPriv - user privilege
344      *  @param[out] usrEnabled - enabled state of the user.
346      *  @return 0 for success, -errno for failure.
352     /** @brief function to add user entry information to the configuration
354      *  @param[in] userName - user name
355      *  @param[in] priv - privilege of the user
356      *  @param[in] enabled - enabled state of the user
363     /** @brief function to delete user entry based on user index
365      *  @param[in] usrIdx - user index
388     /** @brief function to get user configuration file timestamp
390      *  @return time stamp or -EIO for failure
399     /** @brief function to init user data from configuration & D-Bus objects