Apache Mina SSHD 2.15.0 · org.apache.sshd.common.config.SshConfigFileReader

Access	Constructor and Description
private	SshConfigFileReader()

Method Summary

Modifier and Type	Method and Description
public static < The generic factory manager M extends AbstractFactoryManager> M	Returns: The configured manager configure(M The `AbstractFactoryManager` to configure manager, PropertyResolver The `PropertyResolver` to use for configuration - Note: if any known configuration value has a default and does not appear in the properties, the default is used props, boolean If `true` then any unknown configuration values are ignored. Otherwise an `IllegalArgumentException` is thrown lenient, boolean filter out unsupported configuration values (e.g., ciphers, key exchanges, etc..) Note if after filtering out all the unknown or unsupported values there is an empty configuration exception is thrown ignoreUnsupported) Configures an `AbstractFactoryManager` with the values read from some configuration.
public static <M extends AbstractFactoryManager> M	configureCiphers(M manager, PropertyResolver props, boolean lenient, boolean ignoreUnsupported)
public static <M extends AbstractFactoryManager> M	configureCiphers(M manager, String value, boolean lenient, boolean ignoreUnsupported)
public static < The generic factory manager M extends AbstractFactoryManager> M	Returns: The configured manager - Note: if the result of filtering due to lenient mode or ignored unsupported value is empty then no factories are set configureCompression(M The `AbstractFactoryManager` to configure manager, PropertyResolver The configuration `Properties` props, boolean If `true` and an unknown value is provided then it is ignored lenient, boolean If `false` then check if the compression is currently supported before setting it ignoreUnsupported) Configure the factory manager using one of the known `CompressionConfigValue`s.
public static <M extends AbstractFactoryManager> M	configureCompression(M manager, String value, boolean lenient, boolean ignoreUnsupported)
public static < The generic factory manager M extends AbstractFactoryManager> M	Returns: The configured manager configureKeyExchanges(M The `AbstractFactoryManager` to set up (may not be `null`) manager, PropertyResolver The (non-`null`) `PropertyResolver` containing the configuration props, boolean If `true` then any unknown/unsupported configuration values are ignored. Otherwise an `IllegalArgumentException` is thrown lenient, Function<? super DHFactory, ? extends KeyExchangeFactory> A `Function` to convert the configured `DHFactory`-ies to `NamedFactory`-ies of `KeyExchange` xformer, boolean Filter out any un-supported configurations - Note: if after ignoring the unknown and un-supported values the result is an empty list of factories and exception is thrown ignoreUnsupported)
public static <M extends AbstractFactoryManager> M	configureKeyExchanges(M manager, String value, boolean lenient, Function<? super DHFactory, ? extends KeyExchangeFactory> xformer, boolean ignoreUnsupported)
public static <M extends AbstractFactoryManager> M	configureMacs(M manager, PropertyResolver resolver, boolean lenient, boolean ignoreUnsupported)
public static <M extends AbstractFactoryManager> M	configureMacs(M manager, String value, boolean lenient, boolean ignoreUnsupported)
public static <M extends AbstractFactoryManager> M	configureSignatures(M manager, PropertyResolver props, boolean lenient, boolean ignoreUnsupported)
public static <M extends AbstractFactoryManager> M	configureSignatures(M manager, String value, boolean lenient, boolean ignoreUnsupported)
public static BuiltinCiphers.ParseResult	Returns: A `ParseResult` of all the `NamedFactory`-ies whose name appears in the string and represent a built-in cipher. Any unknown name is ignored. The order of the returned result is the same as the original order - bar the unknown ciphers Note it is up to caller to ensure that the lists do not contain duplicates getCiphers(PropertyResolver The `PropertyResolver` - ignored if `null`/empty props)
public static CompressionFactory	Returns: The matching `NamedFactory` for the configured value. `null` if no configuration or unknown name specified getCompression(PropertyResolver The `PropertyResolver` - ignored if `null`/empty props)
public static BuiltinDHFactories.ParseResult	Returns: A `ParseResult` of all the `DHFactory`-ies whose name appears in the string and represent a built-in value. Any unknown name is ignored. The order of the returned result is the same as the original order - bar the unknown ones Note it is up to caller to ensure that the list does not contain duplicates getKexFactories(PropertyResolver The `PropertyResolver` - ignored if `null`/empty props)
public static BuiltinMacs.ParseResult	Returns: A `ParseResult` of all the `NamedFactory`-ies whose name appears in the string and represent a built-in MAC. Any unknown name is ignored. The order of the returned result is the same as the original order - bar the unknown MACs Note it is up to caller to ensure that the list does not contain duplicates getMacs(PropertyResolver The `PropertyResolver` - ignored if `null`/empty props)
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 getSignatures(PropertyResolver The `PropertyResolver` - ignored if `null`/empty props)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

