commit ac30b39b026fbd3e670cd10ed61a0ec508539deb
author Vernon Mauery <vernon.mauery@linux.intel.com> Thu Aug 05 11:08:23 2021 -0700
committer Vernon Mauery <vernon.mauery@linux.intel.com> Thu Aug 12 16:24:11 2021 +0000
tree 00365d4b66e4a7a57e6443f9d500c9fa9f9c3001
parent 3c89de15a600f93e7d879ab48f0c590ce9f8ae09

Rewrite Set User Name command with new API

The Set User Name command was not checking the reserved
bits before. This change adds that in as well as updating
the command to use the new API.

Tested: ipmitool user user set name <N> <new-user-name>
        works as expected (`ipmitool user list` to confirm)

Change-Id: If847dd9c23f809ec13849766ad2435dfeaa6f013
Signed-off-by: Vernon Mauery <vernon.mauery@linux.intel.com>

user_channel/usercommands.cpp

diff --git a/user_channel/usercommands.cpp b/user_channel/usercommands.cpp
index 630a363..c48c476 100644
--- a/user_channel/usercommands.cpp
+++ b/user_channel/usercommands.cpp
@@ -40,23 +40,6 @@
 static constexpr uint8_t enableOperation = 0x00;
 static constexpr uint8_t disableOperation = 0x01;
 
-/** @struct SetUserNameReq
- *
- *  Structure for set user name request command (refer spec sec 22.28)
- */
-struct SetUserNameReq
-{
-#if BYTE_ORDER == LITTLE_ENDIAN
-    uint8_t userId : 6;
-    uint8_t reserved1 : 2;
-#endif
-#if BYTE_ORDER == BIG_ENDIAN
-    uint8_t reserved1 : 2;
-    uint8_t userId : 6;
-#endif
-    uint8_t userName[16];
-} __attribute__((packed));
-
 /** @struct SetUserPasswordReq
  *
  *  Structure for set user password request command (refer spec sec 22.30)
@@ -244,35 +227,36 @@
         static_cast<uint1_t>(privAccess.reserved));
 }
 
-Cc ipmiSetUserName(ipmi_netfn_t netfn, ipmi_cmd_t cmd, ipmi_request_t request,
-                   ipmi_response_t response, ipmi_data_len_t dataLen,
-                   ipmi_context_t context)
-{
-    const SetUserNameReq* req = static_cast<SetUserNameReq*>(request);
-    size_t reqLength = *dataLen;
-    *dataLen = 0;
+/** @brief implementes the get user name command
+ *  @param[in] ctx - ipmi command context
+ *  @param[in] userId - 6-bit user ID
+ *  @param[in] reserved - 2-bits reserved
+ *  @param[in] name - 16-byte array for username
 
-    if (reqLength != sizeof(*req))
+ *  @returns ipmi response
+ */
+ipmi::RspType<>
+    ipmiSetUserName(ipmi::Context::ptr ctx, uint6_t id, uint2_t reserved,
+                    const std::array<uint8_t, ipmi::ipmiMaxUserName>& name)
+{
+    if (reserved)
     {
-        log<level::DEBUG>("Set user name - Invalid Length");
-        return ccReqDataLenInvalid;
+        return ipmi::responseInvalidFieldRequest();
     }
-    if (req->reserved1)
-    {
-        return ccInvalidFieldRequest;
-    }
-    if (!ipmiUserIsValidUserId(req->userId))
+    uint8_t userId = static_cast<uint8_t>(id);
+    if (!ipmiUserIsValidUserId(userId))
     {
         log<level::DEBUG>("Set user name - Invalid user id");
-        return ccParmOutOfRange;
+        return ipmi::responseParmOutOfRange();
     }
 
-    size_t nameLen = strnlen(reinterpret_cast<const char*>(req->userName),
-                             sizeof(req->userName));
-    const std::string strUserName(reinterpret_cast<const char*>(req->userName),
+    size_t nameLen = strnlen(reinterpret_cast<const char*>(name.data()),
+                             ipmi::ipmiMaxUserName);
+    const std::string strUserName(reinterpret_cast<const char*>(name.data()),
                                   nameLen);
 
-    return ipmiUserSetUserName(req->userId, strUserName);
+    ipmi::Cc res = ipmiUserSetUserName(userId, strUserName);
+    return ipmi::response(res);
 }
 
 /** @brief implementes the get user name command
@@ -697,8 +681,9 @@
                           ipmi::app::cmdGetUserNameCommand,
                           ipmi::Privilege::Operator, ipmiGetUserName);
 
-    ipmi_register_callback(NETFUN_APP, IPMI_CMD_SET_USER_NAME, NULL,
-                           ipmiSetUserName, PRIVILEGE_ADMIN);
+    ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnApp,
+                          ipmi::app::cmdSetUserName, ipmi::Privilege::Admin,
+                          ipmiSetUserName);
 
     ipmi_register_callback(NETFUN_APP, IPMI_CMD_SET_USER_PASSWORD, NULL,
                            ipmiSetUserPassword, PRIVILEGE_ADMIN);