[FIXED JENKINS-24130] - Added an option to mask PasswordParameters

This is a straightforward implementation, an additional re-factoring would be useful. The option is enabled by default, but this behavior can be changed in order to prevent any compatibility issues. Signed-off-by: Oleg Nenashev <o.v.nenashev@gmail.com>
jenkinsci · Aug 6, 2014 · dcf5703 · dcf5703
1 parent 13d5902
commit dcf5703
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 0 deletions.
diff --git a/src/main/java/org/jenkinsci/plugins/envinject/EnvInjectPasswordWrapper.java b/src/main/java/org/jenkinsci/plugins/envinject/EnvInjectPasswordWrapper.java
@@ -8,6 +8,9 @@
 import hudson.model.AbstractBuild;
 import hudson.model.AbstractProject;
 import hudson.model.BuildListener;
+import hudson.model.ParameterValue;
+import hudson.model.ParametersAction;
+import hudson.model.PasswordParameterValue;
 import hudson.model.Run;
 import hudson.tasks.BuildWrapper;
 import hudson.tasks.BuildWrapperDescriptor;
@@ -43,6 +46,7 @@ public String apply(EnvInjectPasswordEntry envInjectPasswordEntry) {
     };
 
     private boolean injectGlobalPasswords;
+    private boolean maskPasswordParameters;
     private EnvInjectPasswordEntry[] passwordEntries;
 
     @DataBoundConstructor
@@ -53,10 +57,18 @@ public boolean isInjectGlobalPasswords() {
         return injectGlobalPasswords;
     }
 
+    public boolean isMaskPasswordParameters() {
+        return maskPasswordParameters;
+    }
+
     public void setInjectGlobalPasswords(boolean injectGlobalPasswords) {
         this.injectGlobalPasswords = injectGlobalPasswords;
     }
 
+    public void setMaskPasswordParameters(boolean maskPasswordParameters) {
+        this.maskPasswordParameters = maskPasswordParameters;
+    }
+
     public EnvInjectPasswordEntry[] getPasswordEntries() {
         return passwordEntries;
     }
@@ -106,6 +118,24 @@ public OutputStream decorateLogger(AbstractBuild build, OutputStream outputStrea
             //--Decorate passwords
             List<String> passwords2decorate = Lists.newArrayList(Lists.transform(getEnvInjectPasswordEntries(), PASSWORD_ENTRY_TO_VALUE));
 
+            //-- Decorate password parameters
+            if (isMaskPasswordParameters()) {
+                logger.info("Mask passwords passed as build parameters.");
+
+                ParametersAction parametersAction = build.getAction(ParametersAction.class);
+                if (parametersAction != null) {
+                    List<ParameterValue> parameters = parametersAction.getParameters();
+                    if (parameters != null) {
+                        for (ParameterValue parameter : parameters) {
+                            if (parameter instanceof PasswordParameterValue) {
+                                PasswordParameterValue passwordParameterValue = ((PasswordParameterValue) parameter);
+                                passwords2decorate.add(passwordParameterValue.getValue().getPlainText());
+                            }
+                        }
+                    }
+                }
+            }
+
             return new EnvInjectPasswordsOutputStream(outputStream, passwords2decorate);
 
         } catch (EnvInjectException ee) {
@@ -221,6 +251,7 @@ public BuildWrapper newInstance(StaplerRequest req, JSONObject formData) throws
 
             EnvInjectPasswordWrapper passwordWrapper = new EnvInjectPasswordWrapper();
             passwordWrapper.setInjectGlobalPasswords(formData.getBoolean("injectGlobalPasswords"));
+            passwordWrapper.setMaskPasswordParameters(formData.getBoolean("maskPasswordParameters"));
 
             //Envinject passowrds
             List<EnvInjectPasswordEntry> passwordEntries = req.bindParametersToList(EnvInjectPasswordEntry.class, "envInjectPasswordEntry.");

diff --git a/src/main/resources/org/jenkinsci/plugins/envinject/EnvInjectPasswordWrapper/config.jelly b/src/main/resources/org/jenkinsci/plugins/envinject/EnvInjectPasswordWrapper/config.jelly
@@ -37,4 +37,11 @@
 
     </f:entry>
 
+    <f:entry field="maskPasswordParameters"
+             title="${%Mask password parameters}"
+             help="/plugin/envinject/help-buildWrapperMaskPasswordParameters.html">
+        <f:checkbox
+                name="maskPasswordParameters"
+                checked="${instance.maskPasswordParameters}" default="${true}"/>
+    </f:entry>
 </j:jelly>
diff --git a/src/main/webapp/help-buildWrapperMaskPasswordParameters.html b/src/main/webapp/help-buildWrapperMaskPasswordParameters.html
@@ -0,0 +1,5 @@
+<div>
+    <p>
+        Mask passwords provided by build parameters. <br/>
+    </p>
+</div>