View Javadoc
1   package org.metricshub.ipmi.core.sm.states;
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.commands.session.GetChannelAuthenticationCapabilities;
26  import org.metricshub.ipmi.core.coding.payload.lan.IpmiLanResponse;
27  import org.metricshub.ipmi.core.coding.protocol.AuthenticationType;
28  import org.metricshub.ipmi.core.coding.protocol.IpmiMessage;
29  import org.metricshub.ipmi.core.coding.protocol.decoder.ProtocolDecoder;
30  import org.metricshub.ipmi.core.coding.protocol.decoder.Protocolv15Decoder;
31  import org.metricshub.ipmi.core.coding.rmcp.RmcpMessage;
32  import org.metricshub.ipmi.core.common.TypeConverter;
33  import org.metricshub.ipmi.core.sm.StateMachine;
34  import org.metricshub.ipmi.core.sm.actions.ErrorAction;
35  import org.metricshub.ipmi.core.sm.actions.ResponseAction;
36  import org.metricshub.ipmi.core.sm.events.AuthenticationCapabilitiesReceived;
37  import org.metricshub.ipmi.core.sm.events.StateMachineEvent;
38  import org.metricshub.ipmi.core.sm.events.Timeout;
39  
40  /**
41   * Waiting for the {@link GetChannelAuthenticationCapabilities} response. <br>
42   * 
43   * Transition to: <ul> <li>{@link Ciphers} on {@link Timeout} </li><li>{@link Authcap} on
44   * {@link AuthenticationCapabilitiesReceived}</li></ul>.
45   */
46  public class AuthcapWaiting extends State {
47  
48      private int tag;
49  
50      /**
51       * Instantiates a new {@link AuthcapWaiting} using the given tag 
52       * @param tag int value representing the authentication capabilities
53       */
54      public AuthcapWaiting(int tag) {
55          this.tag = tag;
56      }
57  
58      @Override
59      public void doTransition(StateMachine stateMachine,
60              StateMachineEvent machineEvent) {
61          if (machineEvent instanceof Timeout) {
62              stateMachine.setCurrent(new Ciphers());
63          } else if (machineEvent instanceof AuthenticationCapabilitiesReceived) {
64              stateMachine.setCurrent(new Authcap());
65          } else {
66              stateMachine.doExternalAction(new ErrorAction(
67                      new IllegalArgumentException("Invalid transition")));
68          }
69      }
70  
71      @Override
72      public void doAction(StateMachine stateMachine, RmcpMessage message) {
73          if (ProtocolDecoder.decodeAuthenticationType(message) == AuthenticationType.RMCPPlus) {
74              return; // this isn't IPMI v1.5 message so we ignore it
75          }
76          Protocolv15Decoder decoder = new Protocolv15Decoder();
77          IpmiMessage ipmiMessage = null;
78          try {
79              ipmiMessage = decoder.decode(message);
80              GetChannelAuthenticationCapabilities capabilities = new GetChannelAuthenticationCapabilities();
81              if (capabilities.isCommandResponse(ipmiMessage)
82                      && TypeConverter.byteToInt(((IpmiLanResponse) ipmiMessage
83                              .getPayload()).getSequenceNumber()) == tag) {
84                  stateMachine.doExternalAction(new ResponseAction(capabilities
85                          .getResponseData(ipmiMessage)));
86              }
87          } catch (Exception e) {
88              stateMachine.doExternalAction(new ErrorAction(e));
89          }
90      }
91  
92  }