1 <SPConfig xmlns="urn:mace:shibboleth:2.0:native:sp:config"
2 xmlns:conf="urn:mace:shibboleth:2.0:native:sp:config"
3 xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"
4 xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol"
5 xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata"
8 <!-- This set of components stores sessions and other persistent data in daemon memory. -->
9 <StorageService type="Memory" id="mem" cleanupInterval="900"/>
10 <SessionCache type="StorageService" StorageService="mem" cacheTimeout="3600" inprocTimeout="900" cleanupInterval="900"/>
11 <ReplayCache StorageService="mem"/>
12 <ArtifactMap artifactTTL="180"/>
14 <!-- This set of components stores sessions and other persistent data in an ODBC database. -->
16 <StorageService type="ODBC" id="db" cleanupInterval="900">
18 DRIVER=drivername;SERVER=dbserver;UID=shibboleth;PWD=password;DATABASE=shibboleth;APP=Shibboleth
21 <SessionCache type="StorageService" StorageService="db" cacheTimeout="3600" inprocTimeout="900" cleanupInterval="900"/>
22 <ReplayCache StorageService="db"/>
23 <ArtifactMap StorageService="db" artifactTTL="180"/>
26 <!-- To customize behavior, map hostnames and path components to applicationId and other settings. -->
27 <RequestMapper type="Native">
28 <RequestMap applicationId="default">
30 The example requires a session for documents in /secure on the containing host with http and
31 https on the default ports. Note that the name and port in the <Host> elements MUST match
32 Apache's ServerName and Port directives or the IIS Site name in the <ISAPI> element
35 <Host name="sp.example.org">
36 <Path name="secure" authType="shibboleth" requireSession="true"/>
38 <!-- Example of a second vhost mapped to a different applicationId. -->
40 <Host name="admin.example.org" applicationId="admin" authType="shibboleth" requireSession="true"/>
46 The ApplicationDefaults element is where most of Shibboleth's SAML bits are defined.
47 Resource requests are mapped by the RequestMapper to an applicationId that
48 points into to this section.
50 <ApplicationDefaults id="default" policyId="default"
51 entityID="https://sp.example.org/shibboleth"
52 REMOTE_USER="eppn persistent-id targeted-id"
53 signing="false" encryption="false">
56 Controls session lifetimes, address checks, cookie handling, and the protocol handlers.
57 You MUST supply an effectively unique handlerURL value for each of your applications.
58 The value can be a relative path, a URL with no hostname (https:///path) or a full URL.
59 The system can compute a relative value based on the virtual host. Using handlerSSL="true"
60 will force the protocol to be https. You should also add a cookieProps setting of "; path=/; secure"
61 in that case. Note that while we default checkAddress to "false", this has a negative
62 impact on the security of the SP. Stealing cookies/sessions is much easier with this disabled.
64 <Sessions lifetime="28800" timeout="3600" checkAddress="false"
65 handlerURL="/Shibboleth.sso" handlerSSL="false"
66 exportLocation="http://localhost/Shibboleth.sso/GetAssertion" exportACL="127.0.0.1"
67 idpHistory="false" idpHistoryDays="7">
70 SessionInitiators handle session requests and relay them to a Discovery page,
71 or to an IdP if possible. Automatic session setup will use the default or first
72 element (or requireSessionWith can specify a specific id to use).
75 <!-- Default directs to a specific IdP (favoring SAML 2 over Shib 1). -->
76 <SessionInitiator type="Chaining" Location="/Login" isDefault="true" id="Login"
77 relayState="cookie" entityID="https://idp.example.org/shibboleth">
78 <SessionInitiator type="SAML2" acsIndex="1" template="bindingTemplate.html"/>
79 <SessionInitiator type="Shib1" acsIndex="5"/>
81 To allow for >1 IdP, remove entityID property from Chaining element and add
82 *either* of the SAMLDS or WAYF handlers below:
84 <SessionInitiator type="SAMLDS" URL="https://ds.example.org/DS/WAYF"/>
85 <SessionInitiator type="WAYF" acsIndex="5" URL="https://wayf.example.org/WAYF"/>
90 md:AssertionConsumerService locations handle specific SSO protocol bindings,
91 such as SAML 2.0 POST or SAML 1.1 Artifact. The isDefault and index attributes
92 are used when sessions are initiated to determine how to tell the IdP where and
93 how to return the response.
95 <md:AssertionConsumerService Location="/SAML2/POST" index="1"
96 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"/>
97 <md:AssertionConsumerService Location="/SAML2/POST-SimpleSign" index="2"
98 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST-SimpleSign"/>
99 <md:AssertionConsumerService Location="/SAML2/Artifact" index="3"
100 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact"/>
101 <md:AssertionConsumerService Location="/SAML2/ECP" index="4"
102 Binding="urn:oasis:names:tc:SAML:2.0:bindings:PAOS"/>
103 <md:AssertionConsumerService Location="/SAML/POST" index="5"
104 Binding="urn:oasis:names:tc:SAML:1.0:profiles:browser-post"/>
105 <md:AssertionConsumerService Location="/SAML/Artifact" index="6"
106 Binding="urn:oasis:names:tc:SAML:1.0:profiles:artifact-01"/>
108 <!-- LogoutInitiators enable SP-initiated local or global/single logout of sessions. -->
109 <LogoutInitiator type="Chaining" Location="/Logout" relayState="cookie">
110 <LogoutInitiator type="SAML2" template="bindingTemplate.html"/>
111 <LogoutInitiator type="Local"/>
114 <!-- md:SingleLogoutService locations handle single logout (SLO) protocol messages. -->
115 <md:SingleLogoutService Location="/SLO/SOAP"
116 Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP"/>
117 <md:SingleLogoutService Location="/SLO/Redirect" conf:template="bindingTemplate.html"
118 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"/>
119 <md:SingleLogoutService Location="/SLO/POST" conf:template="bindingTemplate.html"
120 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"/>
121 <md:SingleLogoutService Location="/SLO/Artifact" conf:template="bindingTemplate.html"
122 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact"/>
124 <!-- md:ManageNameIDService locations handle NameID management (NIM) protocol messages. -->
125 <md:ManageNameIDService Location="/NIM/SOAP"
126 Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP"/>
127 <md:ManageNameIDService Location="/NIM/Redirect" conf:template="bindingTemplate.html"
128 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"/>
129 <md:ManageNameIDService Location="/NIM/POST" conf:template="bindingTemplate.html"
130 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"/>
131 <md:ManageNameIDService Location="/NIM/Artifact" conf:template="bindingTemplate.html"
132 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact"/>
135 md:ArtifactResolutionService locations resolve artifacts issued when using the
136 SAML 2.0 HTTP-Artifact binding on outgoing messages, generally uses SOAP.
138 <md:ArtifactResolutionService Location="/Artifact/SOAP" index="1"
139 Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP"/>
141 <!-- Extension service that generates "approximate" metadata based on SP configuration. -->
142 <Handler type="MetadataGenerator" Location="/Metadata" signing="false"/>
144 <!-- Status reporting service. -->
145 <Handler type="Status" Location="/Status" acl="127.0.0.1"/>
147 <!-- Session diagnostic service. -->
148 <Handler type="Session" Location="/Session" showAttributeValues="false"/>
153 Allows overriding of error template filenames. You can also add attributes with values
154 that can be plugged into the templates.
156 <Errors supportContact="root@localhost"
157 logoLocation="/shibboleth-sp/logo.jpg"
158 styleSheet="/shibboleth-sp/main.css"/>
160 <!-- Uncomment and modify to tweak settings for specific IdPs or groups. -->
161 <!-- <RelyingParty Name="SpecialFederation" keyName="SpecialKey"/> -->
163 <!-- Chains together all your metadata sources. -->
164 <MetadataProvider type="Chaining">
165 <!-- Example of remotely supplied batch of signed metadata. -->
167 <MetadataProvider type="XML" uri="http://federation.org/federation-metadata.xml"
168 backingFilePath="federation-metadata.xml" reloadInterval="7200">
169 <MetadataFilter type="RequireValidUntil" maxValidityInterval="2419200"/>
170 <MetadataFilter type="Signature" certificate="fedsigner.pem"/>
174 <!-- Example of locally maintained metadata. -->
176 <MetadataProvider type="XML" file="partner-metadata.xml"/>
180 <!-- Chain the two built-in trust engines together. -->
181 <TrustEngine type="Chaining">
182 <TrustEngine type="ExplicitKey"/>
183 <TrustEngine type="PKIX"/>
186 <!-- Map to extract attributes from SAML assertions. -->
187 <AttributeExtractor type="XML" validate="true" path="attribute-map.xml"/>
189 <!-- Use a SAML query if no attributes are supplied during SSO. -->
190 <AttributeResolver type="Query" subjectMatch="true"/>
192 <!-- Default filtering policy for recognized attributes, lets other data pass. -->
193 <AttributeFilter type="XML" validate="true" path="attribute-policy.xml"/>
195 <!-- Simple file-based resolver for using a single keypair. -->
196 <CredentialResolver type="File" key="sp-key.pem" certificate="sp-cert.pem"/>
198 <!-- Example of a second application (using a second vhost) that has a different entityID. -->
199 <!-- <ApplicationOverride id="admin" entityID="https://admin.example.org/shibboleth"/> -->
201 </ApplicationDefaults>
203 <!-- Policies that determine how to process and authenticate runtime messages. -->
204 <SecurityPolicyProvider type="XML" validate="true" path="security-policy.xml"/>