Apache Mina SSHD 2.15.0 · org.apache.sshd.common.config.keys.loader.PrivateKeyEncryptionContext

Modifier and Type	Field and Description
private String	cipherMode
private String	cipherName
private String	cipherType
public static final String	DEFAULT_CIPHER_MODE
private byte[]	initVector
private transient PrivateKeyObfuscator	obfuscator
private static final Map<String, PrivateKeyObfuscator>	OBFUSCATORS
private String	password

Access	Constructor and Description
public	PrivateKeyEncryptionContext()
public	PrivateKeyEncryptionContext(String algInfo)

Modifier and Type	Method and Description
public PrivateKeyEncryptionContext	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getCipherMode()
public String	getCipherName()
public String	getCipherType()
public byte[]	getInitVector()
public String	getPassword() Implements org.apache.sshd.common.auth.PasswordHolder.getPassword.
public PrivateKeyObfuscator	getPrivateKeyObfuscator()
public static final PrivateKeyObfuscator	getRegisteredPrivateKeyObfuscator(String cipherName)
public static final NavigableSet<String>	getRegisteredPrivateKeyObfuscatorCiphers()
public static final List<PrivateKeyObfuscator>	getRegisteredPrivateKeyObfuscators()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public static final <C extends PrivateKeyEncryptionContext> C	initializeObfuscator(C context, PrivateKeyObfuscator o, String password)
public static final PrivateKeyEncryptionContext	newPrivateKeyEncryptionContext(PrivateKeyObfuscator o, String password)
public PrivateKeyEncryptionContext	Returns: The updated context instance parseAlgorithmInfo(String The algorithm info - format: `name-type-mode` algInfo)
public static final < Generic context type C extends PrivateKeyEncryptionContext> C	Returns: The updated context parseAlgorithmInfo(C The `PrivateKeyEncryptionContext` to update context, String The algorithm info - format: `<I>name</I>-<I>type</I>-<I>mode</I>` algInfo)
public static PrivateKeyObfuscator	registerPrivateKeyObfuscator(PrivateKeyObfuscator o)
public static PrivateKeyObfuscator	registerPrivateKeyObfuscator(String cipherName, PrivateKeyObfuscator o)
public PrivateKeyObfuscator	resolvePrivateKeyObfuscator()
public void	setCipherMode(String value)
public void	setCipherName(String value)
public void	setCipherType(String value)
public void	setInitVector(byte... values)
public void	setPassword(String value) Implements org.apache.sshd.common.auth.MutablePassword.setPassword.
public void	setPrivateKeyObfuscator(PrivateKeyObfuscator value)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public static boolean	unregisterPrivateKeyObfuscator(PrivateKeyObfuscator o)
public static PrivateKeyObfuscator	unregisterPrivateKeyObfuscator(String cipherName)

cipherMode	back to summary
private String cipherMode

cipherName	back to summary
private String cipherName

cipherType	back to summary
private String cipherType

DEFAULT_CIPHER_MODE	back to summary
public static final String DEFAULT_CIPHER_MODE

initVector	back to summary
private byte[] initVector

obfuscator	back to summary
private transient PrivateKeyObfuscator obfuscator

OBFUSCATORS	back to summary
private static final Map<String, PrivateKeyObfuscator> OBFUSCATORS

password	back to summary
private String password

PrivateKeyEncryptionContext	back to summary
public PrivateKeyEncryptionContext()

PrivateKeyEncryptionContext	back to summary
public PrivateKeyEncryptionContext(String algInfo)

Method Detail

clone back to summary

clone	back to summary
public PrivateKeyEncryptionContext clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:PrivateKeyEncryptionContext a clone of this instance. Annotations @Override

public PrivateKeyEncryptionContext clone()

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:PrivateKeyEncryptionContext

a clone of this instance.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getCipherMode	back to summary
public String getCipherMode()

getCipherName	back to summary
public String getCipherName()

getCipherType	back to summary
public String getCipherType()

getInitVector	back to summary
public byte[] getInitVector()

getPassword	back to summary
public String getPassword() Implements org.apache.sshd.common.auth.PasswordHolder.getPassword. Annotations @Override

getPassword

back to summary

public String getPassword()

Implements org.apache.sshd.common.auth.PasswordHolder.getPassword.

Annotations

@Override

getPrivateKeyObfuscator	back to summary
public PrivateKeyObfuscator getPrivateKeyObfuscator()

getRegisteredPrivateKeyObfuscator	back to summary
public static final PrivateKeyObfuscator getRegisteredPrivateKeyObfuscator(String cipherName)

getRegisteredPrivateKeyObfuscatorCiphers	back to summary
public static final NavigableSet<String> getRegisteredPrivateKeyObfuscatorCiphers()

getRegisteredPrivateKeyObfuscators	back to summary
public static final List<PrivateKeyObfuscator> getRegisteredPrivateKeyObfuscators()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

initializeObfuscator	back to summary
public static final <C extends PrivateKeyEncryptionContext> C initializeObfuscator(C context, PrivateKeyObfuscator o, String password)

newPrivateKeyEncryptionContext	back to summary
public static final PrivateKeyEncryptionContext newPrivateKeyEncryptionContext(PrivateKeyObfuscator o, String password)

parseAlgorithmInfo	back to summary
public PrivateKeyEncryptionContext parseAlgorithmInfo(String algInfo) Parameters algInfo:String The algorithm info - format: `name-type-mode` Returns:PrivateKeyEncryptionContext The updated context instance See Also `parseAlgorithmInfo(PrivateKeyEncryptionContext, String)`

parseAlgorithmInfo	back to summary
public static final <C extends PrivateKeyEncryptionContext> C parseAlgorithmInfo(C context, String algInfo) Parameters <C> Generic context type context:C The `PrivateKeyEncryptionContext` to update algInfo:String The algorithm info - format: `<I>name</I>-<I>type</I>-<I>mode</I>` Returns:C The updated context

registerPrivateKeyObfuscator	back to summary
public static PrivateKeyObfuscator registerPrivateKeyObfuscator(PrivateKeyObfuscator o)

registerPrivateKeyObfuscator	back to summary
public static PrivateKeyObfuscator registerPrivateKeyObfuscator(String cipherName, PrivateKeyObfuscator o)

resolvePrivateKeyObfuscator	back to summary
public PrivateKeyObfuscator resolvePrivateKeyObfuscator()

setCipherMode	back to summary
public void setCipherMode(String value)

setCipherName	back to summary
public void setCipherName(String value)

setCipherType	back to summary
public void setCipherType(String value)

setInitVector	back to summary
public void setInitVector(byte... values)

setPassword	back to summary
public void setPassword(String value) Implements org.apache.sshd.common.auth.MutablePassword.setPassword. Annotations @Override

setPassword

back to summary

public void setPassword(String value)

Implements org.apache.sshd.common.auth.MutablePassword.setPassword.

Annotations

@Override

setPrivateKeyObfuscator	back to summary
public void setPrivateKeyObfuscator(PrivateKeyObfuscator value)

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

unregisterPrivateKeyObfuscator	back to summary
public static boolean unregisterPrivateKeyObfuscator(PrivateKeyObfuscator o)

unregisterPrivateKeyObfuscator	back to summary
public static PrivateKeyObfuscator unregisterPrivateKeyObfuscator(String cipherName)

public Class PrivateKeyEncryptionContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail