Class ServerIdentity
java.lang.Object
org.apache.sshd.server.config.keys.ServerIdentity
Loads server identity key files - e.g.,
/etc/ssh/ssh_host_rsa_key- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfindCertificates(Properties props, LinkOption... options) findIdentities(Properties props, LinkOption... options) static StringgetIdentityFileName(String type) static Stringstatic StringgetIdentityType(String name) getLocations(String configPropKey, Properties props, LinkOption... options) loadIdentities(Properties props, LinkOption... options) static KeyPairProviderloadKeyPairProvider(Properties props, boolean supportedOnly, LinkOption... options) static <S extends SshServer>
SsetKeyPairProvider(S server, Properties props, boolean supportedOnly) Sets the server'sKeyPairProviderwith the loaded identities - if any
-
Field Details
-
ID_FILE_PREFIX
- See Also:
-
ID_FILE_SUFFIX
- See Also:
-
HOST_KEY_CONFIG_PROP
The server's keys configuration multi-value- See Also:
-
HOST_CERT_CONFIG_PROP
- See Also:
-
ID_GENERATOR
-
-
Constructor Details
-
ServerIdentity
private ServerIdentity()
-
-
Method Details
-
setKeyPairProvider
public static <S extends SshServer> S setKeyPairProvider(S server, Properties props, boolean supportedOnly) throws IOException, GeneralSecurityException Sets the server'sKeyPairProviderwith the loaded identities - if any- Type Parameters:
S- The generic server type- Parameters:
server- TheSshServerto configureprops- ThePropertiesholding the server's configuration - ignored ifnull/emptysupportedOnly- Iftruethen ignore identities that are not supported internally- Returns:
- The updated server
- Throws:
IOException- If failed to access the file systemGeneralSecurityException- If failed to load the keys- See Also:
-
loadKeyPairProvider
public static KeyPairProvider loadKeyPairProvider(Properties props, boolean supportedOnly, LinkOption... options) throws IOException, GeneralSecurityException - Parameters:
props- ThePropertiesholding the server's configuration - ignored ifnull/emptysupportedOnly- Iftruethen ignore identities that are not supported internallyoptions- TheLinkOptions to use when checking files existence- Returns:
- A
KeyPairfor the identities -nullif no identities available (e.g., after filtering unsupported ones) - Throws:
IOException- If failed to access the file systemGeneralSecurityException- If failed to load the keys- See Also:
-
loadIdentities
public static Map<String,KeyPair> loadIdentities(Properties props, LinkOption... options) throws IOException, GeneralSecurityException - Parameters:
props- ThePropertiesholding the server's configuration - ignored ifnull/emptyoptions- TheLinkOptions to use when checking files existence- Returns:
- A
Mapof the identities where key=identity type (case insensitive), value=theKeyPairof the identity - Throws:
IOException- If failed to access the file systemGeneralSecurityException- If failed to load the keys- See Also:
-
findIdentities
public static Map<String,Path> findIdentities(Properties props, LinkOption... options) throws IOException - Parameters:
props- ThePropertiesholding the server's configuration - ignored ifnull/emptyoptions- TheLinkOptions to use when checking files existence- Returns:
- A
Mapof the found identities where key=the identity type (case insensitive) and value=thePathof the file holding the specific type key - Throws:
IOException- If failed to access the file system- See Also:
-
findCertificates
public static Map<String,Path> findCertificates(Properties props, LinkOption... options) throws IOException - Parameters:
props- ThePropertiesholding the server's configuration - ignored ifnull/emptyoptions- TheLinkOptions to use when checking files existence- Returns:
- A
Mapof the found certificates where key=the identity type (case insensitive) and value=thePathof the file holding the specific type key - Throws:
IOException- If failed to access the file system- See Also:
-
getLocations
private static Map<String,Path> getLocations(String configPropKey, Properties props, LinkOption... options) throws IOException - Throws:
IOException
-
getIdentityType
- Parameters:
name- The file name - ignored ifnull/empty- Returns:
- The identity type -
nullif cannot determine it - e.g., does not start/end with theID_FILE_PREFIX/ID_FILE_SUFFIX
-
getIdentityFileName
-
getIdentityFileName
- Parameters:
type- The identity type - e.g.,rsa- ignored ifnull/empty- Returns:
- The matching file name for the identity -
nullif no name - See Also:
-