Apache Mina SSHD 2.15.0 · org.apache.sshd.common.config.keys.loader.KeyPairResourceLoader

Modifier and Type	Field and Description
public static final KeyPairResourceLoader	EMPTY An empty loader that never fails but always returns an empty list
public static final int	MAX_CIPHER_NAME_LENGTH
public static final int	MAX_KEY_COMMENT_LENGTH
public static final int	MAX_KEY_TYPE_NAME_LENGTH
public static final int	MAX_PRIVATE_KEY_DATA_SIZE
public static final int	MAX_PUBLIC_KEY_DATA_SIZE

Method Summary

Modifier and Type	Method and Description
public default Collection<KeyPair>	Returns: The extracted `KeyPair`s - may be `null`/empty if none Note the resource loader may decide to skip unknown lines if more than one key pair type is encoded in it loadKeyPairs(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 private key file `Path` path, FilePasswordProvider The `FilePasswordProvider` to use in case the data is encrypted - may be `null` if no encrypted data is expected passwordProvider, OpenOption... The `OpenOption`-s to use to access the file data options) Loads private key data - Note: any non-ASCII characters are assumed to be UTF-8 encoded
public default Collection<KeyPair>	loadKeyPairs(SessionContext session, Path path, FilePasswordProvider passwordProvider, Charset cs, OpenOption... options)
public default Collection<KeyPair>	loadKeyPairs(SessionContext session, URL url, FilePasswordProvider passwordProvider)
public default Collection<KeyPair>	loadKeyPairs(SessionContext session, URL url, FilePasswordProvider passwordProvider, Charset cs)
public default Collection<KeyPair>	loadKeyPairs(SessionContext session, IoResource<?> resource, FilePasswordProvider passwordProvider)
public default Collection<KeyPair>	loadKeyPairs(SessionContext session, IoResource<?> resource, FilePasswordProvider passwordProvider, Charset cs)
public default Collection<KeyPair>	loadKeyPairs(SessionContext session, NamedResource resourceKey, FilePasswordProvider passwordProvider, String data)
public default Collection<KeyPair>	loadKeyPairs(SessionContext session, NamedResource resourceKey, FilePasswordProvider passwordProvider, InputStream stream)
public default Collection<KeyPair>	loadKeyPairs(SessionContext session, NamedResource resourceKey, FilePasswordProvider passwordProvider, InputStream stream, Charset cs)
public default Collection<KeyPair>	loadKeyPairs(SessionContext session, NamedResource resourceKey, FilePasswordProvider passwordProvider, Reader r)
public default Collection<KeyPair>	loadKeyPairs(SessionContext session, NamedResource resourceKey, FilePasswordProvider passwordProvider, BufferedReader r)
public Collection<KeyPair>	Returns: The extracted `KeyPair`s - may be `null`/empty if none Note the resource loader may decide to skip unknown lines if more than one key pair type is encoded in it loadKeyPairs(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, NamedResource A hint as to the origin of the text lines resourceKey, FilePasswordProvider The `FilePasswordProvider` to use in case the data is encrypted - may be `null` if no encrypted data is expected passwordProvider, List<String> The `List` of lines as read from the resource lines) Loads key pairs from the given resource text lines

EMPTY	back to summary
public static final KeyPairResourceLoader EMPTY An empty loader that never fails but always returns an empty list

MAX_CIPHER_NAME_LENGTH	back to summary
public static final int MAX_CIPHER_NAME_LENGTH

MAX_KEY_COMMENT_LENGTH	back to summary
public static final int MAX_KEY_COMMENT_LENGTH

MAX_KEY_TYPE_NAME_LENGTH	back to summary
public static final int MAX_KEY_TYPE_NAME_LENGTH

MAX_PRIVATE_KEY_DATA_SIZE	back to summary
public static final int MAX_PRIVATE_KEY_DATA_SIZE

MAX_PUBLIC_KEY_DATA_SIZE	back to summary
public static final int MAX_PUBLIC_KEY_DATA_SIZE

Method Detail

loadKeyPairs back to summary

loadKeyPairs	back to summary
public default Collection<KeyPair> loadKeyPairs(SessionContext session, Path path, FilePasswordProvider passwordProvider, OpenOption... options) throws IOException, GeneralSecurityException Loads private key data - Note: any non-ASCII characters are assumed to be UTF-8 encoded 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). path:Path The private key file `Path` passwordProvider:FilePasswordProvider The `FilePasswordProvider` to use in case the data is encrypted - may be `null` if no encrypted data is expected options:OpenOption[] The `OpenOption`-s to use to access the file data Returns:Collection<KeyPair> The extracted `KeyPair`s - may be `null`/empty if none Note the resource loader may decide to skip unknown lines if more than one key pair type is encoded in it Exceptions IOException: If failed to process the lines GeneralSecurityException: If failed to generate the keys from the parsed data

