The Unified and Autonomous Development Platform
refactor: Move cryptography into a managed service
Robin Shen3778711f143b
diff --git a/server-core/src/main/java/io/onedev/server/CoreModule.java b/server-core/src/main/java/io/onedev/server/CoreModule.javaindex 8185505ca6..bee529cabc 100644--- a/server-core/src/main/java/io/onedev/server/CoreModule.java+++ b/server-core/src/main/java/io/onedev/server/CoreModule.java@@ -87,6 +87,8 @@ import io.onedev.server.commandhandler.EnableInternalLogin;import io.onedev.server.commandhandler.RestoreDatabase;import io.onedev.server.commandhandler.Translate;import io.onedev.server.commandhandler.Upgrade;+import io.onedev.server.crypto.CryptoService;+import io.onedev.server.crypto.DefaultCryptoService;import io.onedev.server.data.DataService;import io.onedev.server.data.DefaultDataService;import io.onedev.server.entityreference.DefaultReferenceChangeService;@@ -502,6 +504,7 @@ public class CoreModule extends AbstractPluginModule {bind(SshService.class).to(DefaultSshService.class);bind(MarkdownService.class).to(DefaultMarkdownService.class);bind(SettingService.class).to(DefaultSettingService.class);+ bind(CryptoService.class).to(DefaultCryptoService.class);bind(DataService.class).to(DefaultDataService.class);bind(TaskScheduler.class).to(DefaultTaskScheduler.class);bind(PullRequestCommentService.class).to(DefaultPullRequestCommentService.class);diff --git a/server-core/src/main/java/io/onedev/server/crypto/CryptoService.java b/server-core/src/main/java/io/onedev/server/crypto/CryptoService.javanew file mode 100644index 0000000000..0881967376--- /dev/null+++ b/server-core/src/main/java/io/onedev/server/crypto/CryptoService.java@@ -0,0 +1,11 @@+package io.onedev.server.crypto;++public interface CryptoService {++ byte[] getCipherKey();++ byte[] encrypt(byte[] data);++ byte[] decrypt(byte[] data);++}diff --git a/server-core/src/main/java/io/onedev/server/crypto/DefaultCryptoService.java b/server-core/src/main/java/io/onedev/server/crypto/DefaultCryptoService.javanew file mode 100644index 0000000000..4ad7850a26--- /dev/null+++ b/server-core/src/main/java/io/onedev/server/crypto/DefaultCryptoService.java@@ -0,0 +1,92 @@+package io.onedev.server.crypto;++import java.io.ObjectStreamException;+import java.io.Serializable;+import java.security.NoSuchAlgorithmException;+import java.security.spec.InvalidKeySpecException;+import java.security.spec.KeySpec;++import javax.crypto.SecretKeyFactory;+import javax.crypto.spec.PBEKeySpec;++import io.onedev.server.persistence.annotation.Transactional;+import org.apache.commons.codec.binary.Base64;+import org.apache.shiro.crypto.cipher.AesCipherService;++import io.onedev.commons.loader.ManagedSerializedForm;+import io.onedev.server.cluster.ClusterService;+import io.onedev.server.event.Listen;+import io.onedev.server.event.entity.EntityPersisted;+import io.onedev.server.model.Setting;+import io.onedev.server.persistence.TransactionService;+import io.onedev.server.service.SettingService;+import jakarta.inject.Inject;+import jakarta.inject.Singleton;++@Singleton+public class DefaultCryptoService implements CryptoService, Serializable {++ @Inject+ private SettingService settingService;++ @Inject+ private TransactionService transactionService;++ @Inject+ private ClusterService clusterService;++ private final AesCipherService cipherService = new AesCipherService();++ private volatile byte[] cipherKey;++ @Override+ public byte[] getCipherKey() {+ byte[] key = cipherKey;+ if (key == null) {+ synchronized (this) {+ key = cipherKey;+ if (key == null) {+ byte[] privateKey = settingService.getSshSetting().getPrivateKey().getEncoded();+ // Keep the derivation stable across restarts and compatible with existing ciphertext.+ KeySpec spec = new PBEKeySpec(Base64.encodeBase64String(privateKey).toCharArray(), new byte[] {0}, 256, 256);+ try {+ SecretKeyFactory factory = SecretKeyFactory.getInstance("PBKDF2WithHmacSHA1");+ key = factory.generateSecret(spec).getEncoded();+ cipherKey = key;+ } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {+ throw new RuntimeException(e);+ }+ }+ }+ }+ return key;+ }++ @Override+ public byte[] encrypt(byte[] data) {+ return cipherService.encrypt(data, getCipherKey()).getBytes();+ }++ @Override+ public byte[] decrypt(byte[] data) {+ return cipherService.decrypt(data, getCipherKey()).getClonedBytes();+ }++ @Transactional+ @Listen+ public void on(EntityPersisted event) {+ if (event.getEntity() instanceof Setting && ((Setting) event.getEntity()).getKey() == Setting.Key.SSH) {+ transactionService.runAfterCommit(() -> clusterService.submitToAllServers(() -> {+ synchronized (DefaultCryptoService.this) {+ cipherKey = null;+ }+ return null;+ }));+ }+ }++ public Object writeReplace() throws ObjectStreamException {+ return new ManagedSerializedForm(CryptoService.class);+ }++}diff --git a/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java b/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.javaindex 3d037560aa..9f0f03ab3e 100644--- a/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java+++ b/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java@@ -40,6 +40,7 @@ import java.util.regex.Pattern;import jakarta.inject.Singleton;import org.apache.commons.io.IOUtils;+import org.apache.commons.lang3.RandomStringUtils;import org.apache.commons.lang3.Strings;import org.apache.commons.lang3.tuple.Triple;import org.apache.sshd.common.config.keys.KeyUtils;@@ -86,7 +87,6 @@ import io.onedev.server.model.support.issue.CommitMessageFixSetting;import io.onedev.server.model.support.issue.field.spec.BuildChoiceField;import io.onedev.server.service.SettingService;import io.onedev.server.ssh.SshKeyUtils;-import io.onedev.server.util.CryptoUtils;import io.onedev.server.util.DateUtils;import io.onedev.server.util.GpgUtils;import io.onedev.server.util.Pair;@@ -2138,7 +2138,7 @@ public class DataMigrator {} else if (file.getName().startsWith("Users.xml")) {VersionedXmlDoc dom = VersionedXmlDoc.fromFile(file);for (Element element : dom.getRootElement().elements()) {- element.addElement("accessToken").setText(CryptoUtils.generateSecret());+ element.addElement("accessToken").setText(RandomStringUtils.secure().nextAlphanumeric(40));element.addElement("ssoInfo").addElement("subject").setText(UUID.randomUUID().toString());}dom.writeToFile(file, false);@@ -2684,7 +2684,7 @@ public class DataMigrator {element.addElement("ssoInfo").addElement("subject").setText(UUID.randomUUID().toString());element.addElement("email").setText("unknown email");element.addElement("alternateEmails");- element.addElement("accessToken").setText(CryptoUtils.generateSecret());+ element.addElement("accessToken").setText(RandomStringUtils.secure().nextAlphanumeric(40));element.addElement("userProjectQueries");element.addElement("userIssueQueries");element.addElement("userIssueQueryWatches");@@ -4820,7 +4820,7 @@ public class DataMigrator {if (file.getName().startsWith("Users.xml")) {VersionedXmlDoc dom = VersionedXmlDoc.fromFile(file);for (Element element : dom.getRootElement().elements()) {- element.element("accessToken").setText(CryptoUtils.generateSecret());+ element.element("accessToken").setText(RandomStringUtils.secure().nextAlphanumeric(40));}dom.writeToFile(file, false);}diff --git a/server-core/src/main/java/io/onedev/server/git/hook/HookUtils.java b/server-core/src/main/java/io/onedev/server/git/hook/HookUtils.javaindex a942a6255c..85dc7f78f4 100644--- a/server-core/src/main/java/io/onedev/server/git/hook/HookUtils.java+++ b/server-core/src/main/java/io/onedev/server/git/hook/HookUtils.java@@ -6,8 +6,8 @@ import io.onedev.commons.utils.StringUtils;import io.onedev.server.OneDev;import io.onedev.server.ServerConfig;import io.onedev.server.service.SettingService;-import io.onedev.server.util.CryptoUtils;import org.apache.commons.io.IOUtils;+import org.apache.commons.lang3.RandomStringUtils;import java.io.File;import java.io.IOException;@@ -18,7 +18,7 @@ import java.util.Map;public class HookUtils {- public static final String RECEIVE_HOOK_TOKEN = CryptoUtils.generateSecret();+ public static final String RECEIVE_HOOK_TOKEN = RandomStringUtils.secure().nextAlphanumeric(40);public static final String PARAM_REF_UPDATES = "REF_UPDATES";diff --git a/server-core/src/main/java/io/onedev/server/model/AccessToken.java b/server-core/src/main/java/io/onedev/server/model/AccessToken.javaindex 61a0709868..976a83f15d 100644--- a/server-core/src/main/java/io/onedev/server/model/AccessToken.java+++ b/server-core/src/main/java/io/onedev/server/model/AccessToken.java@@ -3,8 +3,8 @@ package io.onedev.server.model;import com.fasterxml.jackson.annotation.JsonProperty;import io.onedev.server.rest.annotation.Immutable;import io.onedev.server.security.SecurityUtils;-import io.onedev.server.util.CryptoUtils;import io.onedev.server.util.facade.AccessTokenFacade;+import org.apache.commons.lang3.RandomStringUtils;import org.apache.shiro.authc.AuthenticationInfo;import org.apache.shiro.subject.PrincipalCollection;import org.apache.shiro.subject.Subject;@@ -40,7 +40,7 @@ public class AccessToken extends AbstractEntity implements AuthenticationInfo {@Column(nullable=false, unique=true)@JsonProperty(access = READ_ONLY)- private String value = CryptoUtils.generateSecret();+ private String value = RandomStringUtils.secure().nextAlphanumeric(40);private boolean hasOwnerPermissions;diff --git a/server-core/src/main/java/io/onedev/server/model/EmailAddress.java b/server-core/src/main/java/io/onedev/server/model/EmailAddress.javaindex 5dc835cdd2..0916cda247 100644--- a/server-core/src/main/java/io/onedev/server/model/EmailAddress.java+++ b/server-core/src/main/java/io/onedev/server/model/EmailAddress.java@@ -10,6 +10,7 @@ import jakarta.persistence.Table;import jakarta.validation.constraints.Email;import jakarta.validation.constraints.NotEmpty;+import org.apache.commons.lang3.RandomStringUtils;import org.hibernate.annotations.Cache;import org.hibernate.annotations.CacheConcurrencyStrategy;@@ -18,7 +19,6 @@ import com.fasterxml.jackson.annotation.JsonProperty;import io.onedev.server.annotation.Editable;import io.onedev.server.rest.annotation.Immutable;-import io.onedev.server.util.CryptoUtils;import io.onedev.server.util.facade.EmailAddressFacade;@Editable@@ -37,7 +37,7 @@ public class EmailAddress extends AbstractEntity {private String value;@JsonIgnore- private String verificationCode = CryptoUtils.generateSecret();+ private String verificationCode = RandomStringUtils.secure().nextAlphanumeric(40);@JsonProperty(access = JsonProperty.Access.READ_ONLY)private boolean primary;diff --git a/server-core/src/main/java/io/onedev/server/model/support/WebHook.java b/server-core/src/main/java/io/onedev/server/model/support/WebHook.javaindex 89df126cdf..f487bbed67 100644--- a/server-core/src/main/java/io/onedev/server/model/support/WebHook.java+++ b/server-core/src/main/java/io/onedev/server/model/support/WebHook.java@@ -1,5 +1,6 @@package io.onedev.server.model.support;+import org.apache.commons.lang3.RandomStringUtils;import io.onedev.server.event.project.RefUpdated;import io.onedev.server.event.project.build.BuildEvent;import io.onedev.server.event.project.codecomment.CodeCommentEvent;@@ -7,7 +8,6 @@ import io.onedev.server.event.project.issue.IssueEvent;import io.onedev.server.event.project.pack.PackEvent;import io.onedev.server.event.project.pullrequest.PullRequestEvent;import io.onedev.server.event.project.workspace.WorkspaceEvent;-import io.onedev.server.util.CryptoUtils;import io.onedev.server.annotation.Editable;import jakarta.validation.Valid;@@ -87,7 +87,7 @@ public class WebHook implements Serializable {private List<EventType> eventTypes = new ArrayList<>();- private String secret = CryptoUtils.generateSecret();+ private String secret = RandomStringUtils.secure().nextAlphanumeric(40);private List<WebHookHeader> headers = new ArrayList<>();diff --git a/server-core/src/main/java/io/onedev/server/security/DefaultRememberMeManager.java b/server-core/src/main/java/io/onedev/server/security/DefaultRememberMeManager.javaindex 00866582b9..3034c6e925 100644--- a/server-core/src/main/java/io/onedev/server/security/DefaultRememberMeManager.java+++ b/server-core/src/main/java/io/onedev/server/security/DefaultRememberMeManager.java@@ -1,22 +1,26 @@package io.onedev.server.security;-import io.onedev.server.util.CryptoUtils;+import io.onedev.server.crypto.CryptoService;import org.apache.shiro.subject.PrincipalCollection;import org.apache.shiro.web.mgt.CookieRememberMeManager;+import jakarta.inject.Inject;import jakarta.inject.Singleton;@Singletonpublic class DefaultRememberMeManager extends CookieRememberMeManager {+ @Inject+ private CryptoService cryptoService;+@Overridepublic byte[] getEncryptionCipherKey() {- return CryptoUtils.getCipherKey();+ return cryptoService.getCipherKey();}@Overridepublic byte[] getDecryptionCipherKey() {- return CryptoUtils.getCipherKey();+ return cryptoService.getCipherKey();}@Overridediff --git a/server-core/src/main/java/io/onedev/server/service/impl/DefaultAccessTokenService.java b/server-core/src/main/java/io/onedev/server/service/impl/DefaultAccessTokenService.javaindex dbdfecdb1b..7b65b81a9a 100644--- a/server-core/src/main/java/io/onedev/server/service/impl/DefaultAccessTokenService.java+++ b/server-core/src/main/java/io/onedev/server/service/impl/DefaultAccessTokenService.java@@ -6,6 +6,7 @@ import java.util.concurrent.TimeUnit;import jakarta.inject.Inject;import jakarta.inject.Singleton;+import org.apache.commons.lang3.RandomStringUtils;import org.apache.shiro.authc.DisabledAccountException;import com.hazelcast.core.HazelcastInstance;@@ -25,7 +26,6 @@ import io.onedev.server.persistence.annotation.Sessional;import io.onedev.server.persistence.annotation.Transactional;import io.onedev.server.service.AccessTokenService;import io.onedev.server.service.UserService;-import io.onedev.server.util.CryptoUtils;import io.onedev.server.util.facade.AccessTokenCache;@Singleton@@ -116,7 +116,7 @@ public class DefaultAccessTokenService extends BaseEntityService<AccessToken> im@Overridepublic String createTemporal(Long userId, long secondsToExpire) {- var value = CryptoUtils.generateSecret();+ var value = RandomStringUtils.secure().nextAlphanumeric(40);temporalAccessTokens.put(value, userId, secondsToExpire, TimeUnit.SECONDS);return value;}diff --git a/server-core/src/main/java/io/onedev/server/util/CryptoUtils.java b/server-core/src/main/java/io/onedev/server/util/CryptoUtils.javadeleted file mode 100644index 34eb12f2f3..0000000000--- a/server-core/src/main/java/io/onedev/server/util/CryptoUtils.java+++ /dev/null@@ -1,80 +0,0 @@-package io.onedev.server.util;--import io.onedev.server.OneDev;-import io.onedev.server.service.SettingService;-import org.apache.commons.codec.binary.Base64;-import org.apache.commons.lang3.RandomStringUtils;-import org.apache.shiro.crypto.cipher.AesCipherService;--import javax.crypto.SecretKeyFactory;-import javax.crypto.spec.PBEKeySpec;-import java.security.NoSuchAlgorithmException;-import java.security.SecureRandom;-import java.security.spec.InvalidKeySpecException;-import java.security.spec.KeySpec;--public class CryptoUtils {-- private static final int DEFAULT_SECRET_LEN = 40;-- private static volatile KeyPair keyPair;-- private static AesCipherService cipherService = new AesCipherService();-- public static byte[] getCipherKey() {- byte[] privateKey = OneDev.getInstance(SettingService.class).getSshSetting().getPrivateKey().getEncoded();- if (keyPair == null || !keyPair.getPrivateKey().equals(privateKey)) {- /*- * We do not use salt here to make sure that the cipher key remains the same after server restart.- * This will not sacrificing security as the private key is already a strong cipher- */- KeySpec spec = new PBEKeySpec(Base64.encodeBase64String(privateKey).toCharArray(), new byte[] {0}, 256, 256);- try {- SecretKeyFactory f = SecretKeyFactory.getInstance("PBKDF2WithHmacSHA1");- keyPair = new KeyPair(privateKey, f.generateSecret(spec).getEncoded());- } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {- throw new RuntimeException(e);- }- }- return keyPair.getCipherKey();- }-- public static String generateSecret(int count) {- return RandomStringUtils.random(count, 0, 0, true, true, null,- new SecureRandom());- }-- public static String generateSecret() {- return generateSecret(DEFAULT_SECRET_LEN);- }-- public static byte[] encrypt(byte[] data) {- return cipherService.encrypt(data, getCipherKey()).getBytes();- }-- public static byte[] decrypt(byte[] data) {- return cipherService.decrypt(data, getCipherKey()).getClonedBytes();- }-- private static class KeyPair {-- private final byte[] privateKey;-- private final byte[] cipherKey;-- public KeyPair(byte[] privateKey, byte[] cipherKey) {- this.privateKey = privateKey;- this.cipherKey = cipherKey;- }-- public byte[] getPrivateKey() {- return privateKey;- }-- public byte[] getCipherKey() {- return cipherKey;- }-- }--}diff --git a/server-core/src/main/java/io/onedev/server/web/component/user/accesstoken/AccessTokenPanel.java b/server-core/src/main/java/io/onedev/server/web/component/user/accesstoken/AccessTokenPanel.javaindex 838f22384d..96894ea95e 100644--- a/server-core/src/main/java/io/onedev/server/web/component/user/accesstoken/AccessTokenPanel.java+++ b/server-core/src/main/java/io/onedev/server/web/component/user/accesstoken/AccessTokenPanel.java@@ -2,6 +2,7 @@ package io.onedev.server.web.component.user.accesstoken;import static io.onedev.server.web.translation.Translation._T;+import org.apache.commons.lang3.RandomStringUtils;import org.apache.wicket.Session;import org.apache.wicket.ajax.AjaxRequestTarget;import org.apache.wicket.ajax.attributes.AjaxRequestAttributes;@@ -17,7 +18,6 @@ import io.onedev.server.data.migration.VersionedXmlDoc;import io.onedev.server.service.AccessTokenService;import io.onedev.server.service.AuditService;import io.onedev.server.model.AccessToken;-import io.onedev.server.util.CryptoUtils;import io.onedev.server.web.ajaxlistener.ConfirmClickListener;import io.onedev.server.web.editable.BeanContext;import io.onedev.server.web.page.user.UserPage;@@ -54,7 +54,7 @@ abstract class AccessTokenPanel extends Panel {public void onClick(AjaxRequestTarget target) {var oldAuditContent = VersionedXmlDoc.fromBean(token).toXML();var token = getToken();- token.setValue(CryptoUtils.generateSecret());+ token.setValue(RandomStringUtils.secure().nextAlphanumeric(40));var newAuditContent = VersionedXmlDoc.fromBean(token).toXML();OneDev.getInstance(AccessTokenService.class).createOrUpdate(token);if (getPage() instanceof UserPage) {diff --git a/server-core/src/main/java/io/onedev/server/web/component/user/profile/UserProfilePanel.java b/server-core/src/main/java/io/onedev/server/web/component/user/profile/UserProfilePanel.javaindex e5cb8063f8..3cc785b4c9 100644--- a/server-core/src/main/java/io/onedev/server/web/component/user/profile/UserProfilePanel.java+++ b/server-core/src/main/java/io/onedev/server/web/component/user/profile/UserProfilePanel.java@@ -14,6 +14,7 @@ import java.util.HashMap;import java.util.List;import java.util.Map;+import org.apache.commons.lang3.RandomStringUtils;import org.jspecify.annotations.Nullable;import org.apache.wicket.Component;@@ -66,7 +67,6 @@ import io.onedev.server.model.support.pullrequest.changedata.PullRequestReopenDaimport io.onedev.server.model.support.pullrequest.changedata.PullRequestRequestedForChangesData;import io.onedev.server.persistence.SessionService;import io.onedev.server.security.SecurityUtils;-import io.onedev.server.util.CryptoUtils;import io.onedev.server.util.DateRange;import io.onedev.server.util.DateUtils;import io.onedev.server.web.component.taskbutton.TaskButton;@@ -269,7 +269,7 @@ public abstract class UserProfilePanel extends GenericPanel<User> {if (settingService.getMailConnector() != null) {var user = getUser();if (user.getPrimaryEmailAddress() != null && user.getPrimaryEmailAddress().isVerified()) {- String passwordResetCode = CryptoUtils.generateSecret();+ String passwordResetCode = RandomStringUtils.secure().nextAlphanumeric(40);user.setPasswordResetCode(passwordResetCode);getUserService().update(user, null);diff --git a/server-core/src/main/java/io/onedev/server/web/component/user/twofactorauthentication/TwoFactorAuthenticationSetupPanel.java b/server-core/src/main/java/io/onedev/server/web/component/user/twofactorauthentication/TwoFactorAuthenticationSetupPanel.javaindex cc92a99f4c..602b00e785 100644--- a/server-core/src/main/java/io/onedev/server/web/component/user/twofactorauthentication/TwoFactorAuthenticationSetupPanel.java+++ b/server-core/src/main/java/io/onedev/server/web/component/user/twofactorauthentication/TwoFactorAuthenticationSetupPanel.java@@ -6,6 +6,7 @@ import java.util.ArrayList;import java.util.List;import org.apache.commons.codec.binary.Base32;+import org.apache.commons.lang3.RandomStringUtils;import org.apache.tika.mime.MediaType;import org.apache.wicket.ajax.AjaxRequestTarget;import org.apache.wicket.ajax.markup.html.AjaxLink;@@ -30,7 +31,6 @@ import io.onedev.server.OneDev;import io.onedev.server.service.UserService;import io.onedev.server.model.User;import io.onedev.server.model.support.TwoFactorAuthentication;-import io.onedev.server.util.CryptoUtils;import io.onedev.server.web.page.security.LoginPage;public abstract class TwoFactorAuthenticationSetupPanel extends GenericPanel<User> {@@ -49,7 +49,7 @@ public abstract class TwoFactorAuthenticationSetupPanel extends GenericPanel<UseList<String> scratchCodes = new ArrayList<>();for (int i=0; i<16; i++)- scratchCodes.add(CryptoUtils.generateSecret());+ scratchCodes.add(RandomStringUtils.secure().nextAlphanumeric(40));TwoFactorAuthentication authentication = new TwoFactorAuthentication(secretKey, scratchCodes);diff --git a/server-core/src/main/java/io/onedev/server/web/page/base/BasePage.java b/server-core/src/main/java/io/onedev/server/web/page/base/BasePage.javaindex 0ba12a8424..e74d523a24 100644--- a/server-core/src/main/java/io/onedev/server/web/page/base/BasePage.java+++ b/server-core/src/main/java/io/onedev/server/web/page/base/BasePage.java@@ -69,6 +69,7 @@ import io.onedev.server.OneDev;import io.onedev.server.ai.ChatTool;import io.onedev.server.ai.ChatToolAware;import io.onedev.server.ai.ChatToolsContribution;+import io.onedev.server.crypto.CryptoService;import io.onedev.server.ai.ToolExecutionResult;import io.onedev.server.commandhandler.Upgrade;import io.onedev.server.event.ListenerRegistry;@@ -78,7 +79,6 @@ import io.onedev.server.model.User;import io.onedev.server.security.SecurityUtils;import io.onedev.server.service.AuditService;import io.onedev.server.service.SettingService;-import io.onedev.server.util.CryptoUtils;import io.onedev.server.web.WebSession;import io.onedev.server.web.asset.icon.IconScope;import io.onedev.server.web.behavior.AbstractPostAjaxBehavior;@@ -122,6 +122,9 @@ public abstract class BasePage extends WebPage {@Injectprivate SettingService settingService;+ @Inject+ protected CryptoService cryptoService;+@Injectprotected ListenerRegistry listenerRegistry;@@ -247,7 +250,7 @@ public abstract class BasePage extends WebPage {throw new BadRequestException("Pop state data is missing");byte[] bytes = Base64.decodeBase64(encodedData.getBytes());- Serializable data = (Serializable) SerializationUtils.deserialize(CryptoUtils.decrypt(bytes));+ Serializable data = (Serializable) SerializationUtils.deserialize(cryptoService.decrypt(bytes));onPopState(target, data);resizeWindow(target);target.appendJavaScript("onedev.server.viewState.getFromHistoryAndSetToView();");@@ -437,7 +440,7 @@ public abstract class BasePage extends WebPage {}private String encodeHistoryState(Serializable data) {- return Base64.encodeBase64String(CryptoUtils.encrypt(SerializationUtils.serialize(data)));+ return Base64.encodeBase64String(cryptoService.encrypt(SerializationUtils.serialize(data)));}public void pushState(IPartialPageRequestHandler handler, String url, Serializable data) {diff --git a/server-core/src/main/java/io/onedev/server/web/page/security/PasswordResetPage.java b/server-core/src/main/java/io/onedev/server/web/page/security/PasswordResetPage.javaindex 21a8ae7a94..3ca6cf1f3b 100644--- a/server-core/src/main/java/io/onedev/server/web/page/security/PasswordResetPage.java+++ b/server-core/src/main/java/io/onedev/server/web/page/security/PasswordResetPage.java@@ -11,12 +11,12 @@ import io.onedev.server.model.EmailAddress;import io.onedev.server.model.User;import io.onedev.server.model.support.administration.emailtemplates.EmailTemplates;import io.onedev.server.persistence.SessionService;-import io.onedev.server.util.CryptoUtils;import io.onedev.server.web.component.taskbutton.TaskButton;import io.onedev.server.web.component.taskbutton.TaskResult;import io.onedev.server.web.component.taskbutton.TaskResult.PlainMessage;import io.onedev.server.web.editable.BeanContext;import io.onedev.server.web.page.simple.SimplePage;+import org.apache.commons.lang3.RandomStringUtils;import org.apache.shiro.authc.credential.PasswordService;import org.apache.wicket.Session;import org.apache.wicket.ajax.AjaxRequestTarget;@@ -114,7 +114,7 @@ public class PasswordResetPage extends SimplePage {emailAddressValue = emailAddress.getValue();}- String passwordResetCode = CryptoUtils.generateSecret();+ String passwordResetCode = RandomStringUtils.secure().nextAlphanumeric(40);user.setPasswordResetCode(passwordResetCode);getUserService().update(user, null);diff --git a/server-core/src/main/java/io/onedev/server/web/resource/AttachmentResource.java b/server-core/src/main/java/io/onedev/server/web/resource/AttachmentResource.javaindex fa26e3b9a1..8fd04c2fc6 100644--- a/server-core/src/main/java/io/onedev/server/web/resource/AttachmentResource.java+++ b/server-core/src/main/java/io/onedev/server/web/resource/AttachmentResource.java@@ -32,6 +32,7 @@ import io.onedev.k8shelper.KubernetesHelper;import io.onedev.server.OneDev;import io.onedev.server.attachment.AttachmentService;import io.onedev.server.cluster.ClusterService;+import io.onedev.server.crypto.CryptoService;import io.onedev.server.model.Build;import io.onedev.server.model.Issue;import io.onedev.server.model.Project;@@ -41,7 +42,6 @@ import io.onedev.server.service.CodeCommentService;import io.onedev.server.service.IssueService;import io.onedev.server.service.ProjectService;import io.onedev.server.service.PullRequestService;-import io.onedev.server.util.CryptoUtils;import io.onedev.server.util.IOUtils;public class AttachmentResource extends AbstractResource {@@ -73,7 +73,7 @@ public class AttachmentResource extends AbstractResource {String authorization = params.get(PARAM_AUTHORIZATION).toOptionalString();if (authorization == null- || !new String(CryptoUtils.decrypt(Base64.decodeBase64(authorization)), UTF_8).equals(attachmentGroup)) {+ || !new String(OneDev.getInstance(CryptoService.class).decrypt(Base64.decodeBase64(authorization)), UTF_8).equals(attachmentGroup)) {Issue issue;Build build;if (OneDev.getInstance(PullRequestService.class).find(attachmentGroup) != null@@ -180,7 +180,7 @@ public class AttachmentResource extends AbstractResource {URIBuilder builder = new URIBuilder(attachmentUrl);if (builder.getPathSegments().size() >= 5) {String group = builder.getPathSegments().get(4);- byte[] encrypted = CryptoUtils.encrypt(group.getBytes(UTF_8));+ byte[] encrypted = OneDev.getInstance(CryptoService.class).encrypt(group.getBytes(UTF_8));String base64 = Base64.encodeBase64URLSafeString(encrypted);builder.addParameter(PARAM_AUTHORIZATION, base64);}diff --git a/server-core/src/test/java/io/onedev/server/crypto/DefaultCryptoServiceTest.java b/server-core/src/test/java/io/onedev/server/crypto/DefaultCryptoServiceTest.javanew file mode 100644index 0000000000..2eb2ea33d3--- /dev/null+++ b/server-core/src/test/java/io/onedev/server/crypto/DefaultCryptoServiceTest.java@@ -0,0 +1,238 @@+package io.onedev.server.crypto;++import static java.nio.charset.StandardCharsets.UTF_8;+import static org.junit.jupiter.api.Assertions.*;+import static org.mockito.ArgumentMatchers.any;+import static org.mockito.Mockito.*;++import java.security.PrivateKey;+import java.util.ArrayList;+import java.util.Arrays;+import java.util.Base64;+import java.util.List;+import java.util.Map;+import java.util.concurrent.CountDownLatch;+import java.util.concurrent.Executors;+import java.util.concurrent.Future;+import java.util.concurrent.TimeUnit;+import java.util.concurrent.TimeoutException;+import java.util.concurrent.atomic.AtomicReference;++import org.apache.commons.lang3.SerializationUtils;+import org.junit.jupiter.api.Test;++import com.google.inject.Guice;++import io.onedev.commons.loader.AppLoader;+import io.onedev.server.cluster.ClusterService;+import io.onedev.server.cluster.ClusterTask;+import io.onedev.server.event.entity.EntityPersisted;+import io.onedev.server.model.Setting;+import io.onedev.server.model.User;+import io.onedev.server.model.support.administration.SshSetting;+import io.onedev.server.persistence.TransactionService;+import io.onedev.server.service.SettingService;++class DefaultCryptoServiceTest {++ private final SettingService settingService = mock(SettingService.class);++ private final TransactionService transactionService = mock(TransactionService.class);++ private final ClusterService clusterService = mock(ClusterService.class);++ private final DefaultCryptoService cryptoService = newCryptoService();++ private DefaultCryptoService newCryptoService() {+ return Guice.createInjector(binder -> {+ binder.bind(SettingService.class).toInstance(settingService);+ binder.bind(TransactionService.class).toInstance(transactionService);+ binder.bind(ClusterService.class).toInstance(clusterService);+ }).getInstance(DefaultCryptoService.class);+ }++ private SshSetting sshSetting(int offset) {+ byte[] encoded = new byte[64];+ for (int i = 0; i < encoded.length; i++)+ encoded[i] = (byte) (i + offset);+ var privateKey = mock(PrivateKey.class);+ when(privateKey.getEncoded()).thenAnswer(it -> encoded.clone());+ var sshSetting = mock(SshSetting.class);+ when(sshSetting.getPrivateKey()).thenReturn(privateKey);+ return sshSetting;+ }++ @Test+ void cachesKeyAndPreservesExistingCiphertext() {+ var sshSetting = sshSetting(0);+ when(settingService.getSshSetting()).thenReturn(sshSetting);+ // Captured from the original implementation using encoded private-key bytes 0 through 63.+ byte[] oldKey = Base64.getDecoder().decode("fLpW9Nn+cp8SKEgss4otvEHZ0RdTbWP391YC0Q/5GGo=");+ byte[] oldCiphertext = Base64.getDecoder().decode(+ "Fa6Sl+VOchRgq/PL1GrBXdOzAtut5TqU554/MBgv85CYPO8Zri5U7V3AJT9oAOi4bYSj");+ assertArrayEquals(oldKey, cryptoService.getCipherKey());+ assertArrayEquals("existing ciphertext".getBytes(UTF_8), cryptoService.decrypt(oldCiphertext));++ byte[] data = new byte[1024];+ for (int i = 0; i < data.length; i++)+ data[i] = (byte) i;+ byte[] encrypted = cryptoService.encrypt(data);+ assertArrayEquals(data, cryptoService.decrypt(encrypted));+ assertFalse(Arrays.equals(encrypted, cryptoService.encrypt(data)));+ verify(settingService).getSshSetting();+ verify(sshSetting).getPrivateKey();+ }++ @Test+ void initializesOnlyOnceAndReadsCachedKeyWithoutLocking() throws Exception {+ var sshSetting = sshSetting(0);+ when(settingService.getSshSetting()).thenReturn(sshSetting);+ var executor = Executors.newFixedThreadPool(8);+ var ready = new CountDownLatch(8);+ var start = new CountDownLatch(1);+ try {+ List<Future<byte[]>> results = new ArrayList<>();+ for (int i = 0; i < 8; i++) {+ results.add(executor.submit(() -> {+ ready.countDown();+ assertTrue(start.await(5, TimeUnit.SECONDS));+ return cryptoService.getCipherKey();+ }));+ }+ assertTrue(ready.await(5, TimeUnit.SECONDS));+ start.countDown();+ byte[] key = results.get(0).get(5, TimeUnit.SECONDS);+ for (var result: results)+ assertSame(key, result.get(5, TimeUnit.SECONDS));+ verify(sshSetting).getPrivateKey();+ synchronized (cryptoService) {+ var cachedRead = executor.submit(cryptoService::getCipherKey);+ assertSame(key, cachedRead.get(5, TimeUnit.SECONDS));+ }+ } finally {+ start.countDown();+ executor.shutdownNow();+ assertTrue(executor.awaitTermination(5, TimeUnit.SECONDS));+ }+ }++ @Test+ void oldInitializationDoesNotOverwriteUpdatedKey() throws Exception {+ var oldSshSetting = sshSetting(0);+ var oldPrivateKey = oldSshSetting.getPrivateKey();+ var initializationStarted = new CountDownLatch(1);+ var finishInitialization = new CountDownLatch(1);+ when(oldSshSetting.getPrivateKey()).thenAnswer(it -> {+ initializationStarted.countDown();+ assertTrue(finishInitialization.await(5, TimeUnit.SECONDS));+ return oldPrivateKey;+ });+ when(settingService.getSshSetting()).thenReturn(oldSshSetting);+ doAnswer(it -> {+ it.<Runnable>getArgument(0).run();+ return null;+ }).when(transactionService).runAfterCommit(any());+ var submittedTask = new AtomicReference<ClusterTask<?>>();+ when(clusterService.submitToAllServers(any())).thenAnswer(it -> {+ submittedTask.set(it.getArgument(0));+ return Map.of();+ });++ var executor = Executors.newFixedThreadPool(2);+ try {+ var oldInitialization = executor.submit(cryptoService::getCipherKey);+ assertTrue(initializationStarted.await(5, TimeUnit.SECONDS));+ var newSshSetting = sshSetting(1);+ when(settingService.getSshSetting()).thenReturn(newSshSetting);+ var setting = new Setting();+ setting.setKey(Setting.Key.SSH);+ cryptoService.on(new EntityPersisted(setting, false));+ var invalidationStarted = new CountDownLatch(1);+ var invalidation = executor.submit(() -> {+ invalidationStarted.countDown();+ return submittedTask.get().call();+ });+ assertTrue(invalidationStarted.await(5, TimeUnit.SECONDS));+ assertThrows(TimeoutException.class, () -> invalidation.get(100, TimeUnit.MILLISECONDS));++ finishInitialization.countDown();+ byte[] oldKey = oldInitialization.get(5, TimeUnit.SECONDS);+ invalidation.get(5, TimeUnit.SECONDS);+ byte[] newKey = cryptoService.getCipherKey();+ assertFalse(Arrays.equals(newKey, oldKey));+ assertSame(newKey, cryptoService.getCipherKey());+ } finally {+ finishInitialization.countDown();+ executor.shutdownNow();+ assertTrue(executor.awaitTermination(5, TimeUnit.SECONDS));+ }+ }++ @Test+ void invalidatesEachServerAfterCommitAndReloadsLazily() throws Exception {+ var oldSshSetting = sshSetting(0);+ when(settingService.getSshSetting()).thenReturn(oldSshSetting);+ var otherServer = newCryptoService();+ byte[] oldKey = cryptoService.getCipherKey();+ byte[] otherOldKey = otherServer.getCipherKey();+ var afterCommit = new AtomicReference<Runnable>();+ doAnswer(it -> {+ afterCommit.set(it.getArgument(0));+ return null;+ }).when(transactionService).runAfterCommit(any());++ var previousInjector = AppLoader.injector;+ try {+ var currentServer = new AtomicReference<CryptoService>();+ var submittedTask = new AtomicReference<byte[]>();+ var pendingTask = mock(Future.class);+ AppLoader.injector = Guice.createInjector(binder ->+ binder.bind(CryptoService.class).toProvider(currentServer::get));+ when(clusterService.submitToAllServers(any())).thenAnswer(it -> {+ ClusterTask<?> task = it.getArgument(0);+ submittedTask.set(SerializationUtils.serialize(task));+ return Map.of("first", pendingTask, "second", pendingTask);+ });++ var setting = new Setting();+ setting.setKey(Setting.Key.SSH);+ cryptoService.on(new EntityPersisted(setting, false));+ assertNotNull(afterCommit.get());+ verifyNoInteractions(clusterService);+ assertSame(oldKey, cryptoService.getCipherKey());+ assertSame(otherOldKey, otherServer.getCipherKey());++ var newSshSetting = sshSetting(1);+ when(settingService.getSshSetting()).thenReturn(newSshSetting);+ afterCommit.get().run();+ verify(clusterService).submitToAllServers(any());+ verifyNoInteractions(pendingTask);+ assertSame(oldKey, cryptoService.getCipherKey());+ assertSame(otherOldKey, otherServer.getCipherKey());++ for (var server: List.of(cryptoService, otherServer)) {+ currentServer.set(server);+ ClusterTask<?> remoteTask = SerializationUtils.deserialize(submittedTask.get());+ remoteTask.call();+ }+ verify(newSshSetting, never()).getPrivateKey();+ byte[] newKey = cryptoService.getCipherKey();+ assertFalse(Arrays.equals(oldKey, newKey));+ assertArrayEquals(newKey, otherServer.getCipherKey());+ assertSame(newKey, cryptoService.getCipherKey());+ verify(newSshSetting, times(2)).getPrivateKey();+ } finally {+ AppLoader.injector = previousInjector;+ }+ }++ @Test+ void ignoresUnrelatedChanges() {+ var setting = new Setting();+ setting.setKey(Setting.Key.SYSTEM);+ cryptoService.on(new EntityPersisted(setting, false));+ cryptoService.on(new EntityPersisted(new User(), false));+ verifyNoInteractions(settingService, transactionService, clusterService);+ }++}diff --git a/server-ee b/server-eeindex 463fbb1119..9f9c096b99 160000--- a/server-ee+++ b/server-ee@@ -1 +1 @@-Subproject commit 463fbb11193e5dc1c54bdd603bd42a074e99bbd4+Subproject commit 9f9c096b9915b67726b0bab185925dc65cbd9a59diff --git a/server-plugin/server-plugin-pack-container/src/main/java/io/onedev/server/plugin/pack/container/ContainerServlet.java b/server-plugin/server-plugin-pack-container/src/main/java/io/onedev/server/plugin/pack/container/ContainerServlet.javaindex 6fe8e6f647..c5aae70dd2 100644--- a/server-plugin/server-plugin-pack-container/src/main/java/io/onedev/server/plugin/pack/container/ContainerServlet.java+++ b/server-plugin/server-plugin-pack-container/src/main/java/io/onedev/server/plugin/pack/container/ContainerServlet.java@@ -37,6 +37,7 @@ import jakarta.servlet.http.HttpServlet;import jakarta.servlet.http.HttpServletRequest;import jakarta.servlet.http.HttpServletResponse;+import org.apache.commons.lang3.RandomStringUtils;import org.apache.shiro.authz.UnauthorizedException;import org.eclipse.jetty.http.HttpStatus;@@ -57,7 +58,6 @@ import io.onedev.server.service.PackBlobService;import io.onedev.server.service.PackService;import io.onedev.server.service.ProjectService;import io.onedev.server.service.SettingService;-import io.onedev.server.util.CryptoUtils;import io.onedev.server.util.Digest;import io.onedev.server.util.HttpUtils;import io.onedev.server.util.Pair;@@ -123,7 +123,7 @@ public class ContainerServlet extends HttpServlet {var jsonObj = new HashMap<String, String>();String accessTokenValue = SecurityUtils.createTemporalAccessTokenIfUserPrincipal(3600);if (accessTokenValue == null)- accessTokenValue = CryptoUtils.generateSecret();+ accessTokenValue = RandomStringUtils.secure().nextAlphanumeric(40);var jobToken = HttpUtils.getAuthBasicUser(request);if (jobToken == null)jobToken = UUID.randomUUID().toString();