View Javadoc
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 org.metricshub.ipmi.core.coding.payload.IpmiPayload;
26  import org.metricshub.ipmi.core.coding.payload.PlainMessage;
27  import org.metricshub.ipmi.core.coding.protocol.PayloadType;
28  import org.metricshub.ipmi.core.coding.security.CipherSuite;
29  import org.metricshub.ipmi.core.coding.security.ConfidentialityAlgorithm;
30  
31  /**
32   * Decodes IPMI session header and retrieves encrypted payload. The payload must
33   * not be encapsulated in IPMI LAN message. USed for Open session and RAKP
34   * messages.
35   */
36  public class PlainCommandv20Decoder extends Protocolv20Decoder {
37  
38      public PlainCommandv20Decoder(CipherSuite cipherSuite) {
39          super(cipherSuite);
40      }
41  
42      /**
43       *
44       * @return Payload decoded into {@link PlainMessage}.
45       */
46      @Override
47      protected IpmiPayload decodePayload(byte[] rawData, int offset, int length,
48              ConfidentialityAlgorithm confidentialityAlgorithm, PayloadType payloadType) {
49          byte[] payload = new byte[length];
50  
51          System.arraycopy(rawData, offset, payload, 0, length);
52  
53          return new PlainMessage(confidentialityAlgorithm.decrypt(payload));
54      }
55  }