Apache Mina SSHD 2.15.0 · org.apache.sshd.common.signature.BuiltinSignatures

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

Modifier and Type	Field and Description
public static final BuiltinSignatures	dsa Deprecated
public static final BuiltinSignatures	dsa_cert Deprecated
public static final BuiltinSignatures	ed25519
public static final BuiltinSignatures	ed25519_cert
private static final Map<String, SignatureFactory>	EXTENSIONS
private final String	factoryName
public static final BuiltinSignatures	nistp256
public static final BuiltinSignatures	nistp256_cert
public static final BuiltinSignatures	nistp384
public static final BuiltinSignatures	nistp384_cert
public static final BuiltinSignatures	nistp521
public static final BuiltinSignatures	nistp521_cert
public static final BuiltinSignatures	rsa
public static final BuiltinSignatures	rsa_cert Deprecated
public static final BuiltinSignatures	rsaSHA256
public static final BuiltinSignatures	rsaSHA256_cert
public static final BuiltinSignatures	rsaSHA512
public static final BuiltinSignatures	rsaSHA512_cert
public static final BuiltinSignatures	sk_ecdsa_sha2_nistp256
public static final BuiltinSignatures	sk_ssh_ed25519
public static final Set<BuiltinSignatures>	VALUES

Access	Constructor and Description
private	BuiltinSignatures(String facName)

Method Summary

