org.apache.sshd.client.config.keys

Class ClientIdentity

java.lang.Object

org.apache.sshd.client.config.keys.ClientIdentity

public final class ClientIdentity
extends Object

Provides keys loading capability from the user's keys folder - e.g., id_rsa

Author:

Apache MINA SSHD Project

See Also:

SecurityUtils.getKeyPairResourceParser()

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID_FILE_PREFIX
static String	ID_FILE_SUFFIX
static Function<String,String>	ID_GENERATOR

Method Summary

Modifier and Type	Method and Description
static String	getIdentityFileName(NamedResource r)
static String	getIdentityFileName(String type)
static String	getIdentityType(String name)
static Map<String,KeyPair>	loadDefaultIdentities(boolean strict, FilePasswordProvider provider, LinkOption... options)
static Map<String,KeyPair>	loadDefaultIdentities(Path dir, boolean strict, FilePasswordProvider provider, LinkOption... options)
static KeyPairProvider	loadDefaultKeyPairProvider(boolean strict, boolean supportedOnly, FilePasswordProvider provider, LinkOption... options)
static KeyPairProvider	loadDefaultKeyPairProvider(Path dir, boolean strict, boolean supportedOnly, FilePasswordProvider provider, LinkOption... options)
static Map<String,KeyPair>	loadIdentities(Path dir, boolean strict, Collection<String> types, Function<String,String> idGenerator, FilePasswordProvider provider, LinkOption... options) Scans a folder and loads all available identity files
static Map<String,Path>	scanIdentitiesFolder(Path dir, boolean strict, Collection<String> types, Function<String,String> idGenerator, LinkOption... options) Scans a folder for possible identity files
static <C extends SshClient> C	setKeyPairProvider(C client, boolean strict, boolean supportedOnly, FilePasswordProvider provider, LinkOption... options)
static <C extends SshClient> C	setKeyPairProvider(C client, Path dir, boolean strict, boolean supportedOnly, FilePasswordProvider provider, LinkOption... options)

Methods inherited from class java.lang.Object

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

Field Detail

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

ID_GENERATOR

public static final Function<String,String> ID_GENERATOR

Method Detail

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 with the ID_FILE_PREFIX

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)

setKeyPairProvider

public static <C extends SshClient> C setKeyPairProvider(C client,
                                                         boolean strict,
                                                         boolean supportedOnly,
                                                         FilePasswordProvider provider,
                                                         LinkOption... options)
                                                  throws IOException,
                                                         GeneralSecurityException

Type Parameters:

C - The generic client class

Parameters:

client - The SshClient to updated

strict - If true then files that do not have the required access rights are excluded from consideration

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

provider - A FilePasswordProvider - may be null if the loaded keys are guaranteed not to be encrypted. The argument to FilePasswordProvider.getPassword(String) is the path of the file whose key is to be loaded

options - The LinkOptions to apply when checking for existence

Returns:

The updated client instance - provided a non-null KeyPairProvider was generated

Throws:

IOException - If failed to access the file system

GeneralSecurityException - If failed to load the keys

See Also:

setKeyPairProvider(SshClient, Path, boolean, boolean, FilePasswordProvider, LinkOption...)

setKeyPairProvider

public static <C extends SshClient> C setKeyPairProvider(C client,
                                                         Path dir,
                                                         boolean strict,
                                                         boolean supportedOnly,
                                                         FilePasswordProvider provider,
                                                         LinkOption... options)
                                                  throws IOException,
                                                         GeneralSecurityException

Type Parameters:

C - The generic client class

Parameters:

client - The SshClient to updated

dir - The folder to scan for the built-in identities

strict - If true then files that do not have the required access rights are excluded from consideration

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

provider - A FilePasswordProvider - may be null if the loaded keys are guaranteed not to be encrypted. The argument to FilePasswordProvider.getPassword(String) is the path of the file whose key is to be loaded

options - The LinkOptions to apply when checking for existence

Returns:

The updated client instance - provided a non-null KeyPairProvider was generated

Throws:

IOException - If failed to access the file system

GeneralSecurityException - If failed to load the keys

See Also:

loadDefaultKeyPairProvider(Path, boolean, boolean, FilePasswordProvider, LinkOption...)

loadDefaultKeyPairProvider

public static KeyPairProvider loadDefaultKeyPairProvider(boolean strict,
                                                         boolean supportedOnly,
                                                         FilePasswordProvider provider,
                                                         LinkOption... options)
                                                  throws IOException,
                                                         GeneralSecurityException

