Package org.onlab.packet

Class EAPOLMkpduMACSecUseParameterSet

java.lang.Object

org.onlab.packet.BasePacket

org.onlab.packet.EAPOLMkpduMACSecUseParameterSet

All Implemented Interfaces:

EAPOLMkpduParameterSet, IPacket

public class EAPOLMkpduMACSecUseParameterSet
extends BasePacket
implements EAPOLMkpduParameterSet

Class representing MKPDU MACSec SAK Use Parameter Set. IEEE 802.1X Clause 11; Figure 11-10

Field Summary

Fields

Modifier and Type	Field	Description
static byte	DELAY_PROTECT_MASK
static byte	KEY_AN_MASK
static short	LATEST_KEY_AN_OFFSET
static byte	LATEST_KEY_RX_MASK
static byte	LATEST_KEY_TX_MASK
static short	OLD_KEY_AN_OFFSET
static byte	OLD_KEY_RX_MASK
static byte	OLD_KEY_TX_MASK
static byte	PLAIN_RX_MASK
static byte	PLAIN_TX_MASK
static short	SUPS_FIXED_PART_TOTAL_SIZE
static short	TOTAL_SUPS_BODY_LENGTH

Fields inherited from class org.onlab.packet.BasePacket

parent, payload

Fields inherited from interface org.onlab.packet.EAPOLMkpduParameterSet

BODY_LENGTH_MSB_MASK, BODY_LENGTH_MSB_SHIFT, BODY_LENGTH_OCTET_OFFSET, FIELD_MI_LENGTH, FIELD_MN_LENGTH, FIELD_SCI_LENGTH, PARAMETERSET_TYPE_BASIC, PARAMETERSET_TYPE_DISTRIBUTED_SAK, PARAMETERSET_TYPE_ICV_INDICATOR, PARAMETERSET_TYPE_LIVE_PEER_LIST, PARAMETERSET_TYPE_MACSEC_SAK_USE, PARAMETERSET_TYPE_POTENTIAL_PEER_LIST

Constructor Summary

Constructors

Constructor	Description
EAPOLMkpduMACSecUseParameterSet()

Method Summary

Modifier and Type	Method	Description
static Deserializer<EAPOLMkpduMACSecUseParameterSet>	deserializer()	Deserializer function for MACSec SAK Use Parameter Set.
short	getBodyLength()	Retrieve Body Length field of Parameter Set.
byte	getParameterSetType()	Retrieve Type of Parameter Set.
short	getTotalLength()	Total length; ie.
byte[]	serialize()	Utility function for Serializing Parameter Set.
void	setBodyLength(short bodyLength)
void	setDelayProtect(boolean delayProtect)	To set Delay Protect.
void	setLatestAN(byte latestAN)	Latest Key Server Association Number.
void	setLatestKI(byte[] latestKI)	Latest Key Server Identifier.
void	setLatestKN(int latestKN)	Latest Key Server Key Number.
void	setLatestLAPN(int latestLAPN)	Lowest Acceptable Packet Number for Latest Key Server.
void	setLatestRX(boolean latestRX)	Latest Key Server used for RX protection .
void	setLatestTX(boolean latestTX)	Latest Key Server used for TX protection.
void	setOldAN(byte oldAN)	Old Key Server Association Number.
void	setOldKI(byte[] oldKI)	Old Key Server Identifier.
void	setOldKN(int oldKN)	Old Key Server Number.
void	setOldLAPN(int oldLAPN)	Lowest Acceptable Packet Number for Old Key Server.
void	setOldRX(boolean oldRX)	Old Key Server used for RX protection.
void	setOldTX(boolean oldTX)	Old Key Server used for TX protection.
void	setPlainRX(boolean plainRX)	Plain RX supported or not.
void	setPlainTX(boolean plainTX)	To set Plain TX supported or not.

Methods inherited from class org.onlab.packet.BasePacket

clone, equals, getParent, getPayload, hashCode, resetChecksum, setParent, setPayload

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

TOTAL_SUPS_BODY_LENGTH

public static final short TOTAL_SUPS_BODY_LENGTH

See Also:

Constant Field Values

LATEST_KEY_AN_OFFSET

public static final short LATEST_KEY_AN_OFFSET

See Also:

Constant Field Values

OLD_KEY_AN_OFFSET

public static final short OLD_KEY_AN_OFFSET

See Also:

Constant Field Values

LATEST_KEY_RX_MASK

public static final byte LATEST_KEY_RX_MASK

See Also:

Constant Field Values

