BuiltinCiphers (Apache Mina SSHD :: Common support utilities 2.7.0 API)

java.lang.Object
- java.lang.Enum<BuiltinCiphers>
- - org.apache.sshd.common.cipher.BuiltinCiphers

All Implemented Interfaces:

Serializable, Comparable<BuiltinCiphers>, Supplier<Cipher>, AlgorithmNameProvider, BuiltinFactory<Cipher>, CipherFactory, CipherInformation, Factory<Cipher>, KeySizeIndicator, NamedFactory<Cipher>, NamedResource, OptionalFeature
```
public enum BuiltinCiphers
extends Enum<BuiltinCiphers>
implements CipherFactory
```
Provides easy access to the currently implemented ciphers

Author:

Apache MINA SSHD Project

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)

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`
`aes128gcm`
`aes192cbc`
`aes192ctr`
`aes256cbc`
`aes256ctr`
`aes256gcm`
`arcfour128` Deprecated.
`arcfour256` Deprecated.
`blowfishcbc` Deprecated.
`none`
`tripledescbc` Deprecated.

Field Summary

Fields
Modifier and Type Field and Description

static 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

Fields
Modifier and Type	Field and Description
`static Set<BuiltinCiphers>`	`VALUES`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Cipher`	`create()`
`static BuiltinCiphers`	`fromFactory(NamedFactory<Cipher> factory)`
`static BuiltinCiphers`	`fromFactoryName(String name)`
`static BuiltinCiphers`	`fromString(String s)`
`String`	`getAlgorithm()`
`int`	`getAuthenticationTagSize()`
`int`	`getCipherBlockSize()`
`int`	`getIVSize()`
`int`	`getKdfSize()`
`int`	`getKeySize()`
`String`	`getName()`
`static NavigableSet<CipherFactory>`	`getRegisteredExtensions()`
`String`	`getTransformation()`
`boolean`	`isSupported()`
`static BuiltinCiphers.ParseResult`	`parseCiphersList(Collection<String> ciphers)`
`static BuiltinCiphers.ParseResult`	`parseCiphersList(String... ciphers)`
`static BuiltinCiphers.ParseResult`	`parseCiphersList(String ciphers)`
`static void`	`registerExtension(CipherFactory extension)` Registered a `NamedFactory` to be available besides the built-in ones when parsing configuration
`static CipherFactory`	`resolveFactory(String name)`
`String`	`toString()`
`static NamedFactory<Cipher>`	`unregisterExtension(String name)` Unregisters specified extension
`static BuiltinCiphers`	`valueOf(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, findFirstMatchByName, getNameList, getNames, ofName, removeByName, safeCompareByName

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
```
  - aes128gcm
```
public static final BuiltinCiphers aes128gcm
```
  - aes256gcm
```
public static final BuiltinCiphers aes256gcm
```
  - 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
```
@Deprecated
public static final BuiltinCiphers arcfour128
```
    Deprecated.
    
    See Also:
    
    SSHD-1004
  - arcfour256
```
@Deprecated
public static final BuiltinCiphers arcfour256
```
    Deprecated.
    
    See Also:
    
    SSHD-1004
  - blowfishcbc
```
@Deprecated
public static final BuiltinCiphers blowfishcbc
```
    Deprecated.
    
    See Also:
    
    SSHD-1004
  - tripledescbc
```
@Deprecated
public static final BuiltinCiphers tripledescbc
```
    Deprecated.
    
    See Also:
    
    SSHD-1004
- Field Detail
  - VALUES
```
public static final Set<BuiltinCiphers> VALUES
```
- 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(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getName
```
public final String getName()
```
    Specified by:
    
    getName in interface NamedResource
    
    Returns:
    
    The resource name
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class 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)
  - getAuthenticationTagSize
```
public int getAuthenticationTagSize()
```
    Specified by:
    
    getAuthenticationTagSize in interface CipherInformation
    
    Returns:
    
    Size of the authentication tag (AT) in bytes or 0 if this cipher does not support authentication
  - 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 String getAlgorithm()
```
    Specified by:
    
    getAlgorithm in interface AlgorithmNameProvider
  - getTransformation
```
public 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:
    
    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 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(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(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(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(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(String... ciphers)
```
  - parseCiphersList
```
public static BuiltinCiphers.ParseResult parseCiphersList(Collection<String> ciphers)
```
  - resolveFactory
```
public static CipherFactory resolveFactory(String name)
```
    Parameters:
    
    name - The factory name
    
    Returns:
    
    The factory or null if it is neither a built-in one or a registered extension

Enum BuiltinCiphers

Nested Class Summary

Enum Constant Summary

Field Summary

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

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

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

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

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

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

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

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

Enum Constant Detail

none

aes128cbc

aes128ctr

aes128gcm

aes256gcm

aes192cbc

aes192ctr

aes256cbc

aes256ctr

arcfour128

arcfour256

blowfishcbc

tripledescbc

Field Detail

VALUES

Method Detail

values

valueOf

getName

toString

isSupported

getKeySize

getIVSize

getAuthenticationTagSize

getKdfSize

getCipherBlockSize

getAlgorithm

getTransformation

create

registerExtension

getRegisteredExtensions

unregisterExtension

fromString

fromFactory

fromFactoryName

parseCiphersList

parseCiphersList

parseCiphersList

resolveFactory