Current File(s): conf/intercept/external-intercept-config.xml (V4.0), conf/idp.properties (V4.1+)
Format: Native Spring, Properties (V4.1+)
Table of Contents | ||||
---|---|---|---|---|
|
Overview
The "external" interceptor flow is analagous to the External login flow, but for interceptors. It allows an interceptor to be implemented outside of the IdP's Spring WebFlow architecture and routes through a bridge generally implemented in a Java servlet or JSP page, but can be combined with additional redirects out of and then back into the IdP for additional development flexibility.
Note |
---|
Once control is transferred to the external path, the IdP has no control over what happens. While the sensitivity of this feature is much less than with the authentication use case, it's still the deployer's responsibility to ensure the external code does what it's meant to do. |
General Configuration
Localtabgroupexpand | |||
---|---|---|---|
Localtab live |
| ||
Use conf/intercept/external-intercept-config.xml to configure this flow. The shibboleth.intercept.externalPath bean defines the flow redirection path to the resource that's used to perform the external interceptor's logic, by default a context-relative location. It must be a resource with access to the container session. Modify as needed to match the location of your external interface (see the documentation on flow redirects). You may also dynamically derive the path to use, typically so that it can vary based on aspects of the request, by defining a bean named shibboleth.intercept.externalPathStrategy of type Function<ProfileRequestContext,String> Localtab live | | active | true
Expand | ||
---|---|---|
| ||
The idp.intercept.External.externalPath property defines the flow redirection path to the resource that's used to perform the external interceptor's logic, by default a context-relative location. It must be a resource with access to the container session. Modify as needed to match the location of your external interface (see the documentation on flow redirects). On upgraded systems, the legacy file conf/intercept/external-intercept-config.xml may be removed if the property is defined in place of the original bean. You may also dynamically derive the path to use, typically so that it can vary based on aspects of the request, by defining a bean (e.g., in global.xml) named shibboleth.intercept.externalPathStrategy of type Function<ProfileRequestContext,String> |
...
On first access to the external resource, the request attributes below will be set.
Name | Type | Function |
---|---|---|
opensamlProfileRequestContext | Access to full request context tree |
Outputs
Name | Type | Function |
---|---|---|
event | String | ID of event to signal as result of the flow (defaults to "proceed" for a successful/continue outcome) |
Reference
Localtabgroup | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Expand | ||||||||||||
| ||||||||||||
The beans defined in conf/intercept/external-intercept-config.xml follow:
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
The following bean may be defined in conf/global.xml:
Localtab live | | active | true
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
The following properties may be defined in idp.properties:
|