Modifier and Type	Class and Description
public static class	BuiltinCiphers.Constants
public static class	BuiltinCiphers.ParseResult Holds the result of `BuiltinCiphers#parseCiphersList(String)`

Field Summary

Modifier and Type	Field and Description
public static final BuiltinCiphers	aes128cbc
public static final BuiltinCiphers	aes128ctr
public static final BuiltinCiphers	aes128gcm
public static final BuiltinCiphers	aes192cbc
public static final BuiltinCiphers	aes192ctr
public static final BuiltinCiphers	aes256cbc
public static final BuiltinCiphers	aes256ctr
public static final BuiltinCiphers	aes256gcm
private final String	algorithm
public static final BuiltinCiphers	arcfour128 Deprecated
public static final BuiltinCiphers	arcfour256 Deprecated
private final int	authSize
private final int	blkSize
public static final BuiltinCiphers	blowfishcbc Deprecated
public static final BuiltinCiphers	cc20p1305_openssh
private static final Map<String, CipherFactory>	EXTENSIONS
private final String	factoryName
private final int	ivsize
private final int	keySize
public static final BuiltinCiphers	none
private final AtomicReference<Boolean>	supported
private final String	transformation
public static final BuiltinCiphers	tripledescbc Deprecated
public static final Set<BuiltinCiphers>	VALUES

Access	Constructor and Description
private	BuiltinCiphers(String factoryName, int ivsize, int authSize, String algorithm, int keySizeInBits, String transformation, int blkSize)

Method Summary

