Package jenkins.security.csp

Record Class Directive

java.lang.Object

java.lang.Record

jenkins.security.csp.Directive

Record Components:

name - default-src, frame-ancestors, etc.

inheriting - whether the directive is inheriting or not. Only applies to directives based on FetchDirective.

values - 'self', data:, jenkins.io, etc.

@Restricted(org.kohsuke.accmod.restrictions.Beta.class)
public record Directive(String name, Boolean inheriting, List<String> values)
extends Record

Represents a defined Content Security Policy directive

Since:

TODO

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI
static final String	BLOB
static final String	BLOCK_ALL_MIXED_CONTENT	Deprecated. by CSP spec
static final String	CHILD_SRC
static final String	CONNECT_SRC
static final String	DATA
static final String	DEFAULT_SRC
static final String	FONT_SRC
static final String	FORM_ACTION
static final String	FRAME_ANCESTORS
static final String	FRAME_SRC
static final String	IMG_SRC
static final String	MANIFEST_SRC
static final String	MEDIA_SRC
static final String	NONE	Disallow all.
static final String	OBJECT_SRC
static final String	PREFETCH_SRC
static final String	REPORT_SAMPLE
static final String	REPORT_TO	Unsupported for use in plugins.
static final String	REPORT_URI	Deprecated. by CSP spec
static final String	REQUIRE_TRUSTED_TYPES_FOR
static final String	SANDBOX
static final String	SCRIPT_SRC
static final String	SCRIPT_SRC_ATTR
static final String	SCRIPT_SRC_ELEM
static final String	SELF
static final String	STYLE_SRC
static final String	STYLE_SRC_ATTR
static final String	STYLE_SRC_ELEM
static final String	TRUSTED_TYPES
static final String	UNSAFE_EVAL	Deprecated. This should not be used.
static final String	UNSAFE_INLINE
static final String	UPGRADE_INSECURE_REQUESTS
static final String	WORKER_SRC

Constructor Summary

Constructors

Constructor	Description
Directive(String name, Boolean inheriting, List<String> values)	Creates an instance of a Directive record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Boolean	inheriting()	Returns the value of the inheriting record component.
String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.
List<String>	values()	Returns the value of the values record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_SRC

public static final String DEFAULT_SRC

See Also:

• Constant Field Values

CHILD_SRC

public static final String CHILD_SRC

See Also:

• Constant Field Values

CONNECT_SRC

public static final String CONNECT_SRC

See Also:

• Constant Field Values

FONT_SRC

public static final String FONT_SRC

See Also:

• Constant Field Values

FRAME_SRC

public static final String FRAME_SRC

See Also:

• Constant Field Values

IMG_SRC

public static final String IMG_SRC

See Also:

• Constant Field Values

MANIFEST_SRC

public static final String MANIFEST_SRC

See Also:

• Constant Field Values

MEDIA_SRC

public static final String MEDIA_SRC

See Also:

• Constant Field Values

OBJECT_SRC

public static final String OBJECT_SRC

See Also:

• Constant Field Values

PREFETCH_SRC

public static final String PREFETCH_SRC

See Also:

• Constant Field Values

SCRIPT_SRC

public static final String SCRIPT_SRC

See Also:

• Constant Field Values

SCRIPT_SRC_ELEM

public static final String SCRIPT_SRC_ELEM

See Also:

• Constant Field Values

SCRIPT_SRC_ATTR

public static final String SCRIPT_SRC_ATTR

See Also:

• Constant Field Values

STYLE_SRC

public static final String STYLE_SRC

See Also:

• Constant Field Values

STYLE_SRC_ELEM

public static final String STYLE_SRC_ELEM

See Also:

• Constant Field Values

STYLE_SRC_ATTR

public static final String STYLE_SRC_ATTR

See Also:

• Constant Field Values

WORKER_SRC

public static final String WORKER_SRC

See Also:

• Constant Field Values

BASE_URI

public static final String BASE_URI

See Also:

• Constant Field Values

BLOCK_ALL_MIXED_CONTENT

@Deprecated
public static final String BLOCK_ALL_MIXED_CONTENT

Deprecated.

by CSP spec

Deprecated directive.

See Also:

• MDN
• Constant Field Values

FORM_ACTION

public static final String FORM_ACTION

See Also:

• Constant Field Values

FRAME_ANCESTORS

public static final String FRAME_ANCESTORS

See Also:

• Constant Field Values

REPORT_TO

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static final String REPORT_TO

Unsupported for use in plugins.

See Also:

• CspBuilder.PROHIBITED_KEYS
• Constant Field Values

REPORT_URI

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@Deprecated
public static final String REPORT_URI

Deprecated.

by CSP spec

Deprecated directive. Intended to be replaced by REPORT_TO. Unsupported for use in plugins.

See Also:

• MDN
• CspBuilder.PROHIBITED_KEYS
• Constant Field Values

REQUIRE_TRUSTED_TYPES_FOR

public static final String REQUIRE_TRUSTED_TYPES_FOR

See Also:

• Constant Field Values

SANDBOX

public static final String SANDBOX

See Also:

• Constant Field Values

TRUSTED_TYPES

public static final String TRUSTED_TYPES

See Also:

• Constant Field Values

UPGRADE_INSECURE_REQUESTS

public static final String UPGRADE_INSECURE_REQUESTS

See Also:

• Constant Field Values

SELF

public static final String SELF

See Also:

• Constant Field Values

NONE

public static final String NONE

Disallow all. Note that this is not a valid argument for CspBuilder.add(String, String...). To initialize a previously undefined fetch directive, call CspBuilder.initialize(FetchDirective, String...) and pass no values. To remove all other values, call CspBuilder.remove(String, String...).

See Also:

• Constant Field Values

UNSAFE_INLINE

public static final String UNSAFE_INLINE

See Also:

• Constant Field Values

UNSAFE_EVAL

@Deprecated
public static final String UNSAFE_EVAL

Deprecated.

This should not be used.

Probably should not be used.

See Also:

• Constant Field Values

DATA

public static final String DATA

See Also:

• Constant Field Values

BLOB

public static final String BLOB

See Also:

• Constant Field Values

REPORT_SAMPLE

public static final String REPORT_SAMPLE

See Also:

• Constant Field Values

Constructor Details

Directive

public Directive(String name,
 Boolean inheriting,
 List<String> values)

Creates an instance of a Directive record class.

Parameters:

name - the value for the name record component

inheriting - the value for the inheriting record component

values - the value for the values record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

inheriting

public Boolean inheriting()

Returns the value of the inheriting record component.

Returns:

the value of the inheriting record component

values

public List<String> values()

Returns the value of the values record component.

Returns:

the value of the values record component