com.sshtools.common.auth

Interface PublicKeyAuthenticationProvider

All Superinterfaces:

Authenticator

All Known Implementing Classes:

AbstractPublicKeyAuthenticationProvider, AuthorizedKeysPublicKeyAuthenticationProvider, OpenSshCertificateAuthenticationProvider, PublicKeyAuthenticationAdapter, UniversalAuthenticationProvider

public interface PublicKeyAuthenticationProvider
extends Authenticator

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.

The implementation may optionally support addition, removal and listing of keys. When supported, PublicKeySubsystemServer may be used. If not required the methods should thrown UnsupportedOperationException.

Author:

Lee David Painter

Method Summary

Modifier and Type	Method and Description
void	add(SshPublicKey key, java.lang.String comment, SshConnection con)
boolean	checkKey(SshPublicKey key, SshConnection con)
java.util.Iterator<SshPublicKeyFile>	getKeys(SshConnection con)
boolean	isAuthorizedKey(SshPublicKey key, SshConnection con) Check the supplied public key against the users authorized keys.
void	remove(SshPublicKey key, SshConnection con)

Method Detail

isAuthorizedKey

boolean isAuthorizedKey(SshPublicKey key,
                        SshConnection con)
                 throws java.io.IOException

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 com.sshtools.common.auth.server.PasswordAuthenticationProvider 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

con - connection

authenticationProvider - AuthenticationProvider

Returns:

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

Throws:

java.io.IOException

checkKey

boolean checkKey(SshPublicKey key,
                 SshConnection con)
          throws java.io.IOException

Throws:

java.io.IOException

getKeys

java.util.Iterator<SshPublicKeyFile> getKeys(SshConnection con)
                                      throws PermissionDeniedException,
                                             java.io.IOException

Throws:

PermissionDeniedException

java.io.IOException

remove

void remove(SshPublicKey key,
            SshConnection con)
     throws java.io.IOException,
            PermissionDeniedException,
            SshException

Throws:

java.io.IOException

PermissionDeniedException

SshException

add

void add(SshPublicKey key,
         java.lang.String comment,
         SshConnection con)
  throws java.io.IOException,
         PermissionDeniedException,
         SshException

Throws:

java.io.IOException

PermissionDeniedException

SshException