This project contains a an implementation of the Mapping Combinations policy format that's utilized by OpenStack to map an Identity Provider's Federated Attributes to local Attributes understood by the service providers implementation.
A description of the Mapping Combinations policy format can be found here:
http://docs.openstack.org/developer/keystone/federation/federated_identity.html#mapping-combinations
There are some differences between the OpenStack format described above and the format implemented here (these are described below) however the concepts and much of the format is compatible.
The main idea is that a SAML Request is sent to the identity provider -- if a Mapping Policy exists then the policy translates this SAML Request into one the Identity System can understand.
The current implementation is non-destructive which means it simply adds a new Assertion to the Request that contains only the mapped attributes -- with the idea that the Identity System will process the new assertion. The initial assertion is kept on the request -- and the signature of that assertion can still be verified.
You can interact with the policy engine with CLI utilities to build these utilities you will need.
- Java 1.8
- Maven 3.3 (https://maven.apache.org/download.cgi)
- GCC C compiler
Once you've installed these in the main directory simply type:
mvn install
You'll need to have Maven and Java in the system path. Next add the
bin
directory to your system path.
-
attribmap : given a Mapping Policy and a SAML Request -- displays standard attributes according to the mapping. OR if the
-s
flag is used, then outputs a modified SAML Request with a new assertion. -
attribmap2xml : converts a JSON policy to XML, cus XML is beautiful.
-
attribmap2json : converts an XML policy to JSON, cus JSON rocks!
-
attribmap2xsl : converts a Mapping Policy to an XSL 2.0 stylesheet that can be used to efficiently translate SAML Request so that it contains a new assertion with the mapped attributes.
-
attribmap2yaml : converts a JSON policy to YAML.
TODO
A test suite is here:
Each test suite is a directory with two subdirectories:
-
maps
: contain different versions of a Mapping Policy which are functionally equivalent. -
asserts
: contain different SAML assertions that will work with the policy.
The SAML assertions are annotated with XPath 2.0 expressions at the beginning of the file like this:
<?xml version="1.0" encoding="UTF-8"?>
<!-- There should be two assertions -->
<?assert count(/saml2p:Response/saml2:Assertion) = 2 ?>
<!-- There should be 2 roles -->
<?assert count(mapping:get-attributes('roles')) = 2?>
<!-- The roles should be nova:observer and lbaas:observer -->
<?assert mapping:get-attributes('roles')='lbaas:observer' and mapping:get-attributes('roles')='nova:observer' ?>
<!-- None of the roles should not be lbaas:admin or nova:admin -->
<?assert every $r in mapping:get-attributes('roles') satisfies not($r = ('lbaas:admin', 'nova:admin'))?>
<!-- The name should be john.doe -->
<?assert /saml2p:Response/saml2:Assertion[1]/saml2:Subject/saml2:NameID = 'john.doe'?>
<!-- The message should expire at 2013-11-17T16:19:06.298Z -->
<?assert /saml2p:Response/saml2:Assertion[1]/saml2:Subject/saml2:SubjectConfirmation/saml2:SubjectConfirmationData/@NotOnOrAfter = '2013-11-17T16:19:06.298Z'?>
<!-- The email should be John Doe <[email protected]> -->
<?assert mapping:get-attribute('email') = '[email protected]'?>
<!-- The email should be [email protected] -->
<?assert mapping:get-attribute('domain') = '323676'?>
<saml2p:Response ID="_7fcd6173-e6e0-45a4-a2fd-74a4ef85bf30"
These assertions are made on the converted SAML and the test passes only if they all validate to true.
There are a number of built in functions the XPath implementation understands:
-
mapping:get-attributes()
: Takes a name of an attribute and returns a sequence of all of its values -- only in the FIRST (translated) assertion. -
mapping:get-attribute()
: Does the same as above but only returns the first value. -
mapping:get-expire()
: Gets the expiration time as an ```xs:dateTime`` so you can do assertions based on time.
If a test fails, then take a look in the
core/target/surefire-reports/
directory.
That directory will contain txt files with a detailed explanation on why a test failed.
XPath 2.0 is used by this implementation of the Mapping Policy. You can find a list of XPath 2.0 function here:
http://www.w3schools.com/xml/xsl_functions.asp
TODO : other resources