com.helger.http.csp

Class CSP2SourceList

java.lang.Object

com.helger.http.csp.CSP2SourceList

All Implemented Interfaces:

Serializable

@NotThreadSafe
public class CSP2SourceList
extends Object
implements Serializable

A source list to be used in a CSP 2.0 directive (CSP2Directive). It's just a convenient way to build a CSP directive value.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	HASH_PREFIX
static String	HASH_SUFFIX
static String	KEYWORD_NONE
static String	KEYWORD_SELF
static String	KEYWORD_UNSAFE_EVAL
static String	KEYWORD_UNSAFE_INLINE
static String	NONCE_PREFIX
static String	NONCE_SUFFIX

Constructor Summary

Constructors

Constructor and Description
CSP2SourceList()

Method Summary

Modifier and Type	Method and Description
CSP2SourceList	addHash(com.helger.security.messagedigest.EMessageDigestAlgorithm eMDAlgo, byte[] aHashValue) Add the provided nonce value.
CSP2SourceList	addHash(com.helger.security.messagedigest.EMessageDigestAlgorithm eMDAlgo, String sHashBase64Value) Add the provided Base64 encoded hash value.
CSP2SourceList	addHost(com.helger.commons.url.ISimpleURL aHost) Add a host
CSP2SourceList	addHost(String sHost) Add a host
CSP2SourceList	addKeywordNone() source expression 'none' represents an empty set of URIs
CSP2SourceList	addKeywordSelf() source expression 'self' represents the set of URIs which are in the same origin as the protected resource
CSP2SourceList	addKeywordUnsafeEval()
CSP2SourceList	addKeywordUnsafeInline() source expression 'unsafe-inline' represents content supplied inline in the resource itself
CSP2SourceList	addMimeType(com.helger.commons.mime.IMimeType aMimeType) Add a MIME type (for plugin-types)
CSP2SourceList	addNonce(byte[] aNonceValue) Add the provided nonce value.
CSP2SourceList	addNonce(String sNonceBase64Value) Add the provided Base64 encoded nonce value.
CSP2SourceList	addScheme(String sScheme) Add a scheme
boolean	equals(Object o)
String	getAsString()
int	getExpressionCount()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

KEYWORD_NONE

public static final String KEYWORD_NONE

See Also:

Constant Field Values

KEYWORD_SELF

public static final String KEYWORD_SELF

See Also:

Constant Field Values

KEYWORD_UNSAFE_INLINE

public static final String KEYWORD_UNSAFE_INLINE

See Also:

Constant Field Values

KEYWORD_UNSAFE_EVAL

public static final String KEYWORD_UNSAFE_EVAL

See Also:

Constant Field Values

NONCE_PREFIX

public static final String NONCE_PREFIX

See Also:

Constant Field Values

NONCE_SUFFIX

public static final String NONCE_SUFFIX

See Also:

Constant Field Values

HASH_PREFIX

public static final String HASH_PREFIX

See Also:

Constant Field Values

HASH_SUFFIX

public static final String HASH_SUFFIX

See Also:

Constant Field Values

Constructor Detail

CSP2SourceList

public CSP2SourceList()

Method Detail

getExpressionCount

@Nonnegative
public int getExpressionCount()

addScheme

@Nonnull
public CSP2SourceList addScheme(@Nonnull @Nonempty
                                          String sScheme)

Add a scheme

Parameters:

sScheme - Scheme in the format scheme ":"

Returns:

this

addHost

@Nonnull
public CSP2SourceList addHost(@Nonnull
                                        com.helger.commons.url.ISimpleURL aHost)

Add a host

Parameters:

aHost - Host to add. Must be a valid URL.

Returns:

this

addHost

@Nonnull
public CSP2SourceList addHost(@Nonnull @Nonempty
                                        String sHost)

Add a host

Parameters:

sHost - Host to add. Must be a valid URL or a star prefixed version.

Returns:

this

addMimeType

@Nonnull
public CSP2SourceList addMimeType(@Nonnull
                                            com.helger.commons.mime.IMimeType aMimeType)

Add a MIME type (for plugin-types)

Parameters:

aMimeType - MIME type to add. May not be null.

Returns:

this

addKeywordNone

@Nonnull
public CSP2SourceList addKeywordNone()

source expression 'none' represents an empty set of URIs

Returns:

this

addKeywordSelf

@Nonnull
public CSP2SourceList addKeywordSelf()

source expression 'self' represents the set of URIs which are in the same origin as the protected resource

Returns:

this

addKeywordUnsafeInline

@Nonnull
public CSP2SourceList addKeywordUnsafeInline()

source expression 'unsafe-inline' represents content supplied inline in the resource itself

Returns:

this

addKeywordUnsafeEval

@Nonnull
public CSP2SourceList addKeywordUnsafeEval()

addNonce

@Nonnull
public CSP2SourceList addNonce(@Nonnull @Nonempty
                                         byte[] aNonceValue)

Add the provided nonce value. The "\'nonce-" and NONCE_SUFFIX are added automatically. The byte array is automatically Bas64 encoded!

Parameters:

aNonceValue - The plain nonce value. May not be null.

Returns:

this for chaining

addNonce

@Nonnull
public CSP2SourceList addNonce(@Nonnull @Nonempty
                                         String sNonceBase64Value)

Add the provided Base64 encoded nonce value. The "\'nonce-" and NONCE_SUFFIX are added automatically.

Parameters:

sNonceBase64Value - The Base64 encoded nonce value

Returns:

this for chaining

addHash

@Nonnull
public CSP2SourceList addHash(@Nonnull
                                        com.helger.security.messagedigest.EMessageDigestAlgorithm eMDAlgo,
                                        @Nonnull @Nonempty
                                        byte[] aHashValue)

Add the provided nonce value. The "\'" and HASH_SUFFIX are added automatically. The byte array is automatically Bas64 encoded!

Parameters:

eMDAlgo - The message digest algorithm used. May only EMessageDigestAlgorithm.SHA_256, EMessageDigestAlgorithm.SHA_384 or EMessageDigestAlgorithm.SHA_512. May not be null.

aHashValue - The plain hash digest value. May not be null.

Returns:

this for chaining

addHash

@Nonnull
public CSP2SourceList addHash(@Nonnull
                                        com.helger.security.messagedigest.EMessageDigestAlgorithm eMDAlgo,
                                        @Nonnull
                                        String sHashBase64Value)

Add the provided Base64 encoded hash value. The "\'" and HASH_SUFFIX are added automatically.

Parameters:

eMDAlgo - The message digest algorithm used. May only EMessageDigestAlgorithm.SHA_256, EMessageDigestAlgorithm.SHA_384 or EMessageDigestAlgorithm.SHA_512. May not be null.

sHashBase64Value - The Base64 encoded hash value

Returns:

this for chaining

getAsString

@Nonnull
public String getAsString()

Returns:

The whole source list as a single string, separated by a blank char.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object