com.maverick.sshd
Interface PublicKeyStore

All Known Implementing Classes:

AuthorizedKeysStoreImpl

public interface PublicKeyStore

This interface allows you to define a custom public key store for the publickey authentication mechanism. The actual key verification is performed by the mechanism itself and your only requirement is to return a value which indicates whether the key has been authorized by the user for public key access.

Author:

Lee David Painter

Method Summary

boolean

isAuthorizedKey(SshPublicKey key, byte[] sessionid, java.net.SocketAddress ipAddress, AuthenticationProvider authenticationProvider) Check the supplied public key against the users authorized keys.

Method Detail

isAuthorizedKey

public boolean isAuthorizedKey(SshPublicKey key,
                               byte[] sessionid,
                               java.net.SocketAddress ipAddress,
                               AuthenticationProvider authenticationProvider)

Check the supplied public key against the users authorized keys. The actual verification of the key is performed by the server, you only need to return a value to indicate whether the key is authorized or not. You can obtain the username, home directory, group or remote socket address from the AuthenticationProvider instance.

If your authorized key database is kept on the native file system you can obtain and initialize an instance as follows:

 NativeFileSystemProvider nfs =
         (NativeFileSystemProvider)authenticationProvider.getContext().getFileSystemProvider().newInstance();

 nfs.init(sessionid, null, authenticationProvider.getContext());
 

Don't forget to close any file handles and the file system once you've done accessing files.

Parameters:

key - SshPublicKey

sessionid - byte[]

authenticationProvider - AuthenticationProvider

Returns:

boolean true if the key is an authorized key, otherwise false