Uses of Class
org.metricshub.ipmi.core.coding.security.CipherSuite

Packages that use CipherSuite

Package	Description
org.metricshub.ipmi.client	The client of a BMC.
org.metricshub.ipmi.core.api.async	The asynchronous API.
org.metricshub.ipmi.core.api.sol	The API for Serial Over LAN (SOL) communication for IPMI.
org.metricshub.ipmi.core.api.sync	The synchronous API of the protocol core: IpmiConnector opens RMCP+ sessions and sends commands, waiting for their responses.
org.metricshub.ipmi.core.coding	The part of library responsible for message encoding and decoding.
org.metricshub.ipmi.core.coding.commands.session	Session management related commands.
org.metricshub.ipmi.core.coding.protocol.decoder	IPMI protocol decoder classes.
org.metricshub.ipmi.core.coding.security	Authentication, confidentiality and integrity algorithms.
org.metricshub.ipmi.core.connection	Package responsible for Connection management.
org.metricshub.ipmi.core.sm.events	The StateMachine events.
org.metricshub.ipmi.core.sm.states	The StateMachine states.

Uses of CipherSuite in org.metricshub.ipmi.client

Methods in org.metricshub.ipmi.client that return types with arguments of type CipherSuite

Modifier and Type	Method	Description
List<CipherSuite>	BmcCapabilities.cipherSuites()	Returns the standard cipher suites (0 to 19) the BMC offers, with their algorithms; the OEM suites and reserved suite IDs it lists are left out.

Uses of CipherSuite in org.metricshub.ipmi.core.api.async

Methods in org.metricshub.ipmi.core.api.async that return CipherSuite

Modifier and Type	Method	Description
CipherSuite	ConnectionHandle.getCipherSuite()	Returns the cipher suite of the session, declared with getChannelAuthenticationCapabilities() or createConnection().

Methods in org.metricshub.ipmi.core.api.async that return types with arguments of type CipherSuite

Modifier and Type	Method	Description
List<CipherSuite>	IpmiAsyncConnector.getAvailableCipherSuites(ConnectionHandle connectionHandle)	Gets CipherSuites available for the connection with the remote host.

Methods in org.metricshub.ipmi.core.api.async with parameters of type CipherSuite

Modifier and Type	Method	Description
ConnectionHandle	IpmiAsyncConnector.createConnection(InetAddress address, int port, CipherSuite cipherSuite, PrivilegeLevel privilegeLevel)	Creates connection to the remote host, with pre set CipherSuite and PrivilegeLevel, skipping the getAvailableCipherSuites and getChannelAuthenticationCapabilities phases.
GetChannelAuthenticationCapabilitiesResponseData	IpmiAsyncConnector.getChannelAuthenticationCapabilities(ConnectionHandle connectionHandle, CipherSuite cipherSuite, PrivilegeLevel requestedPrivilegeLevel)	Declares the cipher suite and the privilege of the session, and returns the authentication capabilities of the remote host that IpmiAsyncConnector.getAvailableCipherSuites(ConnectionHandle) read (requested at the User level): sends nothing.
void	ConnectionHandle.setCipherSuite(CipherSuite cipherSuite)	Sets the cipher suite of the session.

Uses of CipherSuite in org.metricshub.ipmi.core.api.sol

Methods in org.metricshub.ipmi.core.api.sol that return CipherSuite

Modifier and Type	Method	Description
CipherSuite	CipherSuiteSelectionHandler.choose(List<CipherSuite> availableCipherSuites)	Chooses one CipherSuite among list of available CipherSuites, to be used during IPMI connection.
CipherSuite	SpecificCipherSuiteSelector.choose(List<CipherSuite> availableCipherSuites)

Method parameters in org.metricshub.ipmi.core.api.sol with type arguments of type CipherSuite

Modifier and Type	Method	Description
CipherSuite	CipherSuiteSelectionHandler.choose(List<CipherSuite> availableCipherSuites)	Chooses one CipherSuite among list of available CipherSuites, to be used during IPMI connection.
CipherSuite	SpecificCipherSuiteSelector.choose(List<CipherSuite> availableCipherSuites)

Constructors in org.metricshub.ipmi.core.api.sol with parameters of type CipherSuite

Modifier	Constructor	Description
	SpecificCipherSuiteSelector(CipherSuite cipherSuite)	Creates a selector that always returns the given suite, whether the BMC offers it or not.

Uses of CipherSuite in org.metricshub.ipmi.core.api.sync

Methods in org.metricshub.ipmi.core.api.sync that return types with arguments of type CipherSuite

