org.apache.sshd.server.config.keys

Class AuthorizedKeysAuthenticator

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.util.io.ModifiableFileWatcher

org.apache.sshd.server.config.keys.AuthorizedKeysAuthenticator

All Implemented Interfaces:

PublickeyAuthenticator

Direct Known Subclasses:

DefaultAuthorizedKeysAuthenticator

public class AuthorizedKeysAuthenticator
extends ModifiableFileWatcher
implements PublickeyAuthenticator

Uses the authorized keys file to implement PublickeyAuthenticator while automatically re-loading the keys if the file has changed when a new authentication request is received. Note: by default, the only validation of the username is that it is not null/empty - see isValidUsername(String, ServerSession)

Author:

Apache MINA SSHD Project

Field Summary

Fields inherited from class org.apache.sshd.common.util.io.ModifiableFileWatcher

options

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor and Description
AuthorizedKeysAuthenticator(File file)
AuthorizedKeysAuthenticator(Path file)
AuthorizedKeysAuthenticator(Path file, LinkOption... options)

Method Summary

Modifier and Type	Method and Description
boolean	authenticate(String username, PublicKey key, ServerSession session) Check the validity of a public key.
protected boolean	isValidUsername(String username, ServerSession session)
protected Collection<AuthorizedKeyEntry>	reloadAuthorizedKeys(Path path, String username, ServerSession session)
protected PublickeyAuthenticator	resolvePublickeyAuthenticator(String username, ServerSession session)

Methods inherited from class org.apache.sshd.common.util.io.ModifiableFileWatcher

checkReloadRequired, exists, getPath, lastModified, resetReloadAttributes, size, updateReloadAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizedKeysAuthenticator

public AuthorizedKeysAuthenticator(File file)

AuthorizedKeysAuthenticator

public AuthorizedKeysAuthenticator(Path file)

AuthorizedKeysAuthenticator

public AuthorizedKeysAuthenticator(Path file,
                                   LinkOption... options)

Method Detail

authenticate

public boolean authenticate(String username,
                            PublicKey key,
                            ServerSession session)

Description copied from interface: PublickeyAuthenticator

Check the validity of a public key.

Specified by:

authenticate in interface PublickeyAuthenticator

Parameters:

username - the username

key - the key

session - the server session

Returns:

a boolean indicating if authentication succeeded or not

isValidUsername

protected boolean isValidUsername(String username,
                                  ServerSession session)

resolvePublickeyAuthenticator

protected PublickeyAuthenticator resolvePublickeyAuthenticator(String username,
                                                               ServerSession session)
                                                        throws IOException,
                                                               GeneralSecurityException

Throws:

IOException

GeneralSecurityException

reloadAuthorizedKeys

protected Collection<AuthorizedKeyEntry> reloadAuthorizedKeys(Path path,
                                                              String username,
                                                              ServerSession session)
                                                       throws IOException

Throws:

IOException