Package org.apache.sshd.server.config.keys

Class ServerIdentity

java.lang.Object

org.apache.sshd.server.config.keys.ServerIdentity

public final class ServerIdentity
extends Object

Loads server identity key files - e.g., /etc/ssh/ssh_host_rsa_key

Author:

Apache MINA SSHD Project

See Also:

• SecurityUtils.getKeyPairResourceParser()

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HOST_CERT_CONFIG_PROP
static final String	HOST_KEY_CONFIG_PROP	The server's keys configuration multi-value
static final String	ID_FILE_PREFIX
static final String	ID_FILE_SUFFIX
static final Function<String,String>	ID_GENERATOR

Method Summary

Modifier and Type	Method	Description
static Map<String,Path>	findCertificates(Properties props, LinkOption... options)
static Map<String,Path>	findIdentities(Properties props, LinkOption... options)
static String	getIdentityFileName(String type)
static String	getIdentityFileName(NamedResource r)
static String	getIdentityType(String name)
static Map<String,KeyPair>	loadIdentities(Properties props, LinkOption... options)
static KeyPairProvider	loadKeyPairProvider(Properties props, boolean supportedOnly, LinkOption... options)
static <S extends SshServer> S	setKeyPairProvider(S server, Properties props, boolean supportedOnly)	Sets the server's KeyPairProvider with the loaded identities - if any

Methods inherited from class java.lang.Object

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

Field Details

ID_FILE_PREFIX

public static final String ID_FILE_PREFIX

See Also:

• Constant Field Values

ID_FILE_SUFFIX

public static final String ID_FILE_SUFFIX

See Also:

• Constant Field Values

HOST_KEY_CONFIG_PROP

public static final String HOST_KEY_CONFIG_PROP

The server's keys configuration multi-value

See Also:

• Constant Field Values

HOST_CERT_CONFIG_PROP

public static final String HOST_CERT_CONFIG_PROP

See Also:

• Constant Field Values

ID_GENERATOR

public static final Function<String,String> ID_GENERATOR

Method Details

setKeyPairProvider

public static <S extends SshServer> S setKeyPairProvider(S server,
 Properties props,
 boolean supportedOnly)
                                                  throws IOException,
GeneralSecurityException

Sets the server's KeyPairProvider with the loaded identities - if any

Type Parameters:

S - The generic server type

Parameters:

server - The SshServer to configure

props - The Properties holding the server's configuration - ignored if null/empty

supportedOnly - If true then ignore identities that are not supported internally

Returns:

The updated server

Throws:

IOException - If failed to access the file system

GeneralSecurityException - If failed to load the keys

See Also:

• loadKeyPairProvider(Properties, boolean, LinkOption...)

loadKeyPairProvider

public static KeyPairProvider loadKeyPairProvider(Properties props,
 boolean supportedOnly,
 LinkOption... options)
                                           throws IOException,
GeneralSecurityException

Parameters:

props - The Properties holding the server's configuration - ignored if null/empty

supportedOnly - If true then ignore identities that are not supported internally

options - The LinkOptions to use when checking files existence

Returns:

A KeyPair for the identities - null if no identities available (e.g., after filtering unsupported ones)

Throws:

IOException - If failed to access the file system

GeneralSecurityException - If failed to load the keys

See Also:

• loadIdentities(Properties, LinkOption...)
• IdentityUtils.createKeyPairProvider(Map, boolean)

loadIdentities

public static Map<String,KeyPair> loadIdentities(Properties props,
 LinkOption... options)
                                          throws IOException,
GeneralSecurityException

Parameters:

props - The Properties holding the server's configuration - ignored if null/empty

options - The LinkOptions to use when checking files existence

Returns:

A Map of the identities where key=identity type (case insensitive), value=the KeyPair of the identity

Throws:

IOException - If failed to access the file system

GeneralSecurityException - If failed to load the keys

See Also:

• findIdentities(Properties, LinkOption...)

findIdentities

public static Map<String,Path> findIdentities(Properties props,
 LinkOption... options)
                                       throws IOException

Parameters:

props - The Properties holding the server's configuration - ignored if null/empty

options - The LinkOptions to use when checking files existence

Returns:

A Map of the found identities where key=the identity type (case insensitive) and value=the Path of the file holding the specific type key

Throws:

IOException - If failed to access the file system

See Also:

• getIdentityType(String)
• HOST_KEY_CONFIG_PROP
• ConfigFileReaderSupport.readConfigFile(Path, java.nio.file.OpenOption...)

findCertificates

public static Map<String,Path> findCertificates(Properties props,
 LinkOption... options)
                                         throws IOException

Parameters:

props - The Properties holding the server's configuration - ignored if null/empty

options - The LinkOptions to use when checking files existence

Returns:

A Map of the found certificates where key=the identity type (case insensitive) and value=the Path of the file holding the specific type key

Throws:

IOException - If failed to access the file system

See Also:

• getIdentityType(String)
• HOST_CERT_CONFIG_PROP
• ConfigFileReaderSupport.readConfigFile(Path, java.nio.file.OpenOption...)

getIdentityType

public static String getIdentityType(String name)

Parameters:

name - The file name - ignored if null/empty

Returns:

The identity type - null if cannot determine it - e.g., does not start/end with the ID_FILE_PREFIX/ID_FILE_SUFFIX

getIdentityFileName

public static String getIdentityFileName(NamedResource r)

getIdentityFileName

public static String getIdentityFileName(String type)

Parameters:

type - The identity type - e.g., rsa - ignored if null/empty

Returns:

The matching file name for the identity - null if no name

See Also:

• ID_FILE_PREFIX
• ID_FILE_SUFFIX
• IdentityUtils.getIdentityFileName(String, String, String)