SshConfigFileReader	back to summary
private SshConfigFileReader()

Method Detail

configure back to summary

configure	back to summary
public static <M extends AbstractFactoryManager> M configure(M manager, PropertyResolver props, boolean lenient, boolean ignoreUnsupported) Configures an `AbstractFactoryManager` with the values read from some configuration. Currently it configures: The `Cipher`s - via the `ConfigFileReaderSupport#CIPHERS_CONFIG_PROP` The `Mac`s - via the `ConfigFileReaderSupport#MACS_CONFIG_PROP` The `Signature`s - via the `ConfigFileReaderSupport#HOST_KEY_ALGORITHMS_CONFIG_PROP` The `Compression` - via the `ConfigFileReaderSupport#COMPRESSION_PROP` Parameters <M> The generic factory manager manager:M The `AbstractFactoryManager` to configure props:PropertyResolver The `PropertyResolver` to use for configuration - Note: if any known configuration value has a default and does not appear in the properties, the default is used lenient:boolean If `true` then any unknown configuration values are ignored. Otherwise an `IllegalArgumentException` is thrown ignoreUnsupported:boolean filter out unsupported configuration values (e.g., ciphers, key exchanges, etc..) Note if after filtering out all the unknown or unsupported values there is an empty configuration exception is thrown Returns:M The configured manager

public static <M extends AbstractFactoryManager> M configure(M manager, PropertyResolver props, boolean lenient, boolean ignoreUnsupported)

Configures an AbstractFactoryManager with the values read from some configuration. Currently it configures:

The Ciphers - via the ConfigFileReaderSupport#CIPHERS_CONFIG_PROP
The Macs - via the ConfigFileReaderSupport#MACS_CONFIG_PROP
The Signatures - via the ConfigFileReaderSupport#HOST_KEY_ALGORITHMS_CONFIG_PROP
The Compression - via the ConfigFileReaderSupport#COMPRESSION_PROP

Parameters

<M>: The generic factory manager
manager:M: The AbstractFactoryManager to configure
props:PropertyResolver: The PropertyResolver to use for configuration - Note: if any known configuration value has a default and does not appear in the properties, the default is used
lenient:boolean: If true then any unknown configuration values are ignored. Otherwise an IllegalArgumentException is thrown
ignoreUnsupported:boolean: filter out unsupported configuration values (e.g., ciphers, key exchanges, etc..)
Note
if after filtering out all the unknown or unsupported values there is an empty configuration exception is thrown

Returns:M

The configured manager

configureCiphers	back to summary
public static <M extends AbstractFactoryManager> M configureCiphers(M manager, PropertyResolver props, boolean lenient, boolean ignoreUnsupported)

configureCiphers	back to summary
public static <M extends AbstractFactoryManager> M configureCiphers(M manager, String value, boolean lenient, boolean ignoreUnsupported)

configureCompression back to summary

configureCompression	back to summary
public static <M extends AbstractFactoryManager> M configureCompression(M manager, PropertyResolver props, boolean lenient, boolean ignoreUnsupported) Configure the factory manager using one of the known `CompressionConfigValue`s. Parameters <M> The generic factory manager manager:M The `AbstractFactoryManager` to configure props:PropertyResolver The configuration `Properties` lenient:boolean If `true` and an unknown value is provided then it is ignored ignoreUnsupported:boolean If `false` then check if the compression is currently supported before setting it Returns:M The configured manager - Note: if the result of filtering due to lenient mode or ignored unsupported value is empty then no factories are set

