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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
7 xsi:schemaLocation="urn:mace:shibboleth:2.0:native:sp:config @-PKGXMLDIR-@/shibboleth-2.0-native-sp-config.xsd"
8 logger="@-PKGSYSCONFDIR-@/syslog.logger" clockSkew="180">
12 <Library path="@-LIBEXECDIR-@/adfs.so" fatal="true"/>
16 <!-- The OutOfProcess section pertains to components that run in the shibd daemon. -->
17 <OutOfProcess logger="@-PKGSYSCONFDIR-@/shibd.logger">
21 <Library path="@-LIBEXECDIR-@/odbc-store.so" fatal="true"/>
25 <!-- Only one listener can be defined. -->
26 <UnixListener address="@-VARRUNDIR-@/shib-shar.sock"/>
28 <!-- <TCPListener address="127.0.0.1" port="12345" acl="127.0.0.1"/> -->
31 <StorageService type="Memory" id="memory" cleanupInterval="900"/>
32 <SessionCache type="StorageService" StorageService="memory" cacheTimeout="3600"/>
33 <ReplayCache StorageService="memory"/>
34 <ArtifactMap artifactTTL="180"/>
37 <StorageService type="ODBC" id="db" cleanupInterval="900">
39 DRIVER=drivername;SERVER=dbserver;UID=shibboleth;PWD=password;DATABASE=shibboleth;APP=Shibboleth
42 <SessionCache type="StorageService" StorageService="db" cacheTimeout="3600"/>
43 <ReplayCache StorageService="db"/>
44 <ArtifactMap StorageService="db" artifactTTL="180"/>
48 <!-- The InProcess section pertains to components that run inside the web server. -->
49 <InProcess logger="@-PKGSYSCONFDIR-@/native.logger">
51 To customize behavior, map hostnames and path components to applicationId and other settings.
53 <RequestMapper type="Native">
54 <RequestMap applicationId="default">
56 The example requires a session for documents in /secure on the containing host with http and
57 https on the default ports. Note that the name and port in the <Host> elements MUST match
58 Apache's ServerName and Port directives or the IIS Site name in the <ISAPI> element
61 <Host name="sp.example.org">
62 <Path name="secure" authType="shibboleth" requireSession="true">
63 <!-- Example shows the folder "/secure/admin" assigned to a separate <Application> -->
65 <Path name="admin" applicationId="foo-admin"/>
73 <ISAPI normalizeRequest="true">
75 Maps IIS Instance ID values to the host scheme/name/port/sslport. The name is
76 required so that the proper <Host> in the request map above is found without
77 having to cover every possible DNS/IP combination the user might enter.
78 The port and scheme can usually be omitted, so the HTTP request's port and
81 <Site id="1" name="sp.example.org"/>
87 The Applications section is where most of Shibboleth's SAML bits are defined.
88 Resource requests are mapped in the Local section into an applicationId that
89 points into to this section.
91 <Applications id="default" policyId="default" entityID="https://sp.example.org/shibboleth"
92 homeURL="https://sp.example.org/index.html" REMOTE_USER="eppn persistent-id"
93 localLogout="@-PKGSYSCONFDIR-@/localLogout.html"
94 globalLogout="@-PKGSYSCONFDIR-@/globalLogout.html">
97 Controls session lifetimes, address checks, cookie handling, and the protocol handlers.
98 You MUST supply an effectively unique handlerURL value for each of your applications.
99 The value can be a relative path, a URL with no hostname (https:///path) or a full URL.
100 The system can compute a relative value based on the virtual host. Using handlerSSL="true"
101 will force the protocol to be https. You should also add a cookieProps setting of "; path=/; secure"
102 in that case. Note that while we default checkAddress to "false", this has a negative
103 impact on the security of the SP. Stealing cookies/sessions is much easier with this
106 <Sessions lifetime="28800" timeout="3600" checkAddress="false"
107 handlerURL="/Shibboleth.sso" handlerSSL="false" idpHistory="true" idpHistoryDays="7">
110 SessionInitiators handle session requests and relay them to a Discovery page,
111 or to an IdP if possible. Automatic session setup will use the default or first
112 element (or requireSessionWith can specify a specific id to use).
115 <!-- Default example directs to a specific IdP's SSO service (favoring SAML 2 over Shib 1). -->
116 <SessionInitiator type="Chaining" Location="/Login" isDefault="true" id="idp.example.org"
117 relayState="cookie" entityID="https://idp.example.org/shibboleth">
118 <SessionInitiator type="SAML2" defaultACSIndex="1" template="@-PKGSYSCONFDIR-@/bindingTemplate.html"/>
119 <SessionInitiator type="Shib1" defaultACSIndex="4"/>
122 <!-- An example using an old-style WAYF, which means Shib 1 only unless an entityID is provided. -->
123 <SessionInitiator type="Chaining" Location="/WAYF" id="WAYF" relayState="cookie">
124 <SessionInitiator type="SAML2" defaultACSIndex="1" template="@-PKGSYSCONFDIR-@/bindingTemplate.html"/>
125 <SessionInitiator type="Shib1" defaultACSIndex="4"/>
126 <SessionInitiator type="WAYF" defaultACSIndex="4" URL="https://wayf.example.org/WAYF"/>
129 <!-- An example supporting the new-style of discovery service. -->
130 <SessionInitiator type="Chaining" Location="/DS" id="DS" relayState="cookie">
131 <SessionInitiator type="SAML2" defaultACSIndex="1" template="@-PKGSYSCONFDIR-@/bindingTemplate.html"/>
132 <SessionInitiator type="Shib1" defaultACSIndex="4"/>
133 <SessionInitiator type="SAMLDS" URL="https://ds.example.org/DS"/>
137 md:AssertionConsumerService locations handle specific SSO protocol bindings,
138 such as SAML 2.0 POST or SAML 1.1 Artifact. The isDefault and index attributes
139 are used when sessions are initiated to determine how to tell the IdP where and
140 how to return the response.
142 <md:AssertionConsumerService Location="/SAML2/POST" index="1"
143 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"/>
144 <md:AssertionConsumerService Location="/SAML2/POST-SimpleSign" index="2"
145 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST-SimpleSign"/>
146 <md:AssertionConsumerService Location="/SAML2/Artifact" index="3"
147 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact"/>
148 <md:AssertionConsumerService Location="/SAML/POST" index="4"
149 Binding="urn:oasis:names:tc:SAML:1.0:profiles:browser-post"/>
150 <md:AssertionConsumerService Location="/SAML/Artifact" index="5"
151 Binding="urn:oasis:names:tc:SAML:1.0:profiles:artifact-01"/>
153 <!-- LogoutInitiators enable SP-initiated local or global/single logout of sessions. -->
154 <LogoutInitiator type="Chaining" Location="/Logout">
155 <LogoutInitiator type="SAML2" template="@-PKGSYSCONFDIR-@/bindingTemplate.html"/>
156 <LogoutInitiator type="Local"/>
159 <!-- md:SingleLogoutService locations handle single logout (SLO) protocol messages. -->
160 <md:SingleLogoutService Location="/SLO/SOAP"
161 Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP"/>
162 <md:SingleLogoutService Location="/SLO/Redirect" conf:template="@-PKGSYSCONFDIR-@/bindingTemplate.html"
163 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"/>
164 <md:SingleLogoutService Location="/SLO/POST" conf:template="@-PKGSYSCONFDIR-@/bindingTemplate.html"
165 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"/>
166 <md:SingleLogoutService Location="/SLO/Artifact" conf:template="@-PKGSYSCONFDIR-@/bindingTemplate.html"
167 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact"/>
170 md:ArtifactResolutionService locations resolve artifacts issued when using the
171 SAML 2.0 HTTP-Artifact binding on outgoing messages, generally uses SOAP.
173 <md:ArtifactResolutionService Location="/Artifact/SOAP" index="1"
174 Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP"/>
179 You should customize these pages! You can add attributes with values that can be plugged
180 into your templates. You can remove the access attribute to cause the module to return a
181 standard 403 Forbidden error code if authorization fails, and then customize that condition
182 using your web server.
184 <Errors session="@-PKGSYSCONFDIR-@/sessionError.html"
185 metadata="@-PKGSYSCONFDIR-@/metadataError.html"
186 access="@-PKGSYSCONFDIR-@/accessError.html"
187 ssl="@-PKGSYSCONFDIR-@/sslError.html"
188 supportContact="root@localhost"
189 logoLocation="/shibboleth-sp/logo.jpg"
190 styleSheet="/shibboleth-sp/main.css"/>
192 <!-- Configure handling of outgoing messages and SOAP authentication. -->
193 <DefaultRelyingParty authType="TLS" artifactEndpointIndex="1"
194 signRequests="front" encryptRequests="front" signResponses="true" encryptResponses="true">
195 <!-- Uncomment and modify to tweak settings for specific IdPs or groups. -->
197 <RelyingParty Name="SpecialFederation" keyName="SpecialKey"/>
199 </DefaultRelyingParty>
201 <!-- Chains together all your metadata sources. -->
202 <MetadataProvider type="Chaining">
203 <!-- Dummy metadata for private testing, delete for production deployments. -->
204 <MetadataProvider type="XML" path="@-PKGSYSCONFDIR-@/example-metadata.xml"/>
207 <!-- Chain the two built-in trust engines together. -->
208 <TrustEngine type="Chaining">
209 <TrustEngine type="ExplicitKey"/>
210 <TrustEngine type="PKIX"/>
213 <!-- Map to extract attributes from SAML assertions. -->
214 <AttributeExtractor type="XML" path="@-PKGSYSCONFDIR-@/attribute-map.xml"/>
216 <!-- Use a SAML query if no attributes are supplied during SSO. -->
217 <AttributeResolver type="Query"/>
219 <!-- Default filtering policy for recognized attributes, lets other data pass. -->
220 <AttributeFilter type="XML" path="@-PKGSYSCONFDIR-@/attribute-policy.xml"/>
222 <!-- Simple file-based resolver for using a single keypair. -->
223 <CredentialResolver type="File">
225 <Path>@-PKGSYSCONFDIR-@/sp-example.key</Path>
228 <Path>@-PKGSYSCONFDIR-@/sp-example.crt</Path>
230 </CredentialResolver>
232 <!-- Advanced resolver allowing for multiple keypairs. -->
234 <CredentialResolver type="Chaining">
235 <CredentialResolver type="File">
237 <Name>DefaultKey</Name>
238 <Path>@-PKGSYSCONFDIR-@/sp-example.key</Path>
241 <Path>@-PKGSYSCONFDIR-@/sp-example.crt</Path>
243 </CredentialResolver>
244 <CredentialResolver type="File">
246 <Name>SpecialKey</Name>
247 <Path>@-PKGSYSCONFDIR-@/special.key</Path>
250 <Path>@-PKGSYSCONFDIR-@/special.crt</Path>
252 </CredentialResolver>
253 </CredentialResolver>
257 <!-- Each policy defines a set of rules to use to secure SAML and SOAP messages. -->
259 <!-- The predefined policy handles SAML 1 and 2 protocols and permits signing and client TLS. -->
262 signedAssertions="false"
263 requireConfidentiality="true"
264 requireTransportAuth="true"
265 chunkedEncoding="true"
266 connectTimeout="15" timeout="30"
268 <Rule type="SAML1Message"/>
269 <Rule type="SAML2Message"/>
270 <Rule type="MessageFlow" checkReplay="true" expires="60"/>
271 <Rule type="ClientCertAuth" errorFatal="true"/>
272 <Rule type="XMLSigning" errorFatal="true"/>
273 <Rule type="SimpleSigning" errorFatal="true"/>