net.sf.sshapi.identity

Interface SshPublicKeySubsystem

All Superinterfaces:

SshLifecycleComponent

public interface SshPublicKeySubsystem
extends SshLifecycleComponent

Some server / provider combinations will be able to support management of authorized keys. Implementations of this interface are returned by SshClient.createPublicKeySubsystem(), which may then be used the keys.

Method Summary

Modifier and Type	Method and Description
void	add(SshPublicKey key, java.lang.String comment) Add a new authorized key.
SshPublicKey[]	list() List all of the available authorized keys.
void	remove(SshPublicKey key) Remove a key from the list of available authorized keys.

Methods inherited from interface net.sf.sshapi.SshLifecycleComponent

addListener, close, isOpen, open, removeListener

Method Detail

add

void add(SshPublicKey key,
         java.lang.String comment)
  throws SshException

Add a new authorized key.

Parameters:

key - key

comment - comment

Throws:

SshException

list

SshPublicKey[] list()
             throws SshException

List all of the available authorized keys.

Returns:

list of all of the available authorized keys.

Throws:

SshException

remove

void remove(SshPublicKey key)
     throws SshException

Remove a key from the list of available authorized keys. Any clients using this key will no longer be able to authenticate as this user.

Parameters:

key -

Throws:

SshException