Package jenkins.security

Interface ExtendedReadRedaction

All Superinterfaces:

ExtensionPoint

All Known Implementing Classes:

ExtendedReadSecretRedaction

public interface ExtendedReadRedaction
extends ExtensionPoint

Redact config.xml contents for users with ExtendedRead permission while lacking the required Configure permission to see the full unredacted configuration.

Since:

2.479

See Also:

• SECURITY-266
• Jenkins Security Advisory 2016-05-11

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Method Summary

Modifier and Type	Method	Description
static ExtensionList<ExtendedReadRedaction>	all()
String	apply(String configDotXml)	Redacts sensitive information from the provided config.xml file content.
static String	applyAll(String configDotXml)

Method Details

apply

String apply(String configDotXml)

Redacts sensitive information from the provided config.xml file content. Input may already have redactions applied; output may be passed through further redactions. These methods are expected to retain the basic structure of the XML document contained in input/output strings.

Parameters:

configDotXml - String representation of (potentially already redacted) config.xml file

Returns:

Redacted config.xml file content

all

static ExtensionList<ExtendedReadRedaction> all()

applyAll

static String applyAll(String configDotXml)