public static <M extends AbstractFactoryManager> M configureCompression(M manager, PropertyResolver props, boolean lenient, boolean ignoreUnsupported)

Configure the factory manager using one of the known CompressionConfigValues.

Parameters

<M>: The generic factory manager
manager:M: The AbstractFactoryManager to configure
props:PropertyResolver: The configuration Properties
lenient:boolean: If true and an unknown value is provided then it is ignored
ignoreUnsupported:boolean: If false then check if the compression is currently supported before setting it

Returns:M

The configured manager - Note: if the result of filtering due to lenient mode or ignored unsupported value is empty then no factories are set

configureCompression	back to summary
public static <M extends AbstractFactoryManager> M configureCompression(M manager, String value, boolean lenient, boolean ignoreUnsupported)

configureKeyExchanges back to summary

configureKeyExchanges	back to summary
public static <M extends AbstractFactoryManager> M configureKeyExchanges(M manager, PropertyResolver props, boolean lenient, Function<? super DHFactory, ? extends KeyExchangeFactory> xformer, boolean ignoreUnsupported) Parameters <M> The generic factory manager manager:M The `AbstractFactoryManager` to set up (may not be `null`) props:PropertyResolver The (non-`null`) `PropertyResolver` containing the configuration lenient:boolean If `true` then any unknown/unsupported configuration values are ignored. Otherwise an `IllegalArgumentException` is thrown xformer:Function<? super DHFactory, ? extends KeyExchangeFactory> A `Function` to convert the configured `DHFactory`-ies to `NamedFactory`-ies of `KeyExchange` ignoreUnsupported:boolean Filter out any un-supported configurations - Note: if after ignoring the unknown and un-supported values the result is an empty list of factories and exception is thrown Returns:M The configured manager See Also `KEX_ALGORITHMS_CONFIG_PROP`

public static <M extends AbstractFactoryManager> M configureKeyExchanges(M manager, PropertyResolver props, boolean lenient, Function<? super DHFactory, ? extends KeyExchangeFactory> xformer, boolean ignoreUnsupported)

Parameters

<M>: The generic factory manager
manager:M: The AbstractFactoryManager to set up (may not be null)
props:PropertyResolver: The (non-null) PropertyResolver containing the configuration
lenient:boolean: If true then any unknown/unsupported configuration values are ignored. Otherwise an IllegalArgumentException is thrown
xformer:Function<? super DHFactory, ? extends KeyExchangeFactory>: A Function to convert the configured DHFactory-ies to NamedFactory-ies of KeyExchange
ignoreUnsupported:boolean: Filter out any un-supported configurations - Note: if after ignoring the unknown and un-supported values the result is an empty list of factories and exception is thrown

Returns:M

The configured manager

See Also

KEX_ALGORITHMS_CONFIG_PROP

configureKeyExchanges	back to summary
public static <M extends AbstractFactoryManager> M configureKeyExchanges(M manager, String value, boolean lenient, Function<? super DHFactory, ? extends KeyExchangeFactory> xformer, boolean ignoreUnsupported)

configureMacs	back to summary
public static <M extends AbstractFactoryManager> M configureMacs(M manager, PropertyResolver resolver, boolean lenient, boolean ignoreUnsupported)

configureMacs	back to summary
public static <M extends AbstractFactoryManager> M configureMacs(M manager, String value, boolean lenient, boolean ignoreUnsupported)

configureSignatures	back to summary
public static <M extends AbstractFactoryManager> M configureSignatures(M manager, PropertyResolver props, boolean lenient, boolean ignoreUnsupported)

configureSignatures	back to summary
public static <M extends AbstractFactoryManager> M configureSignatures(M manager, String value, boolean lenient, boolean ignoreUnsupported)

getCiphers back to summary