Modifier and Type	Method and Description
public Cipher	create() Implements org.apache.sshd.common.Factory.create.
public static BuiltinCiphers	Returns: The matching `BuiltinCiphers` whose factory name matches (case insensitive) the cipher factory name fromFactory(NamedFactory<Cipher> The `NamedFactory` for the cipher - ignored if `null` factory)
public static BuiltinCiphers	Returns: The matching `BuiltinCiphers` whose factory name matches (case insensitive) the provided name - `null` if no match fromFactoryName(String The factory name - ignored if `null`/empty name)
public static BuiltinCiphers	Returns: The matching `BuiltinCiphers` whose `Enum#name()` matches (case insensitive) the provided argument - `null` if no match fromString(String The `Enum`'s name - ignored if `null`/empty s)
public String	getAlgorithm() Implements org.apache.sshd.common.AlgorithmNameProvider.getAlgorithm.
public int	getAuthenticationTagSize() Implements org.apache.sshd.common.cipher.CipherInformation.getAuthenticationTagSize.
public int	getCipherBlockSize() Implements org.apache.sshd.common.cipher.CipherInformation.getCipherBlockSize.
public int	getIVSize() Implements org.apache.sshd.common.cipher.CipherInformation.getIVSize.
public int	getKdfSize() Implements org.apache.sshd.common.cipher.CipherInformation.getKdfSize.
public int	getKeySize() Implements org.apache.sshd.common.keyprovider.KeySizeIndicator.getKeySize.
public final String	getName() Implements org.apache.sshd.common.NamedResource.getName.
public static NavigableSet<CipherFactory>	Returns: A `SortedSet` of the currently registered extensions, sorted according to the factory name (case insensitive) getRegisteredExtensions()
public String	getTransformation() Implements org.apache.sshd.common.cipher.CipherInformation.getTransformation.
public boolean	Returns: `true` if the current JVM configuration supports this cipher - e.g., AES-256 requires the Java Cryptography Extension (JCE) isSupported() Implements org.apache.sshd.common.OptionalFeature.isSupported.
public static BuiltinCiphers.ParseResult	Returns: A `ParseResult` containing the successfully parsed factories and the unknown ones Note it is up to caller to ensure that the lists do not contain duplicates parseCiphersList(String A comma-separated list of ciphers' names - ignored if `null`/empty ciphers)
public static BuiltinCiphers.ParseResult	parseCiphersList(String... ciphers)
public static BuiltinCiphers.ParseResult	parseCiphersList(Collection<String> ciphers)
public static void	registerExtension(CipherFactory The factory to register extension) Registered a `NamedFactory` to be available besides the built-in ones when parsing configuration
public static CipherFactory	Returns: The factory or `null` if it is neither a built-in one or a registered extension resolveFactory(String The factory name name)
public final String	toString() Overrides java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration.
public static NamedFactory<Cipher>	Returns: The registered extension - `null` if not found unregisterExtension(String The factory name - ignored if `null`/empty name) Unregisters specified extension
public static BuiltinCiphers	valueOf(String name)
public static BuiltinCiphers[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal valueOf

Field Detail

aes128cbc	back to summary
public static final BuiltinCiphers aes128cbc

aes128ctr	back to summary
public static final BuiltinCiphers aes128ctr

aes128gcm	back to summary
public static final BuiltinCiphers aes128gcm

aes192cbc	back to summary
public static final BuiltinCiphers aes192cbc

aes192ctr	back to summary
public static final BuiltinCiphers aes192ctr

aes256cbc	back to summary
public static final BuiltinCiphers aes256cbc

aes256ctr	back to summary
public static final BuiltinCiphers aes256ctr

aes256gcm	back to summary
public static final BuiltinCiphers aes256gcm

algorithm	back to summary
private final String algorithm

arcfour128	back to summary
public static final BuiltinCiphers arcfour128 Deprecated Annotations @Deprecated See Also SSHD-1004

arcfour256	back to summary
public static final BuiltinCiphers arcfour256 Deprecated Annotations @Deprecated See Also SSHD-1004

authSize	back to summary
private final int authSize

blkSize	back to summary
private final int blkSize

blowfishcbc	back to summary
public static final BuiltinCiphers blowfishcbc Deprecated Annotations @Deprecated See Also SSHD-1004

cc20p1305_openssh	back to summary
public static final BuiltinCiphers cc20p1305_openssh

EXTENSIONS	back to summary
private static final Map<String, CipherFactory> EXTENSIONS

factoryName	back to summary
private final String factoryName

ivsize	back to summary
private final int ivsize

keySize	back to summary
private final int keySize

none	back to summary
public static final BuiltinCiphers none

supported	back to summary
private final AtomicReference<Boolean> supported

transformation	back to summary
private final String transformation

tripledescbc	back to summary
public static final BuiltinCiphers tripledescbc Deprecated Annotations @Deprecated See Also SSHD-1004

VALUES	back to summary
public static final Set<BuiltinCiphers> VALUES

Constructor Detail

BuiltinCiphers	back to summary
private BuiltinCiphers(String factoryName, int ivsize, int authSize, String algorithm, int keySizeInBits, String transformation, int blkSize)

Method Detail

create	back to summary
public Cipher create() Implements org.apache.sshd.common.Factory.create. Returns:Cipher Doc from org.apache.sshd.common.Factory.create. A new instance Annotations @Override

create

back to summary

public Cipher create()

Implements org.apache.sshd.common.Factory.create.

Returns:Cipher

Doc from org.apache.sshd.common.Factory.create.

A new instance

Annotations

@Override

fromFactory	back to summary
public static BuiltinCiphers fromFactory(NamedFactory<Cipher> factory) Parameters factory:NamedFactory<Cipher> The `NamedFactory` for the cipher - ignored if `null` Returns:BuiltinCiphers The matching `BuiltinCiphers` whose factory name matches (case insensitive) the cipher factory name See Also `fromFactoryName(String)`

fromFactoryName	back to summary
public static BuiltinCiphers fromFactoryName(String name) Parameters name:String The factory name - ignored if `null`/empty Returns:BuiltinCiphers The matching `BuiltinCiphers` whose factory name matches (case insensitive) the provided name - `null` if no match

fromString	back to summary
public static BuiltinCiphers fromString(String s) Parameters s:String The `Enum`'s name - ignored if `null`/empty Returns:BuiltinCiphers The matching `BuiltinCiphers` whose `Enum#name()` matches (case insensitive) the provided argument - `null` if no match

getAlgorithm	back to summary
public String getAlgorithm() Implements org.apache.sshd.common.AlgorithmNameProvider.getAlgorithm. Annotations @Override

getAlgorithm

back to summary

public String getAlgorithm()

Implements org.apache.sshd.common.AlgorithmNameProvider.getAlgorithm.

Annotations

@Override

getAuthenticationTagSize	back to summary
public int getAuthenticationTagSize() Implements org.apache.sshd.common.cipher.CipherInformation.getAuthenticationTagSize. Returns:int Doc from org.apache.sshd.common.cipher.CipherInformation.getAuthenticationTagSize. Size of the authentication tag (AT) in bytes or 0 if this cipher does not support authentication Annotations @Override

getAuthenticationTagSize

back to summary

public int getAuthenticationTagSize()

Implements org.apache.sshd.common.cipher.CipherInformation.getAuthenticationTagSize.

Returns:int

Doc from org.apache.sshd.common.cipher.CipherInformation.getAuthenticationTagSize.

Size of the authentication tag (AT) in bytes or 0 if this cipher does not support authentication

Annotations

@Override

getCipherBlockSize	back to summary
public int getCipherBlockSize() Implements org.apache.sshd.common.cipher.CipherInformation.getCipherBlockSize. Returns:int Doc from org.apache.sshd.common.cipher.CipherInformation.getCipherBlockSize. Size of block data used by the cipher (in bytes). For stream ciphers this value is (currently) used to indicate some average work buffer size to be used for the automatic re-keying mechanism described in RFC 4253 - Section 9 Annotations @Override

getCipherBlockSize

back to summary

public int getCipherBlockSize()

Implements org.apache.sshd.common.cipher.CipherInformation.getCipherBlockSize.

Returns:int

Doc from org.apache.sshd.common.cipher.CipherInformation.getCipherBlockSize.

Size of block data used by the cipher (in bytes). For stream ciphers this value is (currently) used to indicate some average work buffer size to be used for the automatic re-keying mechanism described in RFC 4253 - Section 9

Annotations

@Override

getIVSize	back to summary
public int getIVSize() Implements org.apache.sshd.common.cipher.CipherInformation.getIVSize. Returns:int Doc from org.apache.sshd.common.cipher.CipherInformation.getIVSize. Size of the initialization vector (in bytes) Annotations @Override

getIVSize

back to summary

public int getIVSize()

Implements org.apache.sshd.common.cipher.CipherInformation.getIVSize.

Returns:int

Doc from org.apache.sshd.common.cipher.CipherInformation.getIVSize.

Size of the initialization vector (in bytes)

Annotations

@Override

getKdfSize	back to summary
public int getKdfSize() Implements org.apache.sshd.common.cipher.CipherInformation.getKdfSize. Returns:int Doc from org.apache.sshd.common.cipher.CipherInformation.getKdfSize. The block size (in bytes) used to derive the secret key for this cipher Annotations @Override

getKdfSize

back to summary

public int getKdfSize()

Implements org.apache.sshd.common.cipher.CipherInformation.getKdfSize.

Returns:int

Doc from org.apache.sshd.common.cipher.CipherInformation.getKdfSize.

The block size (in bytes) used to derive the secret key for this cipher

Annotations

@Override

getKeySize	back to summary
public int getKeySize() Implements org.apache.sshd.common.keyprovider.KeySizeIndicator.getKeySize. Returns:int Doc from org.apache.sshd.common.keyprovider.KeySizeIndicator.getKeySize. The number of bits used in the key Annotations @Override

getKeySize

back to summary

public int getKeySize()

Implements org.apache.sshd.common.keyprovider.KeySizeIndicator.getKeySize.

Returns:int

Doc from org.apache.sshd.common.keyprovider.KeySizeIndicator.getKeySize.

The number of bits used in the key

Annotations

@Override

getName	back to summary
public final String getName() Implements org.apache.sshd.common.NamedResource.getName. Returns:String Doc from org.apache.sshd.common.NamedResource.getName. The resource name Annotations @Override

getName

back to summary

public final String getName()

Implements org.apache.sshd.common.NamedResource.getName.

Returns:String

Doc from org.apache.sshd.common.NamedResource.getName.

The resource name

Annotations

@Override

getRegisteredExtensions	back to summary
public static NavigableSet<CipherFactory> getRegisteredExtensions() Returns:NavigableSet<CipherFactory> A `SortedSet` of the currently registered extensions, sorted according to the factory name (case insensitive)

getTransformation	back to summary
public String getTransformation() Implements org.apache.sshd.common.cipher.CipherInformation.getTransformation. Returns:String Doc from org.apache.sshd.common.cipher.CipherInformation.getTransformation. The actual transformation used - e.g., AES/CBC/NoPadding Annotations @Override

getTransformation

back to summary

public String getTransformation()

Implements org.apache.sshd.common.cipher.CipherInformation.getTransformation.

Returns:String

Doc from org.apache.sshd.common.cipher.CipherInformation.getTransformation.

The actual transformation used - e.g., AES/CBC/NoPadding

Annotations

@Override

isSupported back to summary

isSupported	back to summary
public boolean isSupported() Implements org.apache.sshd.common.OptionalFeature.isSupported. Returns:boolean `true` if the current JVM configuration supports this cipher - e.g., AES-256 requires the Java Cryptography Extension (JCE) Annotations @Override

public boolean isSupported()

Implements org.apache.sshd.common.OptionalFeature.isSupported.

Returns:boolean

true if the current JVM configuration supports this cipher - e.g., AES-256 requires the Java Cryptography Extension (JCE)

Annotations

@Override

parseCiphersList	back to summary
public static BuiltinCiphers.ParseResult parseCiphersList(String ciphers) Parameters ciphers:String A comma-separated list of ciphers' names - ignored if `null`/empty Returns:BuiltinCiphers.ParseResult A `ParseResult` containing the successfully parsed factories and the unknown ones Note it is up to caller to ensure that the lists do not contain duplicates

parseCiphersList	back to summary
public static BuiltinCiphers.ParseResult parseCiphersList(String... ciphers)

parseCiphersList	back to summary
public static BuiltinCiphers.ParseResult parseCiphersList(Collection<String> ciphers)

registerExtension back to summary

registerExtension	back to summary
public static void registerExtension(CipherFactory extension) Registered a `NamedFactory` to be available besides the built-in ones when parsing configuration Parameters extension:CipherFactory The factory to register Exceptions IllegalArgumentException: if factory instance is `null`, or overrides a built-in one or overrides another registered factory with the same name (case insensitive).

public static void registerExtension(CipherFactory extension)

Registered a NamedFactory to be available besides the built-in ones when parsing configuration

Parameters

extension:CipherFactory: The factory to register

Exceptions

IllegalArgumentException:: if factory instance is null, or overrides a built-in one or overrides another registered factory with the same name (case insensitive).

resolveFactory	back to summary
public static CipherFactory resolveFactory(String name) Parameters name:String The factory name Returns:CipherFactory The factory or `null` if it is neither a built-in one or a registered extension

toString	back to summary
public final String toString() Overrides java.lang.Enum.toString. Doc from java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists. Returns:String the name of this enum constant Annotations @Override

toString

back to summary

public final String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations

@Override

unregisterExtension back to summary

unregisterExtension	back to summary
public static NamedFactory<Cipher> unregisterExtension(String name) Unregisters specified extension Parameters name:String The factory name - ignored if `null`/empty Returns:NamedFactory<Cipher> The registered extension - `null` if not found

public static NamedFactory<Cipher> unregisterExtension(String name)

Unregisters specified extension

Parameters

name:String: The factory name - ignored if null/empty

Returns:NamedFactory<Cipher>

The registered extension - null if not found

valueOf	back to summary
public static BuiltinCiphers valueOf(String name)

values	back to summary
public static BuiltinCiphers[] values()

org.apache.sshd.common.cipher back to summary

public final Class BuiltinCiphers.Constants

Class Inheritance

extends Object

java.lang.Object
org.apache.sshd.common.cipher.BuiltinCiphers.Constants

Field Summary

Modifier and Type	Field and Description
public static final String	AES128_CBC
public static final String	AES128_CTR
public static final String	AES128_GCM
public static final String	AES192_CBC
public static final String	AES192_CTR
public static final String	AES256_CBC
public static final String	AES256_CTR
public static final String	AES256_GCM
public static final String	ARCFOUR128
public static final String	ARCFOUR256
public static final String	BLOWFISH_CBC
public static final String	CC20P1305_OPENSSH
public static final String	NONE
public static final Pattern	NONE_CIPHER_PATTERN
public static final String	TRIPLE_DES_CBC

Constructor Summary

Access	Constructor and Description
private	Constants()

Method Summary

Modifier and Type	Method and Description
public static boolean	Returns: `true` if the `NONE` cipher name appears in it isNoneCipherIncluded(String A comma-separated list of ciphers - ignored if `null`/empty s)

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

Field Detail

AES128_CBC	back to summary
public static final String AES128_CBC

AES128_CTR	back to summary
public static final String AES128_CTR

AES128_GCM	back to summary
public static final String AES128_GCM

AES192_CBC	back to summary
public static final String AES192_CBC

AES192_CTR	back to summary
public static final String AES192_CTR

AES256_CBC	back to summary
public static final String AES256_CBC

AES256_CTR	back to summary
public static final String AES256_CTR

AES256_GCM	back to summary
public static final String AES256_GCM

ARCFOUR128	back to summary
public static final String ARCFOUR128

ARCFOUR256	back to summary
public static final String ARCFOUR256

BLOWFISH_CBC	back to summary
public static final String BLOWFISH_CBC

CC20P1305_OPENSSH	back to summary
public static final String CC20P1305_OPENSSH

NONE	back to summary
public static final String NONE

NONE_CIPHER_PATTERN	back to summary
public static final Pattern NONE_CIPHER_PATTERN

TRIPLE_DES_CBC	back to summary
public static final String TRIPLE_DES_CBC

Constructor Detail

Constants	back to summary
private Constants()

Method Detail

isNoneCipherIncluded	back to summary
public static boolean isNoneCipherIncluded(String s) Parameters s:String A comma-separated list of ciphers - ignored if `null`/empty Returns:boolean `true` if the `NONE` cipher name appears in it

public sealed Enum BuiltinCiphers

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class BuiltinCiphers.Constants

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class BuiltinCiphers.ParseResult

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail