Interface SecurityProviderRegistrar
-
- All Superinterfaces:
NamedResource
,OptionalFeature
,PropertyResolver
,SecurityProviderChoice
- All Known Implementing Classes:
AbstractSecurityProviderRegistrar
,BouncyCastleSecurityProviderRegistrar
,EdDSASecurityProviderRegistrar
,SunJCESecurityProviderRegistrar
public interface SecurityProviderRegistrar extends SecurityProviderChoice, OptionalFeature, PropertyResolver
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ALL_OPTIONS_VALUE
static java.lang.String
ALL_OPTIONS_WILDCARD
static java.lang.String
CONFIG_PROP_BASE
Base name for configuration properties related to security providersstatic java.lang.String
ENABLED_PROPERTY
Property used to configure whether the provider is enabled regardless of whether it is supported.static java.lang.String
NAMED_PROVIDER_PROPERTY
Property used to configure whether to use the provider's name rather than itsProvider
instancestatic java.lang.String
NO_OPTIONS_VALUE
static java.util.List<java.lang.Class<?>>
SECURITY_ENTITIES
All the entities that are used in calls toisSecurityEntitySupported(Class, String)
-
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 inherited from interface org.apache.sshd.common.PropertyResolver
EMPTY
-
Fields inherited from interface org.apache.sshd.common.util.security.SecurityProviderChoice
EMPTY
-
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static SecurityProviderRegistrar
findSecurityProviderRegistrarBySecurityEntity(java.util.function.Predicate<? super SecurityProviderRegistrar> entitySelector, java.util.Collection<? extends SecurityProviderRegistrar> registrars)
default java.lang.String
getBasePropertyName()
default java.lang.String
getConfigurationPropertyName(java.lang.String name)
default java.lang.String
getDefaultSecurityEntitySupportValue(java.lang.Class<?> entityType)
static java.lang.String
getEffectiveSecurityEntityName(java.lang.Class<?> entityType, java.lang.String name)
Determines the "pure" security entity name - e.g., forCipher
s it strips the trailing transformation specification in order to extract the base cipher name - e.g., "AES/CBC/NoPadding" => "AES"default PropertyResolver
getParentPropertyResolver()
default java.util.Map<java.lang.String,java.lang.Object>
getProperties()
A map of properties that can be used to configure the SSH server or client.static boolean
isAllOptionsValue(java.lang.String v)
default boolean
isCertificateFactorySupported(java.lang.String type)
default boolean
isCipherSupported(java.lang.String transformation)
default boolean
isEnabled()
default boolean
isKeyAgreementSupported(java.lang.String algorithm)
default boolean
isKeyFactorySupported(java.lang.String algorithm)
default boolean
isKeyPairGeneratorSupported(java.lang.String algorithm)
default boolean
isMacSupported(java.lang.String algorithm)
default boolean
isMessageDigestSupported(java.lang.String algorithm)
default boolean
isNamedProviderUsed()
default boolean
isSecurityEntitySupported(java.lang.Class<?> entityType, java.lang.String name)
static boolean
isSecurityEntitySupported(PropertyResolver resolver, java.lang.String propName, java.lang.Class<?> entityType, java.lang.String name, java.lang.String defaultValue)
static boolean
isSecurityEntitySupported(SecurityProviderRegistrar registrar, java.lang.Class<?> entityType, java.lang.String name, java.lang.String defaultValue)
Checks whether the requested entity type algorithm/name is listed as supported by the registrar's configurationdefault boolean
isSignatureSupported(java.lang.String algorithm)
static boolean
registerSecurityProvider(SecurityProviderRegistrar registrar)
Attempts to register the security provider represented by the registrar if not already registered.-
Methods inherited from interface org.apache.sshd.common.NamedResource
getName
-
Methods inherited from interface org.apache.sshd.common.OptionalFeature
isSupported
-
Methods inherited from interface org.apache.sshd.common.PropertyResolver
getBoolean, getBooleanProperty, getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getString, getStringProperty, isEmpty
-
Methods inherited from interface org.apache.sshd.common.util.security.SecurityProviderChoice
getProviderName, getSecurityProvider
-
-
-
-
Field Detail
-
CONFIG_PROP_BASE
static final java.lang.String CONFIG_PROP_BASE
Base name for configuration properties related to security providers- See Also:
- Constant Field Values
-
ENABLED_PROPERTY
static final java.lang.String ENABLED_PROPERTY
Property used to configure whether the provider is enabled regardless of whether it is supported.- See Also:
isEnabled()
, Constant Field Values
-
NAMED_PROVIDER_PROPERTY
static final java.lang.String NAMED_PROVIDER_PROPERTY
Property used to configure whether to use the provider's name rather than itsProvider
instance- See Also:
isNamedProviderUsed()
, Constant Field Values
-
ALL_OPTIONS_VALUE
static final java.lang.String ALL_OPTIONS_VALUE
- See Also:
- Constant Field Values
-
ALL_OPTIONS_WILDCARD
static final java.lang.String ALL_OPTIONS_WILDCARD
- See Also:
- Constant Field Values
-
NO_OPTIONS_VALUE
static final java.lang.String NO_OPTIONS_VALUE
- See Also:
- Constant Field Values
-
SECURITY_ENTITIES
static final java.util.List<java.lang.Class<?>> SECURITY_ENTITIES
All the entities that are used in calls toisSecurityEntitySupported(Class, String)
-
-
Method Detail
-
getBasePropertyName
default java.lang.String getBasePropertyName()
-
getConfigurationPropertyName
default java.lang.String getConfigurationPropertyName(java.lang.String name)
-
isEnabled
default 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 viaSecurityUtils.setAPrioriDisabledProvider(String, boolean)
- See Also:
ENABLED_PROPERTY
-
getParentPropertyResolver
default PropertyResolver getParentPropertyResolver()
- Specified by:
getParentPropertyResolver
in interfacePropertyResolver
- Returns:
- The parent resolver that can be used to query for missing properties -
null
if no parent
-
getProperties
default java.util.Map<java.lang.String,java.lang.Object> getProperties()
Description copied from interface:PropertyResolver
A map of properties that can be used to configure the SSH server or client. This map will never be changed by either the server or client and is not supposed to be changed at runtime (changes are not bound to have any effect on a running client or server), though it may affect the creation of sessions later as these values are usually not cached.
Note: the type of the mapped property should match the expected configuration value type -
Long, Integer, Boolean, String
, etc.... If it doesn't, thetoString()
result of the mapped value is used to convert it to the required type. E.g., if the mapped value is the string "1234" and the expected value is along
then it will be parsed into one. Also, if the mapped value is anInteger
but along
is expected, then it will be converted into one.- Specified by:
getProperties
in interfacePropertyResolver
- Returns:
- a valid
Map
containing configuration values, nevernull
. Note: may be immutable.
-
isCipherSupported
default boolean isCipherSupported(java.lang.String transformation)
- Parameters:
transformation
- The requestedCipher
transformation- Returns:
true
if this security provider supports the transformation- See Also:
isSecurityEntitySupported(Class, String)
-
isKeyFactorySupported
default boolean isKeyFactorySupported(java.lang.String algorithm)
- Parameters:
algorithm
- TheKeyFactory
algorithm- Returns:
true
if this security provider supports the algorithm- See Also:
isSecurityEntitySupported(Class, String)
-
isMessageDigestSupported
default boolean isMessageDigestSupported(java.lang.String algorithm)
- Parameters:
algorithm
- TheMessageDigest
algorithm- Returns:
true
if this security provider supports the algorithm- See Also:
isSecurityEntitySupported(Class, String)
-
isKeyPairGeneratorSupported
default boolean isKeyPairGeneratorSupported(java.lang.String algorithm)
- Parameters:
algorithm
- TheKeyPairGenerator
algorithm- Returns:
true
if this security provider supports the algorithm- See Also:
isSecurityEntitySupported(Class, String)
-
isKeyAgreementSupported
default boolean isKeyAgreementSupported(java.lang.String algorithm)
- Parameters:
algorithm
- TheKeyAgreement
algorithm- Returns:
true
if this security provider supports the algorithm- See Also:
isSecurityEntitySupported(Class, String)
-
isMacSupported
default boolean isMacSupported(java.lang.String algorithm)
- Parameters:
algorithm
- TheMac
algorithm- Returns:
true
if this security provider supports the algorithm- See Also:
isSecurityEntitySupported(Class, String)
-
isSignatureSupported
default boolean isSignatureSupported(java.lang.String algorithm)
- Parameters:
algorithm
- TheSignature
algorithm- Returns:
true
if this security provider supports the algorithm- See Also:
isSecurityEntitySupported(Class, String)
-
isCertificateFactorySupported
default boolean isCertificateFactorySupported(java.lang.String type)
- Parameters:
type
- TheCertificateFactory
type- Returns:
true
if this security provider supports the algorithm- See Also:
isSecurityEntitySupported(Class, String)
-
getDefaultSecurityEntitySupportValue
default java.lang.String getDefaultSecurityEntitySupportValue(java.lang.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:
isSecurityEntitySupported(Class, String)
-
isSecurityEntitySupported
default boolean isSecurityEntitySupported(java.lang.Class<?> entityType, java.lang.String name)
-
isNamedProviderUsed
default boolean isNamedProviderUsed()
- Specified by:
isNamedProviderUsed
in interfaceSecurityProviderChoice
- Returns:
true
if to use the provider's name rather than itsProvider
instance - default=true
- See Also:
NAMED_PROVIDER_PROPERTY
,SecurityProviderChoice.getSecurityProvider()
,registerSecurityProvider(SecurityProviderRegistrar)
-
isAllOptionsValue
static boolean isAllOptionsValue(java.lang.String v)
- Parameters:
v
- Value to be examined- Returns:
true
if the value equals (case insensitive) to eitherALL_OPTIONS_VALUE
orALL_OPTIONS_WILDCARD
-
isSecurityEntitySupported
static boolean isSecurityEntitySupported(SecurityProviderRegistrar registrar, java.lang.Class<?> entityType, java.lang.String name, java.lang.String defaultValue)
Checks whether the requested entity type algorithm/name is listed as supported by the registrar's configuration- Parameters:
registrar
- TheSecurityProviderRegistrar
entityType
- The requested entity type - its simple name serves to build the configuration property name.name
- The requested algorithm/name - Note: if the requested entity is aCipher
then the argument is assumed to be a possible "/" separated transformation and parsed as such in order to retrieve the pure cipher namedefaultValue
- Configuration value to use if no specific configuration provided- Returns:
true
registrar is supported and the value is listed (case insensitive) or * the property is one of the "all" markers- See Also:
OptionalFeature.isSupported()
,isAllOptionsValue(String)
-
isSecurityEntitySupported
static boolean isSecurityEntitySupported(PropertyResolver resolver, java.lang.String propName, java.lang.Class<?> entityType, java.lang.String name, java.lang.String defaultValue)
-
getEffectiveSecurityEntityName
static java.lang.String getEffectiveSecurityEntityName(java.lang.Class<?> entityType, java.lang.String name)
Determines the "pure" security entity name - e.g., forCipher
s it strips the trailing transformation specification in order to extract the base cipher name - e.g., "AES/CBC/NoPadding" => "AES"- Parameters:
entityType
- The security entity type - ignored ifnull
name
- The effective name - ignored ifnull
/empty- Returns:
- The resolved name
-
registerSecurityProvider
static boolean registerSecurityProvider(SecurityProviderRegistrar registrar)
Attempts to register the security provider represented by the registrar if not already registered. Note: ifisNamedProviderUsed()
istrue
then the generated provider will be added to the system's list of known providers.- Parameters:
registrar
- TheSecurityProviderRegistrar
- Returns:
true
if no provider was previously registered- See Also:
Security.getProvider(String)
,SecurityProviderChoice.getSecurityProvider()
,Security.addProvider(Provider)
-
findSecurityProviderRegistrarBySecurityEntity
static SecurityProviderRegistrar findSecurityProviderRegistrarBySecurityEntity(java.util.function.Predicate<? super SecurityProviderRegistrar> entitySelector, java.util.Collection<? extends SecurityProviderRegistrar> registrars)
-
-