Package org.metricshub.ipmi.core.coding.security

Class CipherSuite

java.lang.Object

org.metricshub.ipmi.core.coding.security.CipherSuite

public class CipherSuite
extends Object

Provides cipher suite (authentication, confidentiality and integrity algorithms used during the session).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NOT_YET_IMPLEMENTED_MESSAGE

Constructor Summary

Constructors

Constructor	Description
CipherSuite(byte id, byte authenticationAlgorithm, byte confidentialityAlgorithm, byte integrityAlgorithm)

Method Summary

Modifier and Type	Method	Description
AuthenticationAlgorithm	getAuthenticationAlgorithm()	Returns instance of AuthenticationAlgorithm class.
static List<CipherSuite>	getCipherSuites(byte[] bytes)	Builds Cipher Suites collection from raw data received by GetChannelCipherSuites commands.
ConfidentialityAlgorithm	getConfidentialityAlgorithm()	Returns instance of ConfidentialityAlgorithm class.
static CipherSuite	getEmpty()
byte	getId()
IntegrityAlgorithm	getIntegrityAlgorithm()	Returns instance of IntegrityAlgorithm class.
void	initializeAlgorithms(byte[] sik)	Initializes algorithms contained in this CipherSuite.
static Mac	newMacInstance(String algorithmName)	Constructs a Mac object that implements the given MAC algorithm.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NOT_YET_IMPLEMENTED_MESSAGE

public static final String NOT_YET_IMPLEMENTED_MESSAGE

See Also:

• Constant Field Values

Constructor Details

CipherSuite

public CipherSuite(byte id,
 byte authenticationAlgorithm,
 byte confidentialityAlgorithm,
 byte integrityAlgorithm)

Method Details

getId

public byte getId()

initializeAlgorithms

public void initializeAlgorithms(byte[] sik)
                          throws InvalidKeyException,
NoSuchAlgorithmException,
NoSuchPaddingException

Initializes algorithms contained in this CipherSuite.

Parameters:

sik - - Session Integrity Key calculated during the opening of the session or user password if 'one-key' logins are enabled.

Throws:

IllegalArgumentException

InvalidKeyException - - when initiation of the algorithm fails

NoSuchAlgorithmException - - when initiation of the algorithm fails

NoSuchPaddingException - - when initiation of the algorithm fails

getAuthenticationAlgorithm

public AuthenticationAlgorithm getAuthenticationAlgorithm()

Returns instance of AuthenticationAlgorithm class.

Throws:

IllegalArgumentException - when authentication algorithm code is incorrect.

getIntegrityAlgorithm

public IntegrityAlgorithm getIntegrityAlgorithm()

Returns instance of IntegrityAlgorithm class.

Throws:

IllegalArgumentException - when integrity algorithm code is incorrect.

getConfidentialityAlgorithm

public ConfidentialityAlgorithm getConfidentialityAlgorithm()

Returns instance of ConfidentialityAlgorithm class.

Throws:

IllegalArgumentException - when confidentiality algorithm code is incorrect.

getCipherSuites

public static List<CipherSuite> getCipherSuites(byte[] bytes)

Builds Cipher Suites collection from raw data received by GetChannelCipherSuites commands. Cannot be executed in GetChannelCipherSuitesResponseData since data comes in 16-byte packets and is fragmented. Supports only one integrity and one confidentiality algorithm per suite.

Parameters:

bytes - - concatenated Cipher Suite Records received by GetChannelCipherSuites commands.

Returns:

list of Cipher Suites supported by BMC.

getEmpty

public static CipherSuite getEmpty()

Returns:

CipherSuite with algorithms set to AuthenticationRakpNone, ConfidentialityNone and IntegrityNone.

newMacInstance

public static Mac newMacInstance(String algorithmName)

Constructs a Mac object that implements the given MAC algorithm.

Parameters:

algorithmName - the name of the algorithm to use

Returns:

The Mac object that implements the specified MAC algorithm.