package org.metricshub.ipmi.core.coding.commands.session;
   
   /*-
    * ╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲
    * IPMI Java Client
    * ჻჻჻჻჻჻
    * Copyright 2023 Verax Systems, MetricsHub
    * ჻჻჻჻჻჻
    * This program is free software: you can redistribute it and/or modify
   * it under the terms of the GNU Lesser General Public License as
   * published by the Free Software Foundation, either version 3 of the
   * License, or (at your option) any later version.
   *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Lesser Public License for more details.
   *
   * You should have received a copy of the GNU General Lesser Public
   * License along with this program.  If not, see
   * <http://www.gnu.org/licenses/lgpl-3.0.html>.
   * ╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱
   */
  
  import org.metricshub.ipmi.core.coding.commands.CommandCodes;
  import org.metricshub.ipmi.core.coding.commands.IpmiCommandCoder;
  import org.metricshub.ipmi.core.coding.commands.IpmiVersion;
  import org.metricshub.ipmi.core.coding.commands.PrivilegeLevel;
  import org.metricshub.ipmi.core.coding.payload.IpmiPayload;
  import org.metricshub.ipmi.core.coding.payload.lan.IPMIException;
  import org.metricshub.ipmi.core.coding.payload.lan.IpmiLanRequest;
  import org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction;
  import org.metricshub.ipmi.core.coding.protocol.AuthenticationType;
  import org.metricshub.ipmi.core.coding.protocol.IpmiMessage;
  import org.metricshub.ipmi.core.coding.protocol.Ipmiv15Message;
  import org.metricshub.ipmi.core.coding.security.CipherSuite;
  import org.metricshub.ipmi.core.common.TypeConverter;
  
  import java.security.InvalidKeyException;
  import java.security.NoSuchAlgorithmException;
  import java.util.ArrayList;
  
  /**
   * Wrapper for Get Channel Authentication Capabilities request
   */
  public class GetChannelAuthenticationCapabilities
  		extends IpmiCommandCoder<GetChannelAuthenticationCapabilitiesResponseData> {
  
  	private PrivilegeLevel requestedPrivilegeLevel;
  
  	private byte channelNumber;
  
  	private IpmiVersion requestVersion;
  
  	public void setRequestedPrivilegeLevel(PrivilegeLevel requestedPrivilegeLevel) {
  		this.requestedPrivilegeLevel = requestedPrivilegeLevel;
  	}
  
  	public PrivilegeLevel getRequestedPrivilegeLevel() {
  		return requestedPrivilegeLevel;
  	}
  
  	/**
  	 * Sets the channel number that will be put into IPMI command.
  	 *
  	 * @param channelNumber
  	 *        - must be 0h-Bh or Eh-Fh <br>
  	 *        Eh = retrieve information for channel this request was issued
  	 *        on
  	 * @throws IllegalArgumentException
  	 */
  	public void setChannelNumber(int channelNumber) {
  		if (channelNumber < 0 || channelNumber > 0xF || channelNumber == 0xC || channelNumber == 0xD) {
  			throw new IllegalArgumentException("Invalid channel number");
  		}
  		this.channelNumber = TypeConverter.intToByte(channelNumber);
  	}
  
  	public int getChannelNumber() {
  		return TypeConverter.byteToInt(channelNumber);
  	}
  
  	protected void setRequestVersion(IpmiVersion requestVersion) {
  		this.requestVersion = requestVersion;
  	}
  
  	protected IpmiVersion getRequestVersion() {
  		return requestVersion;
  	}
  
  	/**
  	 * Initiates class for decoding in 1.5 version. Sets requested privilege
  	 * level to user. Sets channel number to 14 indicating that response will
  	 * contain information for channel this request was issued on. Sets session
  	 * parameters to default.
  	 *
  	 * @see IpmiCommandCoder#setSessionParameters(IpmiVersion, CipherSuite,
  	 *      AuthenticationType)
  	 * @see IpmiVersion
 	 */
 	public GetChannelAuthenticationCapabilities() {
 		super();
 		setRequestedPrivilegeLevel(PrivilegeLevel.User);
 		setChannelNumber(14);
 	}
 
 	/**
 	 * Initiates class. Sets IPMI version to version. Sets requested privilege
 	 * level to user. Sets channel number to 14 indicating that response will
 	 * contain information for channel this request was issued on.
 	 *
 	 * @param version
 	 *        - Version of IPMI protocol used
 	 * @param requestVersion
 	 *        - If Get Channel Authentication Capabilities command is sent
 	 *        to BMC with requestVersion = {@link IpmiVersion#V15} it will
 	 *        respond, that it does not support IPMI v2.0 even if it does.
 	 * @param cipherSuite
 	 *        - {@link CipherSuite} containing authentication,
 	 *        confidentiality and integrity algorithms for this session.
 	 * @see IpmiVersion
 	 */
 	public GetChannelAuthenticationCapabilities(IpmiVersion version, IpmiVersion requestVersion,
 			CipherSuite cipherSuite) {
 		setSessionParameters(version, cipherSuite, AuthenticationType.None);
 		this.setRequestVersion(requestVersion);
 		setRequestedPrivilegeLevel(PrivilegeLevel.User);
 		setChannelNumber(14);
 	}
 
 	/**
 	 * Initiates class. Sets IPMI version to version. Sets requested privilege
 	 * level privilegeLevel. Sets channel number to channelNumber.
 	 *
 	 * @param version
 	 *        - Version of IPMI protocol used
 	 * @param requestVersion
 	 *        - If Get Channel Authentication Capabilities command is sent
 	 *        to BMC with requestVersion = {@link IpmiVersion#V15} it will
 	 *        respond, that it does not support IPMI v2.0 even if it does.
 	 * @param cipherSuite
 	 *        - {@link CipherSuite} containing authentication,
 	 *        confidentiality and integrity algorithms for this session.
 	 * @param privilegeLevel
 	 *        - Maximum requested privilege level. Can't be
 	 *        {@link PrivilegeLevel#MaximumAvailable}.
 	 * @param channelNumber
 	 *        - must be 0h-Bh or Eh-Fh <br>
 	 *        Eh = retrieve information for channel this request was issued
 	 *        on.
 	 * @see IpmiVersion
 	 * @see PrivilegeLevel
 	 */
 	public GetChannelAuthenticationCapabilities(IpmiVersion version, IpmiVersion requestVersion, CipherSuite cipherSuite,
 			PrivilegeLevel privilegeLevel, byte channelNumber) {
 		setSessionParameters(version, cipherSuite, AuthenticationType.None);
 		this.setRequestVersion(requestVersion);
 		setRequestedPrivilegeLevel(privilegeLevel);
 		setChannelNumber(channelNumber);
 	}
 
 	@Override
 	public IpmiMessage encodePayload(int messageSequenceNumber, int sessionSequenceNumber, int sessionId)
 			throws InvalidKeyException,
 			NoSuchAlgorithmException {
 		if (getIpmiVersion() == IpmiVersion.V15) {
 			if (sessionId != 0) {
 				throw new IllegalArgumentException("Session ID must be 0");
 			}
 
 			Ipmiv15Message message = new Ipmiv15Message();
 
 			message.setAuthenticationType(getAuthenticationType());
 
 			message.setSessionSequenceNumber(0);
 
 			message.setSessionID(0);
 
 			message.setPayload(preparePayload(messageSequenceNumber));
 
 			return message;
 		} else {
 			setAuthenticationType(AuthenticationType.RMCPPlus);
 
 			return super.encodePayload(messageSequenceNumber, sessionSequenceNumber, sessionId);
 		}
 	}
 
 	@Override
 	protected IpmiPayload preparePayload(int sequenceNumber) {
 		byte[] payload = new byte[2];
 
 		payload[0] = 0;
 
 		if (getRequestVersion() == IpmiVersion.V20) {
 			payload[0] |= TypeConverter.intToByte(0x80);
 		}
 
 		payload[0] |= channelNumber;
 
 		payload[1] = encodePrivilegeLevel(requestedPrivilegeLevel);
 		return new IpmiLanRequest(getNetworkFunction(), getCommandCode(), payload, TypeConverter.intToByte(sequenceNumber));
 	}
 
 	@Override
 	public byte getCommandCode() {
 		return CommandCodes.GET_CHANNEL_AUTHENTICATION_CAPABILITIES;
 	}
 
 	@Override
 	public NetworkFunction getNetworkFunction() {
 		return NetworkFunction.ApplicationRequest;
 	}
 
 	@Override
 	public GetChannelAuthenticationCapabilitiesResponseData getResponseData(IpmiMessage message) throws IPMIException {
 		byte[] raw = validateResponse(message);
 
 		GetChannelAuthenticationCapabilitiesResponseData responseData = new GetChannelAuthenticationCapabilitiesResponseData();
 
 		if (raw.length != 8) {
 			throw new IllegalArgumentException("Data has invalid length");
 		}
 
 		responseData.setChannelNumber(raw[0]);
 
 		// Byte 3 bit 7 only says that byte 5 holds the extended capabilities, whose bit 1 is the IPMI v2.0 support
 		// (IPMI 2.0 table 22-15; raw[0] is byte 2, the channel number)
 		responseData.setIpmiv20Support((raw[1] & 0x80) != 0 && (raw[3] & 0x02) != 0);
 
 		responseData.setAuthenticationTypes(new ArrayList<AuthenticationType>());
 
 		if ((raw[1] & 0x20) != 0) {
 			responseData.getAuthenticationTypes().add(AuthenticationType.Oem);
 		}
 
 		if ((raw[1] & 0x10) != 0) {
 			responseData.getAuthenticationTypes().add(AuthenticationType.Simple);
 		}
 
 		if ((raw[1] & 0x04) != 0) {
 			responseData.getAuthenticationTypes().add(AuthenticationType.Md5);
 		}
 
 		if ((raw[1] & 0x02) != 0) {
 			responseData.getAuthenticationTypes().add(AuthenticationType.Md2);
 		}
 
 		if ((raw[1] & 0x01) != 0) {
 			responseData.getAuthenticationTypes().add(AuthenticationType.None);
 		}
 
 		responseData.setKgEnabled((raw[2] & 0x20) != 0);
 
 		responseData.setPerMessageAuthenticationEnabled((raw[2] & 0x10) == 0);
 
 		responseData.setUserLevelAuthenticationEnabled((raw[2] & 0x08) == 0);
 
 		responseData.setNonNullUsernamesEnabled((raw[2] & 0x04) != 0);
 
 		responseData.setNullUsernamesEnabled((raw[2] & 0x02) != 0);
 
 		responseData.setAnonymusLoginEnabled((raw[2] & 0x01) != 0);
 
 		byte[] oemId = new byte[4];
 
 		System.arraycopy(raw, 4, oemId, 0, 3);
 
 		oemId[3] = 0;
 
 		responseData.setOemId(TypeConverter.littleEndianByteArrayToInt(oemId));
 
 		responseData.setOemData(raw[7]);
 
 		return responseData;
 	}
 
 	/**
 	 * Sets session parameters.
 	 *
 	 * @param version
 	 *        - IPMI version of the command.
 	 * @param cipherSuite
 	 *        - {@link CipherSuite} containing authentication,
 	 *        confidentiality and integrity algorithms for this session.
 	 * @param authenticationType
 	 *        - Type of authentication used. Must be RMCPPlus for IPMI v2.0.
 	 */
 	@Override
 	public void setSessionParameters(
 			IpmiVersion version,
 			CipherSuite cipherSuite,
 			AuthenticationType authenticationType) {
 
 		if (version == IpmiVersion.V20
 				&& authenticationType != AuthenticationType.RMCPPlus
 				&& authenticationType != AuthenticationType.None) {
 			throw new IllegalArgumentException("Authentication Type must be RMCPPlus for IPMI v2.0 messages");
 		}
 
 		setIpmiVersion(version);
 		setAuthenticationType(authenticationType);
 		setCipherSuite(cipherSuite);
 	}
 
 }