public default Collection<KeyPair> loadKeyPairs(SessionContext session, Path path, FilePasswordProvider passwordProvider, OpenOption... options) throws IOException, GeneralSecurityException

Loads private key data - Note: any non-ASCII characters are assumed to be UTF-8 encoded

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).
path:Path: The private key file Path
passwordProvider:FilePasswordProvider: The FilePasswordProvider to use in case the data is encrypted - may be null if no encrypted data is expected
options:OpenOption[]: The OpenOption-s to use to access the file data

Returns:Collection<KeyPair>

The extracted KeyPairs - may be null/empty if none

Note

the resource loader may decide to skip unknown lines if more than one key pair type is encoded in it

Exceptions

IOException:: If failed to process the lines
GeneralSecurityException:: If failed to generate the keys from the parsed data

loadKeyPairs	back to summary
public default Collection<KeyPair> loadKeyPairs(SessionContext session, Path path, FilePasswordProvider passwordProvider, Charset cs, OpenOption... options) throws IOException, GeneralSecurityException

loadKeyPairs	back to summary
public default Collection<KeyPair> loadKeyPairs(SessionContext session, URL url, FilePasswordProvider passwordProvider) throws IOException, GeneralSecurityException

loadKeyPairs	back to summary
public default Collection<KeyPair> loadKeyPairs(SessionContext session, URL url, FilePasswordProvider passwordProvider, Charset cs) throws IOException, GeneralSecurityException

loadKeyPairs	back to summary
public default Collection<KeyPair> loadKeyPairs(SessionContext session, IoResource<?> resource, FilePasswordProvider passwordProvider) throws IOException, GeneralSecurityException

loadKeyPairs	back to summary
public default Collection<KeyPair> loadKeyPairs(SessionContext session, IoResource<?> resource, FilePasswordProvider passwordProvider, Charset cs) throws IOException, GeneralSecurityException

loadKeyPairs	back to summary
public default Collection<KeyPair> loadKeyPairs(SessionContext session, NamedResource resourceKey, FilePasswordProvider passwordProvider, String data) throws IOException, GeneralSecurityException

loadKeyPairs	back to summary
public default Collection<KeyPair> loadKeyPairs(SessionContext session, NamedResource resourceKey, FilePasswordProvider passwordProvider, InputStream stream) throws IOException, GeneralSecurityException

loadKeyPairs	back to summary
public default Collection<KeyPair> loadKeyPairs(SessionContext session, NamedResource resourceKey, FilePasswordProvider passwordProvider, InputStream stream, Charset cs) throws IOException, GeneralSecurityException

loadKeyPairs	back to summary
public default Collection<KeyPair> loadKeyPairs(SessionContext session, NamedResource resourceKey, FilePasswordProvider passwordProvider, Reader r) throws IOException, GeneralSecurityException

loadKeyPairs	back to summary
public default Collection<KeyPair> loadKeyPairs(SessionContext session, NamedResource resourceKey, FilePasswordProvider passwordProvider, BufferedReader r) throws IOException, GeneralSecurityException

loadKeyPairs back to summary

loadKeyPairs	back to summary
public Collection<KeyPair> loadKeyPairs(SessionContext session, NamedResource resourceKey, FilePasswordProvider passwordProvider, List<String> lines) throws IOException, GeneralSecurityException Loads key pairs from the given resource text lines 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). resourceKey:NamedResource A hint as to the origin of the text lines passwordProvider:FilePasswordProvider The `FilePasswordProvider` to use in case the data is encrypted - may be `null` if no encrypted data is expected lines:List<String> The `List` of lines as read from the resource Returns:Collection<KeyPair> The extracted `KeyPair`s - may be `null`/empty if none Note the resource loader may decide to skip unknown lines if more than one key pair type is encoded in it Exceptions IOException: If failed to process the lines GeneralSecurityException: If failed to generate the keys from the parsed data

public Collection<KeyPair> loadKeyPairs(SessionContext session, NamedResource resourceKey, FilePasswordProvider passwordProvider, List<String> lines) throws IOException, GeneralSecurityException

Loads key pairs from the given resource text lines

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).
resourceKey:NamedResource: A hint as to the origin of the text lines
passwordProvider:FilePasswordProvider: The FilePasswordProvider to use in case the data is encrypted - may be null if no encrypted data is expected
lines:List<String>: The List of lines as read from the resource

Returns:Collection<KeyPair>

The extracted KeyPairs - may be null/empty if none

Note

the resource loader may decide to skip unknown lines if more than one key pair type is encoded in it

Exceptions

IOException:: If failed to process the lines
GeneralSecurityException:: If failed to generate the keys from the parsed data

public Interface KeyPairResourceLoader

Field Summary

Method Summary

Field Detail

Method Detail