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

Class IntegrityAlgorithm

java.lang.Object

org.metricshub.ipmi.core.coding.security.IntegrityAlgorithm

Direct Known Subclasses:

IntegrityHmacMd5_128, IntegrityHmacSha1_96, IntegrityHmacSha256_128, IntegrityMd5_128, IntegrityNone

public abstract class IntegrityAlgorithm
extends Object

Interface for Integrity Algorithms. All classes extending this one must implement constructor(byte[]).

Method Summary

Modifier and Type	Method	Description
byte[]	generateAuthCode(byte[] base)	Creates AuthCode field for message.
abstract String	getAlgorithmName()	Returns the name of the algorithm.
abstract int	getAuthCodeLength()	Returns the length of the authentication code
abstract byte	getCode()	Returns the algorithm's ID.
void	initialize(byte[] key)	Initializes Integrity Algorithm
void	wipeKey()	Wipes the key passed to initialize(byte[]) (the password for MD5-128 integrity) once the session is over, and keys the MAC with the wiped key: the codes the algorithm generates no longer match the session.

Methods inherited from class java.lang.Object

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

Method Details

initialize

public void initialize(byte[] key)
                throws InvalidKeyException

Initializes Integrity Algorithm

Parameters:

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

Throws:

InvalidKeyException

wipeKey

public void wipeKey()

Wipes the key passed to initialize(byte[]) (the password for MD5-128 integrity) once the session is over, and keys the MAC with the wiped key: the codes the algorithm generates no longer match the session.

getCode

public abstract byte getCode()

Returns the algorithm's ID.

generateAuthCode

public byte[] generateAuthCode(byte[] base)

Creates AuthCode field for message. Synchronized: the sending, receiving and keep-alive threads share this instance and its Mac.

Parameters:

base - - data starting with the AuthType/Format field up to and including the field that immediately precedes the AuthCode field

Returns:

AuthCode field. Might be null if empty AuthCOde field is generated.

See Also:

• Rakp1.calculateSik(org.metricshub.ipmi.core.coding.commands.session.Rakp1ResponseData)

getAlgorithmName

public abstract String getAlgorithmName()

Returns the name of the algorithm.

Returns:

The algorithm name as a String.

getAuthCodeLength

public abstract int getAuthCodeLength()

Returns the length of the authentication code

Returns:

The length of the authentication code in bytes.