Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 1 | #include "message_parsers.hpp" |
| 2 | |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 3 | #include "endian.hpp" |
| 4 | #include "main.hpp" |
| 5 | #include "message.hpp" |
| 6 | #include "sessions_manager.hpp" |
| 7 | |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 8 | #include <memory> |
| 9 | |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 10 | namespace message |
| 11 | { |
| 12 | |
| 13 | namespace parser |
| 14 | { |
| 15 | |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 16 | std::tuple<std::shared_ptr<Message>, SessionHeader> |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 17 | unflatten(std::vector<uint8_t>& inPacket) |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 18 | { |
| 19 | // Check if the packet has atleast the size of the RMCP Header |
Kirill Pakhomov | de7dd5c | 2021-02-27 18:45:22 +0300 | [diff] [blame] | 20 | if (inPacket.size() < sizeof(RmcpHeader_t)) |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 21 | { |
| 22 | throw std::runtime_error("RMCP Header missing"); |
| 23 | } |
| 24 | |
Kirill Pakhomov | de7dd5c | 2021-02-27 18:45:22 +0300 | [diff] [blame] | 25 | auto rmcpHeaderPtr = reinterpret_cast<RmcpHeader_t*>(inPacket.data()); |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 26 | |
| 27 | // Verify if the fields in the RMCP header conforms to the specification |
| 28 | if ((rmcpHeaderPtr->version != RMCP_VERSION) || |
| 29 | (rmcpHeaderPtr->rmcpSeqNum != RMCP_SEQ) || |
Kirill Pakhomov | de7dd5c | 2021-02-27 18:45:22 +0300 | [diff] [blame] | 30 | (rmcpHeaderPtr->classOfMsg < static_cast<uint8_t>(ClassOfMsg::ASF) && |
| 31 | rmcpHeaderPtr->classOfMsg > static_cast<uint8_t>(ClassOfMsg::OEM))) |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 32 | { |
| 33 | throw std::runtime_error("RMCP Header is invalid"); |
| 34 | } |
| 35 | |
Kirill Pakhomov | de7dd5c | 2021-02-27 18:45:22 +0300 | [diff] [blame] | 36 | if (rmcpHeaderPtr->classOfMsg == static_cast<uint8_t>(ClassOfMsg::ASF)) |
| 37 | { |
| 38 | #ifndef RMCP_PING |
| 39 | throw std::runtime_error("RMCP Ping is not supported"); |
| 40 | #else |
| 41 | return std::make_tuple(asfparser::unflatten(inPacket), |
| 42 | SessionHeader::IPMI15); |
| 43 | #endif // RMCP_PING |
| 44 | } |
| 45 | |
| 46 | auto sessionHeaderPtr = reinterpret_cast<BasicHeader_t*>(inPacket.data()); |
| 47 | |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 48 | // Read the Session Header and invoke the parser corresponding to the |
| 49 | // header type |
Kirill Pakhomov | de7dd5c | 2021-02-27 18:45:22 +0300 | [diff] [blame] | 50 | switch (static_cast<SessionHeader>(sessionHeaderPtr->format.formatType)) |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 51 | { |
| 52 | case SessionHeader::IPMI15: |
| 53 | { |
| 54 | return std::make_tuple(ipmi15parser::unflatten(inPacket), |
| 55 | SessionHeader::IPMI15); |
| 56 | } |
| 57 | case SessionHeader::IPMI20: |
| 58 | { |
| 59 | return std::make_tuple(ipmi20parser::unflatten(inPacket), |
| 60 | SessionHeader::IPMI20); |
| 61 | } |
| 62 | default: |
| 63 | { |
| 64 | throw std::runtime_error("Invalid Session Header"); |
| 65 | } |
| 66 | } |
| 67 | } |
| 68 | |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 69 | std::vector<uint8_t> flatten(std::shared_ptr<Message> outMessage, |
Vernon Mauery | 224f36a | 2018-10-25 08:52:23 -0700 | [diff] [blame] | 70 | SessionHeader authType, |
| 71 | std::shared_ptr<session::Session> session) |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 72 | { |
| 73 | // Call the flatten routine based on the header type |
| 74 | switch (authType) |
| 75 | { |
| 76 | case SessionHeader::IPMI15: |
| 77 | { |
| 78 | return ipmi15parser::flatten(outMessage, session); |
| 79 | } |
| 80 | case SessionHeader::IPMI20: |
| 81 | { |
| 82 | return ipmi20parser::flatten(outMessage, session); |
| 83 | } |
| 84 | default: |
| 85 | { |
| 86 | return {}; |
| 87 | } |
| 88 | } |
| 89 | } |
| 90 | |
| 91 | } // namespace parser |
| 92 | |
| 93 | namespace ipmi15parser |
| 94 | { |
| 95 | |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 96 | std::shared_ptr<Message> unflatten(std::vector<uint8_t>& inPacket) |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 97 | { |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 98 | if (inPacket.size() < sizeof(SessionHeader_t)) |
| 99 | { |
| 100 | throw std::runtime_error("IPMI1.5 Session Header Missing"); |
| 101 | } |
| 102 | |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 103 | auto message = std::make_shared<Message>(); |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 104 | |
| 105 | auto header = reinterpret_cast<SessionHeader_t*>(inPacket.data()); |
| 106 | |
| 107 | message->payloadType = PayloadType::IPMI; |
Tom Joseph | 6a56076 | 2017-01-10 15:30:28 +0530 | [diff] [blame] | 108 | message->bmcSessionID = endian::from_ipmi(header->sessId); |
| 109 | message->sessionSeqNum = endian::from_ipmi(header->sessSeqNum); |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 110 | message->isPacketEncrypted = false; |
| 111 | message->isPacketAuthenticated = false; |
Kirill Pakhomov | de7dd5c | 2021-02-27 18:45:22 +0300 | [diff] [blame] | 112 | message->rmcpMsgClass = |
| 113 | static_cast<ClassOfMsg>(header->base.rmcp.classOfMsg); |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 114 | |
Zhikui Ren | 2b1edef | 2020-07-24 14:32:13 -0700 | [diff] [blame] | 115 | // Confirm the number of data bytes received correlates to |
| 116 | // the packet length in the header |
Vernon Mauery | a71b1ba | 2021-06-08 15:53:46 -0700 | [diff] [blame^] | 117 | size_t payloadLen = header->payloadLength; |
| 118 | if ((payloadLen == 0) || (inPacket.size() < (sizeof(*header) + payloadLen))) |
Zhikui Ren | 2b1edef | 2020-07-24 14:32:13 -0700 | [diff] [blame] | 119 | { |
| 120 | throw std::runtime_error("Invalid data length"); |
| 121 | } |
| 122 | |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 123 | (message->payload) |
| 124 | .assign(inPacket.data() + sizeof(SessionHeader_t), |
| 125 | inPacket.data() + sizeof(SessionHeader_t) + payloadLen); |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 126 | |
| 127 | return message; |
| 128 | } |
| 129 | |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 130 | std::vector<uint8_t> flatten(std::shared_ptr<Message> outMessage, |
Vernon Mauery | 224f36a | 2018-10-25 08:52:23 -0700 | [diff] [blame] | 131 | std::shared_ptr<session::Session> session) |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 132 | { |
| 133 | std::vector<uint8_t> packet(sizeof(SessionHeader_t)); |
| 134 | |
| 135 | // Insert Session Header into the Packet |
| 136 | auto header = reinterpret_cast<SessionHeader_t*>(packet.data()); |
Kirill Pakhomov | de7dd5c | 2021-02-27 18:45:22 +0300 | [diff] [blame] | 137 | header->base.rmcp.version = parser::RMCP_VERSION; |
| 138 | header->base.rmcp.reserved = 0x00; |
| 139 | header->base.rmcp.rmcpSeqNum = parser::RMCP_SEQ; |
| 140 | header->base.rmcp.classOfMsg = static_cast<uint8_t>(ClassOfMsg::IPMI); |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 141 | header->base.format.formatType = |
| 142 | static_cast<uint8_t>(parser::SessionHeader::IPMI15); |
| 143 | header->sessSeqNum = 0; |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 144 | header->sessId = endian::to_ipmi(outMessage->rcSessionID); |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 145 | |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 146 | header->payloadLength = static_cast<uint8_t>(outMessage->payload.size()); |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 147 | |
| 148 | // Insert the Payload into the Packet |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 149 | packet.insert(packet.end(), outMessage->payload.begin(), |
| 150 | outMessage->payload.end()); |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 151 | |
| 152 | // Insert the Session Trailer |
| 153 | packet.resize(packet.size() + sizeof(SessionTrailer_t)); |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 154 | auto trailer = |
| 155 | reinterpret_cast<SessionTrailer_t*>(packet.data() + packet.size()); |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 156 | trailer->legacyPad = 0x00; |
| 157 | |
| 158 | return packet; |
| 159 | } |
| 160 | |
| 161 | } // namespace ipmi15parser |
| 162 | |
| 163 | namespace ipmi20parser |
| 164 | { |
| 165 | |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 166 | std::shared_ptr<Message> unflatten(std::vector<uint8_t>& inPacket) |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 167 | { |
| 168 | // Check if the packet has atleast the Session Header |
| 169 | if (inPacket.size() < sizeof(SessionHeader_t)) |
| 170 | { |
| 171 | throw std::runtime_error("IPMI2.0 Session Header Missing"); |
| 172 | } |
| 173 | |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 174 | auto message = std::make_shared<Message>(); |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 175 | |
| 176 | auto header = reinterpret_cast<SessionHeader_t*>(inPacket.data()); |
| 177 | |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 178 | message->payloadType = static_cast<PayloadType>(header->payloadType & 0x3F); |
Tom Joseph | 6a56076 | 2017-01-10 15:30:28 +0530 | [diff] [blame] | 179 | message->bmcSessionID = endian::from_ipmi(header->sessId); |
| 180 | message->sessionSeqNum = endian::from_ipmi(header->sessSeqNum); |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 181 | message->isPacketEncrypted = |
| 182 | ((header->payloadType & PAYLOAD_ENCRYPT_MASK) ? true : false); |
| 183 | message->isPacketAuthenticated = |
| 184 | ((header->payloadType & PAYLOAD_AUTH_MASK) ? true : false); |
Kirill Pakhomov | de7dd5c | 2021-02-27 18:45:22 +0300 | [diff] [blame] | 185 | message->rmcpMsgClass = |
| 186 | static_cast<ClassOfMsg>(header->base.rmcp.classOfMsg); |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 187 | |
Vernon Mauery | a71b1ba | 2021-06-08 15:53:46 -0700 | [diff] [blame^] | 188 | // Confirm the number of data bytes received correlates to |
| 189 | // the packet length in the header |
| 190 | size_t payloadLen = endian::from_ipmi(header->payloadLength); |
| 191 | if ((payloadLen == 0) || (inPacket.size() < (sizeof(*header) + payloadLen))) |
| 192 | { |
| 193 | throw std::runtime_error("Invalid data length"); |
| 194 | } |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 195 | |
Tom Joseph | 5fa487c | 2017-01-20 12:42:39 +0530 | [diff] [blame] | 196 | if (message->isPacketAuthenticated) |
Tom Joseph | 64703f4 | 2017-01-10 17:03:48 +0530 | [diff] [blame] | 197 | { |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 198 | if (!(internal::verifyPacketIntegrity(inPacket, message, payloadLen))) |
Tom Joseph | 64703f4 | 2017-01-10 17:03:48 +0530 | [diff] [blame] | 199 | { |
| 200 | throw std::runtime_error("Packet Integrity check failed"); |
| 201 | } |
| 202 | } |
| 203 | |
Tom Joseph | 78478a8 | 2017-01-26 14:24:29 +0530 | [diff] [blame] | 204 | // Decrypt the payload if the payload is encrypted |
| 205 | if (message->isPacketEncrypted) |
| 206 | { |
| 207 | // Assign the decrypted payload to the IPMI Message |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 208 | message->payload = |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 209 | internal::decryptPayload(inPacket, message, payloadLen); |
Tom Joseph | 78478a8 | 2017-01-26 14:24:29 +0530 | [diff] [blame] | 210 | } |
| 211 | else |
| 212 | { |
| 213 | message->payload.assign(inPacket.begin() + sizeof(SessionHeader_t), |
| 214 | inPacket.begin() + sizeof(SessionHeader_t) + |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 215 | payloadLen); |
Tom Joseph | 78478a8 | 2017-01-26 14:24:29 +0530 | [diff] [blame] | 216 | } |
| 217 | |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 218 | return message; |
| 219 | } |
| 220 | |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 221 | std::vector<uint8_t> flatten(std::shared_ptr<Message> outMessage, |
Vernon Mauery | 224f36a | 2018-10-25 08:52:23 -0700 | [diff] [blame] | 222 | std::shared_ptr<session::Session> session) |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 223 | { |
| 224 | std::vector<uint8_t> packet(sizeof(SessionHeader_t)); |
| 225 | |
| 226 | SessionHeader_t* header = reinterpret_cast<SessionHeader_t*>(packet.data()); |
Kirill Pakhomov | de7dd5c | 2021-02-27 18:45:22 +0300 | [diff] [blame] | 227 | header->base.rmcp.version = parser::RMCP_VERSION; |
| 228 | header->base.rmcp.reserved = 0x00; |
| 229 | header->base.rmcp.rmcpSeqNum = parser::RMCP_SEQ; |
| 230 | header->base.rmcp.classOfMsg = static_cast<uint8_t>(ClassOfMsg::IPMI); |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 231 | header->base.format.formatType = |
| 232 | static_cast<uint8_t>(parser::SessionHeader::IPMI20); |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 233 | header->payloadType = static_cast<uint8_t>(outMessage->payloadType); |
| 234 | header->sessId = endian::to_ipmi(outMessage->rcSessionID); |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 235 | |
| 236 | // Add session sequence number |
| 237 | internal::addSequenceNumber(packet, session); |
| 238 | |
Tom Joseph | 1404bca | 2017-01-26 14:17:02 +0530 | [diff] [blame] | 239 | size_t payloadLen = 0; |
| 240 | |
Tom Joseph | 7536283 | 2017-01-26 15:17:04 +0530 | [diff] [blame] | 241 | // Encrypt the payload if needed |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 242 | if (outMessage->isPacketEncrypted) |
Tom Joseph | 7536283 | 2017-01-26 15:17:04 +0530 | [diff] [blame] | 243 | { |
| 244 | header->payloadType |= PAYLOAD_ENCRYPT_MASK; |
| 245 | auto cipherPayload = internal::encryptPayload(outMessage); |
| 246 | payloadLen = cipherPayload.size(); |
| 247 | header->payloadLength = endian::to_ipmi<uint16_t>(cipherPayload.size()); |
| 248 | |
| 249 | // Insert the encrypted payload into the outgoing IPMI packet |
| 250 | packet.insert(packet.end(), cipherPayload.begin(), cipherPayload.end()); |
| 251 | } |
| 252 | else |
| 253 | { |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 254 | header->payloadLength = |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 255 | endian::to_ipmi<uint16_t>(outMessage->payload.size()); |
| 256 | payloadLen = outMessage->payload.size(); |
Tom Joseph | 7536283 | 2017-01-26 15:17:04 +0530 | [diff] [blame] | 257 | |
| 258 | // Insert the Payload into the Packet |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 259 | packet.insert(packet.end(), outMessage->payload.begin(), |
| 260 | outMessage->payload.end()); |
Tom Joseph | 7536283 | 2017-01-26 15:17:04 +0530 | [diff] [blame] | 261 | } |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 262 | |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 263 | if (outMessage->isPacketAuthenticated) |
Tom Joseph | 64703f4 | 2017-01-10 17:03:48 +0530 | [diff] [blame] | 264 | { |
Tom Joseph | b882dbb | 2019-02-09 23:13:48 +0530 | [diff] [blame] | 265 | header = reinterpret_cast<SessionHeader_t*>(packet.data()); |
| 266 | header->payloadType |= PAYLOAD_AUTH_MASK; |
Tom Joseph | 1404bca | 2017-01-26 14:17:02 +0530 | [diff] [blame] | 267 | internal::addIntegrityData(packet, outMessage, payloadLen); |
Tom Joseph | 64703f4 | 2017-01-10 17:03:48 +0530 | [diff] [blame] | 268 | } |
| 269 | |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 270 | return packet; |
| 271 | } |
| 272 | |
| 273 | namespace internal |
| 274 | { |
| 275 | |
Vernon Mauery | 224f36a | 2018-10-25 08:52:23 -0700 | [diff] [blame] | 276 | void addSequenceNumber(std::vector<uint8_t>& packet, |
| 277 | std::shared_ptr<session::Session> session) |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 278 | { |
| 279 | SessionHeader_t* header = reinterpret_cast<SessionHeader_t*>(packet.data()); |
| 280 | |
Suryakanth Sekar | f8a34fc | 2019-06-12 20:59:18 +0530 | [diff] [blame] | 281 | if (header->sessId == session::sessionZero) |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 282 | { |
| 283 | header->sessSeqNum = 0x00; |
| 284 | } |
| 285 | else |
| 286 | { |
Vernon Mauery | 224f36a | 2018-10-25 08:52:23 -0700 | [diff] [blame] | 287 | auto seqNum = session->sequenceNums.increment(); |
Tom Joseph | 6a56076 | 2017-01-10 15:30:28 +0530 | [diff] [blame] | 288 | header->sessSeqNum = endian::to_ipmi(seqNum); |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 289 | } |
| 290 | } |
| 291 | |
Tom Joseph | 64703f4 | 2017-01-10 17:03:48 +0530 | [diff] [blame] | 292 | bool verifyPacketIntegrity(const std::vector<uint8_t>& packet, |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 293 | const std::shared_ptr<Message> message, |
| 294 | size_t payloadLen) |
Tom Joseph | 64703f4 | 2017-01-10 17:03:48 +0530 | [diff] [blame] | 295 | { |
Tom Joseph | 64703f4 | 2017-01-10 17:03:48 +0530 | [diff] [blame] | 296 | /* |
| 297 | * Padding bytes are added to cause the number of bytes in the data range |
| 298 | * covered by the AuthCode(Integrity Data) field to be a multiple of 4 bytes |
| 299 | * .If present each integrity Pad byte is set to FFh. The following logic |
| 300 | * calculates the number of padding bytes added in the IPMI packet. |
| 301 | */ |
Tom Joseph | 5a2d3ce | 2017-02-01 20:18:37 +0530 | [diff] [blame] | 302 | auto paddingLen = 4 - ((payloadLen + 2) & 3); |
Tom Joseph | 64703f4 | 2017-01-10 17:03:48 +0530 | [diff] [blame] | 303 | |
| 304 | auto sessTrailerPos = sizeof(SessionHeader_t) + payloadLen + paddingLen; |
| 305 | |
Zhikui Ren | 2b1edef | 2020-07-24 14:32:13 -0700 | [diff] [blame] | 306 | // verify packet size includes trailer struct starts at sessTrailerPos |
| 307 | if (packet.size() < (sessTrailerPos + sizeof(SessionTrailer_t))) |
| 308 | { |
| 309 | return false; |
| 310 | } |
| 311 | |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 312 | auto trailer = reinterpret_cast<const SessionTrailer_t*>(packet.data() + |
| 313 | sessTrailerPos); |
Tom Joseph | 64703f4 | 2017-01-10 17:03:48 +0530 | [diff] [blame] | 314 | |
| 315 | // Check trailer->padLength against paddingLen, both should match up, |
| 316 | // return false if the lengths don't match |
Tom Joseph | 5fa487c | 2017-01-20 12:42:39 +0530 | [diff] [blame] | 317 | if (trailer->padLength != paddingLen) |
Tom Joseph | 64703f4 | 2017-01-10 17:03:48 +0530 | [diff] [blame] | 318 | { |
| 319 | return false; |
| 320 | } |
| 321 | |
Vernon Mauery | ae1fda4 | 2018-10-15 12:55:34 -0700 | [diff] [blame] | 322 | auto session = std::get<session::Manager&>(singletonPool) |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 323 | .getSession(message->bmcSessionID); |
Tom Joseph | 64703f4 | 2017-01-10 17:03:48 +0530 | [diff] [blame] | 324 | |
| 325 | auto integrityAlgo = session->getIntegrityAlgo(); |
| 326 | |
| 327 | // Check if Integrity data length is as expected, check integrity data |
| 328 | // length is same as the length expected for the Integrity Algorithm that |
| 329 | // was negotiated during the session open process. |
Tom Joseph | 5fa487c | 2017-01-20 12:42:39 +0530 | [diff] [blame] | 330 | if ((packet.size() - sessTrailerPos - sizeof(SessionTrailer_t)) != |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 331 | integrityAlgo->authCodeLength) |
Tom Joseph | 64703f4 | 2017-01-10 17:03:48 +0530 | [diff] [blame] | 332 | { |
| 333 | return false; |
| 334 | } |
| 335 | |
| 336 | auto integrityIter = packet.cbegin(); |
| 337 | std::advance(integrityIter, sessTrailerPos + sizeof(SessionTrailer_t)); |
| 338 | |
| 339 | // The integrity data is calculated from the AuthType/Format field up to and |
| 340 | // including the field that immediately precedes the AuthCode field itself. |
| 341 | size_t length = packet.size() - integrityAlgo->authCodeLength - |
| 342 | message::parser::RMCP_SESSION_HEADER_SIZE; |
| 343 | |
| 344 | return integrityAlgo->verifyIntegrityData(packet, length, integrityIter); |
| 345 | } |
| 346 | |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 347 | void addIntegrityData(std::vector<uint8_t>& packet, |
| 348 | const std::shared_ptr<Message> message, size_t payloadLen) |
Tom Joseph | 64703f4 | 2017-01-10 17:03:48 +0530 | [diff] [blame] | 349 | { |
Tom Joseph | 64703f4 | 2017-01-10 17:03:48 +0530 | [diff] [blame] | 350 | // The following logic calculates the number of padding bytes to be added to |
| 351 | // IPMI packet. If needed each integrity Pad byte is set to FFh. |
Tom Joseph | 5a2d3ce | 2017-02-01 20:18:37 +0530 | [diff] [blame] | 352 | auto paddingLen = 4 - ((payloadLen + 2) & 3); |
Tom Joseph | 64703f4 | 2017-01-10 17:03:48 +0530 | [diff] [blame] | 353 | packet.insert(packet.end(), paddingLen, 0xFF); |
| 354 | |
| 355 | packet.resize(packet.size() + sizeof(SessionTrailer_t)); |
| 356 | |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 357 | auto trailer = reinterpret_cast<SessionTrailer_t*>( |
| 358 | packet.data() + packet.size() - sizeof(SessionTrailer_t)); |
Tom Joseph | 64703f4 | 2017-01-10 17:03:48 +0530 | [diff] [blame] | 359 | |
| 360 | trailer->padLength = paddingLen; |
| 361 | trailer->nextHeader = parser::RMCP_MESSAGE_CLASS_IPMI; |
| 362 | |
Vernon Mauery | ae1fda4 | 2018-10-15 12:55:34 -0700 | [diff] [blame] | 363 | auto session = std::get<session::Manager&>(singletonPool) |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 364 | .getSession(message->bmcSessionID); |
Tom Joseph | 64703f4 | 2017-01-10 17:03:48 +0530 | [diff] [blame] | 365 | |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 366 | auto integrityData = |
| 367 | session->getIntegrityAlgo()->generateIntegrityData(packet); |
Tom Joseph | 64703f4 | 2017-01-10 17:03:48 +0530 | [diff] [blame] | 368 | |
| 369 | packet.insert(packet.end(), integrityData.begin(), integrityData.end()); |
| 370 | } |
| 371 | |
Tom Joseph | 78478a8 | 2017-01-26 14:24:29 +0530 | [diff] [blame] | 372 | std::vector<uint8_t> decryptPayload(const std::vector<uint8_t>& packet, |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 373 | const std::shared_ptr<Message> message, |
| 374 | size_t payloadLen) |
Tom Joseph | 78478a8 | 2017-01-26 14:24:29 +0530 | [diff] [blame] | 375 | { |
Vernon Mauery | ae1fda4 | 2018-10-15 12:55:34 -0700 | [diff] [blame] | 376 | auto session = std::get<session::Manager&>(singletonPool) |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 377 | .getSession(message->bmcSessionID); |
Tom Joseph | 78478a8 | 2017-01-26 14:24:29 +0530 | [diff] [blame] | 378 | |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 379 | return session->getCryptAlgo()->decryptPayload( |
| 380 | packet, sizeof(SessionHeader_t), payloadLen); |
Tom Joseph | 78478a8 | 2017-01-26 14:24:29 +0530 | [diff] [blame] | 381 | } |
| 382 | |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 383 | std::vector<uint8_t> encryptPayload(std::shared_ptr<Message> message) |
Tom Joseph | 7536283 | 2017-01-26 15:17:04 +0530 | [diff] [blame] | 384 | { |
Vernon Mauery | ae1fda4 | 2018-10-15 12:55:34 -0700 | [diff] [blame] | 385 | auto session = std::get<session::Manager&>(singletonPool) |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 386 | .getSession(message->bmcSessionID); |
Tom Joseph | 7536283 | 2017-01-26 15:17:04 +0530 | [diff] [blame] | 387 | |
Vernon Mauery | d999ffc | 2018-10-25 09:16:05 -0700 | [diff] [blame] | 388 | return session->getCryptAlgo()->encryptPayload(message->payload); |
Tom Joseph | 7536283 | 2017-01-26 15:17:04 +0530 | [diff] [blame] | 389 | } |
| 390 | |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 391 | } // namespace internal |
| 392 | |
| 393 | } // namespace ipmi20parser |
| 394 | |
Kirill Pakhomov | de7dd5c | 2021-02-27 18:45:22 +0300 | [diff] [blame] | 395 | #ifdef RMCP_PING |
| 396 | namespace asfparser |
| 397 | { |
| 398 | std::shared_ptr<Message> unflatten(std::vector<uint8_t>& inPacket) |
| 399 | { |
| 400 | auto message = std::make_shared<Message>(); |
| 401 | |
| 402 | auto header = reinterpret_cast<AsfMessagePing_t*>(inPacket.data()); |
| 403 | |
| 404 | message->payloadType = PayloadType::IPMI; |
| 405 | message->rmcpMsgClass = ClassOfMsg::ASF; |
| 406 | message->asfMsgTag = header->msgTag; |
| 407 | |
| 408 | return message; |
| 409 | } |
| 410 | |
| 411 | std::vector<uint8_t> flatten(uint8_t asfMsgTag) |
| 412 | { |
| 413 | std::vector<uint8_t> packet(sizeof(AsfMessagePong_t)); |
| 414 | |
| 415 | // Insert RMCP header into the Packet |
| 416 | auto header = reinterpret_cast<AsfMessagePong_t*>(packet.data()); |
| 417 | header->ping.rmcp.version = parser::RMCP_VERSION; |
| 418 | header->ping.rmcp.reserved = 0x00; |
| 419 | header->ping.rmcp.rmcpSeqNum = parser::RMCP_SEQ; |
| 420 | header->ping.rmcp.classOfMsg = static_cast<uint8_t>(ClassOfMsg::ASF); |
| 421 | |
| 422 | // No OEM-specific capabilities exist, therefore the second |
| 423 | // IANA Enterprise Number contains the same IANA(4542) |
| 424 | header->ping.iana = header->iana = endian::to_ipmi(parser::ASF_IANA); |
| 425 | header->ping.msgType = static_cast<uint8_t>(RmcpMsgType::PONG); |
| 426 | header->ping.msgTag = asfMsgTag; |
| 427 | header->ping.reserved = 0x00; |
| 428 | header->ping.dataLen = |
| 429 | parser::RMCP_ASF_PONG_DATA_LEN; // as per spec 13.2.4, |
| 430 | |
| 431 | header->iana = parser::ASF_IANA; |
| 432 | header->oemDefined = 0x00; |
| 433 | header->suppEntities = parser::ASF_SUPP_ENT; |
| 434 | header->suppInteract = parser::ASF_SUPP_INT; |
| 435 | header->reserved1 = 0x00; |
| 436 | header->reserved2 = 0x00; |
| 437 | |
| 438 | return packet; |
| 439 | } |
| 440 | |
| 441 | } // namespace asfparser |
| 442 | #endif // RMCP_PING |
| 443 | |
Tom Joseph | 4e57ada | 2016-08-10 06:51:12 -0500 | [diff] [blame] | 444 | } // namespace message |