Package org.apache.sshd.server.forward

Class StaticDecisionForwardingFilter

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.server.forward.StaticDecisionForwardingFilter

All Implemented Interfaces:

AgentForwardingFilter, ForwardingFilter, TcpForwardingFilter, X11ForwardingFilter

Direct Known Subclasses:

AcceptAllForwardingFilter, RejectAllForwardingFilter

public class StaticDecisionForwardingFilter
extends AbstractLoggingBean
implements ForwardingFilter

A ForwardingFilter implementation that returns the same "static" result for all the queries.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.sshd.server.forward.TcpForwardingFilter

TcpForwardingFilter.Type

Field Summary

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.server.forward.AgentForwardingFilter

DEFAULT

Fields inherited from interface org.apache.sshd.server.forward.TcpForwardingFilter

DEFAULT

Fields inherited from interface org.apache.sshd.server.forward.X11ForwardingFilter

DEFAULT

Constructor Summary

Constructors

Constructor	Description
StaticDecisionForwardingFilter(boolean acceptance)

Method Summary

Modifier and Type	Method	Description
boolean	canConnect(TcpForwardingFilter.Type type, SshdSocketAddress address, Session session)	Determine if the session may create an outbound connection.
boolean	canForwardAgent(Session session, String requestType)	Determine if the session may arrange for agent forwarding.
boolean	canForwardX11(Session session, String requestType)	Determine if the session may arrange for X11 forwarding.
boolean	canListen(SshdSocketAddress address, Session session)	Determine if the session may listen for inbound connections.
protected boolean	checkAcceptance(String request, Session session, SshdSocketAddress target)
boolean	isAccepted()

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticDecisionForwardingFilter

public StaticDecisionForwardingFilter(boolean acceptance)

Parameters:

acceptance - The acceptance status for all the queries

Method Detail

isAccepted

public final boolean isAccepted()

canForwardAgent

public boolean canForwardAgent(Session session,
                               String requestType)

Description copied from interface: AgentForwardingFilter

Determine if the session may arrange for agent forwarding.

This server process will open a new listen socket locally and export the address in the SshAgent.SSH_AUTHSOCKET_ENV_NAME environment variable.

Specified by:

canForwardAgent in interface AgentForwardingFilter

Parameters:

session - The Session requesting permission to forward the agent.

requestType - The request type string that triggered this call

Returns:

true if the agent forwarding is permitted, false if denied.

canForwardX11

public boolean canForwardX11(Session session,
                             String requestType)

Description copied from interface: X11ForwardingFilter

Determine if the session may arrange for X11 forwarding.

This server process will open a new listen socket locally and export the address in the environment so X11 clients can be tunneled to the user's X11 display server.

Specified by:

canForwardX11 in interface X11ForwardingFilter

Parameters:

session - The Session requesting permission to forward X11 connections.

requestType - The request type string that triggered this call

Returns:

true if the X11 forwarding is permitted, false if denied.

canListen

public boolean canListen(SshdSocketAddress address,
                         Session session)

Description copied from interface: TcpForwardingFilter

Determine if the session may listen for inbound connections.

This server process will open a new listen socket on the address given by the client (usually 127.0.0.1 but may be any address). Any inbound connections to this socket will be tunneled over the session to the client, which the client will then forward the connection to another host on the client's side of the network.

Specified by:

canListen in interface TcpForwardingFilter

Parameters:

address - address the client has requested this server listen for inbound connections on, and relay them through the client.

session - The Session requesting permission to listen for connections.

Returns:

true if the socket is permitted; false if it must be denied.

canConnect

public boolean canConnect(TcpForwardingFilter.Type type,
                          SshdSocketAddress address,
                          Session session)

Description copied from interface: TcpForwardingFilter

Determine if the session may create an outbound connection.

This server process will connect to another server listening on the address specified by the client. Usually this is to another port on the same host (127.0.0.1) but may be to any other system this server can reach on the server's side of the network.

Specified by:

canConnect in interface TcpForwardingFilter

Parameters:

type - The TcpForwardingFilter.Type of requested connection forwarding

address - address the client has requested this server listen for inbound connections on, and relay them through the client.

session - session requesting permission to listen for connections.

Returns:

true if the socket is permitted; false if it must be denied.

checkAcceptance

protected boolean checkAcceptance(String request,
                                  Session session,
                                  SshdSocketAddress target)

Parameters:

request - The SSH request that ultimately led to this filter being consulted

session - The requesting Session

target - The request target - may be SshdSocketAddress.LOCALHOST_ADDRESS if no real target

Returns:

The (static) isAccepted() flag