org.apache.sshd.common.signature

Enum BuiltinSignatures

java.lang.Object

java.lang.Enum<BuiltinSignatures>

org.apache.sshd.common.signature.BuiltinSignatures

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BuiltinSignatures>, java.util.function.Supplier<Signature>, BuiltinFactory<Signature>, Factory<Signature>, NamedFactory<Signature>, NamedResource, OptionalFeature, SignatureFactory

public enum BuiltinSignatures
extends java.lang.Enum<BuiltinSignatures>
implements SignatureFactory

Provides easy access to the currently implemented signatures

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BuiltinSignatures.ParseResult Holds the result of the parseSignatureList(String)

Enum Constant Summary

Enum Constants

Enum Constant and Description
dsa
dsa_cert
ed25519
ed25519_cert
nistp256
nistp256_cert
nistp384
nistp384_cert
nistp521
nistp521_cert
rsa
rsa_cert
rsaSHA256
rsaSHA256_cert
rsaSHA512
rsaSHA512_cert
sk_ecdsa_sha2_nistp256
sk_ssh_ed25519

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Map<java.lang.String,SignatureFactory>	EXTENSIONS
private java.lang.String	factoryName
static java.util.Set<BuiltinSignatures>	VALUES

Fields inherited from interface org.apache.sshd.common.signature.SignatureFactory

ECC_SIGNATURE_TYPE_PREFERENCES, RSA_SIGNATURE_TYPE_PREFERENCES

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
static BuiltinSignatures	fromFactory(NamedFactory<Signature> factory)
static BuiltinSignatures	fromFactoryName(java.lang.String name)
static BuiltinSignatures	fromString(java.lang.String s)
static Signature	getByCurveSize(java.security.spec.ECParameterSpec params)
java.lang.String	getName()
static java.util.NavigableSet<SignatureFactory>	getRegisteredExtensions()
boolean	isSupported()
static BuiltinSignatures.ParseResult	parseSignatureList(java.util.Collection<java.lang.String> sigs)
static BuiltinSignatures.ParseResult	parseSignatureList(java.lang.String... sigs)
static BuiltinSignatures.ParseResult	parseSignatureList(java.lang.String sigs)
static void	registerExtension(SignatureFactory extension) Registered a NamedFactory to be available besides the built-in ones when parsing configuration
static SignatureFactory	resolveFactory(java.lang.String name)
java.lang.String	toString()
static SignatureFactory	unregisterExtension(java.lang.String name) Unregisters specified extension
static BuiltinSignatures	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BuiltinSignatures[]	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.signature.SignatureFactory

resolvePreferredSignaturePosition, resolvePreferredSignaturePosition, resolveSignatureFactoriesProposal, resolveSignatureFactoryNamesProposal

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

create, 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

dsa

public static final BuiltinSignatures dsa

dsa_cert

public static final BuiltinSignatures dsa_cert

rsa

public static final BuiltinSignatures rsa

rsa_cert

public static final BuiltinSignatures rsa_cert

rsaSHA256

public static final BuiltinSignatures rsaSHA256

rsaSHA256_cert

public static final BuiltinSignatures rsaSHA256_cert

rsaSHA512

public static final BuiltinSignatures rsaSHA512

rsaSHA512_cert

public static final BuiltinSignatures rsaSHA512_cert

nistp256

public static final BuiltinSignatures nistp256

nistp256_cert

public static final BuiltinSignatures nistp256_cert

nistp384

public static final BuiltinSignatures nistp384

nistp384_cert

public static final BuiltinSignatures nistp384_cert

nistp521

public static final BuiltinSignatures nistp521

nistp521_cert

public static final BuiltinSignatures nistp521_cert

sk_ecdsa_sha2_nistp256

public static final BuiltinSignatures sk_ecdsa_sha2_nistp256

ed25519

public static final BuiltinSignatures ed25519

ed25519_cert

public static final BuiltinSignatures ed25519_cert

sk_ssh_ed25519

public static final BuiltinSignatures sk_ssh_ed25519

Field Detail

VALUES

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

EXTENSIONS

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

factoryName

private final java.lang.String factoryName

Method Detail

values

public static BuiltinSignatures[] 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 (BuiltinSignatures c : BuiltinSignatures.values())
    System.out.println(c);

Returns:

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

valueOf

public static BuiltinSignatures 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

getByCurveSize

public static Signature getByCurveSize(java.security.spec.ECParameterSpec params)

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<BuiltinSignatures>

isSupported

public boolean isSupported()

Specified by:

isSupported in interface OptionalFeature

registerExtension

public static void registerExtension(SignatureFactory 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<SignatureFactory> getRegisteredExtensions()

Returns:

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

unregisterExtension

public static SignatureFactory 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 BuiltinSignatures fromString(java.lang.String s)

Parameters:

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

Returns:

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

fromFactory

public static BuiltinSignatures fromFactory(NamedFactory<Signature> factory)

Parameters:

factory - The NamedFactory for the signature - ignored if null

Returns:

The matching BuiltinSignatures whose factory name matches (case insensitive) the digest factory name

See Also:

fromFactoryName(String)

fromFactoryName

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

Parameters:

name - The factory name - ignored if null/empty

Returns:

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

parseSignatureList

public static BuiltinSignatures.ParseResult parseSignatureList(java.lang.String sigs)

Parameters:

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

Returns:

A BuiltinSignatures.ParseResult of all the NamedFactory whose name appears in the string and represent a built-in signature. Any unknown name is ignored. The order of the returned result is the same as the original order - bar the unknown signatures. Note: it is up to caller to ensure that the list does not contain duplicates

parseSignatureList

public static BuiltinSignatures.ParseResult parseSignatureList(java.lang.String... sigs)

parseSignatureList

public static BuiltinSignatures.ParseResult parseSignatureList(java.util.Collection<java.lang.String> sigs)

resolveFactory

public static SignatureFactory 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