Class SignedHeadersConfig

java.lang.Object

io.helidon.security.providers.httpsign.SignedHeadersConfig

public final class SignedHeadersConfig
extends Object

Configuration of required and "if-present" headers to be signed.

Example for configuration based approach:

sign-headers: [
 # request may sign headers not specified here - only specify the ones that MUST be signed
 {
     # if method is not defined, then this is the default config
     # MUST be present and signed
     always = ["date"]
 }
 {
     method = "GET"
     # MUST be present and signed
     always = ["date", "(request-target)", "host"]
     # MUST be signed IF present
     if-present = ["authorization"]
 }
]

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SignedHeadersConfig.Builder	Fluent API builder to create SignedHeadersConfig instances.
static final class	SignedHeadersConfig.HeadersConfig	Configuration of headers to be signed.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REQUEST_TARGET	Special header "(request-target)" is used for method and request target, including query when present.

Method Summary

Modifier and Type	Method	Description
static SignedHeadersConfig.Builder	builder()	Builder to create a new instance.
static SignedHeadersConfig	create(Config config)	Load header configuration from config.
List<String>	headers(String method)	Headers configured for a method.
List<String>	headers(String method, Map<String, List<String>> transportHeaders)	Headers configured for a method with optional headers matched against actual transport headers.

Methods inherited from class Object

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

Field Details

REQUEST_TARGET

public static final String REQUEST_TARGET

Special header "(request-target)" is used for method and request target, including query when present.

See Also:

• Constant Field Values

Method Details

create

public static SignedHeadersConfig create(Config config)

Load header configuration from config. Non-uppercase known HTTP methods also configure their uppercase names for compatibility and log a warning. An explicit uppercase configuration takes precedence over this compatibility configuration. Otherwise, the last non-uppercase configuration for a known method supplies its uppercase configuration. Custom methods retain exact case. Use uppercase names for known HTTP methods; this compatibility will be removed in a future major version.

Parameters:

config - config instance, expecting object array as children

Returns:

signed headers configuration loaded from config

builder

public static SignedHeadersConfig.Builder builder()

Builder to create a new instance.

Returns:

new builder

headers

public List<String> headers(String method,
 Map<String, List<String>> transportHeaders)

Headers configured for a method with optional headers matched against actual transport headers.

Parameters:

method - method (such as GET)

transportHeaders - actual headers received on the transport

Returns:

list of headers that must be signed

headers

public List<String> headers(String method)

Headers configured for a method.

Parameters:

method - method (such as GET)

Returns:

list of headers