Apache Mina SSHD 2.15.0 · org.apache.sshd.client.config.keys.ClientIdentity

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

Access	Constructor and Description
private	ClientIdentity()

Method Summary

Modifier and Type	Method and Description
public static String	getIdentityFileName(NamedResource r)
public static String	Returns: The matching file name for the identity - `null` if no name getIdentityFileName(String The identity type - e.g., `rsa` - ignored if `null`/empty type)
public static String	Returns: The identity type - `null` if cannot determine it - e.g., does not start with the `ID_FILE_PREFIX` getIdentityType(String The file name - ignored if `null`/empty name)
public static Map<String, KeyPair>	Returns: A `Map` of the found files where key=identity type (case insensitive), value=the `KeyPair` of the identity loadDefaultIdentities(boolean If `true` then files that do not have the required access rights are excluded from consideration strict, FilePasswordProvider A `FilePasswordProvider` - may be `null` if the loaded keys are guaranteed not to be encrypted. The argument to `FilePasswordProvider#getPassword` is the path of the file whose key is to be loaded provider, LinkOption... The `LinkOption`s to apply when checking for existence options)
public static Map<String, KeyPair>	Returns: A `Map` of the found files where key=identity type (case insensitive), value=the `KeyPair` of the identity loadDefaultIdentities(Path The folder to scan for the built-in identities dir, boolean If `true` then files that do not have the required access rights are excluded from consideration strict, FilePasswordProvider A `FilePasswordProvider` - may be `null` if the loaded keys are guaranteed not to be encrypted. The argument to `FilePasswordProvider#getPassword` is the path of the file whose key is to be loaded provider, LinkOption... The `LinkOption`s to apply when checking for existence options)
public static KeyPairProvider	Returns: A `KeyPair` for the identities - `null` if no identities available (e.g., after filtering unsupported ones or strict permissions) loadDefaultKeyPairProvider(boolean If `true` then files that do not have the required access rights are excluded from consideration strict, boolean If `true` then ignore identities that are not supported internally supportedOnly, FilePasswordProvider A `FilePasswordProvider` - may be `null` if the loaded keys are guaranteed not to be encrypted. The argument to `FilePasswordProvider#getPassword` is the path of the file whose key is to be loaded provider, LinkOption... The `LinkOption`s to apply when checking for existence options)
public static KeyPairProvider	Returns: A `KeyPair` for the identities - `null` if no identities available (e.g., after filtering unsupported ones or strict permissions) loadDefaultKeyPairProvider(Path The folder to scan for the built-in identities dir, boolean If `true` then files that do not have the required access rights are excluded from consideration strict, boolean If `true` then ignore identities that are not supported internally supportedOnly, FilePasswordProvider A `FilePasswordProvider` - may be `null` if the loaded keys are guaranteed not to be encrypted. The argument to `FilePasswordProvider#getPassword` is the path of the file whose key is to be loaded provider, LinkOption... The `LinkOption`s to apply when checking for existence options)
public static Map<String, KeyPair>	Returns: A `Map` of the found files where key=identity type (case insensitive), value=the `KeyPair` of the identity loadIdentities(SessionContext The `SessionContext` for invoking this load command - may be `null` if not invoked within a session context (e.g., offline tool or session unknown). session, Path The `Path` of the folder to scan - ignored if not exists dir, boolean If `true` then files that do not have the required access rights are excluded from consideration strict, Collection<String> The identity types - ignored if `null`/empty types, Function<? super String, String> A `Function` to derive the file name holding the specified type idGenerator, FilePasswordProvider A `FilePasswordProvider` - may be `null` if the loaded keys are guaranteed not to be encrypted. The argument to `FilePasswordProvider#getPassword` is the path of the file whose key is to be loaded provider, LinkOption... The `LinkOption`s to apply when checking for existence options) Scans a folder and loads all available identity files
public static Map<String, Path>	Returns: A `Map` of the found files where key=identity type (case insensitive), value=the `Path` of the file holding the key scanIdentitiesFolder(Path The `Path` of the folder to scan - ignored if not exists dir, boolean If `true` then files that do not have the required access rights are excluded from consideration strict, Collection<String> The identity types - ignored if `null`/empty types, Function<? super String, String> A `Function` to derive the file name holding the specified type idGenerator, LinkOption... The `LinkOption`s to apply when checking for existence options) Scans a folder for possible identity files

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

ID_FILE_PREFIX	back to summary
public static final String ID_FILE_PREFIX

ID_FILE_SUFFIX	back to summary
public static final String ID_FILE_SUFFIX

ID_GENERATOR	back to summary
public static final Function<String, String> ID_GENERATOR

ClientIdentity	back to summary
private ClientIdentity()

Method Detail

getIdentityFileName	back to summary
public static String getIdentityFileName(NamedResource r)

getIdentityFileName	back to summary
public static String getIdentityFileName(String type) Parameters type:String The identity type - e.g., `rsa` - ignored if `null`/empty Returns:String The matching file name for the identity - `null` if no name See Also `ID_FILE_PREFIX`, `ID_FILE_SUFFIX`, `IdentityUtils#getIdentityFileName(String, String, String)`

