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"
6 logger="syslog.logger" clockSkew="180">
8 <!-- The OutOfProcess section contains properties affecting the shibd daemon. -->
9 <OutOfProcess logger="shibd.logger">
12 <Library path="odbc-store.so" fatal="true"/>
17 <!-- The InProcess section conrains settings affecting web server modules/filters. -->
18 <InProcess logger="native.logger">
19 <ISAPI normalizeRequest="true" safeHeaderNames="true">
21 Maps IIS Instance ID values to the host scheme/name/port. The name is
22 required so that the proper <Host> in the request map above is found without
23 having to cover every possible DNS/IP combination the user might enter.
25 <Site id="1" name="sp.example.org"/>
27 When the port and scheme are omitted, the HTTP request's port and scheme are used.
28 If these are wrong because of virtualization, they can be explicitly set here to
29 ensure proper redirect generation.
32 <Site id="42" name="virtual.example.org" scheme="https" port="443"/>
37 <!-- Only one listener can be defined, to connect in-process modules to shibd. -->
38 <UnixListener address="shibd.sock"/>
39 <!-- <TCPListener address="127.0.0.1" port="12345" acl="127.0.0.1"/> -->
41 <!-- This set of components stores sessions and other persistent data in daemon memory. -->
42 <StorageService type="Memory" id="mem" cleanupInterval="900"/>
43 <SessionCache type="StorageService" StorageService="mem" cacheTimeout="3600" inprocTimeout="900" cleanupInterval="900"/>
44 <ReplayCache StorageService="mem"/>
45 <ArtifactMap artifactTTL="180"/>
47 <!-- This set of components stores sessions and other persistent data in an ODBC database. -->
49 <StorageService type="ODBC" id="db" cleanupInterval="900">
51 DRIVER=drivername;SERVER=dbserver;UID=shibboleth;PWD=password;DATABASE=shibboleth;APP=Shibboleth
54 <SessionCache type="StorageService" StorageService="db" cacheTimeout="3600" inprocTimeout="900" cleanupInterval="900"/>
55 <ReplayCache StorageService="db"/>
56 <ArtifactMap StorageService="db" artifactTTL="180"/>
59 <!-- To customize behavior, map hostnames and path components to applicationId and other settings. -->
60 <RequestMapper type="Native">
61 <RequestMap applicationId="default">
63 The example requires a session for documents in /secure on the containing host with http and
64 https on the default ports. Note that the name and port in the <Host> elements MUST match
65 Apache's ServerName and Port directives or the IIS Site name in the <ISAPI> element
68 <Host name="sp.example.org">
69 <Path name="secure" authType="shibboleth" requireSession="true"/>
71 <!-- Example of a second vhost mapped to a different applicationId. -->
73 <Host name="admin.example.org" applicationId="admin" authType="shibboleth" requireSession="true"/>
79 The ApplicationDefaults element is where most of Shibboleth's SAML bits are defined.
80 Resource requests are mapped by the RequestMapper to an applicationId that
81 points into to this section.
83 <ApplicationDefaults id="default" policyId="default"
84 entityID="https://sp.example.org/shibboleth"
85 REMOTE_USER="eppn persistent-id targeted-id"
86 signing="false" encryption="false">
89 Controls session lifetimes, address checks, cookie handling, and the protocol handlers.
90 You MUST supply an effectively unique handlerURL value for each of your applications.
91 The value can be a relative path, a URL with no hostname (https:///path) or a full URL.
92 The system can compute a relative value based on the virtual host. Using handlerSSL="true"
93 will force the protocol to be https. You should also add a cookieProps setting of "; path=/; secure"
94 in that case. Note that while we default checkAddress to "false", this has a negative
95 impact on the security of the SP. Stealing cookies/sessions is much easier with this disabled.
97 <Sessions lifetime="28800" timeout="3600" checkAddress="false"
98 handlerURL="/Shibboleth.sso" handlerSSL="false"
99 exportLocation="http://localhost/Shibboleth.sso/GetAssertion" exportACL="127.0.0.1"
100 idpHistory="false" idpHistoryDays="7">
103 SessionInitiators handle session requests and relay them to a Discovery page,
104 or to an IdP if possible. Automatic session setup will use the default or first
105 element (or requireSessionWith can specify a specific id to use).
108 <!-- Default directs to a specific IdP (favoring SAML 2 over Shib 1). -->
109 <SessionInitiator type="Chaining" Location="/Login" isDefault="true" id="Login"
110 relayState="cookie" entityID="https://idp.example.org/shibboleth">
111 <SessionInitiator type="SAML2" acsIndex="1" template="bindingTemplate.html"/>
112 <SessionInitiator type="Shib1" acsIndex="5"/>
114 To allow for >1 IdP, remove entityID property from Chaining element and add
115 *either* of the SAMLDS or WAYF handlers below:
117 <SessionInitiator type="SAMLDS" URL="https://ds.example.org/DS/WAYF"/>
118 <SessionInitiator type="WAYF" acsIndex="5" URL="https://wayf.example.org/WAYF"/>
123 md:AssertionConsumerService locations handle specific SSO protocol bindings,
124 such as SAML 2.0 POST or SAML 1.1 Artifact. The isDefault and index attributes
125 are used when sessions are initiated to determine how to tell the IdP where and
126 how to return the response.
128 <md:AssertionConsumerService Location="/SAML2/POST" index="1"
129 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"/>
130 <md:AssertionConsumerService Location="/SAML2/POST-SimpleSign" index="2"
131 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST-SimpleSign"/>
132 <md:AssertionConsumerService Location="/SAML2/Artifact" index="3"
133 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact"/>
134 <md:AssertionConsumerService Location="/SAML2/ECP" index="4"
135 Binding="urn:oasis:names:tc:SAML:2.0:bindings:PAOS"/>
136 <md:AssertionConsumerService Location="/SAML/POST" index="5"
137 Binding="urn:oasis:names:tc:SAML:1.0:profiles:browser-post"/>
138 <md:AssertionConsumerService Location="/SAML/Artifact" index="6"
139 Binding="urn:oasis:names:tc:SAML:1.0:profiles:artifact-01"/>
141 <!-- LogoutInitiators enable SP-initiated local or global/single logout of sessions. -->
142 <LogoutInitiator type="Chaining" Location="/Logout" relayState="cookie">
143 <LogoutInitiator type="SAML2" template="bindingTemplate.html"/>
144 <LogoutInitiator type="Local"/>
147 <!-- md:SingleLogoutService locations handle single logout (SLO) protocol messages. -->
148 <md:SingleLogoutService Location="/SLO/SOAP"
149 Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP"/>
150 <md:SingleLogoutService Location="/SLO/Redirect" conf:template="bindingTemplate.html"
151 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"/>
152 <md:SingleLogoutService Location="/SLO/POST" conf:template="bindingTemplate.html"
153 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"/>
154 <md:SingleLogoutService Location="/SLO/Artifact" conf:template="bindingTemplate.html"
155 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact"/>
157 <!-- md:ManageNameIDService locations handle NameID management (NIM) protocol messages. -->
158 <md:ManageNameIDService Location="/NIM/SOAP"
159 Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP"/>
160 <md:ManageNameIDService Location="/NIM/Redirect" conf:template="bindingTemplate.html"
161 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"/>
162 <md:ManageNameIDService Location="/NIM/POST" conf:template="bindingTemplate.html"
163 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"/>
164 <md:ManageNameIDService Location="/NIM/Artifact" conf:template="bindingTemplate.html"
165 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact"/>
168 md:ArtifactResolutionService locations resolve artifacts issued when using the
169 SAML 2.0 HTTP-Artifact binding on outgoing messages, generally uses SOAP.
171 <md:ArtifactResolutionService Location="/Artifact/SOAP" index="1"
172 Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP"/>
174 <!-- Extension service that generates "approximate" metadata based on SP configuration. -->
175 <Handler type="MetadataGenerator" Location="/Metadata" signing="false"/>
177 <!-- Status reporting service. -->
178 <Handler type="Status" Location="/Status" acl="127.0.0.1"/>
180 <!-- Session diagnostic service. -->
181 <Handler type="Session" Location="/Session" showAttributeValues="false"/>
186 Allows overriding of error template filenames. You can also add attributes with values
187 that can be plugged into the templates.
189 <Errors supportContact="root@localhost"
190 logoLocation="/shibboleth-sp/logo.jpg"
191 styleSheet="/shibboleth-sp/main.css"/>
193 <!-- Uncomment and modify to tweak settings for specific IdPs or groups. -->
194 <!-- <RelyingParty Name="SpecialFederation" keyName="SpecialKey"/> -->
196 <!-- Chains together all your metadata sources. -->
197 <MetadataProvider type="Chaining">
198 <!-- Example of remotely supplied batch of signed metadata. -->
200 <MetadataProvider type="XML" uri="http://federation.org/federation-metadata.xml"
201 backingFilePath="federation-metadata.xml" reloadInterval="7200">
202 <MetadataFilter type="RequireValidUntil" maxValidityInterval="2419200"/>
203 <MetadataFilter type="Signature" certificate="fedsigner.pem"/>
207 <!-- Example of locally maintained metadata. -->
209 <MetadataProvider type="XML" file="partner-metadata.xml"/>
213 <!-- Chain the two built-in trust engines together. -->
214 <TrustEngine type="Chaining">
215 <TrustEngine type="ExplicitKey"/>
216 <TrustEngine type="PKIX"/>
219 <!-- Map to extract attributes from SAML assertions. -->
220 <AttributeExtractor type="XML" validate="true" path="attribute-map.xml"/>
222 <!-- Use a SAML query if no attributes are supplied during SSO. -->
223 <AttributeResolver type="Query" subjectMatch="true"/>
225 <!-- Default filtering policy for recognized attributes, lets other data pass. -->
226 <AttributeFilter type="XML" validate="true" path="attribute-policy.xml"/>
228 <!-- Simple file-based resolver for using a single keypair. -->
229 <CredentialResolver type="File" key="sp-key.pem" certificate="sp-cert.pem"/>
231 <!-- Example of a second application (using a second vhost) that has a different entityID. -->
232 <!-- <ApplicationOverride id="admin" entityID="https://admin.example.org/shibboleth"/> -->
234 </ApplicationDefaults>
236 <!-- Policies that determine how to process and authenticate runtime messages. -->
237 <SecurityPolicyProvider type="XML" validate="true" path="security-policy.xml"/>