Package org.jenkinsci.plugins.credentialsbinding.masking

Class SecretPatterns

java.lang.Object

org.jenkinsci.plugins.credentialsbinding.masking.SecretPatterns

public class SecretPatterns
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SecretPatterns.MaskingOutputStream	Delegating output stream that masks occurrences of a set of secrets.

Method Summary

Modifier and Type	Method	Description
static Pattern	getAggregateSecretPattern(Collection<String> inputs)	Constructs a regular expression to match against all known forms that the given collection of input strings may appear.

Methods inherited from class java.lang.Object

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

Method Details

getAggregateSecretPattern

@NonNull
public static Pattern getAggregateSecretPattern(@NonNull
 Collection<String> inputs)

Constructs a regular expression to match against all known forms that the given collection of input strings may appear. This pattern is optimized such that longer masks are checked before shorter masks. By doing so, this makes inputs that are substrings of other inputs be masked as the longer input, though there is no guarantee this will work in every possible situation. Another consequence of this ordering is that inputs that require quoting will be masked before a substring of the input was matched, thus avoiding leakage of information. For example, bash -x will only quote arguments echoed when necessary. To avoid leaking the presence or absence of quoting, the longer form is masked.