getIdentityType	back to summary
public static String getIdentityType(String name) Parameters name:String The file name - ignored if `null`/empty Returns:String The identity type - `null` if cannot determine it - e.g., does not start with the `ID_FILE_PREFIX`

loadDefaultIdentities back to summary

loadDefaultIdentities	back to summary
public static Map<String, KeyPair> loadDefaultIdentities(boolean strict, FilePasswordProvider provider, LinkOption... options) throws IOException, GeneralSecurityException Parameters strict:boolean If `true` then files that do not have the required access rights are excluded from consideration provider:FilePasswordProvider A `FilePasswordProvider` - may be `null` if the loaded keys are guaranteed not to be encrypted. The argument to `FilePasswordProvider#getPassword` is the path of the file whose key is to be loaded options:LinkOption[] The `LinkOption`s to apply when checking for existence Returns:Map<String, KeyPair> A `Map` of the found files where key=identity type (case insensitive), value=the `KeyPair` of the identity Exceptions IOException: If failed to access the file system GeneralSecurityException: If failed to load the keys See Also `PublicKeyEntry#getDefaultKeysFolderPath()`, `loadDefaultIdentities(Path, boolean, FilePasswordProvider, LinkOption...)`

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

Parameters

strict:boolean: If true then files that do not have the required access rights are excluded from consideration
provider:FilePasswordProvider: A FilePasswordProvider - may be null if the loaded keys are guaranteed not to be encrypted. The argument to FilePasswordProvider#getPassword is the path of the file whose key is to be loaded
options:LinkOption[]: The LinkOptions to apply when checking for existence

Returns:Map<String, KeyPair>

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

Exceptions

IOException:: If failed to access the file system
GeneralSecurityException:: If failed to load the keys

loadDefaultIdentities back to summary

loadDefaultIdentities	back to summary
public static Map<String, KeyPair> loadDefaultIdentities(Path dir, boolean strict, FilePasswordProvider provider, LinkOption... options) throws IOException, GeneralSecurityException Parameters dir:Path The folder to scan for the built-in identities strict:boolean If `true` then files that do not have the required access rights are excluded from consideration provider:FilePasswordProvider A `FilePasswordProvider` - may be `null` if the loaded keys are guaranteed not to be encrypted. The argument to `FilePasswordProvider#getPassword` is the path of the file whose key is to be loaded options:LinkOption[] The `LinkOption`s to apply when checking for existence Returns:Map<String, KeyPair> A `Map` of the found files where key=identity type (case insensitive), value=the `KeyPair` of the identity Exceptions IOException: If failed to access the file system GeneralSecurityException: If failed to load the keys See Also `BuiltinIdentities`

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

Parameters

dir:Path: The folder to scan for the built-in identities
strict:boolean: If true then files that do not have the required access rights are excluded from consideration
provider:FilePasswordProvider: A FilePasswordProvider - may be null if the loaded keys are guaranteed not to be encrypted. The argument to FilePasswordProvider#getPassword is the path of the file whose key is to be loaded
options:LinkOption[]: The LinkOptions to apply when checking for existence

Returns:Map<String, KeyPair>

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

Exceptions

IOException:: If failed to access the file system
GeneralSecurityException:: If failed to load the keys

See Also

BuiltinIdentities

loadDefaultKeyPairProvider back to summary

loadDefaultKeyPairProvider	back to summary
public static KeyPairProvider loadDefaultKeyPairProvider(boolean strict, boolean supportedOnly, FilePasswordProvider provider, LinkOption... options) throws IOException, GeneralSecurityException Parameters strict:boolean If `true` then files that do not have the required access rights are excluded from consideration supportedOnly:boolean If `true` then ignore identities that are not supported internally provider:FilePasswordProvider A `FilePasswordProvider` - may be `null` if the loaded keys are guaranteed not to be encrypted. The argument to `FilePasswordProvider#getPassword` is the path of the file whose key is to be loaded options:LinkOption[] The `LinkOption`s to apply when checking for existence Returns:KeyPairProvider A `KeyPair` for the identities - `null` if no identities available (e.g., after filtering unsupported ones or strict permissions) Exceptions IOException: If failed to access the file system GeneralSecurityException: If failed to load the keys See Also `PublicKeyEntry#getDefaultKeysFolderPath()`, `loadDefaultIdentities(Path, boolean, FilePasswordProvider, LinkOption...)`

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

Parameters

strict:boolean: If true then files that do not have the required access rights are excluded from consideration
supportedOnly:boolean: If true then ignore identities that are not supported internally
provider:FilePasswordProvider: A FilePasswordProvider - may be null if the loaded keys are guaranteed not to be encrypted. The argument to FilePasswordProvider#getPassword is the path of the file whose key is to be loaded
options:LinkOption[]: The LinkOptions to apply when checking for existence

Returns:KeyPairProvider

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

Exceptions

