Skip to content

The Unified and Autonomous Development Platform

Added validation for the SSH key pair inserted during config phase.

Andrea Del Benef27405fedd24
diff --git a/server-core/src/main/java/io/onedev/server/crypto/DefaultKeyPairProvider.java b/server-core/src/main/java/io/onedev/server/crypto/DefaultKeyPairProvider.java
index dad2369758..6b27968964 100644
--- a/server-core/src/main/java/io/onedev/server/crypto/DefaultKeyPairProvider.java
+++ b/server-core/src/main/java/io/onedev/server/crypto/DefaultKeyPairProvider.java
@@ -1,22 +1,15 @@
package io.onedev.server.crypto;
-import java.io.StringReader;
-import java.security.KeyFactory;
import java.security.KeyPair;
import java.security.PrivateKey;
import java.security.PublicKey;
-import java.security.spec.PKCS8EncodedKeySpec;
-import java.security.spec.X509EncodedKeySpec;
import java.util.ArrayList;
import java.util.List;
import javax.inject.Inject;
import javax.inject.Singleton;
-import org.apache.sshd.common.config.keys.KeyUtils;
import org.apache.sshd.common.keyprovider.KeyPairProvider;
-import org.apache.sshd.common.util.security.SecurityUtils;
-import org.bouncycastle.util.io.pem.PemObject;
-import org.bouncycastle.util.io.pem.PemReader;
import io.onedev.server.entitymanager.SettingManager;
+import io.onedev.server.git.ssh.SshKeyUtils;
import io.onedev.server.model.Setting;
import io.onedev.server.model.Setting.Key;
import io.onedev.server.model.support.administration.SshSettings;
@@ -36,19 +29,9 @@ public class DefaultKeyPairProvider implements KeyPairProvider {
Setting setting = settingManager.getSetting(Key.SSH);
SshSettings sshSettings = (SshSettings) setting.getValue();
- try (PemReader pemReaderPrivate = new PemReader(new StringReader(sshSettings.getPrivateKey()));
- PemReader pemReaderPublic = new PemReader(new StringReader(sshSettings.getPublicKey()));
- ) {
- KeyFactory kf = SecurityUtils.getKeyFactory(KeyUtils.RSA_ALGORITHM);
-
- PemObject pemObjectPrivate = pemReaderPrivate.readPemObject();
- PKCS8EncodedKeySpec spec = new PKCS8EncodedKeySpec(pemObjectPrivate.getContent());
- PrivateKey privateKey = kf.generatePrivate(spec);
-
- PemObject pemObjectPublic = pemReaderPublic.readPemObject();
- X509EncodedKeySpec x509EncodedKeySpec = new X509EncodedKeySpec(pemObjectPublic.getContent());
- PublicKey publicKey = kf.generatePublic(x509EncodedKeySpec);
-
+ try {
+ PublicKey publicKey = SshKeyUtils.decodePublicKey(sshSettings.getPublicKey());
+ PrivateKey privateKey = SshKeyUtils.decodePrivateKey(sshSettings.getPrivateKey());
List<KeyPair> keys = new ArrayList<>();
keys.add(new KeyPair(publicKey, privateKey));
diff --git a/server-core/src/main/java/io/onedev/server/git/ssh/SshKeyUtils.java b/server-core/src/main/java/io/onedev/server/git/ssh/SshKeyUtils.java
index 85262d8415..e62c4fffe0 100644
--- a/server-core/src/main/java/io/onedev/server/git/ssh/SshKeyUtils.java
+++ b/server-core/src/main/java/io/onedev/server/git/ssh/SshKeyUtils.java
@@ -3,21 +3,38 @@ package io.onedev.server.git.ssh;
import java.io.IOException;
import java.io.StringReader;
import java.security.GeneralSecurityException;
+import java.security.KeyFactory;
+import java.security.PrivateKey;
import java.security.PublicKey;
-import java.util.List;
-import org.apache.sshd.common.config.keys.AuthorizedKeyEntry;
-import org.apache.sshd.common.config.keys.PublicKeyEntryResolver;
+import java.security.spec.PKCS8EncodedKeySpec;
+import java.security.spec.X509EncodedKeySpec;
+import org.apache.sshd.common.config.keys.KeyUtils;
import org.apache.sshd.common.digest.BaseDigest;
+import org.apache.sshd.common.util.security.SecurityUtils;
+import org.bouncycastle.util.io.pem.PemObject;
+import org.bouncycastle.util.io.pem.PemReader;
public class SshKeyUtils {
public static final BaseDigest MD5_DIGESTER = new BaseDigest("MD5", 512);
-
+
public static PublicKey decodePublicKey(String publicKey) throws IOException, GeneralSecurityException {
- StringReader stringReader = new StringReader(publicKey);
- List<AuthorizedKeyEntry> entries = AuthorizedKeyEntry.readAuthorizedKeys(stringReader, true);
-
- AuthorizedKeyEntry entry = entries.get(0);
- PublicKey pubEntry = entry.resolvePublicKey(PublicKeyEntryResolver.FAILING);
- return pubEntry;
+ try (PemReader pemReaderPublic = new PemReader(new StringReader(publicKey))) {
+ KeyFactory kf = SecurityUtils.getKeyFactory(KeyUtils.RSA_ALGORITHM);
+
+ PemObject pemObjectPublic = pemReaderPublic.readPemObject();
+ X509EncodedKeySpec x509EncodedKeySpec = new X509EncodedKeySpec(pemObjectPublic.getContent());
+ return kf.generatePublic(x509EncodedKeySpec);
+ }
+ }
+
+ public static PrivateKey decodePrivateKey(String privateKey) throws IOException, GeneralSecurityException {
+ try (PemReader pemReaderPrivate = new PemReader(new StringReader(privateKey))) {
+ KeyFactory kf = SecurityUtils.getKeyFactory(KeyUtils.RSA_ALGORITHM);
+
+ PemObject pemObjectPrivate = pemReaderPrivate.readPemObject();
+ PKCS8EncodedKeySpec spec = new PKCS8EncodedKeySpec(pemObjectPrivate.getContent());
+ return kf.generatePrivate(spec);
+ }
}
+
}
diff --git a/server-core/src/main/java/io/onedev/server/model/support/administration/SshSettings.java b/server-core/src/main/java/io/onedev/server/model/support/administration/SshSettings.java
index 5bc219468b..d5b8cc3480 100644
--- a/server-core/src/main/java/io/onedev/server/model/support/administration/SshSettings.java
+++ b/server-core/src/main/java/io/onedev/server/model/support/administration/SshSettings.java
@@ -3,6 +3,7 @@ package io.onedev.server.model.support.administration;
import java.io.Serializable;
import javax.validation.ConstraintValidatorContext;
import org.hibernate.validator.constraints.NotEmpty;
+import io.onedev.server.git.ssh.SshKeyUtils;
import io.onedev.server.util.validation.Validatable;
import io.onedev.server.util.validation.annotation.ClassValidating;
import io.onedev.server.web.editable.annotation.Editable;
@@ -17,10 +18,11 @@ public class SshSettings implements Serializable, Validatable {
private String serverSshUrl;
private String privateKey;
-
+
private String publicKey;
-
- @Editable(name="Ssh URL", order=90, description="Specify the URL to use with Git to access repositories via SSH")
+
+ @Editable(name = "Ssh URL", order = 90,
+ description = "Specify the URL to use with Git to access repositories via SSH")
@NotEmpty
public String getServerSshUrl() {
return serverSshUrl;
@@ -29,8 +31,9 @@ public class SshSettings implements Serializable, Validatable {
public void setServerSshUrl(String serverSshUrl) {
this.serverSshUrl = serverSshUrl;
}
-
- @Editable(name="Server private Key", order=90, description="Specify the private key (in PEM format) used by SSH server to establish connections")
+
+ @Editable(name = "Server private Key", order = 90,
+ description = "Specify the private key (in PEM format) used by SSH server to establish connections")
@Multiline
@NotEmpty
public String getPrivateKey() {
@@ -41,7 +44,8 @@ public class SshSettings implements Serializable, Validatable {
this.privateKey = privateKey;
}
- @Editable(name="Server public Key", order=90, description="Specify the public key (in PEM format) used by SSH server to establish connections")
+ @Editable(name = "Server public Key", order = 90,
+ description = "Specify the public key (in PEM format) used by SSH server to establish connections")
@Multiline
@NotEmpty
public String getPublicKey() {
@@ -54,7 +58,18 @@ public class SshSettings implements Serializable, Validatable {
@Override
public boolean isValid(ConstraintValidatorContext context) {
- //TODO build a keypair to validate the inserted keys
- return true;
+ boolean hasErrors = false;
+ String propertyNode = "privateKey";
+ try {
+ SshKeyUtils.decodePrivateKey(privateKey);
+ propertyNode = "publicKey";
+ SshKeyUtils.decodePublicKey(publicKey);
+ } catch (Exception e) {
+ context.buildConstraintViolationWithTemplate("The provided key is not valid. Please check it and try again.")
+ .addPropertyNode(propertyNode).addConstraintViolation()
+ .disableDefaultConstraintViolation();
+ hasErrors = true;
+ }
+ return !hasErrors;
}
}