SpringCloud/spring-cloud-config
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Replaces Jsch with Apache MINA in config-server (#2113)

Browse Source 
* Bumps jgit to 6.2.x

* FileBasedSshSessionFacotry sets the properties only for relevant host

Co-authored-by: Ryan Baxter <rbaxter@vmware.com>
This commit is contained in:
Kaveh Shamsi
2022-07-26 16:57:08 -04:00
committed by GitHub
parent dc810e2c83
commit cc22b88a5b
6 changed files with 60 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
spring-cloud-config-dependencies/pom.xml
View File

@@ -15,7 +15,7 @@
<name>spring-cloud-config-dependencies</name>
<description>Spring Cloud Config Dependencies</description>
<properties>
<jgit.version>5.13.1.202206130422-r</jgit.version>
<jgit.version>6.2.0.202206071550-r</jgit.version>
<spring-vault.version>3.0.0-M2</spring-vault.version>
<spring-credhub.version>2.1.1.RELEASE</spring-credhub.version>
</properties>

15
spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/ssh/FileBasedSshSessionFactory.java
View File

@@ -17,6 +17,7 @@
package org.springframework.cloud.config.server.ssh;
import java.io.File;
import java.util.Map;
import org.eclipse.jgit.annotations.NonNull;
import org.eclipse.jgit.internal.transport.ssh.OpenSshConfigFile;
@@ -33,10 +34,11 @@ public class FileBasedSshSessionFactory extends SshdSessionFactory {
private static final String NO_OPTION = "no";
private final JGitEnvironmentProperties sshUriProperties;
private final Map<String, JGitEnvironmentProperties> sshKeysByHostname;
public FileBasedSshSessionFactory(JGitEnvironmentProperties sshUriProperties) {
this.sshUriProperties = sshUriProperties;
public FileBasedSshSessionFactory(Map<String, JGitEnvironmentProperties> sshKeysByHostname) {
this.sshKeysByHostname = sshKeysByHostname;
assert this.sshKeysByHostname.entrySet().size() > 0;
}
@Override
@@ -47,8 +49,13 @@ public class FileBasedSshSessionFactory extends SshdSessionFactory {
public HostEntry lookup(@NonNull String hostName, int port, String userName) {
HostEntry hostEntry = super.lookup(hostName, port, userName);
JGitEnvironmentProperties sshProperties = sshKeysByHostname.get(hostName);
if (sshProperties == null) {
return hostEntry;
}
hostEntry.setValue(STRICT_HOST_KEY_CHECKING,
sshUriProperties.isStrictHostKeyChecking() ? YES_OPTION : NO_OPTION);
sshProperties.isStrictHostKeyChecking() ? YES_OPTION : NO_OPTION);
return hostEntry;
}

3
spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/ssh/FileBasedSshTransportConfigCallback.java
View File

@@ -43,7 +43,8 @@ public class FileBasedSshTransportConfigCallback implements TransportConfigCallb
@Override
public void configure(Transport transport) {
if (transport instanceof SshTransport) {
((SshTransport) transport).setSshSessionFactory(new FileBasedSshSessionFactory(sshUriProperties));
((SshTransport) transport).setSshSessionFactory(new FileBasedSshSessionFactory(
new SshUriPropertyProcessor(this.sshUriProperties).getSshKeysByHostname()));
}
}

13
spring-cloud-config-server/src/main/java/org/springframework/cloud/config/server/ssh/PropertyBasedSshSessionFactory.java
View File

@@ -40,6 +40,7 @@ import org.eclipse.jgit.internal.transport.ssh.OpenSshConfigFile;
import org.eclipse.jgit.internal.transport.sshd.OpenSshServerKeyDatabase;
import org.eclipse.jgit.transport.CredentialsProvider;
import org.eclipse.jgit.transport.SshConfigStore;
import org.eclipse.jgit.transport.SshConstants;
import org.eclipse.jgit.transport.sshd.JGitKeyCache;
import org.eclipse.jgit.transport.sshd.ProxyData;
import org.eclipse.jgit.transport.sshd.ProxyDataFactory;
@@ -88,6 +89,18 @@ public class PropertyBasedSshSessionFactory extends SshdSessionFactory {
return updateIfNeeded(hostEntry, hostName);
}
@Override
public HostConfig lookupDefault(String hostName, int port, String userName) {
OpenSshConfigFile.HostEntry hostEntry = new OpenSshConfigFile.HostEntry();
hostEntry.setValue(SshConstants.HOST_NAME, hostName);
hostEntry.setValue(SshConstants.PORT,
Integer.toString(port > 0 ? port : SshConstants.SSH_DEFAULT_PORT));
hostEntry.setValue(SshConstants.USER, userName);
return updateIfNeeded(hostEntry, hostName);
}
private OpenSshConfigFile.HostEntry updateIfNeeded(OpenSshConfigFile.HostEntry hostEntry, String hostName) {
JGitEnvironmentProperties sshProperties = sshKeysByHostname.get(hostName);
if (sshProperties == null) {

17
spring-cloud-config-server/src/test/java/org/springframework/cloud/config/server/ssh/FileBasedSshSessionFactoryTest.java
View File

@@ -17,6 +17,8 @@
package org.springframework.cloud.config.server.ssh;
import java.io.File;
import java.util.HashMap;
import java.util.Map;
import org.eclipse.jgit.transport.SshConfigStore;
import org.junit.Test;
@@ -58,6 +60,17 @@ public class FileBasedSshSessionFactoryTest {
assertThat(sshConfig.getValue("StrictHostKeyChecking")).isEqualTo("yes");
}
@Test
public void sshConfigurationIsDoneForRelevantHostOnly() {
JGitEnvironmentProperties sshKey = new JGitEnvironmentProperties();
sshKey.setUri("ssh://gitlab.example.local:3322/somerepo.git");
setupSessionFactory(sshKey);
SshConfigStore.HostConfig sshConfig = getSshHostConfig("another.host");
assertThat(sshConfig.getValue("StrictHostKeyChecking")).isNull();
}
@Test
public void handlesNullConfigFile() {
JGitEnvironmentProperties sshKey = new JGitEnvironmentProperties();
@@ -75,7 +88,9 @@ public class FileBasedSshSessionFactoryTest {
}
private void setupSessionFactory(JGitEnvironmentProperties sshKey) {
this.factory = new FileBasedSshSessionFactory(sshKey);
Map<String, JGitEnvironmentProperties> sshKeysByHostname = new HashMap<>();
sshKeysByHostname.put(SshUriPropertyProcessor.getHostname(sshKey.getUri()), sshKey);
this.factory = new FileBasedSshSessionFactory(sshKeysByHostname);
}
}

18
spring-cloud-config-server/src/test/java/org/springframework/cloud/config/server/ssh/PropertyBasedSshSessionFactoryTest.java
View File

@@ -209,7 +209,7 @@ public class PropertyBasedSshSessionFactoryTest {
}
@Test
public void proxySettingsIsUsed() throws Exception {
public void proxySettingsIsUsed() {
JGitEnvironmentProperties sshProperties = new JGitEnvironmentProperties();
sshProperties.setUri("ssh://gitlab.example.local:3322/somerepo.git");
sshProperties.setPrivateKey(PRIVATE_KEY);
@@ -231,6 +231,17 @@ public class PropertyBasedSshSessionFactoryTest {
assertThat(proxyData.getProxy().address().toString()).containsPattern("host\\.domain.*:8080");
}
@Test
public void defaultSshConfigIsSet() {
setupSessionFactory(new JGitEnvironmentProperties());
SshConfigStore.HostConfig sshConfig = getDefaultSshHostConfig("host.name", 123, "user.name");
assertThat(sshConfig.getValue("HostName")).isEqualTo("host.name");
assertThat(sshConfig.getValue("Port")).isEqualTo("123");
assertThat(sshConfig.getValue("User")).isEqualTo("user.name");
}
@Test
public void sshConfigFileIsNotUsed() {
setupSessionFactory(new JGitEnvironmentProperties());
@@ -309,6 +320,11 @@ public class PropertyBasedSshSessionFactoryTest {
"userName");
}
private SshConfigStore.HostConfig getDefaultSshHostConfig(String hostName, int port, String username) {
return factory.createSshConfigStore(new File("dummy"), new File("dummy"), "localUserName")
.lookupDefault(hostName, port, username);
}
private void setupSessionFactory(JGitEnvironmentProperties sshKey) {
Map<String, JGitEnvironmentProperties> sshKeysByHostname = new HashMap<>();
sshKeysByHostname.put(SshUriPropertyProcessor.getHostname(sshKey.getUri()), sshKey);