Class SunECSecurityProviderRegistrar

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.util.security.AbstractSecurityProviderRegistrar

org.apache.sshd.common.util.security.SunECSecurityProviderRegistrar

All Implemented Interfaces:

NamedResource, OptionalFeature, PropertyResolver, PublicKeyFactory, SecurityProviderChoice, SecurityProviderRegistrar

public class SunECSecurityProviderRegistrar
extends AbstractSecurityProviderRegistrar

This is registrar ensures that even if other registrars are active, we still use the Java built-in security provider at least for some security entities.

This registrar can be used to enforce using some security entities from the JDK's SunEC provider even if other registrars also provide the same entity. Care should be taken to use consistent configurations. For instance, to use EC keys from this provider instead of Bouncy Castle, all of "KeyPairGenerator", "KeyFactory", and "Signature" should be set correctly. Mixing SunEC keys with Bouncy Castle signatures won't work.

This registrar is enabled by default. It can be disabled via a system property org.apache.sshd.security.provider.SunECWrapper.enabled=false.

The registrar can be configured as usual. By default are enabled:

"Ed25519"

KeyFactory, KeyPairGenerator, and Signature, if "Ed25519" is supported by SunEC

"X25519"

KeyAgreement, KeyFactory, and KeyPairGenerator, if "X25519" is supported by SunEC

"X448"

KeyAgreement, KeyFactory, and KeyPairGenerator, if "X448" is supported by SunEC

Everything else is disabled.

Author:

Apache MINA SSHD Project

Field Summary

Fields inherited from class AbstractSecurityProviderRegistrar

props, providerHolder, supportedEntities

Fields inherited from class AbstractLoggingBean

log

Fields inherited from interface NamedResource

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Fields inherited from interface OptionalFeature

FALSE, TRUE

Fields inherited from interface PropertyResolver

EMPTY

Fields inherited from interface SecurityProviderChoice

EMPTY

Fields inherited from interface SecurityProviderRegistrar

ALL_OPTIONS_VALUE, ALL_OPTIONS_WILDCARD, CONFIG_PROP_BASE, ENABLED_PROPERTY, NAMED_PROVIDER_PROPERTY, NO_OPTIONS_VALUE, SECURITY_ENTITIES

Constructor Summary

Constructors

Constructor	Description
SunECSecurityProviderRegistrar()

Method Summary

Modifier and Type	Method	Description
Boolean	getBoolean(String name)
boolean	getBooleanProperty(String name, boolean def)
String	getDefaultSecurityEntitySupportValue(Class<?> entityType)
String	getProviderName()	Retrieves the underlying Provider's name.
Provider	getSecurityProvider()
String	getString(String name)
boolean	isEnabled()
boolean	isNamedProviderUsed()
boolean	isSupported()

Methods inherited from class AbstractSecurityProviderRegistrar

createProviderInstance, getName, getOrCreateProvider, getProperties, isSecurityEntitySupported, toString

Methods inherited from class AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface PropertyResolver

getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getStringProperty, isEmpty

Methods inherited from interface SecurityProviderChoice

getFactory

Methods inherited from interface SecurityProviderRegistrar

getBasePropertyName, getConfigurationPropertyName, getParentPropertyResolver, getPublicKey, isCertificateFactorySupported, isCipherSupported, isKEMSupported, isKeyAgreementSupported, isKeyFactorySupported, isKeyPairGeneratorSupported, isMacSupported, isMessageDigestSupported, isSignatureSupported

Constructor Details

SunECSecurityProviderRegistrar

public SunECSecurityProviderRegistrar()

Method Details

isEnabled

public boolean isEnabled()

Returns:

true if the provider is enabled regardless of whether it is supported - default=true. Note: checks if the provider has been programmatically disabled via SecurityUtils.setAPrioriDisabledProvider(String, boolean)

See Also:

• SecurityProviderRegistrar.ENABLED_PROPERTY

getProviderName

public String getProviderName()

Description copied from interface: SecurityProviderChoice

Retrieves the underlying Provider's name.

Returns:

the Provider's name

getDefaultSecurityEntitySupportValue

public String getDefaultSecurityEntitySupportValue(Class<?> entityType)

Parameters:

entityType - The requested entity type - its simple name serves to build the configuration property name.

Returns:

Configuration value to use if no specific configuration provided - default=empty

See Also:

• SecurityProviderRegistrar.isSecurityEntitySupported(Class, String)

getBoolean

public Boolean getBoolean(String name)

getBooleanProperty

public boolean getBooleanProperty(String name,
 boolean def)

getString

public String getString(String name)

isNamedProviderUsed

public boolean isNamedProviderUsed()

Returns:

true if to use the provider's name rather than its Provider instance - default=true

See Also:

• SecurityProviderRegistrar.NAMED_PROVIDER_PROPERTY
• SecurityProviderChoice.getSecurityProvider()
• SecurityProviderRegistrar.registerSecurityProvider(SecurityProviderRegistrar)

getSecurityProvider

public Provider getSecurityProvider()

Returns:

The security Provider to use in case SecurityProviderChoice.isNamedProviderUsed() is false. Can be null if SecurityProviderChoice.isNamedProviderUsed() is true, but not recommended.

isSupported

public boolean isSupported()