Page tree

Previous Stable Release

Please note that the V3 release branch is now the previous stable release, with the current stable releases from the V4 branch.
Support for V3 will end on Dec 31, 2020.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Overview

The Script (basic:Script prior to V3.2.0) type allows definition of complex filtering by defining an ECMA script is a either a Mapper or a PolicyRule depending on the location.  The script has define either a Policy Rule or a Mapper depending on its location

  • If the script is specified within the scope of an <AttributeRule> element then the script has to be Mapper, returning a java.util.Set<AttributeValue>, which is added to the permit or deny list for the attribute in questione
  • If the script  is specified within the scope of a <PolicyRequirementRule>element then the script has to be a PolicyRule  (returning a java.lang.Boolean), whuich defines whether the rule is active or not.

Schema Name

The Script type is defined by the urn:mace:shibboleth:2.0:afp schema, which can be located at http://shibboleth.net/schema/idp/shibboleth-afp.xsd..

Prior to release 3.2.0 the basic:Script type is defined by the urn:mace:shibboleth:2.0:afp:mf:basic schema, which can be located at http://shibboleth.net/schema/idp/shibboleth-afp-mf-basic.xsd.

Use of that namespace is deprecated, but is supported.

Attributes

Two optional attributes may be specified

NameTypeDefaultDescription
langStringjavascript

The ECMA language that the script is in

customObjectRef3.2.0

string The name of a Spring Bean defined elsewhere. This bean will be made available to the script with the name "custom". See the ScriptedAttributeDefinition for more details

Child Elements

One of two child elements can be provided

NameCardinalityDescription
<ScriptFile> The path of a resource (usually a file) which contains the script
<Script> The script. It is usual to specify this within a CDATA

Data available to the script

The script has the following variables available

NameTypeDescription
filterContext AttributeFilterContextThe AttributeFilter context provides some information about the request, and a mechanism to navigate to other contexts
profileContextProfileRequestContext

The root context for the request

attribute (Matcher Only)Attribute

The attribute being filtered

custom3.2ObjectContains whatever was provided by the customObjectRef attribute (see above)
subjects3.3

array of
javax.security.auth.Subject

The Subjects associated with this authorization.  Note that these will only be present if the attribute resolution has been associated with an Authentication (and so this will not work for back channel requests).

Examples

Inline Matcher
<AttributeRule attributeID="email">
	<PermitValueRule xsi:type="Script">
		<Script>
        <![CDATA[
            hashSetType = Java.type("java.util.HashSet");
            result = new hashSetType();
            result.add(attribute.getValues().iterator().next());
            result;
        ]]>
		</Script>
	</PermitValueRule>
</AttributeRule>

This simple rule just adds the first value of the attribute "email" to its permit list.

Externally specified PolicyRule
<AttributeFilterPolicy id="Example">
	<PolicyRequirementRule xsi:type="Script" language="JavaScript">
		<ScriptFile>%{idp.home}/conf/scripts/simple.js</ScriptFile>
	</PolicyRequirementRule>
</AttributeFilterPolicy>
Simple JavaScript PolicyRule
boolType = Java.type("java.lang.Boolean");
if (/* Some sort of condition */) {
  result = new boolType(false);
} else {
  result = new boolType(true);
}
result;

V2 Compatibility

No compatibility with V2 is provided.. 

  • No labels