getCiphers	back to summary
public static BuiltinCiphers.ParseResult getCiphers(PropertyResolver props) Parameters props:PropertyResolver The `PropertyResolver` - ignored if `null`/empty Returns:BuiltinCiphers.ParseResult A `ParseResult` of all the `NamedFactory`-ies whose name appears in the string and represent a built-in cipher. Any unknown name is ignored. The order of the returned result is the same as the original order - bar the unknown ciphers Note it is up to caller to ensure that the lists do not contain duplicates See Also `CIPHERS_CONFIG_PROP`, `BuiltinCiphers#parseCiphersList(String)`

public static BuiltinCiphers.ParseResult getCiphers(PropertyResolver props)

Parameters

props:PropertyResolver: The PropertyResolver - ignored if null/empty

Returns:BuiltinCiphers.ParseResult

A ParseResult of all the NamedFactory-ies whose name appears in the string and represent a built-in cipher. Any unknown name is ignored. The order of the returned result is the same as the original order - bar the unknown ciphers

Note

it is up to caller to ensure that the lists do not contain duplicates

getCompression	back to summary
public static CompressionFactory getCompression(PropertyResolver props) Parameters props:PropertyResolver The `PropertyResolver` - ignored if `null`/empty Returns:CompressionFactory The matching `NamedFactory` for the configured value. `null` if no configuration or unknown name specified See Also `COMPRESSION_PROP`

getKexFactories back to summary

getKexFactories	back to summary
public static BuiltinDHFactories.ParseResult getKexFactories(PropertyResolver props) Parameters props:PropertyResolver The `PropertyResolver` - ignored if `null`/empty Returns:BuiltinDHFactories.ParseResult A `ParseResult` of all the `DHFactory`-ies whose name appears in the string and represent a built-in value. Any unknown name is ignored. The order of the returned result is the same as the original order - bar the unknown ones Note it is up to caller to ensure that the list does not contain duplicates See Also `KEX_ALGORITHMS_CONFIG_PROP`, `BuiltinDHFactories#parseDHFactoriesList(String)`

public static BuiltinDHFactories.ParseResult getKexFactories(PropertyResolver props)

Parameters

props:PropertyResolver: The PropertyResolver - ignored if null/empty

Returns:BuiltinDHFactories.ParseResult

A ParseResult of all the DHFactory-ies whose name appears in the string and represent a built-in value. Any unknown name is ignored. The order of the returned result is the same as the original order - bar the unknown ones

Note

it is up to caller to ensure that the list does not contain duplicates

getMacs back to summary

getMacs	back to summary
public static BuiltinMacs.ParseResult getMacs(PropertyResolver props) Parameters props:PropertyResolver The `PropertyResolver` - ignored if `null`/empty Returns:BuiltinMacs.ParseResult A `ParseResult` of all the `NamedFactory`-ies whose name appears in the string and represent a built-in MAC. Any unknown name is ignored. The order of the returned result is the same as the original order - bar the unknown MACs Note it is up to caller to ensure that the list does not contain duplicates See Also `MACS_CONFIG_PROP`, `BuiltinMacs#parseMacsList(String)`

public static BuiltinMacs.ParseResult getMacs(PropertyResolver props)

Parameters

props:PropertyResolver: The PropertyResolver - ignored if null/empty

Returns:BuiltinMacs.ParseResult

A ParseResult of all the NamedFactory-ies whose name appears in the string and represent a built-in MAC. Any unknown name is ignored. The order of the returned result is the same as the original order - bar the unknown MACs

Note

it is up to caller to ensure that the list does not contain duplicates

getSignatures back to summary

getSignatures	back to summary
public static BuiltinSignatures.ParseResult getSignatures(PropertyResolver props) Parameters props:PropertyResolver The `PropertyResolver` - 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 See Also `HOST_KEY_ALGORITHMS_CONFIG_PROP`, `BuiltinSignatures#parseSignatureList(String)`

public static BuiltinSignatures.ParseResult getSignatures(PropertyResolver props)

Parameters

props:PropertyResolver: The PropertyResolver - 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 final Class SshConfigFileReader

Constructor Summary

Method Summary

Constructor Detail

Method Detail