Modifier and Type	Method and Description
public static BuiltinSignatures	Returns: The matching `org.apache.sshd.common.signature.BuiltinSignatures` whose factory name matches (case insensitive) the digest factory name fromFactory(NamedFactory<Signature> The `org.apache.sshd.common.NamedFactory` for the signature - ignored if `null` factory)
public static BuiltinSignatures	Returns: The matching `BuiltinSignatures` 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 BuiltinSignatures	Returns: The matching `org.apache.sshd.common.signature.BuiltinSignatures` 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 static BuiltinSignatures	getFactoryByCurveSize(ECParameterSpec params)
public final String	getName() Implements org.apache.sshd.common.NamedResource.getName.
public static NavigableSet<SignatureFactory>	Returns: A `NavigableSet` of the currently registered extensions, sorted according to the factory name (case insensitive) getRegisteredExtensions()
public static Signature	getSignerByCurveSize(ECParameterSpec params)
public boolean	isSupported() Implements org.apache.sshd.common.OptionalFeature.isSupported.
public static BuiltinSignatures.ParseResult	Returns: A `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(String A comma-separated list of signatures' names - ignored if `null`/empty sigs)
public static BuiltinSignatures.ParseResult	parseSignatureList(String... sigs)
public static BuiltinSignatures.ParseResult	parseSignatureList(Collection<String> sigs)
public static void	registerExtension(SignatureFactory The factory to register extension) Registered a `NamedFactory` to be available besides the built-in ones when parsing configuration
public static SignatureFactory	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 SignatureFactory	Returns: The registered extension - `null` if not found unregisterExtension(String The factory name - ignored if `null`/empty name) Unregisters specified extension
public static BuiltinSignatures	valueOf(String name)
public static BuiltinSignatures[]	values()

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

Field Detail

dsa	back to summary
public static final BuiltinSignatures dsa Deprecated Annotations @Deprecated See Also SSHD-1004

dsa_cert	back to summary
public static final BuiltinSignatures dsa_cert Deprecated Annotations @Deprecated See Also SSHD-1004

ed25519	back to summary
public static final BuiltinSignatures ed25519

ed25519_cert	back to summary
public static final BuiltinSignatures ed25519_cert

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

factoryName	back to summary
private final String factoryName

nistp256	back to summary
public static final BuiltinSignatures nistp256

nistp256_cert	back to summary
public static final BuiltinSignatures nistp256_cert

nistp384	back to summary
public static final BuiltinSignatures nistp384

nistp384_cert	back to summary
public static final BuiltinSignatures nistp384_cert

nistp521	back to summary
public static final BuiltinSignatures nistp521

nistp521_cert	back to summary
public static final BuiltinSignatures nistp521_cert

rsa	back to summary
public static final BuiltinSignatures rsa

rsa_cert	back to summary
public static final BuiltinSignatures rsa_cert Deprecated Annotations @Deprecated See Also SSHD-1004

rsaSHA256	back to summary
public static final BuiltinSignatures rsaSHA256

rsaSHA256_cert	back to summary
public static final BuiltinSignatures rsaSHA256_cert

rsaSHA512	back to summary
public static final BuiltinSignatures rsaSHA512

rsaSHA512_cert	back to summary
public static final BuiltinSignatures rsaSHA512_cert

sk_ecdsa_sha2_nistp256	back to summary
public static final BuiltinSignatures sk_ecdsa_sha2_nistp256

sk_ssh_ed25519	back to summary
public static final BuiltinSignatures sk_ssh_ed25519

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

Constructor Detail

BuiltinSignatures	back to summary
private BuiltinSignatures(String facName)

Method Detail

fromFactory back to summary

fromFactory	back to summary
public static BuiltinSignatures fromFactory(NamedFactory<Signature> factory) Parameters factory:NamedFactory<Signature> The `org.apache.sshd.common.NamedFactory` for the signature - ignored if `null` Returns:BuiltinSignatures The matching `org.apache.sshd.common.signature.BuiltinSignatures` whose factory name matches (case insensitive) the digest factory name See Also `fromFactoryName(String)`

public static BuiltinSignatures fromFactory(NamedFactory<Signature> factory)

Parameters

factory:NamedFactory<Signature>: The org.apache.sshd.common.NamedFactory for the signature - ignored if null

Returns:BuiltinSignatures

The matching org.apache.sshd.common.signature.BuiltinSignatures whose factory name matches (case insensitive) the digest factory name

See Also

fromFactoryName(String)

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

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

getFactoryByCurveSize	back to summary
public static BuiltinSignatures getFactoryByCurveSize(ECParameterSpec params)

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<SignatureFactory> getRegisteredExtensions() Returns:NavigableSet<SignatureFactory> A `NavigableSet` of the currently registered extensions, sorted according to the factory name (case insensitive)

getSignerByCurveSize	back to summary
public static Signature getSignerByCurveSize(ECParameterSpec params)

isSupported	back to summary
public boolean isSupported() Implements org.apache.sshd.common.OptionalFeature.isSupported. Annotations @Override

isSupported

back to summary

public boolean isSupported()

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

Annotations

@Override

parseSignatureList back to summary

parseSignatureList	back to summary
public static BuiltinSignatures.ParseResult parseSignatureList(String sigs) Parameters sigs:String A comma-separated list of signatures' names - ignored if `null`/empty Returns:BuiltinSignatures.ParseResult A `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

public static BuiltinSignatures.ParseResult parseSignatureList(String sigs)

Parameters

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

Returns:BuiltinSignatures.ParseResult

A 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	back to summary
public static BuiltinSignatures.ParseResult parseSignatureList(String... sigs)

parseSignatureList	back to summary
public static BuiltinSignatures.ParseResult parseSignatureList(Collection<String> sigs)

registerExtension back to summary

registerExtension	back to summary
public static void registerExtension(SignatureFactory extension) Registered a `NamedFactory` to be available besides the built-in ones when parsing configuration Parameters extension:SignatureFactory 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(SignatureFactory extension)

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

Parameters

extension:SignatureFactory: 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 SignatureFactory resolveFactory(String name) Parameters name:String The factory name Returns:SignatureFactory 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 SignatureFactory unregisterExtension(String name) Unregisters specified extension Parameters name:String The factory name - ignored if `null`/empty Returns:SignatureFactory The registered extension - `null` if not found

public static SignatureFactory unregisterExtension(String name)

Unregisters specified extension

Parameters

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

Returns:SignatureFactory

The registered extension - null if not found

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

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

public sealed Enum BuiltinSignatures

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class BuiltinSignatures.ParseResult

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail