Apache Mina SSHD 2.15.0 · org.apache.sshd.common.kex.AbstractDH

Modifier and Type	Field and Description
private byte[]	e_array
private byte[]	k_array
protected KeyAgreement	myKeyAgree

Access	Constructor and Description
protected	AbstractDH()

Method Summary

Modifier and Type	Method and Description
protected abstract byte[]	Returns: The calculated public key data calculateE() Lazy-called by `getE()` if the public key data has not been generated yet.
protected abstract byte[]	Returns: The shared secret data calculateK() Lazy-called by `getK()` if the shared secret data has not been calculated yet
protected void	checkKeyAgreementNecessity() Called after either public or private parts have been calculated in order to check if the key-agreement mediator is still required.
public byte[]	Returns: The local public key data getE()
public abstract Digest	getHash()
public byte[]	Returns: The shared secret key getK()
public KeyEncapsulationMethod	getKeyEncapsulation()
public boolean	isPublicDataAvailable()
public boolean	isSharedSecretAvailable()
public void	putE(Buffer buffer, byte[] e)
public void	putF(Buffer buffer, byte[] f)
public abstract void	setF(byte[] f)
public static byte[]	Returns: An (possibly) sub-array guaranteed to start with a non-zero byte stripLeadingZeroes(byte[] The original array x) The shared secret returned by `javax.crypto.KeyAgreement#generateSecret()` is a byte array, which can (by chance, roughly 1 out of 256 times) begin with zero byte (some JCE providers might strip this, though).
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

e_array	back to summary
private byte[] e_array

k_array	back to summary
private byte[] k_array

myKeyAgree	back to summary
protected KeyAgreement myKeyAgree

AbstractDH	back to summary
protected AbstractDH()

Method Detail

calculateE back to summary

calculateE	back to summary
protected abstract byte[] calculateE() throws Exception Lazy-called by `getE()` if the public key data has not been generated yet. Returns:byte[] The calculated public key data Exceptions Exception: If failed to generate the relevant data

protected abstract byte[] calculateE() throws Exception

Lazy-called by getE() if the public key data has not been generated yet.

Returns:byte[]

The calculated public key data

Exceptions

Exception:: If failed to generate the relevant data

calculateK back to summary

calculateK	back to summary
protected abstract byte[] calculateK() throws Exception Lazy-called by `getK()` if the shared secret data has not been calculated yet Returns:byte[] The shared secret data Exceptions Exception: If failed to calculate it

protected abstract byte[] calculateK() throws Exception

Lazy-called by getK() if the shared secret data has not been calculated yet

Returns:byte[]

The shared secret data

Exceptions

Exception:: If failed to calculate it

checkKeyAgreementNecessity back to summary

checkKeyAgreementNecessity	back to summary
protected void checkKeyAgreementNecessity() Called after either public or private parts have been calculated in order to check if the key-agreement mediator is still required. By default, if both public and private parts have been calculated then key-agreement mediator is null-ified to enable GC for it. See Also `getE()`, `getK()`

protected void checkKeyAgreementNecessity()

Called after either public or private parts have been calculated in order to check if the key-agreement mediator is still required. By default, if both public and private parts have been calculated then key-agreement mediator is null-ified to enable GC for it.

See Also: getE(), getK()

getE	back to summary
public byte[] getE() throws Exception Returns:byte[] The local public key data Exceptions Exception: If failed to calculate it

getHash	back to summary
public abstract Digest getHash() throws Exception

getK	back to summary
public byte[] getK() throws Exception Returns:byte[] The shared secret key Exceptions Exception: If failed to calculate it

getKeyEncapsulation	back to summary
public KeyEncapsulationMethod getKeyEncapsulation()

isPublicDataAvailable	back to summary
public boolean isPublicDataAvailable()

isSharedSecretAvailable	back to summary
public boolean isSharedSecretAvailable()

putE	back to summary
public void putE(Buffer buffer, byte[] e)

putF	back to summary
public void putF(Buffer buffer, byte[] f)

setF	back to summary
public abstract void setF(byte[] f)

stripLeadingZeroes back to summary

stripLeadingZeroes	back to summary
public static byte[] stripLeadingZeroes(byte[] x) The shared secret returned by `javax.crypto.KeyAgreement#generateSecret()` is a byte array, which can (by chance, roughly 1 out of 256 times) begin with zero byte (some JCE providers might strip this, though). In SSH, the shared secret is an integer, so we need to strip the leading zero(es). Parameters x:byte[] The original array Returns:byte[] An (possibly) sub-array guaranteed to start with a non-zero byte Exceptions IllegalArgumentException: If all zeroes array See Also SSHD-330

public static byte[] stripLeadingZeroes(byte[] x)

The shared secret returned by javax.crypto.KeyAgreement#generateSecret() is a byte array, which can (by chance, roughly 1 out of 256 times) begin with zero byte (some JCE providers might strip this, though). In SSH, the shared secret is an integer, so we need to strip the leading zero(es).

Parameters

x:byte[]: The original array

Returns:byte[]

An (possibly) sub-array guaranteed to start with a non-zero byte

Exceptions

IllegalArgumentException:: If all zeroes array

See Also

SSHD-330

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public abstract Class AbstractDH

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail