Package io.jenkins.plugins.batchcontrol.store

Class SecretMasker

java.lang.Object

io.jenkins.plugins.batchcontrol.store.SecretMasker

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public final class SecretMasker
extends Object

Masks secret material in config XML text BEFORE it is diffed or stored (SPEC item 9: "unified diff with secrets masked"). Both diff sides must be masked with the same rules so a secret can never leak through either side of a hunk.

Two rules:

1. the text content of any element whose tag name contains password, secret, token (covers apiToken) or passphrase, case-insensitively;
2. anything shaped like an encrypted Jenkins Secret payload ({AQ<base64>}), wherever it appears.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MASK

Method Summary

Modifier and Type	Method	Description
static String	mask(String text)	Returns the text with every secret occurrence replaced by "********".

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MASK

public static final String MASK

See Also:

• Constant Field Values

Method Details

mask

public static String mask(String text)

Returns the text with every secret occurrence replaced by "********".