org.apache.sshd.common.cipher

Enum BuiltinCiphers

java.lang.Object

java.lang.Enum<BuiltinCiphers>

org.apache.sshd.common.cipher.BuiltinCiphers

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BuiltinCiphers>, java.util.function.Supplier<Cipher>, AlgorithmNameProvider, BuiltinFactory<Cipher>, CipherFactory, CipherInformation, Factory<Cipher>, KeySizeIndicator, NamedFactory<Cipher>, NamedResource, OptionalFeature

public enum BuiltinCiphers
extends java.lang.Enum<BuiltinCiphers>
implements CipherFactory

Provides easy access to the currently implemented ciphers

Nested Class Summary

Nested Classes

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
aes128cbc
aes128ctr
aes192cbc
aes192ctr
aes256cbc
aes256ctr
arcfour128
arcfour256
blowfishcbc
none
tripledescbc

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	algorithm
private int	blkSize
private static java.util.Map<java.lang.String,CipherFactory>	EXTENSIONS
private java.lang.String	factoryName
private int	ivsize
private int	kdfSize
private int	keysize
private boolean	supported
private java.lang.String	transformation
static java.util.Set<BuiltinCiphers>	VALUES

Fields inherited from interface org.apache.sshd.common.NamedResource

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Fields inherited from interface org.apache.sshd.common.OptionalFeature

FALSE, TRUE

Method Summary

Modifier and Type	Method and Description
Cipher	create()
static BuiltinCiphers	fromFactory(NamedFactory<Cipher> factory)
static BuiltinCiphers	fromFactoryName(java.lang.String name)
static BuiltinCiphers	fromString(java.lang.String s)
java.lang.String	getAlgorithm()
int	getCipherBlockSize()
int	getIVSize()
int	getKdfSize()
int	getKeySize()
java.lang.String	getName()
static java.util.NavigableSet<CipherFactory>	getRegisteredExtensions()
java.lang.String	getTransformation()
boolean	isSupported()
static BuiltinCiphers.ParseResult	parseCiphersList(java.util.Collection<java.lang.String> ciphers)
static BuiltinCiphers.ParseResult	parseCiphersList(java.lang.String... ciphers)
static BuiltinCiphers.ParseResult	parseCiphersList(java.lang.String ciphers)
static void	registerExtension(CipherFactory extension) Registered a NamedFactory to be available besides the built-in ones when parsing configuration
static CipherFactory	resolveFactory(java.lang.String name)
java.lang.String	toString()
static NamedFactory<Cipher>	unregisterExtension(java.lang.String name) Unregisters specified extension
static BuiltinCiphers	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BuiltinCiphers[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.sshd.common.BuiltinFactory

setUpFactories

Methods inherited from interface org.apache.sshd.common.NamedFactory

create, setUpBuiltinFactories, setUpTransformedFactories

Methods inherited from interface org.apache.sshd.common.Factory

get

Methods inherited from interface org.apache.sshd.common.NamedResource

findByName, getNameList, getNames, ofName, removeByName

Methods inherited from interface org.apache.sshd.common.OptionalFeature

all, any, of

Enum Constant Detail

none

public static final BuiltinCiphers none

aes128cbc

public static final BuiltinCiphers aes128cbc

aes128ctr

public static final BuiltinCiphers aes128ctr

aes192cbc

public static final BuiltinCiphers aes192cbc

aes192ctr

public static final BuiltinCiphers aes192ctr

aes256cbc

public static final BuiltinCiphers aes256cbc

aes256ctr

public static final BuiltinCiphers aes256ctr

arcfour128

public static final BuiltinCiphers arcfour128

arcfour256

public static final BuiltinCiphers arcfour256

blowfishcbc

public static final BuiltinCiphers blowfishcbc

tripledescbc

public static final BuiltinCiphers tripledescbc

Field Detail

VALUES

public static final java.util.Set<BuiltinCiphers> VALUES

EXTENSIONS

private static final java.util.Map<java.lang.String,CipherFactory> EXTENSIONS

factoryName

private final java.lang.String factoryName

ivsize

private final int ivsize

kdfSize

private final int kdfSize

keysize

private final int keysize

blkSize

private final int blkSize

algorithm

private final java.lang.String algorithm

transformation

private final java.lang.String transformation

supported

private final boolean supported

Method Detail

values

public static BuiltinCiphers[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BuiltinCiphers c : BuiltinCiphers.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BuiltinCiphers valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getName

public final java.lang.String getName()

Specified by:

getName in interface NamedResource

Returns:

The resource name

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Enum<BuiltinCiphers>

isSupported

public boolean isSupported()

Specified by:

isSupported in interface OptionalFeature

Returns:

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

getKeySize

public int getKeySize()

Specified by:

getKeySize in interface KeySizeIndicator

Returns:

The number of bits used in the key

getIVSize

public int getIVSize()

Specified by:

getIVSize in interface CipherInformation

Returns:

Size of the initialization vector (in bytes)

getKdfSize

public int getKdfSize()

Specified by:

getKdfSize in interface CipherInformation

Returns:

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

getCipherBlockSize

public int getCipherBlockSize()

Specified by:

getCipherBlockSize in interface CipherInformation

Returns:

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

getAlgorithm

public java.lang.String getAlgorithm()

Specified by:

getAlgorithm in interface AlgorithmNameProvider

getTransformation

public java.lang.String getTransformation()

Specified by:

getTransformation in interface CipherInformation

Returns:

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

create

public Cipher create()

Specified by:

create in interface Factory<Cipher>

Returns:

A new instance

registerExtension

public static void registerExtension(CipherFactory extension)

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

Parameters:

extension - The factory to register

Throws:

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

getRegisteredExtensions

public static java.util.NavigableSet<CipherFactory> getRegisteredExtensions()

Returns:

A SortedSet of the currently registered extensions, sorted according to the factory name (case insensitive)

unregisterExtension

public static NamedFactory<Cipher> unregisterExtension(java.lang.String name)

Unregisters specified extension

Parameters:

name - The factory name - ignored if null/empty

Returns:

The registered extension - null if not found

fromString

public static BuiltinCiphers fromString(java.lang.String s)

Parameters:

s - The Enum's name - ignored if null/empty

Returns:

The matching BuiltinCiphers whose Enum.name() matches (case insensitive) the provided argument - null if no match

fromFactory

public static BuiltinCiphers fromFactory(NamedFactory<Cipher> factory)

Parameters:

factory - The NamedFactory for the cipher - ignored if null

Returns:

The matching BuiltinCiphers whose factory name matches (case insensitive) the cipher factory name

See Also:

fromFactoryName(String)

fromFactoryName

public static BuiltinCiphers fromFactoryName(java.lang.String name)

Parameters:

name - The factory name - ignored if null/empty

Returns:

The matching BuiltinCiphers whose factory name matches (case insensitive) the provided name - null if no match

parseCiphersList

public static BuiltinCiphers.ParseResult parseCiphersList(java.lang.String ciphers)

Parameters:

ciphers - A comma-separated list of ciphers' names - ignored if null/empty

Returns:

A BuiltinCiphers.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

public static BuiltinCiphers.ParseResult parseCiphersList(java.lang.String... ciphers)

parseCiphersList

public static BuiltinCiphers.ParseResult parseCiphersList(java.util.Collection<java.lang.String> ciphers)

resolveFactory

public static CipherFactory resolveFactory(java.lang.String name)

Parameters:

name - The factory name

Returns:

The factory or null if it is neither a built-in one or a registered extension