Class ClientIdentity
java.lang.Object
org.apache.sshd.client.config.keys.ClientIdentity
Provides keys loading capability from the user's keys folder - e.g.,
id_rsa- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic StringgetIdentityFileName(String type) static Stringstatic StringgetIdentityType(String name) loadDefaultIdentities(boolean strict, FilePasswordProvider provider, LinkOption... options) loadDefaultIdentities(Path dir, boolean strict, FilePasswordProvider provider, LinkOption... options) static KeyPairProviderloadDefaultKeyPairProvider(boolean strict, boolean supportedOnly, FilePasswordProvider provider, LinkOption... options) static KeyPairProviderloadDefaultKeyPairProvider(Path dir, boolean strict, boolean supportedOnly, FilePasswordProvider provider, LinkOption... options) loadIdentities(SessionContext session, Path dir, boolean strict, Collection<String> types, Function<? super String, String> idGenerator, FilePasswordProvider provider, LinkOption... options) Scans a folder and loads all available identity filesscanIdentitiesFolder(Path dir, boolean strict, Collection<String> types, Function<? super String, String> idGenerator, LinkOption... options) Scans a folder for possible identity files
-
Field Details
-
ID_FILE_PREFIX
- See Also:
-
ID_FILE_SUFFIX
- See Also:
-
ID_GENERATOR
-
-
Constructor Details
-
ClientIdentity
private ClientIdentity()
-
-
Method Details
-
getIdentityType
- Parameters:
name- The file name - ignored ifnull/empty- Returns:
- The identity type -
nullif cannot determine it - e.g., does not start with theID_FILE_PREFIX
-
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:
-
loadDefaultKeyPairProvider
public static KeyPairProvider loadDefaultKeyPairProvider(boolean strict, boolean supportedOnly, FilePasswordProvider provider, LinkOption... options) throws IOException, GeneralSecurityException - Parameters:
strict- Iftruethen files that do not have the required access rights are excluded from considerationsupportedOnly- Iftruethen ignore identities that are not supported internallyprovider- AFilePasswordProvider- may benullif the loaded keys are guaranteed not to be encrypted. The argument toFilePasswordProvider#getPasswordis the path of the file whose key is to be loadedoptions- TheLinkOptions to apply when checking for existence- Returns:
- A
KeyPairfor the identities -nullif no identities available (e.g., after filtering unsupported ones or strict permissions) - Throws:
IOException- If failed to access the file systemGeneralSecurityException- If failed to load the keys- See Also:
-
loadDefaultKeyPairProvider
public static KeyPairProvider loadDefaultKeyPairProvider(Path dir, boolean strict, boolean supportedOnly, FilePasswordProvider provider, LinkOption... options) throws IOException, GeneralSecurityException - Parameters:
dir- The folder to scan for the built-in identitiesstrict- Iftruethen files that do not have the required access rights are excluded from considerationsupportedOnly- Iftruethen ignore identities that are not supported internallyprovider- AFilePasswordProvider- may benullif the loaded keys are guaranteed not to be encrypted. The argument toFilePasswordProvider#getPasswordis the path of the file whose key is to be loadedoptions- TheLinkOptions to apply when checking for existence- Returns:
- A
KeyPairfor the identities -nullif no identities available (e.g., after filtering unsupported ones or strict permissions) - Throws:
IOException- If failed to access the file systemGeneralSecurityException- If failed to load the keys- See Also:
-
loadDefaultIdentities
public static Map<String,KeyPair> loadDefaultIdentities(boolean strict, FilePasswordProvider provider, LinkOption... options) throws IOException, GeneralSecurityException - Parameters:
strict- Iftruethen files that do not have the required access rights are excluded from considerationprovider- AFilePasswordProvider- may benullif the loaded keys are guaranteed not to be encrypted. The argument toFilePasswordProvider#getPasswordis the path of the file whose key is to be loadedoptions- TheLinkOptions to apply when checking for existence- Returns:
- A
Mapof the found files 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:
-
loadDefaultIdentities
public static Map<String,KeyPair> loadDefaultIdentities(Path dir, boolean strict, FilePasswordProvider provider, LinkOption... options) throws IOException, GeneralSecurityException - Parameters:
dir- The folder to scan for the built-in identitiesstrict- Iftruethen files that do not have the required access rights are excluded from considerationprovider- AFilePasswordProvider- may benullif the loaded keys are guaranteed not to be encrypted. The argument toFilePasswordProvider#getPasswordis the path of the file whose key is to be loadedoptions- TheLinkOptions to apply when checking for existence- Returns:
- A
Mapof the found files 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:
-
loadIdentities
public static Map<String,KeyPair> loadIdentities(SessionContext session, Path dir, boolean strict, Collection<String> types, Function<? super String, String> idGenerator, FilePasswordProvider provider, LinkOption... options) throws IOException, GeneralSecurityExceptionScans a folder and loads all available identity files- Parameters:
session- TheSessionContextfor invoking this load command - may benullif not invoked within a session context (e.g., offline tool or session unknown).dir- ThePathof the folder to scan - ignored if not existsstrict- Iftruethen files that do not have the required access rights are excluded from considerationtypes- The identity types - ignored ifnull/emptyidGenerator- AFunctionto derive the file name holding the specified typeprovider- AFilePasswordProvider- may benullif the loaded keys are guaranteed not to be encrypted. The argument toFilePasswordProvider#getPasswordis the path of the file whose key is to be loadedoptions- TheLinkOptions to apply when checking for existence- Returns:
- A
Mapof the found files 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
-
scanIdentitiesFolder
public static Map<String,Path> scanIdentitiesFolder(Path dir, boolean strict, Collection<String> types, Function<? super String, String> idGenerator, LinkOption... options) throws IOExceptionScans a folder for possible identity files- Parameters:
dir- ThePathof the folder to scan - ignored if not existsstrict- Iftruethen files that do not have the required access rights are excluded from considerationtypes- The identity types - ignored ifnull/emptyidGenerator- AFunctionto derive the file name holding the specified typeoptions- TheLinkOptions to apply when checking for existence- Returns:
- A
Mapof the found files where key=identity type (case insensitive), value=thePathof the file holding the key - Throws:
IOException- If failed to access the file system- See Also:
-