Parameters:

strict - If true then files that do not have the required access rights are excluded from consideration

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

provider - A FilePasswordProvider - may be null if the loaded keys are guaranteed not to be encrypted. The argument to FilePasswordProvider.getPassword(String) is the path of the file whose key is to be loaded

options - The LinkOptions to apply when checking for existence

Returns:

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

Throws:

IOException - If failed to access the file system

GeneralSecurityException - If failed to load the keys

See Also:

PublicKeyEntry.getDefaultKeysFolderPath(), loadDefaultIdentities(Path, boolean, FilePasswordProvider, LinkOption...)

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 identities

strict - If true then files that do not have the required access rights are excluded from consideration

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

provider - A FilePasswordProvider - may be null if the loaded keys are guaranteed not to be encrypted. The argument to FilePasswordProvider.getPassword(String) is the path of the file whose key is to be loaded

options - The LinkOptions to apply when checking for existence

Returns:

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

Throws:

IOException - If failed to access the file system

GeneralSecurityException - If failed to load the keys

See Also:

loadDefaultIdentities(Path, boolean, FilePasswordProvider, LinkOption...), IdentityUtils.createKeyPairProvider(Map, boolean)

loadDefaultIdentities

public static Map<String,KeyPair> loadDefaultIdentities(boolean strict,
                                                        FilePasswordProvider provider,
                                                        LinkOption... options)
                                                 throws IOException,
                                                        GeneralSecurityException

Parameters:

strict - If true then files that do not have the required access rights are excluded from consideration

provider - A FilePasswordProvider - may be null if the loaded keys are guaranteed not to be encrypted. The argument to FilePasswordProvider.getPassword(String) is the path of the file whose key is to be loaded

options - The LinkOptions to apply when checking for existence

Returns:

A Map of the found files 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:

PublicKeyEntry.getDefaultKeysFolderPath(), loadDefaultIdentities(Path, boolean, FilePasswordProvider, LinkOption...)

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 identities

strict - If true then files that do not have the required access rights are excluded from consideration

provider - A FilePasswordProvider - may be null if the loaded keys are guaranteed not to be encrypted. The argument to FilePasswordProvider.getPassword(String) is the path of the file whose key is to be loaded

options - The LinkOptions to apply when checking for existence

Returns:

A Map of the found files 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:

loadIdentities(Path, boolean, Collection, Function, FilePasswordProvider, LinkOption...), BuiltinIdentities

loadIdentities

public static Map<String,KeyPair> loadIdentities(Path dir,
                                                 boolean strict,
                                                 Collection<String> types,
                                                 Function<String,String> idGenerator,
                                                 FilePasswordProvider provider,
                                                 LinkOption... options)
                                          throws IOException,
                                                 GeneralSecurityException

Scans a folder and loads all available identity files

Parameters:

dir - The Path of the folder to scan - ignored if not exists

strict - If true then files that do not have the required access rights are excluded from consideration

types - The identity types - ignored if null/empty

idGenerator - A Function to derive the file name holding the specified type

provider - A FilePasswordProvider - may be null if the loaded keys are guaranteed not to be encrypted. The argument to FilePasswordProvider.getPassword(String) is the path of the file whose key is to be loaded

options - The LinkOptions to apply when checking for existence

Returns:

A Map of the found files 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:

scanIdentitiesFolder(Path, boolean, Collection, Function, LinkOption...), IdentityUtils.loadIdentities(Map, FilePasswordProvider, java.nio.file.OpenOption...)

scanIdentitiesFolder

public static Map<String,Path> scanIdentitiesFolder(Path dir,
                                                    boolean strict,
                                                    Collection<String> types,
                                                    Function<String,String> idGenerator,
                                                    LinkOption... options)
                                             throws IOException

Scans a folder for possible identity files

Parameters:

dir - The Path of the folder to scan - ignored if not exists

strict - If true then files that do not have the required access rights are excluded from consideration

types - The identity types - ignored if null/empty

idGenerator - A Function to derive the file name holding the specified type

options - The LinkOptions to apply when checking for existence

Returns:

A Map of the found files where key=identity type (case insensitive), value=the Path of the file holding the key

Throws:

IOException - If failed to access the file system

See Also:

KeyUtils.validateStrictKeyFilePermissions(Path, LinkOption...)