com.sshtools.common.auth

Class UniversalAuthenticationProvider

java.lang.Object

com.sshtools.common.auth.UniversalAuthenticationProvider

All Implemented Interfaces:

Authenticator, PublicKeyAuthenticationProvider

public class UniversalAuthenticationProvider
extends java.lang.Object
implements PublicKeyAuthenticationProvider

Constructor Summary

Constructors

Constructor and Description
UniversalAuthenticationProvider(UniversalAuthenticatorAccountDatabase accountDatabase)
UniversalAuthenticationProvider(UniversalAuthenticatorAccountDatabase accountDatabase, java.lang.String hostname)
UniversalAuthenticationProvider(UniversalAuthenticatorAccountDatabase accountDatabase, java.lang.String hostname, int port)

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)

Methods inherited from class java.lang.Object

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

Constructor Detail

UniversalAuthenticationProvider

public UniversalAuthenticationProvider(UniversalAuthenticatorAccountDatabase accountDatabase)

UniversalAuthenticationProvider

public UniversalAuthenticationProvider(UniversalAuthenticatorAccountDatabase accountDatabase,
                                       java.lang.String hostname)

UniversalAuthenticationProvider

public UniversalAuthenticationProvider(UniversalAuthenticatorAccountDatabase accountDatabase,
                                       java.lang.String hostname,
                                       int port)

Method Detail

isAuthorizedKey

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

Description copied from interface: PublicKeyAuthenticationProvider

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.

Specified by:

isAuthorizedKey in interface PublicKeyAuthenticationProvider

Parameters:

key - SshPublicKey

con - connection

Returns:

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

Throws:

java.io.IOException

getKeys

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

Specified by:

getKeys in interface PublicKeyAuthenticationProvider

Throws:

PermissionDeniedException

java.io.IOException

remove

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

Specified by:

remove in interface PublicKeyAuthenticationProvider

Throws:

java.io.IOException

PermissionDeniedException

SshException

add

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

Specified by:

add in interface PublicKeyAuthenticationProvider

Throws:

java.io.IOException

PermissionDeniedException

SshException

checkKey

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

Specified by:

checkKey in interface PublicKeyAuthenticationProvider

Throws:

java.io.IOException