Modifier and Type	Method	Description
List<CipherSuite>	IpmiConnector.getAvailableCipherSuites(ConnectionHandle connectionHandle)	Gets CipherSuites available for the connection with the remote host.

Methods in org.metricshub.ipmi.core.api.sync with parameters of type CipherSuite

Modifier and Type	Method	Description
ConnectionHandle	IpmiConnector.createConnection(InetAddress address, int port, CipherSuite cipherSuite, PrivilegeLevel privilegeLevel)	Creates connection to the remote host, with pre set CipherSuite and PrivilegeLevel, skipping the getAvailableCipherSuites and getChannelAuthenticationCapabilities phases.
ConnectionHandle	IpmiConnector.createConnection(InetAddress address, CipherSuite cipherSuite, PrivilegeLevel privilegeLevel)	Creates connection to the remote host, with pre set CipherSuite and PrivilegeLevel, skipping the getAvailableCipherSuites and getChannelAuthenticationCapabilities phases.
GetChannelAuthenticationCapabilitiesResponseData	IpmiConnector.getChannelAuthenticationCapabilities(ConnectionHandle connectionHandle, CipherSuite cipherSuite, PrivilegeLevel requestedPrivilegeLevel)	Declares the cipher suite and the privilege of the session, and returns the authentication capabilities of the remote host that IpmiConnector.getAvailableCipherSuites(ConnectionHandle) read (requested at the User level): sends nothing.

Uses of CipherSuite in org.metricshub.ipmi.core.coding

Methods in org.metricshub.ipmi.core.coding that return CipherSuite

Modifier and Type	Method	Description
CipherSuite	PayloadCoder.getCipherSuite()

Methods in org.metricshub.ipmi.core.coding with parameters of type CipherSuite

Modifier and Type	Method	Description
void	PayloadCoder.setCipherSuite(CipherSuite cipherSuite)
void	PayloadCoder.setSessionParameters(IpmiVersion version, CipherSuite sessionCipherSuite, AuthenticationType sessionAuthenticationType)	Sets session parameters.

Constructors in org.metricshub.ipmi.core.coding with parameters of type CipherSuite

Modifier	Constructor	Description
	PayloadCoder(IpmiVersion version, CipherSuite cipherSuite, AuthenticationType authenticationType)

Uses of CipherSuite in org.metricshub.ipmi.core.coding.commands.session

Methods in org.metricshub.ipmi.core.coding.commands.session with parameters of type CipherSuite

Modifier and Type	Method	Description
void	GetChannelAuthenticationCapabilities.setSessionParameters(IpmiVersion version, CipherSuite cipherSuite, AuthenticationType authenticationType)	Sets session parameters.

Constructors in org.metricshub.ipmi.core.coding.commands.session with parameters of type CipherSuite

Modifier	Constructor	Description
	GetChannelAuthenticationCapabilities(IpmiVersion version, IpmiVersion requestVersion, CipherSuite cipherSuite)	Initiates class.
	GetChannelAuthenticationCapabilities(IpmiVersion version, IpmiVersion requestVersion, CipherSuite cipherSuite, PrivilegeLevel privilegeLevel, byte channelNumber)	Initiates class.
	OpenSession(int sessionID, PrivilegeLevel privilegeLevel, CipherSuite cipherSuite)	Initiates class for encoding and decoding.
	OpenSession(CipherSuite cipherSuite)	Initiates class for decoding.
	Rakp1(int managedSystemSessionId, PrivilegeLevel privilegeLevel, String username, byte[] password, byte[] bmcKey, CipherSuite cipherSuite)	Initiates class for encoding and decoding.
	Rakp3(byte statusCode, int managedSystemSessionId, CipherSuite cipherSuite, Rakp1 rakp1, Rakp1ResponseData rakp1ResponseData)	Initiates class for encoding and decoding.
	Rakp3(CipherSuite cipherSuite, Rakp1 rakp1, Rakp1ResponseData rakp1ResponseData)	Initiates class for decoding.

Uses of CipherSuite in org.metricshub.ipmi.core.coding.protocol.decoder

Constructors in org.metricshub.ipmi.core.coding.protocol.decoder with parameters of type CipherSuite

Modifier	Constructor	Description
	PlainCommandv20Decoder(CipherSuite cipherSuite)
	Protocolv20Decoder(CipherSuite cipherSuite)	Initiates IPMI v2.0 packet decoder.

Uses of CipherSuite in org.metricshub.ipmi.core.coding.security

Methods in org.metricshub.ipmi.core.coding.security that return CipherSuite

