com.sshtools.common.auth

Class AuthorizedKeysPublicKeyAuthenticationProvider

java.lang.Object

com.sshtools.common.auth.AbstractPublicKeyAuthenticationProvider

com.sshtools.common.auth.AuthorizedKeysPublicKeyAuthenticationProvider

All Implemented Interfaces:

Authenticator, PublicKeyAuthenticationProvider

public class AuthorizedKeysPublicKeyAuthenticationProvider
extends AbstractPublicKeyAuthenticationProvider

This class implements the OpenSSH style authorized_keys public key store.

Author:

Lee David Painter

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	authorizedKeysFile The path relative to the users home directory from which to load authorized keys

Constructor Summary

Constructors

Constructor and Description
AuthorizedKeysPublicKeyAuthenticationProvider() Create a default authorized_keys store that reads keys from .ssh/authorized_keys.
AuthorizedKeysPublicKeyAuthenticationProvider(java.lang.String authorizedKeysFile) Create an authorized keys stores that reads keys from a custom location.

Method Summary

Modifier and Type	Method and Description
void	add(SshPublicKey key, java.lang.String comment, SshConnection con)
boolean	checkKey(SshPublicKey key, SshConnection con)
protected AbstractFile	getFile(SshConnection con)
java.util.Iterator<SshPublicKeyFile>	getKeys(SshConnection con)
boolean	isAuthorizedKey(SshPublicKey key, SshConnection con) Checks the given public key by comparing it against the public keys stored in the users authorized_keys file.
void	remove(SshPublicKey key, SshConnection con)

Methods inherited from class com.sshtools.common.auth.AbstractPublicKeyAuthenticationProvider

getName

Methods inherited from class java.lang.Object

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

Field Detail

authorizedKeysFile

protected java.lang.String authorizedKeysFile

The path relative to the users home directory from which to load authorized keys

Constructor Detail

AuthorizedKeysPublicKeyAuthenticationProvider

public AuthorizedKeysPublicKeyAuthenticationProvider()

Create a default authorized_keys store that reads keys from .ssh/authorized_keys.

AuthorizedKeysPublicKeyAuthenticationProvider

public AuthorizedKeysPublicKeyAuthenticationProvider(java.lang.String authorizedKeysFile)

Create an authorized keys stores that reads keys from a custom location.

Parameters:

authorizedKeysFile - String

Method Detail

isAuthorizedKey

public boolean isAuthorizedKey(SshPublicKey key,
                               SshConnection con)

Checks the given public key by comparing it against the public keys stored in the users authorized_keys file.

Parameters:

key - SshPublicKey

sessionid - byte[]

authenticationProvider - AuthenticationProvider

Returns:

boolean

add

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

Specified by:

add in interface PublicKeyAuthenticationProvider

Overrides:

add in class AbstractPublicKeyAuthenticationProvider

Throws:

java.io.IOException

PermissionDeniedException

SshException

remove

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

Specified by:

remove in interface PublicKeyAuthenticationProvider

Overrides:

remove in class AbstractPublicKeyAuthenticationProvider

Throws:

java.io.IOException

PermissionDeniedException

SshException

getKeys

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

Specified by:

getKeys in interface PublicKeyAuthenticationProvider

Overrides:

getKeys in class AbstractPublicKeyAuthenticationProvider

Throws:

PermissionDeniedException

java.io.IOException

getFile

protected AbstractFile getFile(SshConnection con)
                        throws PermissionDeniedException,
                               java.io.IOException

Throws:

PermissionDeniedException

java.io.IOException

checkKey

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

Specified by:

checkKey in interface PublicKeyAuthenticationProvider

Overrides:

checkKey in class AbstractPublicKeyAuthenticationProvider

Throws:

java.io.IOException