Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.wl4g.infra.common.cli.ssh.SshdHelper Maven / Gradle / Ivy
/*
* Copyright 2017 ~ 2025 the original author or authors. James Wong
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.wl4g.infra.common.cli.ssh;
import static com.wl4g.infra.common.lang.Assert2.hasTextOf;
import static com.wl4g.infra.common.lang.Assert2.isTrueOf;
import static com.wl4g.infra.common.lang.Assert2.notNullOf;
import static java.util.Collections.singleton;
import static java.util.Objects.isNull;
import static java.util.Objects.nonNull;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.security.GeneralSecurityException;
import java.security.KeyPair;
import java.util.Iterator;
import java.util.Objects;
import org.apache.sshd.client.SshClient;
import org.apache.sshd.client.channel.ChannelExec;
import org.apache.sshd.client.channel.ClientChannelEvent;
import org.apache.sshd.client.future.AuthFuture;
import org.apache.sshd.client.session.ClientSession;
import org.apache.sshd.common.util.security.SecurityUtils;
import org.apache.sshd.scp.client.DefaultScpClientCreator;
import org.apache.sshd.scp.client.ScpClient;
import com.google.common.annotations.Beta;
import com.wl4g.infra.common.function.CallbackFunction;
import com.wl4g.infra.common.function.ProcessFunction;
import lombok.CustomLog;
/**
* Sshd based SSH2 tools.
*
* @author James Wong James Wong
* @version v1.0 2019年5月24日
* @see https://github.com/insinfo/java_native/tree/main/app/src/main/java/demo
*/
@Beta
@CustomLog
public class SshdHelper extends SshHelperBase {
private static final SshdHelper DEFAULT = new SshdHelper();
public static SshdHelper getInstance() {
return DEFAULT;
}
// --- Transfer files. ---
@Override
public void scpGetFile(
String host,
int port,
String user,
char[] pemPrivateKey,
String password,
File localFile,
String remoteFilePath) throws Exception {
notNullOf(localFile, "localFile");
hasTextOf(remoteFilePath, "remoteFilePath");
log.debug("SSH2 transfer file from {} to {}@{}:{}", localFile.getAbsolutePath(), user, host, remoteFilePath);
try {
// Transfer get file.
doScpTransfer(host, port, user, pemPrivateKey, password, scp -> {
scp.download(remoteFilePath, localFile.getAbsolutePath());
});
log.debug("SCP get transfered: '{}' from '{}@{}:{}'", localFile.getAbsolutePath(), user, host, remoteFilePath);
} catch (IOException e) {
throw e;
}
}
@Override
public void scpPutFile(
String host,
int port,
String user,
char[] pemPrivateKey,
String password,
File localFile,
String remoteDir) throws Exception {
notNullOf(localFile, "localFile");
hasTextOf(remoteDir, "remoteDir");
log.debug("SSH2 transfer file from {} to {}@{}:{}", localFile.getAbsolutePath(), user, host, remoteDir);
try {
// Transfer send file.
doScpTransfer(host, port, user, pemPrivateKey, password, scp -> {
scp.upload(localFile.getAbsolutePath(), remoteDir);
});
log.debug("SCP put transfered: '{}' to '{}@{}:{}'", localFile.getAbsolutePath(), user, host, remoteDir);
} catch (IOException e) {
throw e;
}
}
@Override
protected void doScpTransfer(
String host,
int port,
String user,
char[] pemPrivateKey,
String password,
CallbackFunction processor) throws Exception {
hasTextOf(host, "host");
isTrueOf(port >= 1, "port>=1");
hasTextOf(user, "user");
notNullOf(processor, "processor");
// Fallback uses the local current user private key by default.
if (isNull(pemPrivateKey)) {
pemPrivateKey = getDefaultLocalUserPrivateKey();
}
notNullOf(pemPrivateKey, "pemPrivateKey");
SshClient client = null;
ClientSession session = null;
ScpClient scpClient = null;
try {
client = SshClient.setUpDefaultClient();
client.start();
session = authWithPrivateKey(client, host, port, user, pemPrivateKey, password);
scpClient = DefaultScpClientCreator.INSTANCE.createScpClient(session);
processor.process(scpClient);
} catch (Exception e) {
throw e;
} finally {
try {
if (nonNull(session)) {
session.close();
}
} catch (Exception e) {
log.error("Closing session failure", e);
}
try {
if (nonNull(client)) {
client.stop();
client.close();
}
} catch (Exception e) {
log.error("Closing client failure", e);
}
}
}
// --- Execution commands. ---
public SSHExecResult execWaitForResponse(
String host,
int port,
String user,
char[] pemPrivateKey,
String password,
String command,
long timeoutMs) throws Exception {
return execWaitForComplete(host, port, user, pemPrivateKey, password, command, session -> {
String msg = null, errmsg = null;
if (nonNull(session.getOut())) {
// msg = readFullyToString(session.getOut());
msg = session.getOut().toString();
}
if (nonNull(session.getErr())) {
errmsg = session.getErr().toString();
}
return new SSHExecResult(session.getExitSignal(), session.getExitStatus(), msg, errmsg);
}, timeoutMs);
}
@Override
public T execWaitForComplete(
String host,
int port,
String user,
char[] pemPrivateKey,
String password,
String command,
ProcessFunction processor,
long timeoutMs) throws Exception {
return doExecCommand(host, port, user, pemPrivateKey, password, command, channelExec -> {
// Wait for completed by condition.
channelExec.waitFor(singleton(ClientChannelEvent.CLOSED), timeoutMs);
return processor.process(channelExec);
});
}
@Override
public T doExecCommand(
String host,
int port,
String user,
char[] pemPrivateKey,
String password,
String command,
ProcessFunction processor) throws Exception {
hasTextOf(host, "host");
isTrueOf(port >= 1, "port>=1");
hasTextOf(user, "user");
notNullOf(processor, "processor");
// Fallback uses the local current user private key by default.
if (isNull(pemPrivateKey) && isNull(password)) {
pemPrivateKey = getDefaultLocalUserPrivateKey();
}
ClientSession session = null;
ChannelExec chSession = null;
SshClient client = null;
ByteArrayOutputStream out = new ByteArrayOutputStream();
ByteArrayOutputStream err = new ByteArrayOutputStream();
try {
client = SshClient.setUpDefaultClient();
client.start();
session = authWithPrivateKey(client, host, null, user, pemPrivateKey, password);
// channelExec = session.createExecChannel(DEFAULT_LINUX_ENV_CMD +
// command);
chSession = session.createExecChannel(command);
chSession.setErr(err);
chSession.setOut(out);
chSession.open();
return processor.process(chSession);
} catch (Exception e) {
throw e;
} finally {
if (nonNull(out)) {
try {
out.close();
} catch (Exception e) {
log.error("Closing sshd output stream failure", e);
}
}
try {
if (nonNull(chSession)) {
chSession.close();
}
} catch (Exception e) {
log.error("Closing sshd channel failure", e);
}
try {
if (nonNull(session)) {
session.close();
}
} catch (Exception e) {
log.error("Closing sshd session failure", e);
}
try {
if (nonNull(client)) {
client.stop();
client.close();
}
} catch (Exception e) {
log.error("Closing sshd client failure", e);
}
}
}
private InputStream getStrToStream(String sInputString) {
if (sInputString != null && !sInputString.trim().equals("")) {
return new ByteArrayInputStream(sInputString.getBytes());
}
return null;
}
private ClientSession authWithPrivateKey(
SshClient client,
String host,
Integer port,
String user,
char[] pemPrivateKey,
String password) throws IOException, GeneralSecurityException {
final ClientSession session = client.connect(user, host, Objects.isNull(port) ? 22 : port).verify(10000).getSession();
if (nonNull(pemPrivateKey)) {
Iterable keyPairs = SecurityUtils.loadKeyPairIdentities(session, null,
getStrToStream(new String(pemPrivateKey)), null);
Iterator iterator = keyPairs.iterator();
if (iterator.hasNext()) {
KeyPair next = iterator.next();
session.addPublicKeyIdentity(next);// for password-less
}
} else {
notNullOf(password, "password");
session.addPasswordIdentity(password); // for password-based
}
AuthFuture verify = session.auth().verify(10_000);
if (!verify.isSuccess()) {
throw new GeneralSecurityException("auth fail");
}
return session;
}
// --- Tool function's. ---
@Override
public SSHKeyPair generateKeypair(AlgorithmType type, String comment) throws Exception {
throw new UnsupportedOperationException();
}
}