IOException:: If failed to access the file system
GeneralSecurityException:: If failed to load the keys

loadDefaultKeyPairProvider back to summary

loadDefaultKeyPairProvider	back to summary
public static KeyPairProvider loadDefaultKeyPairProvider(Path dir, boolean strict, boolean supportedOnly, FilePasswordProvider provider, LinkOption... options) throws IOException, GeneralSecurityException Parameters dir:Path The folder to scan for the built-in identities strict:boolean If `true` then files that do not have the required access rights are excluded from consideration supportedOnly:boolean If `true` then ignore identities that are not supported internally provider:FilePasswordProvider A `FilePasswordProvider` - may be `null` if the loaded keys are guaranteed not to be encrypted. The argument to `FilePasswordProvider#getPassword` is the path of the file whose key is to be loaded options:LinkOption[] The `LinkOption`s to apply when checking for existence Returns:KeyPairProvider A `KeyPair` for the identities - `null` if no identities available (e.g., after filtering unsupported ones or strict permissions) Exceptions 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)`

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

Parameters

dir:Path: The folder to scan for the built-in identities
strict:boolean: If true then files that do not have the required access rights are excluded from consideration
supportedOnly:boolean: If true then ignore identities that are not supported internally
provider:FilePasswordProvider: A FilePasswordProvider - may be null if the loaded keys are guaranteed not to be encrypted. The argument to FilePasswordProvider#getPassword is the path of the file whose key is to be loaded
options:LinkOption[]: The LinkOptions to apply when checking for existence

Returns:KeyPairProvider

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

Exceptions

IOException:: If failed to access the file system
GeneralSecurityException:: If failed to load the keys

loadIdentities back to summary

loadIdentities	back to summary
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, GeneralSecurityException Scans a folder and loads all available identity files Parameters session:SessionContext The `SessionContext` for invoking this load command - may be `null` if not invoked within a session context (e.g., offline tool or session unknown). dir:Path The `Path` of the folder to scan - ignored if not exists strict:boolean If `true` then files that do not have the required access rights are excluded from consideration types:Collection<String> The identity types - ignored if `null`/empty idGenerator:Function<? super String, String> A `Function` to derive the file name holding the specified type provider:FilePasswordProvider A `FilePasswordProvider` - may be `null` if the loaded keys are guaranteed not to be encrypted. The argument to `FilePasswordProvider#getPassword` is the path of the file whose key is to be loaded options:LinkOption[] The `LinkOption`s to apply when checking for existence Returns:Map<String, KeyPair> A `Map` of the found files where key=identity type (case insensitive), value=the `KeyPair` of the identity Exceptions IOException: If failed to access the file system GeneralSecurityException: If failed to load the keys

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, GeneralSecurityException

Scans a folder and loads all available identity files

Parameters

session:SessionContext: The SessionContext for invoking this load command - may be null if not invoked within a session context (e.g., offline tool or session unknown).
dir:Path: The Path of the folder to scan - ignored if not exists
strict:boolean: If true then files that do not have the required access rights are excluded from consideration
types:Collection<String>: The identity types - ignored if null/empty
idGenerator:Function<? super String, String>: A Function to derive the file name holding the specified type
provider:FilePasswordProvider: A FilePasswordProvider - may be null if the loaded keys are guaranteed not to be encrypted. The argument to FilePasswordProvider#getPassword is the path of the file whose key is to be loaded
options:LinkOption[]: The LinkOptions to apply when checking for existence

Returns:Map<String, KeyPair>

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

Exceptions

IOException:: If failed to access the file system
GeneralSecurityException:: If failed to load the keys

scanIdentitiesFolder back to summary

scanIdentitiesFolder	back to summary
public static Map<String, Path> scanIdentitiesFolder(Path dir, boolean strict, Collection<String> types, Function<? super String, String> idGenerator, LinkOption... options) throws IOException Scans a folder for possible identity files Parameters dir:Path The `Path` of the folder to scan - ignored if not exists strict:boolean If `true` then files that do not have the required access rights are excluded from consideration types:Collection<String> The identity types - ignored if `null`/empty idGenerator:Function<? super String, String> A `Function` to derive the file name holding the specified type options:LinkOption[] The `LinkOption`s to apply when checking for existence Returns:Map<String, Path> A `Map` of the found files where key=identity type (case insensitive), value=the `Path` of the file holding the key Exceptions IOException: If failed to access the file system See Also `KeyUtils#validateStrictKeyFilePermissions(Path, LinkOption...)`

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

Scans a folder for possible identity files

Parameters

dir:Path: The Path of the folder to scan - ignored if not exists
strict:boolean: If true then files that do not have the required access rights are excluded from consideration
types:Collection<String>: The identity types - ignored if null/empty
idGenerator:Function<? super String, String>: A Function to derive the file name holding the specified type
options:LinkOption[]: The LinkOptions to apply when checking for existence

Returns:Map<String, Path>

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

Exceptions

IOException:: If failed to access the file system

public final Class ClientIdentity

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail