cn.orionsec.kit.net.host.ssh.shell

Class ShellExecutor

java.lang.Object

cn.orionsec.kit.net.host.ssh.BaseHostExecutor<com.jcraft.jsch.ChannelShell>

cn.orionsec.kit.net.host.ssh.shell.ShellExecutor

All Implemented Interfaces:

Executable, SafeCloseable, HostConnector, IHostExecutor, IShellExecutor, Closeable, AutoCloseable, Runnable

public class ShellExecutor
extends BaseHostExecutor<com.jcraft.jsch.ChannelShell>
implements IShellExecutor

shell 执行器

Since:

2020/10/7 19:50

Version:

1.0.0

Author:

Jiahang Li

Field Summary

Fields inherited from class cn.orionsec.kit.net.host.ssh.BaseHostExecutor

callback, channel, done, inputStream, outputStream, streamHandler

Constructor Summary

Constructors

Constructor and Description
ShellExecutor(com.jcraft.jsch.ChannelShell channel)

Method Summary

Modifier and Type	Method and Description
void	close() 安全关闭
void	connect() 建立连接
void	connect(int timeout) 建立连接 使用此方法可能会导致连接不上 但是还不会抛出异常!
void	dpi(int width, int height) 设置页面 dpi
void	env(byte[] key, byte[] value) 设置环境变量 这里只支持设置 /etc/ssh/sshd_config AcceptEnv 的环境变量 否则只能使用 export LANG="en_US"; 来设置
void	env(String key, String value) 设置环境变量 这里只支持设置 /etc/ssh/sshd_config AcceptEnv 的环境变量 否则只能使用 export LANG="en_US"; 来设置
void	exec() 执行
int	getCols() 获取 行字数
int	getHeight() 获取 高px
int	getRows() 获取 列数
String	getTerminalType() 获取设置的终端类型
int	getWidth() 获取 宽px
protected void	listenerOutput() 监听 标准输出/错误输出
void	resize() 告知服务器重新设置终端大小
void	setAgentForwarding(boolean enable) 启用代理转发
void	size(int cols, int rows) 设置页面大小
void	size(int cols, int rows, int width, int height) 设置页面大小
void	terminalType(String terminalType) 设置终端类型
void	x11Forward(boolean enable) 是否启用 x11forwarding

Methods inherited from class cn.orionsec.kit.net.host.ssh.BaseHostExecutor

callback, getChannel, getInputStream, getOutputStream, isDone, sendSignal, streamHandler, transfer, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface cn.orionsec.kit.net.host.ssh.shell.IShellExecutor

terminalType

Methods inherited from interface cn.orionsec.kit.net.host.ssh.IHostExecutor

callback, exit, exit, getInputStream, getOutputStream, interrupt, isDone, run, sendSignal, streamHandler, transfer, write, write, write, writeLine, writeLine

Methods inherited from interface cn.orionsec.kit.net.host.HostConnector

disconnect, disconnectChannel, disconnectSession, getChannel, getSession, isClosed, isConnected, isEof

Constructor Detail

ShellExecutor

public ShellExecutor(com.jcraft.jsch.ChannelShell channel)

Method Detail

x11Forward

public void x11Forward(boolean enable)

Description copied from interface: IHostExecutor

是否启用 x11forwarding

Specified by:

x11Forward in interface IHostExecutor

Parameters:

enable - 是否启用

setAgentForwarding

public void setAgentForwarding(boolean enable)

Description copied from interface: IHostExecutor

启用代理转发

Specified by:

setAgentForwarding in interface IHostExecutor

Parameters:

enable - 是否启用

terminalType

public void terminalType(String terminalType)

Description copied from interface: IShellExecutor

设置终端类型

Specified by:

terminalType in interface IShellExecutor

Parameters:

terminalType - terminalType

size

public void size(int cols,
                 int rows)

Description copied from interface: IShellExecutor

设置页面大小

Specified by:

size in interface IShellExecutor

Parameters:

cols - 行字数

rows - 列数

dpi

public void dpi(int width,
                int height)

Description copied from interface: IShellExecutor

设置页面 dpi

Specified by:

dpi in interface IShellExecutor

Parameters:

width - 宽px

height - 高px

size

public void size(int cols,
                 int rows,
                 int width,
                 int height)

Description copied from interface: IShellExecutor

设置页面大小

Specified by:

size in interface IShellExecutor

Parameters:

cols - 行字数

rows - 列数

width - 宽px

height - 高px

resize

public void resize()

Description copied from interface: IShellExecutor

告知服务器重新设置终端大小

Specified by:

resize in interface IShellExecutor

connect

public void connect()

Description copied from interface: HostConnector

建立连接

Specified by:

connect in interface HostConnector

connect

public void connect(int timeout)

Description copied from interface: HostConnector

建立连接 使用此方法可能会导致连接不上 但是还不会抛出异常! 即 isConnected() 返回 false 因为设置了超时时间 会将 Channel.sendChannelOpen() 的 retry 设置为 1

Specified by:

connect in interface HostConnector

Parameters:

timeout - 超时时间 ms

env

public void env(byte[] key,
                byte[] value)

Description copied from interface: IHostExecutor

设置环境变量 这里只支持设置 /etc/ssh/sshd_config AcceptEnv 的环境变量 否则只能使用 export LANG="en_US"; 来设置

Specified by:

env in interface IHostExecutor

Parameters:

key - key

value - value

env

public void env(String key,
                String value)

Description copied from interface: IHostExecutor

设置环境变量 这里只支持设置 /etc/ssh/sshd_config AcceptEnv 的环境变量 否则只能使用 export LANG="en_US"; 来设置

Specified by:

env in interface IHostExecutor

Parameters:

key - key

value - value

listenerOutput

protected void listenerOutput()

Description copied from class: BaseHostExecutor

监听 标准输出/错误输出

Specified by:

listenerOutput in class BaseHostExecutor<com.jcraft.jsch.ChannelShell>

exec

public void exec()

Description copied from interface: Executable

执行

Specified by:

exec in interface Executable

close

public void close()

Description copied from interface: SafeCloseable

安全关闭

Specified by:

close in interface SafeCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class BaseHostExecutor<com.jcraft.jsch.ChannelShell>

getTerminalType

public String getTerminalType()

Description copied from interface: IShellExecutor

获取设置的终端类型

Specified by:

getTerminalType in interface IShellExecutor

Returns:

终端类型

getCols

public int getCols()

Description copied from interface: IShellExecutor

获取 行字数

Specified by:

getCols in interface IShellExecutor

Returns:

行字数

getRows

public int getRows()

Description copied from interface: IShellExecutor

获取 列数

Specified by:

getRows in interface IShellExecutor

Returns:

列数

getWidth

public int getWidth()

Description copied from interface: IShellExecutor

获取 宽px

Specified by:

getWidth in interface IShellExecutor

Returns:

宽px

getHeight

public int getHeight()

Description copied from interface: IShellExecutor

获取 高px

Specified by:

getHeight in interface IShellExecutor

Returns:

高px