org.apache.sshd.common.config.keys

Interface FilePasswordProvider

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface FilePasswordProvider

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FilePasswordProvider.Decoder<T> Something that can produce a result given a password.
static class	FilePasswordProvider.ResourceDecodeResult

Field Summary

Fields

Modifier and Type	Field and Description
static FilePasswordProvider	EMPTY An "empty" provider that returns null - i.e., unprotected key file

Method Summary

Modifier and Type	Method and Description
default <T> T	decode(SessionContext session, NamedResource resourceKey, FilePasswordProvider.Decoder<? extends T> decoder) Obtains the password through getPassword(SessionContext, NamedResource, int), invokes the FilePasswordProvider.Decoder and then handleDecodeAttemptResult(SessionContext, NamedResource, int, String, Exception) and then returns the decoded result.
String	getPassword(SessionContext session, NamedResource resourceKey, int retryIndex)
default FilePasswordProvider.ResourceDecodeResult	handleDecodeAttemptResult(SessionContext session, NamedResource resourceKey, int retryIndex, String password, Exception err) Invoked to inform the password provide about the decoding result.
static FilePasswordProvider	of(String password)

Field Detail

EMPTY

static final FilePasswordProvider EMPTY

An "empty" provider that returns null - i.e., unprotected key file

Method Detail

getPassword

String getPassword(SessionContext session,
                   NamedResource resourceKey,
                   int retryIndex)
            throws IOException

Parameters:

session - 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 - The resource key representing the private file

retryIndex - The zero-based index of the invocation for the specific resource (in case invoked several times for the same resource)

Returns:

The password - if null/empty then no password is required

Throws:

IOException - if cannot resolve password

See Also:

handleDecodeAttemptResult(SessionContext, NamedResource, int, String, Exception)

handleDecodeAttemptResult

default FilePasswordProvider.ResourceDecodeResult handleDecodeAttemptResult(SessionContext session,
                                                                            NamedResource resourceKey,
                                                                            int retryIndex,
                                                                            String password,
                                                                            Exception err)
                                                                     throws IOException,
                                                                            GeneralSecurityException

Invoked to inform the password provide about the decoding result. Note: any exception thrown from this method (including if called to inform about success) will be propagated instead of the original (if any was reported)

Parameters:

session - 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 - The resource key representing the private file

retryIndex - The zero-based index of the invocation for the specific resource (in case invoked several times for the same resource). If success report, it indicates the number of retries it took to succeed

password - The password that was attempted

err - The attempt result - null for success

Returns:

How to proceed in case of error - ignored if invoked in order to report success. Note: null is same as FilePasswordProvider.ResourceDecodeResult.TERMINATE.

Throws:

IOException - If cannot resolve a new password

GeneralSecurityException - If not attempting to resolve a new password

decode

default <T> T decode(SessionContext session,
                     NamedResource resourceKey,
                     FilePasswordProvider.Decoder<? extends T> decoder)
              throws IOException,
                     GeneralSecurityException

Obtains the password through getPassword(SessionContext, NamedResource, int), invokes the FilePasswordProvider.Decoder and then handleDecodeAttemptResult(SessionContext, NamedResource, int, String, Exception) and then returns the decoded result. If the decoder fails and the FilePasswordProvider.ResourceDecodeResult is FilePasswordProvider.ResourceDecodeResult.RETRY, the whole process is re-tried.

Type Parameters:

T - Result type of the decoder

Parameters:

session - SessionContext, may be null

resourceKey - NamedResource used for error reporting

decoder - FilePasswordProvider.Decoder to produce the result given a password

Returns:

the decoder's result, or null if none

Throws:

IOException - if an I/O problem occurs

GeneralSecurityException - if the decoder throws it

of

static FilePasswordProvider of(String password)