blob: 07945f03b79f080751c9e425bed90e71003e6d4c [file] [log] [blame]
Tom Joseph4e57ada2016-08-10 06:51:12 -05001#include "message_parsers.hpp"
2
3#include <iostream>
4#include <memory>
5
6#include "endian.hpp"
7#include "main.hpp"
8#include "message.hpp"
9#include "sessions_manager.hpp"
10
11namespace message
12{
13
14namespace parser
15{
16
17std::tuple<std::unique_ptr<Message>, SessionHeader> unflatten(
18 std::vector<uint8_t>& inPacket)
19{
20 // Check if the packet has atleast the size of the RMCP Header
21 if (inPacket.size() < sizeof(BasicHeader_t))
22 {
23 throw std::runtime_error("RMCP Header missing");
24 }
25
26 auto rmcpHeaderPtr = reinterpret_cast<BasicHeader_t*>(inPacket.data());
27
28 // Verify if the fields in the RMCP header conforms to the specification
29 if ((rmcpHeaderPtr->version != RMCP_VERSION) ||
30 (rmcpHeaderPtr->rmcpSeqNum != RMCP_SEQ) ||
31 (rmcpHeaderPtr->classOfMsg != RMCP_MESSAGE_CLASS_IPMI))
32 {
33 throw std::runtime_error("RMCP Header is invalid");
34 }
35
36 // Read the Session Header and invoke the parser corresponding to the
37 // header type
38 switch (static_cast<SessionHeader>(rmcpHeaderPtr->format.formatType))
39 {
40 case SessionHeader::IPMI15:
41 {
42 return std::make_tuple(ipmi15parser::unflatten(inPacket),
43 SessionHeader::IPMI15);
44 }
45 case SessionHeader::IPMI20:
46 {
47 return std::make_tuple(ipmi20parser::unflatten(inPacket),
48 SessionHeader::IPMI20);
49 }
50 default:
51 {
52 throw std::runtime_error("Invalid Session Header");
53 }
54 }
55}
56
57std::vector<uint8_t> flatten(Message& outMessage,
58 SessionHeader authType,
59 session::Session& session)
60{
61 // Call the flatten routine based on the header type
62 switch (authType)
63 {
64 case SessionHeader::IPMI15:
65 {
66 return ipmi15parser::flatten(outMessage, session);
67 }
68 case SessionHeader::IPMI20:
69 {
70 return ipmi20parser::flatten(outMessage, session);
71 }
72 default:
73 {
74 return {};
75 }
76 }
77}
78
79} // namespace parser
80
81namespace ipmi15parser
82{
83
84std::unique_ptr<Message> unflatten(std::vector<uint8_t>& inPacket)
85{
86 // Check if the packet has atleast the Session Header
87 if (inPacket.size() < sizeof(SessionHeader_t))
88 {
89 throw std::runtime_error("IPMI1.5 Session Header Missing");
90 }
91
92 auto message = std::make_unique<Message>();
93
94 auto header = reinterpret_cast<SessionHeader_t*>(inPacket.data());
95
96 message->payloadType = PayloadType::IPMI;
97 message->bmcSessionID = endian::from_ipmi<>(header->sessId);
98 message->sessionSeqNum = endian::from_ipmi<>(header->sessSeqNum);
99 message->isPacketEncrypted = false;
100 message->isPacketAuthenticated = false;
101
102 auto payloadLen = header->payloadLength;
103
104 (message->payload).assign(inPacket.data() + sizeof(SessionHeader_t),
105 inPacket.data() + sizeof(SessionHeader_t) +
106 payloadLen);
107
108 return message;
109}
110
111std::vector<uint8_t> flatten(Message& outMessage, session::Session& session)
112{
113 std::vector<uint8_t> packet(sizeof(SessionHeader_t));
114
115 // Insert Session Header into the Packet
116 auto header = reinterpret_cast<SessionHeader_t*>(packet.data());
117 header->base.version = parser::RMCP_VERSION;
118 header->base.reserved = 0x00;
119 header->base.rmcpSeqNum = parser::RMCP_SEQ;
120 header->base.classOfMsg = parser::RMCP_MESSAGE_CLASS_IPMI;
121 header->base.format.formatType =
122 static_cast<uint8_t>(parser::SessionHeader::IPMI15);
123 header->sessSeqNum = 0;
124 header->sessId = endian::to_ipmi<>(outMessage.rcSessionID);
125
126 header->payloadLength = static_cast<uint8_t>(outMessage.payload.size());
127
128 // Insert the Payload into the Packet
129 packet.insert(packet.end(), outMessage.payload.begin(),
130 outMessage.payload.end());
131
132 // Insert the Session Trailer
133 packet.resize(packet.size() + sizeof(SessionTrailer_t));
134 auto trailer = reinterpret_cast<SessionTrailer_t*>(packet.data() +
135 packet.size());
136 trailer->legacyPad = 0x00;
137
138 return packet;
139}
140
141} // namespace ipmi15parser
142
143namespace ipmi20parser
144{
145
146std::unique_ptr<Message> unflatten(std::vector<uint8_t>& inPacket)
147{
148 // Check if the packet has atleast the Session Header
149 if (inPacket.size() < sizeof(SessionHeader_t))
150 {
151 throw std::runtime_error("IPMI2.0 Session Header Missing");
152 }
153
154 auto message = std::make_unique<Message>();
155
156 auto header = reinterpret_cast<SessionHeader_t*>(inPacket.data());
157
158 message->payloadType = static_cast<PayloadType>
159 (header->payloadType & 0x3F);
160 message->bmcSessionID = endian::from_ipmi<>(header->sessId);
161 message->sessionSeqNum = endian::from_ipmi<>(header->sessSeqNum);
162 message->isPacketEncrypted =
163 ((header->payloadType & PAYLOAD_ENCRYPT_MASK) ? true : false);
164 message->isPacketAuthenticated =
165 ((header->payloadType & PAYLOAD_AUTH_MASK) ? true : false);
166
167 auto payloadLen = endian::from_ipmi<>(header->payloadLength);
168 message->payload.assign(inPacket.begin() + sizeof(SessionHeader_t),
169 inPacket.begin() + sizeof(SessionHeader_t) +
170 payloadLen);
171
172 return message;
173}
174
175std::vector<uint8_t> flatten(Message& outMessage, session::Session& session)
176{
177 std::vector<uint8_t> packet(sizeof(SessionHeader_t));
178
179 SessionHeader_t* header = reinterpret_cast<SessionHeader_t*>(packet.data());
180 header->base.version = parser::RMCP_VERSION;
181 header->base.reserved = 0x00;
182 header->base.rmcpSeqNum = parser::RMCP_SEQ;
183 header->base.classOfMsg = parser::RMCP_MESSAGE_CLASS_IPMI;
184 header->base.format.formatType =
185 static_cast<uint8_t>(parser::SessionHeader::IPMI20);
186 header->payloadType = static_cast<uint8_t>(outMessage.payloadType);
187 header->sessId = endian::to_ipmi<>(outMessage.rcSessionID);
188
189 // Add session sequence number
190 internal::addSequenceNumber(packet, session);
191
192 // Add Payload
193 header->payloadLength = endian::to_ipmi<>(outMessage.payload.size());
194 // Insert the Payload into the Packet
195 packet.insert(packet.end(), outMessage.payload.begin(),
196 outMessage.payload.end());
197
198 return packet;
199}
200
201namespace internal
202{
203
204void addSequenceNumber(std::vector<uint8_t>& packet, session::Session& session)
205{
206 SessionHeader_t* header = reinterpret_cast<SessionHeader_t*>(packet.data());
207
208 if (header->sessId == session::SESSION_ZERO)
209 {
210 header->sessSeqNum = 0x00;
211 }
212 else
213 {
214 auto seqNum = session.sequenceNums.increment();
215 header->sessSeqNum = endian::to_ipmi<>(seqNum);
216 }
217}
218
219} // namespace internal
220
221} // namespace ipmi20parser
222
223} // namespace message