LATEST_KEY_TX_MASK

public static final byte LATEST_KEY_TX_MASK

See Also:

Constant Field Values

OLD_KEY_RX_MASK

public static final byte OLD_KEY_RX_MASK

See Also:

Constant Field Values

OLD_KEY_TX_MASK

public static final byte OLD_KEY_TX_MASK

See Also:

Constant Field Values

KEY_AN_MASK

public static final byte KEY_AN_MASK

See Also:

Constant Field Values

PLAIN_TX_MASK

public static final byte PLAIN_TX_MASK

See Also:

Constant Field Values

PLAIN_RX_MASK

public static final byte PLAIN_RX_MASK

See Also:

Constant Field Values

DELAY_PROTECT_MASK

public static final byte DELAY_PROTECT_MASK

See Also:

Constant Field Values

SUPS_FIXED_PART_TOTAL_SIZE

public static final short SUPS_FIXED_PART_TOTAL_SIZE

See Also:

Constant Field Values

Constructor Detail

EAPOLMkpduMACSecUseParameterSet

public EAPOLMkpduMACSecUseParameterSet()

Method Detail

serialize

public byte[] serialize()

Description copied from interface: EAPOLMkpduParameterSet

Utility function for Serializing Parameter Set.

Specified by:

serialize in interface EAPOLMkpduParameterSet

Specified by:

serialize in interface IPacket

Returns:

byte[] value

deserializer

public static Deserializer<EAPOLMkpduMACSecUseParameterSet> deserializer()

Deserializer function for MACSec SAK Use Parameter Set.

Returns:

deserializer function

getParameterSetType

public byte getParameterSetType()

Description copied from interface: EAPOLMkpduParameterSet

Retrieve Type of Parameter Set.

Specified by:

getParameterSetType in interface EAPOLMkpduParameterSet

Returns:

parameter set type.

getTotalLength

public short getTotalLength()

Description copied from interface: EAPOLMkpduParameterSet

Total length; ie. including header and body length.

Specified by:

getTotalLength in interface EAPOLMkpduParameterSet

Returns:

short value.

getBodyLength

public short getBodyLength()

Description copied from interface: EAPOLMkpduParameterSet

Retrieve Body Length field of Parameter Set.

Specified by:

getBodyLength in interface EAPOLMkpduParameterSet

Returns:

body length of parameter set.

setBodyLength

public void setBodyLength(short bodyLength)

setDelayProtect

public void setDelayProtect(boolean delayProtect)

To set Delay Protect.

Parameters:

delayProtect - , type boolean

setPlainTX

public void setPlainTX(boolean plainTX)

To set Plain TX supported or not.

Parameters:

plainTX - , type boolean

setPlainRX

public void setPlainRX(boolean plainRX)

Plain RX supported or not.

Parameters:

plainRX - , type boolean

setLatestLAPN

public void setLatestLAPN(int latestLAPN)

Lowest Acceptable Packet Number for Latest Key Server.

Parameters:

latestLAPN - ,type int

setLatestAN

public void setLatestAN(byte latestAN)

Latest Key Server Association Number.

Parameters:

latestAN - , type byte

setLatestKI

public void setLatestKI(byte[] latestKI)

Latest Key Server Identifier.

Parameters:

latestKI - ,type byte[]

setLatestKN

public void setLatestKN(int latestKN)

Latest Key Server Key Number.

Parameters:

latestKN - ,type int

setLatestTX

public void setLatestTX(boolean latestTX)

Latest Key Server used for TX protection.

Parameters:

latestTX - ,type boolean

setLatestRX

public void setLatestRX(boolean latestRX)

Latest Key Server used for RX protection .

Parameters:

latestRX - ,type boolean.

setOldLAPN

public void setOldLAPN(int oldLAPN)

Lowest Acceptable Packet Number for Old Key Server.

Parameters:

oldLAPN - , type int

setOldAN

public void setOldAN(byte oldAN)

Old Key Server Association Number.

Parameters:

oldAN - , type byte

setOldKI

public void setOldKI(byte[] oldKI)

Old Key Server Identifier.

Parameters:

oldKI - , type byte[]

setOldKN

public void setOldKN(int oldKN)

Old Key Server Number.

Parameters:

oldKN - , type int

setOldTX

public void setOldTX(boolean oldTX)

Old Key Server used for TX protection.

Parameters:

oldTX - ,type boolean

setOldRX

public void setOldRX(boolean oldRX)

Old Key Server used for RX protection.

Parameters:

oldRX - , type boolean