Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 1 | #include "rakp34.hpp" |
| 2 | |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 3 | #include "comm_module.hpp" |
| 4 | #include "endian.hpp" |
| 5 | #include "guid.hpp" |
Vernon Mauery | 9b307be | 2017-11-22 09:28:16 -0800 | [diff] [blame] | 6 | #include "rmcp.hpp" |
Vernon Mauery | 2085ae0 | 2021-06-10 11:51:00 -0700 | [diff] [blame] | 7 | #include "sessions_manager.hpp" |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 8 | |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 9 | #include <algorithm> |
| 10 | #include <cstring> |
Vernon Mauery | fc37e59 | 2018-12-19 14:55:15 -0800 | [diff] [blame] | 11 | #include <phosphor-logging/log.hpp> |
| 12 | |
| 13 | using namespace phosphor::logging; |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 14 | |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 15 | namespace command |
| 16 | { |
| 17 | |
Tom Joseph | ef02fb3 | 2017-01-19 12:55:11 +0530 | [diff] [blame] | 18 | void applyIntegrityAlgo(const uint32_t bmcSessionID) |
| 19 | { |
Vernon Mauery | 2085ae0 | 2021-06-10 11:51:00 -0700 | [diff] [blame] | 20 | auto session = session::Manager::get().getSession(bmcSessionID); |
Tom Joseph | ef02fb3 | 2017-01-19 12:55:11 +0530 | [diff] [blame] | 21 | |
| 22 | auto authAlgo = session->getAuthAlgo(); |
| 23 | |
| 24 | switch (authAlgo->intAlgo) |
| 25 | { |
| 26 | case cipher::integrity::Algorithms::HMAC_SHA1_96: |
| 27 | { |
| 28 | session->setIntegrityAlgo( |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 29 | std::make_unique<cipher::integrity::AlgoSHA1>( |
| 30 | authAlgo->sessionIntegrityKey)); |
Tom Joseph | ef02fb3 | 2017-01-19 12:55:11 +0530 | [diff] [blame] | 31 | break; |
| 32 | } |
Vernon Mauery | 7e9e2ef | 2017-11-29 08:36:29 -0800 | [diff] [blame] | 33 | case cipher::integrity::Algorithms::HMAC_SHA256_128: |
| 34 | { |
| 35 | session->setIntegrityAlgo( |
| 36 | std::make_unique<cipher::integrity::AlgoSHA256>( |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 37 | authAlgo->sessionIntegrityKey)); |
Vernon Mauery | 7e9e2ef | 2017-11-29 08:36:29 -0800 | [diff] [blame] | 38 | break; |
| 39 | } |
Tom Joseph | ef02fb3 | 2017-01-19 12:55:11 +0530 | [diff] [blame] | 40 | default: |
| 41 | break; |
| 42 | } |
| 43 | } |
| 44 | |
Tom Joseph | 4c766eb | 2017-01-24 18:24:57 +0530 | [diff] [blame] | 45 | void applyCryptAlgo(const uint32_t bmcSessionID) |
| 46 | { |
Vernon Mauery | 2085ae0 | 2021-06-10 11:51:00 -0700 | [diff] [blame] | 47 | auto session = session::Manager::get().getSession(bmcSessionID); |
Tom Joseph | 4c766eb | 2017-01-24 18:24:57 +0530 | [diff] [blame] | 48 | |
| 49 | auto authAlgo = session->getAuthAlgo(); |
| 50 | |
| 51 | switch (authAlgo->cryptAlgo) |
| 52 | { |
| 53 | case cipher::crypt::Algorithms::AES_CBC_128: |
| 54 | { |
Vernon Mauery | 9b307be | 2017-11-22 09:28:16 -0800 | [diff] [blame] | 55 | auto intAlgo = session->getIntegrityAlgo(); |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 56 | auto k2 = intAlgo->generateKn(authAlgo->sessionIntegrityKey, |
| 57 | rmcp::const_2); |
Vernon Mauery | 9b307be | 2017-11-22 09:28:16 -0800 | [diff] [blame] | 58 | session->setCryptAlgo( |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 59 | std::make_unique<cipher::crypt::AlgoAES128>(k2)); |
Tom Joseph | 4c766eb | 2017-01-24 18:24:57 +0530 | [diff] [blame] | 60 | break; |
| 61 | } |
| 62 | default: |
| 63 | break; |
| 64 | } |
| 65 | } |
| 66 | |
Tom Joseph | 18a45e9 | 2017-04-11 11:30:44 +0530 | [diff] [blame] | 67 | std::vector<uint8_t> RAKP34(const std::vector<uint8_t>& inPayload, |
Vernon Mauery | 41ff9b5 | 2021-06-11 11:37:40 -0700 | [diff] [blame] | 68 | std::shared_ptr<message::Handler>& handler) |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 69 | { |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 70 | |
| 71 | std::vector<uint8_t> outPayload(sizeof(RAKP4response)); |
Tom Joseph | 18a45e9 | 2017-04-11 11:30:44 +0530 | [diff] [blame] | 72 | auto request = reinterpret_cast<const RAKP3request*>(inPayload.data()); |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 73 | auto response = reinterpret_cast<RAKP4response*>(outPayload.data()); |
| 74 | |
| 75 | // Check if the RAKP3 Payload Length is as expected |
Vernon Mauery | 9b307be | 2017-11-22 09:28:16 -0800 | [diff] [blame] | 76 | if (inPayload.size() < sizeof(RAKP3request)) |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 77 | { |
Vernon Mauery | fc37e59 | 2018-12-19 14:55:15 -0800 | [diff] [blame] | 78 | log<level::INFO>("RAKP34: Invalid RAKP3 request"); |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 79 | response->rmcpStatusCode = |
| 80 | static_cast<uint8_t>(RAKP_ReturnCode::INVALID_INTEGRITY_VALUE); |
| 81 | return outPayload; |
| 82 | } |
| 83 | |
| 84 | // Session ID zero is reserved for Session Setup |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 85 | if (endian::from_ipmi(request->managedSystemSessionID) == |
Suryakanth Sekar | f8a34fc | 2019-06-12 20:59:18 +0530 | [diff] [blame] | 86 | session::sessionZero) |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 87 | { |
Vernon Mauery | fc37e59 | 2018-12-19 14:55:15 -0800 | [diff] [blame] | 88 | log<level::INFO>("RAKP34: BMC invalid Session ID"); |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 89 | response->rmcpStatusCode = |
| 90 | static_cast<uint8_t>(RAKP_ReturnCode::INVALID_SESSION_ID); |
| 91 | return outPayload; |
| 92 | } |
| 93 | |
| 94 | std::shared_ptr<session::Session> session; |
| 95 | try |
| 96 | { |
Vernon Mauery | ae1fda4 | 2018-10-15 12:55:34 -0700 | [diff] [blame] | 97 | session = |
Vernon Mauery | 2085ae0 | 2021-06-10 11:51:00 -0700 | [diff] [blame] | 98 | session::Manager::get().getSession(request->managedSystemSessionID); |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 99 | } |
| 100 | catch (std::exception& e) |
| 101 | { |
Vernon Mauery | fc37e59 | 2018-12-19 14:55:15 -0800 | [diff] [blame] | 102 | log<level::ERR>("RAKP12 : session not found", |
| 103 | entry("EXCEPTION=%s", e.what())); |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 104 | response->rmcpStatusCode = |
| 105 | static_cast<uint8_t>(RAKP_ReturnCode::INVALID_SESSION_ID); |
| 106 | return outPayload; |
| 107 | } |
| 108 | |
| 109 | session->updateLastTransactionTime(); |
| 110 | |
| 111 | auto authAlgo = session->getAuthAlgo(); |
| 112 | /* |
| 113 | * Key Authentication Code - RAKP 3 |
| 114 | * |
| 115 | * 1) Managed System Random Number - 16 bytes |
| 116 | * 2) Remote Console Session ID - 4 bytes |
| 117 | * 3) Session Privilege Level - 1 byte |
| 118 | * 4) User Name Length Byte - 1 byte (0 for 'null' username) |
| 119 | * 5) User Name - variable (absent for 'null' username) |
| 120 | */ |
| 121 | |
| 122 | // Remote Console Session ID |
| 123 | auto rcSessionID = endian::to_ipmi(session->getRCSessionID()); |
| 124 | |
| 125 | // Session Privilege Level |
Tom Joseph | 4021b1f | 2019-02-12 10:10:12 +0530 | [diff] [blame] | 126 | auto sessPrivLevel = static_cast<uint8_t>(session->reqMaxPrivLevel); |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 127 | |
| 128 | // User Name Length Byte |
Tom Joseph | 56527b9 | 2018-03-21 19:31:58 +0530 | [diff] [blame] | 129 | auto userLength = static_cast<uint8_t>(session->userName.size()); |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 130 | |
| 131 | std::vector<uint8_t> input; |
| 132 | input.resize(cipher::rakp_auth::BMC_RANDOM_NUMBER_LEN + |
| 133 | sizeof(rcSessionID) + sizeof(sessPrivLevel) + |
Tom Joseph | 56527b9 | 2018-03-21 19:31:58 +0530 | [diff] [blame] | 134 | sizeof(userLength) + userLength); |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 135 | |
| 136 | auto iter = input.begin(); |
| 137 | |
| 138 | // Managed System Random Number |
| 139 | std::copy(authAlgo->bmcRandomNum.begin(), authAlgo->bmcRandomNum.end(), |
| 140 | iter); |
| 141 | std::advance(iter, cipher::rakp_auth::BMC_RANDOM_NUMBER_LEN); |
| 142 | |
| 143 | // Remote Console Session ID |
| 144 | std::copy_n(reinterpret_cast<uint8_t*>(&rcSessionID), sizeof(rcSessionID), |
| 145 | iter); |
| 146 | std::advance(iter, sizeof(rcSessionID)); |
| 147 | |
| 148 | // Session Privilege Level |
| 149 | std::copy_n(reinterpret_cast<uint8_t*>(&sessPrivLevel), |
| 150 | sizeof(sessPrivLevel), iter); |
| 151 | std::advance(iter, sizeof(sessPrivLevel)); |
| 152 | |
| 153 | // User Name Length Byte |
| 154 | std::copy_n(&userLength, sizeof(userLength), iter); |
Tom Joseph | 56527b9 | 2018-03-21 19:31:58 +0530 | [diff] [blame] | 155 | std::advance(iter, sizeof(userLength)); |
| 156 | |
| 157 | std::copy_n(session->userName.data(), userLength, iter); |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 158 | |
| 159 | // Generate Key Exchange Authentication Code - RAKP2 |
| 160 | auto output = authAlgo->generateHMAC(input); |
| 161 | |
Vernon Mauery | 9b307be | 2017-11-22 09:28:16 -0800 | [diff] [blame] | 162 | if (inPayload.size() != (sizeof(RAKP3request) + output.size()) || |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 163 | std::memcmp(output.data(), request + 1, output.size())) |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 164 | { |
Vernon Mauery | fc37e59 | 2018-12-19 14:55:15 -0800 | [diff] [blame] | 165 | log<level::INFO>("Mismatch in HMAC sent by remote console"); |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 166 | |
| 167 | response->messageTag = request->messageTag; |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 168 | response->rmcpStatusCode = |
| 169 | static_cast<uint8_t>(RAKP_ReturnCode::INVALID_INTEGRITY_VALUE); |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 170 | response->reserved = 0; |
| 171 | response->remoteConsoleSessionID = rcSessionID; |
| 172 | |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 173 | // close the session |
Vernon Mauery | 2085ae0 | 2021-06-10 11:51:00 -0700 | [diff] [blame] | 174 | session::Manager::get().stopSession(session->getBMCSessionID()); |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 175 | |
| 176 | return outPayload; |
| 177 | } |
| 178 | |
| 179 | /* |
| 180 | * Session Integrity Key |
| 181 | * |
| 182 | * 1) Remote Console Random Number - 16 bytes |
| 183 | * 2) Managed System Random Number - 16 bytes |
| 184 | * 3) Session Privilege Level - 1 byte |
| 185 | * 4) User Name Length Byte - 1 byte (0 for 'null' username) |
| 186 | * 5) User Name - variable (absent for 'null' username) |
| 187 | */ |
| 188 | |
| 189 | input.clear(); |
| 190 | |
| 191 | input.resize(cipher::rakp_auth::REMOTE_CONSOLE_RANDOM_NUMBER_LEN + |
| 192 | cipher::rakp_auth::BMC_RANDOM_NUMBER_LEN + |
Tom Joseph | 56527b9 | 2018-03-21 19:31:58 +0530 | [diff] [blame] | 193 | sizeof(sessPrivLevel) + sizeof(userLength) + userLength); |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 194 | iter = input.begin(); |
| 195 | |
| 196 | // Remote Console Random Number |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 197 | std::copy(authAlgo->rcRandomNum.begin(), authAlgo->rcRandomNum.end(), iter); |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 198 | std::advance(iter, cipher::rakp_auth::REMOTE_CONSOLE_RANDOM_NUMBER_LEN); |
| 199 | |
| 200 | // Managed Console Random Number |
| 201 | std::copy(authAlgo->bmcRandomNum.begin(), authAlgo->bmcRandomNum.end(), |
| 202 | iter); |
| 203 | std::advance(iter, cipher::rakp_auth::BMC_RANDOM_NUMBER_LEN); |
| 204 | |
| 205 | // Session Privilege Level |
| 206 | std::copy_n(reinterpret_cast<uint8_t*>(&sessPrivLevel), |
| 207 | sizeof(sessPrivLevel), iter); |
| 208 | std::advance(iter, sizeof(sessPrivLevel)); |
| 209 | |
| 210 | // User Name Length Byte |
| 211 | std::copy_n(&userLength, sizeof(userLength), iter); |
Tom Joseph | 56527b9 | 2018-03-21 19:31:58 +0530 | [diff] [blame] | 212 | std::advance(iter, sizeof(userLength)); |
| 213 | |
| 214 | std::copy_n(session->userName.data(), userLength, iter); |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 215 | |
| 216 | // Generate Session Integrity Key |
| 217 | auto sikOutput = authAlgo->generateHMAC(input); |
| 218 | |
| 219 | // Update the SIK in the Authentication Algo Interface |
| 220 | authAlgo->sessionIntegrityKey.insert(authAlgo->sessionIntegrityKey.begin(), |
| 221 | sikOutput.begin(), sikOutput.end()); |
| 222 | |
| 223 | /* |
| 224 | * Integrity Check Value |
| 225 | * |
| 226 | * 1) Remote Console Random Number - 16 bytes |
| 227 | * 2) Managed System Session ID - 4 bytes |
| 228 | * 3) Managed System GUID - 16 bytes |
| 229 | */ |
| 230 | |
| 231 | // Get Managed System Session ID |
| 232 | auto bmcSessionID = endian::to_ipmi(session->getBMCSessionID()); |
| 233 | |
| 234 | input.clear(); |
| 235 | |
| 236 | input.resize(cipher::rakp_auth::REMOTE_CONSOLE_RANDOM_NUMBER_LEN + |
| 237 | sizeof(bmcSessionID) + BMC_GUID_LEN); |
| 238 | iter = input.begin(); |
| 239 | |
| 240 | // Remote Console Random Number |
Vernon Mauery | 9e801a2 | 2018-10-12 13:20:49 -0700 | [diff] [blame] | 241 | std::copy(authAlgo->rcRandomNum.begin(), authAlgo->rcRandomNum.end(), iter); |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 242 | std::advance(iter, cipher::rakp_auth::REMOTE_CONSOLE_RANDOM_NUMBER_LEN); |
| 243 | |
| 244 | // Managed System Session ID |
| 245 | std::copy_n(reinterpret_cast<uint8_t*>(&bmcSessionID), sizeof(bmcSessionID), |
| 246 | iter); |
| 247 | std::advance(iter, sizeof(bmcSessionID)); |
| 248 | |
| 249 | // Managed System GUID |
Tom Joseph | 83029cb | 2017-09-01 16:37:31 +0530 | [diff] [blame] | 250 | std::copy_n(cache::guid.data(), cache::guid.size(), iter); |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 251 | |
| 252 | // Integrity Check Value |
| 253 | auto icv = authAlgo->generateICV(input); |
| 254 | |
| 255 | outPayload.resize(sizeof(RAKP4response)); |
| 256 | |
| 257 | response->messageTag = request->messageTag; |
| 258 | response->rmcpStatusCode = static_cast<uint8_t>(RAKP_ReturnCode::NO_ERROR); |
| 259 | response->reserved = 0; |
| 260 | response->remoteConsoleSessionID = rcSessionID; |
| 261 | |
| 262 | // Insert the HMAC output into the payload |
| 263 | outPayload.insert(outPayload.end(), icv.begin(), icv.end()); |
| 264 | |
Tom Joseph | ef02fb3 | 2017-01-19 12:55:11 +0530 | [diff] [blame] | 265 | // Set the Integrity Algorithm |
| 266 | applyIntegrityAlgo(session->getBMCSessionID()); |
Tom Joseph | 818d070 | 2017-01-10 16:39:38 +0530 | [diff] [blame] | 267 | |
Tom Joseph | 4c766eb | 2017-01-24 18:24:57 +0530 | [diff] [blame] | 268 | // Set the Confidentiality Algorithm |
| 269 | applyCryptAlgo(session->getBMCSessionID()); |
| 270 | |
Suryakanth Sekar | f8a34fc | 2019-06-12 20:59:18 +0530 | [diff] [blame] | 271 | session->state(static_cast<uint8_t>(session::State::active)); |
Tom Joseph | 50fb50a | 2016-12-06 17:51:06 +0530 | [diff] [blame] | 272 | return outPayload; |
| 273 | } |
| 274 | |
| 275 | } // namespace command |