blob: a1e42fae1558c1ade6621647016f0d0e8563a388 [file] [log] [blame]
#include "channel.hpp"
#include "user_channel/channel_layer.hpp"
#include <arpa/inet.h>
#include <boost/process/child.hpp>
#include <ipmid/types.hpp>
#include <ipmid/utils.hpp>
#include <phosphor-logging/elog-errors.hpp>
#include <phosphor-logging/lg2.hpp>
#include <xyz/openbmc_project/Common/error.hpp>
#include <fstream>
#include <set>
#include <string>
using namespace phosphor::logging;
using namespace sdbusplus::error::xyz::openbmc_project::common;
namespace cipher
{
/** @brief Get the supported Cipher records
*
* The cipher records are read from the JSON file and converted into
* 1. cipher suite record format mentioned in the IPMI specification. The
* records can be either OEM or standard cipher. Each json entry is parsed and
* converted into the cipher record format and pushed into the vector.
* 2. Algorithms listed in vector format
*
* @return pair of vector containing 1. all the cipher suite records. 2.
* Algorithms supported
*
*/
std::pair<std::vector<uint8_t>, std::vector<uint8_t>> getCipherRecords()
{
std::vector<uint8_t> cipherRecords;
std::vector<uint8_t> supportedAlgorithmRecords;
// create set to get the unique supported algorithms
std::set<uint8_t> supportedAlgorithmSet;
std::ifstream jsonFile(configFile);
if (!jsonFile.is_open())
{
lg2::error("Channel Cipher suites file not found");
elog<InternalFailure>();
}
auto data = Json::parse(jsonFile, nullptr, false);
if (data.is_discarded())
{
lg2::error("Parsing channel cipher suites JSON failed");
elog<InternalFailure>();
}
for (const auto& record : data)
{
if (record.find(oem) != record.end())
{
// OEM cipher suite - 0xC1
cipherRecords.push_back(oemCipherSuite);
// Cipher Suite ID
cipherRecords.push_back(record.value(cipher, 0));
// OEM IANA - 3 bytes
cipherRecords.push_back(record.value(oem, 0));
cipherRecords.push_back(record.value(oem, 0) >> 8);
cipherRecords.push_back(record.value(oem, 0) >> 16);
}
else
{
// Standard cipher suite - 0xC0
cipherRecords.push_back(stdCipherSuite);
// Cipher Suite ID
cipherRecords.push_back(record.value(cipher, 0));
}
// Authentication algorithm number
cipherRecords.push_back(record.value(auth, 0));
supportedAlgorithmSet.insert(record.value(auth, 0));
// Integrity algorithm number
cipherRecords.push_back(record.value(integrity, 0) | integrityTag);
supportedAlgorithmSet.insert(record.value(integrity, 0) | integrityTag);
// Confidentiality algorithm number
cipherRecords.push_back(record.value(conf, 0) | confTag);
supportedAlgorithmSet.insert(record.value(conf, 0) | confTag);
}
// copy the set to supportedAlgorithmRecord which is vector based.
std::copy(supportedAlgorithmSet.begin(), supportedAlgorithmSet.end(),
std::back_inserter(supportedAlgorithmRecords));
return std::make_pair(cipherRecords, supportedAlgorithmRecords);
}
} // namespace cipher
/** @brief this command is used to look up what authentication, integrity,
* confidentiality algorithms are supported.
*
* @ param ctx - context pointer
* @ param channelNumber - channel number
* @ param payloadType - payload type
* @ param listIndex - list index
* @ param algoSelectBit - list algorithms
*
* @returns ipmi completion code plus response data
* - rspChannel - channel number for authentication algorithm.
* - rspRecords - cipher suite records.
**/
ipmi::RspType<uint8_t, // Channel Number
std::vector<uint8_t> // Cipher Records
>
getChannelCipherSuites(ipmi::Context::ptr ctx, uint4_t channelNumber,
uint4_t reserved1, uint8_t payloadType,
uint6_t listIndex, uint1_t reserved2,
uint1_t algoSelectBit)
{
static std::vector<uint8_t> cipherRecords;
static std::vector<uint8_t> supportedAlgorithms;
static auto recordInit = false;
uint8_t rspChannel = ipmi::convertCurrentChannelNum(
static_cast<uint8_t>(channelNumber), ctx->channel);
if (!ipmi::isValidChannel(rspChannel) || reserved1 != 0 || reserved2 != 0)
{
return ipmi::responseInvalidFieldRequest();
}
if (!ipmi::isValidPayloadType(static_cast<ipmi::PayloadType>(payloadType)))
{
lg2::debug("Get channel cipher suites - Invalid payload type");
constexpr uint8_t ccPayloadTypeNotSupported = 0x80;
return ipmi::response(ccPayloadTypeNotSupported);
}
if (!recordInit)
{
try
{
std::tie(cipherRecords,
supportedAlgorithms) = cipher::getCipherRecords();
recordInit = true;
}
catch (const std::exception& e)
{
return ipmi::responseUnspecifiedError();
}
}
const std::vector<uint8_t>& records = algoSelectBit ? cipherRecords
: supportedAlgorithms;
static constexpr auto respSize = 16;
// Session support is available in active LAN channels.
if ((ipmi::getChannelSessionSupport(rspChannel) ==
ipmi::EChannelSessSupported::none) ||
!(ipmi::doesDeviceExist(rspChannel)))
{
lg2::debug("Get channel cipher suites - Device does not exist");
return ipmi::responseInvalidFieldRequest();
}
// List index(00h-3Fh), 0h selects the first set of 16, 1h selects the next
// set of 16 and so on.
// Calculate the number of record data bytes to be returned.
auto start = std::min(static_cast<size_t>(listIndex) * respSize,
records.size());
auto end = std::min((static_cast<size_t>(listIndex) * respSize) + respSize,
records.size());
auto size = end - start;
std::vector<uint8_t> rspRecords;
std::copy_n(records.data() + start, size, std::back_inserter(rspRecords));
return ipmi::responseSuccess(rspChannel, rspRecords);
}