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