Modifier and Type	Method	Description
CipherSuite	CipherSuite.copy()	Returns a new instance of this suite, with uninitialized algorithms: opening a session keys the algorithms of its suite, so two sessions must never share an instance.
static CipherSuite	CipherSuite.forId(int id)	Creates one of the standard cipher suites (IPMI 2.0 table 22-20) from its ID, with the algorithms the specification assigns to it: the suite to use with a BMC whose offer is not read.
static CipherSuite	CipherSuite.getEmpty()

Methods in org.metricshub.ipmi.core.coding.security that return types with arguments of type CipherSuite

Modifier and Type	Method	Description
static List<CipherSuite>	CipherSuite.getCipherSuites(byte[] bytes)	Builds Cipher Suites collection from raw data received by GetChannelCipherSuites commands.

Method parameters in org.metricshub.ipmi.core.coding.security with type arguments of type CipherSuite

Modifier and Type	Method	Description
static String	CipherSuite.listIds(List<CipherSuite> suites)	Lists the IDs of the given suites, for messages.

Uses of CipherSuite in org.metricshub.ipmi.core.connection

Methods in org.metricshub.ipmi.core.connection that return CipherSuite

Modifier and Type	Method	Description
static CipherSuite	Connection.getDefaultCipherSuite()

Methods in org.metricshub.ipmi.core.connection that return types with arguments of type CipherSuite

Modifier and Type	Method	Description
List<CipherSuite>	Connection.getAvailableCipherSuites(int tag)	Gets from the managed system supported CipherSuites.
List<CipherSuite>	ConnectionManager.getAvailableCipherSuites(int connection)	Gets from the managed system supported CipherSuites.

Methods in org.metricshub.ipmi.core.connection with parameters of type CipherSuite

Modifier and Type	Method	Description
GetChannelAuthenticationCapabilitiesResponseData	Connection.getChannelAuthenticationCapabilities(int tag, CipherSuite cipherSuite, PrivilegeLevel requestedPrivilegeLevel)	Declares the cipher suite and the privilege of the session, and returns the authentication capabilities of the managed system that Connection.getAvailableCipherSuites(int), which must be performed first, read.
GetChannelAuthenticationCapabilitiesResponseData	ConnectionManager.getChannelAuthenticationCapabilities(int connection, CipherSuite cipherSuite, PrivilegeLevel requestedPrivilegeLevel)	Declares the cipher suite and the privilege of the session, and returns the authentication capabilities of the managed system that ConnectionManager.getAvailableCipherSuites(int), which must be performed first, read (requested at the User level).
int	Connection.startSession(int tag, CipherSuite cipherSuite, PrivilegeLevel privilegeLevel, String username, byte[] password, byte[] bmcKey)	Initiates the session with the managed system.
int	ConnectionManager.startSession(int connection, CipherSuite cipherSuite, PrivilegeLevel privilegeLevel, String username, byte[] password, byte[] bmcKey)	Initiates the session with the managed system.

Uses of CipherSuite in org.metricshub.ipmi.core.sm.events

Methods in org.metricshub.ipmi.core.sm.events that return CipherSuite

Modifier and Type	Method	Description
CipherSuite	Default.getCipherSuite()
CipherSuite	Rakp2Ack.getCipherSuite()
CipherSuite	StartSession.getCipherSuite()

Constructors in org.metricshub.ipmi.core.sm.events with parameters of type CipherSuite

Modifier	Constructor	Description
	Authorize(CipherSuite cipherSuite, int sequenceNumber, PrivilegeLevel privilegeLevel, int sessionId)
	Default(CipherSuite cipherSuite, int sequenceNumber, PrivilegeLevel privilegeLevel)
	OpenSessionAck(CipherSuite cipherSuite, PrivilegeLevel privilegeLevel, int sequenceNumber, int managedSystemSessionId, String username, byte[] password, byte[] bmcKey)	Provides data required to send RAKP Message 1.
	Rakp2Ack(CipherSuite cipherSuite, int sequenceNumber, byte statusCode, int managedSystemSessionId, Rakp1ResponseData rakp1ResponseData)	Prepares Rakp2Ack.
	StartSession(CipherSuite cipherSuite, int sessionId)

Uses of CipherSuite in org.metricshub.ipmi.core.sm.states

Methods in org.metricshub.ipmi.core.sm.states that return CipherSuite

Modifier and Type	Method	Description
CipherSuite	SessionValid.getCipherSuite()

Constructors in org.metricshub.ipmi.core.sm.states with parameters of type CipherSuite

Modifier	Constructor	Description
	Rakp3Waiting(int tag, Rakp1 rakp1, Rakp1ResponseData rakp1ResponseData, CipherSuite cipherSuite)	Initiates state.
	SessionValid(CipherSuite cipherSuite, int sessionId)	Initiates the state.