Skip to content

The Unified and Autonomous Development Platform

Mask secret input from build log and build status message

Robin Shen7bfec63716dd
diff --git a/core/src/main/java/io/onedev/server/ci/job/log/DefaultLogManager.java b/core/src/main/java/io/onedev/server/ci/job/log/DefaultLogManager.java
index d2edad299a..1d4ac8e6ae 100644
--- a/core/src/main/java/io/onedev/server/ci/job/log/DefaultLogManager.java
+++ b/core/src/main/java/io/onedev/server/ci/job/log/DefaultLogManager.java
@@ -11,6 +11,7 @@ import java.io.InputStream;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.util.ArrayList;
+import java.util.Collection;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
@@ -49,6 +50,7 @@ import io.onedev.server.event.build.BuildFinished;
import io.onedev.server.model.Build;
import io.onedev.server.persistence.annotation.Sessional;
import io.onedev.server.storage.StorageManager;
+import io.onedev.server.util.inputspec.secretinput.SecretInput;
import io.onedev.server.web.websocket.WebSocketManager;
@Singleton
@@ -95,6 +97,7 @@ public class DefaultLogManager implements LogManager {
Long projectId = build.getProject().getId();
Long buildId = build.getId();
Long buildNumber = build.getNumber();
+ Collection<String> maskSecrets = build.getMaskSecrets();
return new JobLogger(loggerLevel) {
private static final long serialVersionUID = 1L;
@@ -108,6 +111,10 @@ public class DefaultLogManager implements LogManager {
break;
}
}
+
+ for (String maskSecret: maskSecrets)
+ message = StringUtils.replace(message, maskSecret, SecretInput.MASK);
+
if (logLevel.ordinal() <= loggerLevel.ordinal()) {
Lock lock = LockUtils.getReadWriteLock(getLockKey(buildId)).writeLock();
lock.lock();
diff --git a/core/src/main/java/io/onedev/server/model/Build.java b/core/src/main/java/io/onedev/server/model/Build.java
index 3a6b61b28e..bc8e916369 100644
--- a/core/src/main/java/io/onedev/server/model/Build.java
+++ b/core/src/main/java/io/onedev/server/model/Build.java
@@ -40,6 +40,8 @@ import io.onedev.server.util.Input;
import io.onedev.server.util.IssueUtils;
import io.onedev.server.util.Referenceable;
import io.onedev.server.util.facade.BuildFacade;
+import io.onedev.server.util.inputspec.InputSpec;
+import io.onedev.server.util.inputspec.secretinput.SecretInput;
@Entity
@Table(
@@ -277,8 +279,11 @@ public class Build extends AbstractEntity implements Referenceable {
}
public void setStatusMessage(String statusMessage) {
- if (statusMessage != null)
+ if (statusMessage != null) {
statusMessage = StringUtils.abbreviate(statusMessage, MAX_STATUS_MESSAGE);
+ for (String maskSecret: getMaskSecrets())
+ statusMessage = StringUtils.replace(statusMessage, maskSecret, SecretInput.MASK);
+ }
this.statusMessage = statusMessage;
}
@@ -374,6 +379,17 @@ public class Build extends AbstractEntity implements Referenceable {
return new BuildFacade(getId(), getProject().getId(), getCommitHash());
}
+ public Collection<String> getMaskSecrets() {
+ Collection<String> secrets = new HashSet<>();
+ for (BuildParam param: getParams()) {
+ if (param.getType().equals(InputSpec.SECRET)) {
+ if (param.getValue() != null && param.getValue().length() >= SecretInput.MASK.length())
+ secrets.add(param.getValue());
+ }
+ }
+ return secrets;
+ }
+
public static String getLogWebSocketObservable(Long buildId) {
return "build-log:" + buildId;
}
@@ -381,5 +397,5 @@ public class Build extends AbstractEntity implements Referenceable {
public static String getWebSocketObservable(Long buildId) {
return Build.class.getName() + ":" + buildId;
}
-
+
}
diff --git a/core/src/main/java/io/onedev/server/model/support/jobexecutor/ServerDockerExecutor.java b/core/src/main/java/io/onedev/server/model/support/jobexecutor/ServerDockerExecutor.java
index 195ab8004f..1a1d9f24d3 100644
--- a/core/src/main/java/io/onedev/server/model/support/jobexecutor/ServerDockerExecutor.java
+++ b/core/src/main/java/io/onedev/server/model/support/jobexecutor/ServerDockerExecutor.java
@@ -311,7 +311,7 @@ public class ServerDockerExecutor extends JobExecutor implements Testable<TestDa
cmd.execute(newInfoLogger(logger), newErrorLogger(logger));
}
- }).checkReturnCode();
+ }, logger).checkReturnCode();
return null;
} finally {
diff --git a/core/src/main/java/io/onedev/server/util/inputspec/secretinput/SecretInput.java b/core/src/main/java/io/onedev/server/util/inputspec/secretinput/SecretInput.java
index 6cd720dd19..54edc18d12 100644
--- a/core/src/main/java/io/onedev/server/util/inputspec/secretinput/SecretInput.java
+++ b/core/src/main/java/io/onedev/server/util/inputspec/secretinput/SecretInput.java
@@ -17,7 +17,7 @@ public class SecretInput extends InputSpec {
private static final long serialVersionUID = 1L;
- public static final String MASK = "******";
+ public static final String MASK = "*****";
private DefaultValueProvider defaultValueProvider;