Package com.predic8.membrane.core.interceptor.apikey

Class ApiKeysInterceptor

java.lang.Object

com.predic8.membrane.core.interceptor.AbstractInterceptor

com.predic8.membrane.core.interceptor.apikey.ApiKeysInterceptor

All Implemented Interfaces:

Interceptor

public class ApiKeysInterceptor
extends AbstractInterceptor

Description

Secures APIs by validating keys stored in either files or proxies.xml. Keys can be received from clients via HTTP headers or URL query parameters. Additional permission checks are possible through scope validation - scopes are loaded into an Exchange property and can be checked using the "hasScope()" SpEL function.

Topic

6. Security

Nested Class Summary

Nested classes/interfaces inherited from interface com.predic8.membrane.core.interceptor.Interceptor

Interceptor.Flow

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SCOPES
static final String	TITLE_4XX
static final String	TYPE_4XX

Fields inherited from class com.predic8.membrane.core.interceptor.AbstractInterceptor

name, router

Constructor Summary

Constructors

Constructor	Description
ApiKeysInterceptor()

Method Summary

Modifier and Type	Method	Description
List<ApiKeyExtractor>	getExtractors()
Optional<LocationNameValue>	getKey(Exchange exc)
String	getLongDescription()
Set<String>	getScopes(String key)
String	getShortDescription()
List<ApiKeyStore>	getStores()
Outcome	handleRequest(Exchange exc)
void	init()	Called after parsing is complete and this has been added to the object tree (whose root is Router).
boolean	isRequired()
void	setExtractors(List<ApiKeyExtractor> extractors)
void	setRequired(boolean required)
void	setStores(List<ApiKeyStore> stores)

Methods inherited from class com.predic8.membrane.core.interceptor.AbstractInterceptor

getDisplayName, getFlow, getHelpId, getMessage, getRouter, getRule, handleAbort, handleResponse, init, setDisplayName, setFlow

Methods inherited from class java.lang.Object

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

Field Details

SCOPES

public static final String SCOPES

See Also:

• Constant Field Values

TYPE_4XX

public static final String TYPE_4XX

See Also:

• Constant Field Values

TITLE_4XX

public static final String TITLE_4XX

See Also:

• Constant Field Values

Constructor Details

ApiKeysInterceptor

public ApiKeysInterceptor()

Method Details

getShortDescription

public String getShortDescription()

Specified by:

getShortDescription in interface Interceptor

Overrides:

getShortDescription in class AbstractInterceptor

getLongDescription

public String getLongDescription()

Specified by:

getLongDescription in interface Interceptor

Overrides:

getLongDescription in class AbstractInterceptor

init

public void init()

Description copied from class: AbstractInterceptor

Called after parsing is complete and this has been added to the object tree (whose root is Router).

Overrides:

init in class AbstractInterceptor

handleRequest

public Outcome handleRequest(Exchange exc)

Specified by:

handleRequest in interface Interceptor

Overrides:

handleRequest in class AbstractInterceptor

getScopes

public Set<String> getScopes(String key)
                      throws UnauthorizedApiKeyException

Throws:

UnauthorizedApiKeyException

getKey

public Optional<LocationNameValue> getKey(Exchange exc)

setRequired

public void setRequired(boolean required)

Default

true

Description

Controls whether API key validation is enforced or optional. Optional will still load scopes and make them available for checking through SpEL function "hasScope()".

Example

false

isRequired

public boolean isRequired()

setStores

public void setStores(List<ApiKeyStore> stores)

Description

API key stores to validate keys against

getStores

public List<ApiKeyStore> getStores()

setExtractors

public void setExtractors(List<ApiKeyExtractor> extractors)

Default

(Using default header "X-Api-Key")

Description

Extractors that define where and how to extract API keys from requests

getExtractors

public List<ApiKeyExtractor> getExtractors()