1 package org.metricshub.ipmi.core.coding.protocol.decoder;
2
3 /*-
4 * ╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲
5 * IPMI Java Client
6 * ჻჻჻჻჻჻
7 * Copyright 2023 Verax Systems, MetricsHub
8 * ჻჻჻჻჻჻
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation, either version 3 of the
12 * License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Lesser Public License for more details.
18 *
19 * You should have received a copy of the GNU General Lesser Public
20 * License along with this program. If not, see
21 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
22 * ╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱
23 */
24
25 import java.security.InvalidKeyException;
26
27 import org.metricshub.ipmi.core.coding.protocol.IpmiMessage;
28 import org.metricshub.ipmi.core.coding.rmcp.RmcpMessage;
29
30 /**
31 * Decodes IPMI session header and retrieves encrypted payload.
32 */
33 public interface IpmiDecoder {
34
35 /**
36 * Decodes IPMI message.
37 * @param rmcpMessage
38 * - RMCP message to decode.
39 * @see IpmiMessage
40 * @return Decoded IPMI message
41 * @throws IllegalArgumentException
42 * when delivered RMCP message does not contain encapsulated IPMI message.
43 * @throws InvalidKeyException
44 * - when initiation of the integrity algorithm fails
45 */
46 IpmiMessage decode(RmcpMessage rmcpMessage) throws InvalidKeyException;
47 }