Class IdentityUtils
- java.lang.Object
-
- org.apache.sshd.common.config.keys.IdentityUtils
-
public final class IdentityUtils extends Object
- Author:
- Apache MINA SSHD Project
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static KeyPairProvider
createKeyPairProvider(Map<String,KeyPair> ids, boolean supportedOnly)
static String
getIdentityFileName(String prefix, String type, String suffix)
static Path
getUserHomeFolder()
static NavigableMap<String,KeyPair>
loadIdentities(SessionContext session, Map<String,? extends Path> paths, FilePasswordProvider provider, OpenOption... options)
-
-
-
Method Detail
-
getUserHomeFolder
public static Path getUserHomeFolder()
- Returns:
- The
Path
to the currently running user home
-
getIdentityFileName
public static String getIdentityFileName(String prefix, String type, String suffix)
- Parameters:
prefix
- The file name prefix - ignored ifnull
/emptytype
- The identity type - ignored ifnull
/emptysuffix
- The file name suffix - ignored ifnull
/empty- Returns:
- The identity file name or
null
if no name
-
createKeyPairProvider
public static KeyPairProvider createKeyPairProvider(Map<String,KeyPair> ids, boolean supportedOnly)
- Parameters:
ids
- AMap
of the loaded identities where key=the identity type, value=the matchingKeyPair
- ignored ifnull
/emptysupportedOnly
- Iftrue
then ignore identities that are not supported internally- Returns:
- A
KeyPair
for the identities -null
if no identities available (e.g., after filtering unsupported ones) - See Also:
BuiltinIdentities
-
loadIdentities
public static NavigableMap<String,KeyPair> loadIdentities(SessionContext session, Map<String,? extends Path> paths, FilePasswordProvider provider, OpenOption... options) throws IOException, GeneralSecurityException
- Parameters:
session
- TheSessionContext
for invoking this load command - may benull
if not invoked within a session context (e.g., offline tool or session unknown).paths
- AMap
of the identities where key=identity type (case insensitive), value=thePath
of file with the identity keyprovider
- AFilePasswordProvider
- may benull
if the loaded keys are guaranteed not to be encrypted. The argument toFilePasswordProvider#getPassword
is the path of the file whose key is to be loadedoptions
- TheOpenOption
s to use when reading the key data- Returns:
- A
NavigableMap
of the identities where key=identity type (case insensitive), value=theKeyPair
of the identity - Throws:
IOException
- If failed to access the file systemGeneralSecurityException
- If failed to load the keys
-
-