Skip to content

[FIXED JENKINS-43857] Mask Secret parameters in InputSubmittedAction #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

[FIXED JENKINS-43857] Mask Secret parameters in InputSubmittedAction #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f55a95
[FIXED JENKINS-43857] Mask Secret parameters in InputSubmittedAction
abayer Apr 26, 2017
935b338
Ordering is not determinative.
abayer Apr 26, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion src/main/java/org/jenkinsci/plugins/workflow/support/steps/input/InputSubmittedAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@

package org.jenkinsci.plugins.workflow.support.steps.input;

import hudson.util.Secret;
import org.jenkinsci.plugins.workflow.actions.PersistentAction;

import javax.annotation.CheckForNull;
Expand All @@ -46,7 +47,15 @@ public class InputSubmittedAction implements PersistentAction {
public InputSubmittedAction(String approver, @CheckForNull Map<String,Object> parameters) {
this.approver = approver;
if (parameters != null) {
this.parameters.putAll(parameters);
for (Map.Entry<String,Object> entry : parameters.entrySet()) {
String k = entry.getKey();
Object v = entry.getValue();
if (v instanceof Secret) {
this.parameters.put(k, "******");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why? The plaintext cannot be recovered from build.xml without access to global keys anyway. PasswordParameterValue stores a Secret so why should we not do the same here?

} else {
this.parameters.put(k, v);
}
}
}
}

Expand Down
13 changes: 9 additions & 4 deletions src/test/java/org/jenkinsci/plugins/workflow/support/steps/input/InputStepTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public void parameter() throws Exception {
WorkflowJob foo = j.jenkins.createProject(WorkflowJob.class, "foo");
foo.setDefinition(new CpsFlowDefinition(StringUtils.join(Arrays.asList(
"echo('before');",
"def x = input message:'Do you want chocolate?', id:'Icecream', ok: 'Purchase icecream', parameters: [[$class: 'BooleanParameterDefinition', name: 'chocolate', defaultValue: false, description: 'Favorite icecream flavor']], submitter:'alice';",
"def x = input message:'Do you want chocolate?', id:'Icecream', ok: 'Purchase icecream', parameters: [[$class: 'BooleanParameterDefinition', name: 'chocolate', defaultValue: false, description: 'Favorite icecream flavor'], [$class: 'PasswordParameterDefinition', name: 'password', defaultValue: 'defaultPassword', description: 'A password']], submitter:'alice';",
"echo(\"after: ${x}\");"),"\n"),true));


Expand All @@ -95,7 +95,7 @@ public void parameter() throws Exception {

InputStepExecution is = a.getExecution("Icecream");
assertEquals("Do you want chocolate?", is.getInput().getMessage());
assertEquals(1, is.getInput().getParameters().size());
assertEquals(2, is.getInput().getParameters().size());
assertEquals("alice", is.getInput().getSubmitter());

j.assertEqualDataBoundBeans(is.getInput().getParameters().get(0), new BooleanParameterDefinition("chocolate", false, "Favorite icecream flavor"));
Expand All @@ -122,7 +122,10 @@ public void parameter() throws Exception {

// make sure 'x' gets assigned to false
System.out.println(b.getLog());
assertTrue(b.getLog().contains("after: false"));
// TODO: Should we be masking Secrets?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well yes, that is the important problem to solve!

assertTrue(b.getLog().contains("after: "));
assertTrue(b.getLog().contains("password:defaultPassword"));
assertTrue(b.getLog().contains("chocolate:false"));

//make sure the approver name corresponds to the submitter
ApproverAction action = b.getAction(ApproverAction.class);
Expand All @@ -143,9 +146,11 @@ public boolean apply(@Nullable FlowNode input) {

assertEquals("alice", inputSubmittedAction.getApprover());
Map<String,Object> submittedParams = inputSubmittedAction.getParameters();
assertEquals(1, submittedParams.size());
assertEquals(2, submittedParams.size());
assertTrue(submittedParams.containsKey("chocolate"));
assertEquals(false, submittedParams.get("chocolate"));
assertTrue(submittedParams.containsKey("password"));
assertEquals("******", submittedParams.get("password"));
}

@Test
Expand Down