cn.orionsec.kit.net.host.ssh.command

Class CommandExecutor

java.lang.Object

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

cn.orionsec.kit.net.host.ssh.command.CommandExecutor

All Implemented Interfaces:

Executable, SafeCloseable, TimeoutEndpoint, HostConnector, ICommandExecutor, IHostExecutor, Closeable, AutoCloseable, Runnable

public class CommandExecutor
extends BaseHostExecutor<com.jcraft.jsch.ChannelExec>
implements ICommandExecutor

命令执行器

Since:

2020/10/6 12:51

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
CommandExecutor(com.jcraft.jsch.ChannelExec channel, byte[] command)
CommandExecutor(com.jcraft.jsch.ChannelExec channel, String command)
CommandExecutor(com.jcraft.jsch.ChannelExec channel, String command, String charset)

Method Summary

Modifier and Type	Method and Description
boolean	checkTimeout() 检测是否超时
void	close() 安全关闭
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	errorStreamHandler(Consumer<InputStream> errorStreamHandler) 设置错误输出流处理器
void	exec() 执行
String	getCommand() 获取执行的命令
byte[]	getCommandBytes() 获取执行的命令 byte
InputStream	getErrorStream() 获取错误输出流
int	getExitCode() 获取退出码
boolean	isTimeout() 是否超时
protected void	listenerOutput() 监听 标准输出/错误输出
void	merge() 合并标准输出流和错误输出流
void	pty(boolean enable) 是否使用伪终端 如果使用 当程序关闭时 命令进程一起关闭 如果不使用 当程序关闭时 命令进程可能不会一起关闭 必须在 HostConnector.connect() 之前调用
void	setAgentForwarding(boolean enable) 启用代理转发
void	timeout(long timeout, TimeoutChecker<TimeoutEndpoint> checker) 设置超时时间
String	toString()
void	transferError(OutputStream out) 传输错误输出流到指定输出流
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, wait, wait, wait

Methods inherited from interface cn.orionsec.kit.net.host.ssh.command.ICommandExecutor

isSuccessExit, timeout

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

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

Methods inherited from interface cn.orionsec.kit.lang.support.timeout.TimeoutEndpoint

isDone

Constructor Detail

CommandExecutor

public CommandExecutor(com.jcraft.jsch.ChannelExec channel,
                       String command)

CommandExecutor

public CommandExecutor(com.jcraft.jsch.ChannelExec channel,
                       String command,
                       String charset)

CommandExecutor

public CommandExecutor(com.jcraft.jsch.ChannelExec channel,
                       byte[] command)

Method Detail

pty

public void pty(boolean enable)

Description copied from interface: ICommandExecutor

是否使用伪终端

如果使用 当程序关闭时 命令进程一起关闭 如果不使用 当程序关闭时 命令进程可能不会一起关闭

必须在 HostConnector.connect() 之前调用

Specified by:

pty in interface ICommandExecutor

Parameters:

enable - 是否使用

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

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 - 是否启用

merge

public void merge()

Description copied from interface: ICommandExecutor

合并标准输出流和错误输出流

Specified by:

merge in interface ICommandExecutor

errorStreamHandler

public void errorStreamHandler(Consumer<InputStream> errorStreamHandler)

Description copied from interface: ICommandExecutor

设置错误输出流处理器

Specified by:

errorStreamHandler in interface ICommandExecutor

Parameters:

errorStreamHandler - 错误输出流处理器

transferError

public void transferError(OutputStream out)
                   throws IOException

Description copied from interface: ICommandExecutor

传输错误输出流到指定输出流

Specified by:

transferError in interface ICommandExecutor

Parameters:

out - out

Throws:

IOException - IOException

timeout

public void timeout(long timeout,
                    TimeoutChecker<TimeoutEndpoint> checker)

Description copied from interface: ICommandExecutor

设置超时时间

Specified by:

timeout in interface ICommandExecutor

Parameters:

timeout - timeout

checker - checker

checkTimeout

public boolean checkTimeout()

Description copied from interface: TimeoutEndpoint

检测是否超时

Specified by:

checkTimeout in interface TimeoutEndpoint

Returns:

是否超时

listenerOutput

protected void listenerOutput()

Description copied from class: BaseHostExecutor

监听 标准输出/错误输出

Specified by:

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

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.ChannelExec>

getExitCode

public int getExitCode()

Description copied from interface: ICommandExecutor

获取退出码

Specified by:

getExitCode in interface ICommandExecutor

Returns:

0正常结束

getCommand

public String getCommand()

Description copied from interface: ICommandExecutor

获取执行的命令

Specified by:

getCommand in interface ICommandExecutor

Returns:

command

getCommandBytes

public byte[] getCommandBytes()

Description copied from interface: ICommandExecutor

获取执行的命令 byte

Specified by:

getCommandBytes in interface ICommandExecutor

Returns:

command

isTimeout

public boolean isTimeout()

Description copied from interface: ICommandExecutor

是否超时

Specified by:

isTimeout in interface ICommandExecutor

Returns:

是否超时

getErrorStream

public InputStream getErrorStream()

Description copied from interface: ICommandExecutor

获取错误输出流

Specified by:

getErrorStream in interface ICommandExecutor

Returns:

错误输出流

toString

public String toString()

Overrides:

toString in class Object