1 <SPConfig xmlns="urn:mace:shibboleth:target:config:1.0"
2 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3 xsi:schemaLocation="urn:mace:shibboleth:target:config:1.0 @-PKGXMLDIR-@/shibboleth-targetconfig-1.0.xsd"
4 logger="@-PKGSYSCONFDIR-@/shibboleth.logger" clockSkew="180">
6 <!-- These extensions are "universal", loaded by all Shibboleth-aware processes. -->
8 <Library path="@-LIBEXECDIR-@/xmlproviders.so" fatal="true"/>
11 <!-- The Global section pertains to shared Shibboleth processes like the shibd daemon. -->
12 <Global logger="@-PKGSYSCONFDIR-@/shibd.logger">
16 <Library path="@-LIBEXECDIR-@/shib-mysql-ccache.so" fatal="false"/>
20 <!-- Only one listener can be defined. -->
21 <UnixListener address="@-VARRUNDIR-@/shib-shar.sock"/>
23 <!-- <TCPListener address="127.0.0.1" port="12345" acl="127.0.0.1"/> -->
26 See deploy guide for details, but:
27 cacheTimeout - how long before expired sessions are purged from the cache
28 AATimeout - how long to wait for an AA to respond
29 AAConnectTimeout - how long to wait while connecting to an AA
30 defaultLifetime - if attributes come back without guidance, how long should they last?
31 strictValidity - if we have expired attrs, and can't get new ones, keep using them?
32 propagateErrors - suppress errors while getting attrs or let user see them?
33 retryInterval - if propagateErrors is false and query fails, how long to wait before trying again
34 Only one session cache can be defined.
36 <MemorySessionCache cleanupInterval="300" cacheTimeout="3600" AATimeout="30" AAConnectTimeout="15"
37 defaultLifetime="1800" retryInterval="300" strictValidity="false" propagateErrors="false"/>
39 <MySQLSessionCache cleanupInterval="300" cacheTimeout="3600" AATimeout="30" AAConnectTimeout="15"
40 defaultLifetime="1800" retryInterval="300" strictValidity="false" propagateErrors="false"
41 mysqlTimeout="14400" storeAttributes="false">
42 <Argument>--language=@-PREFIX-@/share/english</Argument>
43 <Argument>--datadir=@-PREFIX-@/data</Argument>
47 <!-- Default replay cache is in-memory. -->
50 <Argument>--language=@-PREFIX-@/share/english</Argument>
51 <Argument>--datadir=@-PREFIX-@/data</Argument>
56 <!-- The Local section pertains to resource-serving processes (often process pools) like web servers. -->
57 <Local logger="@-PKGSYSCONFDIR-@/native.logger" localRelayState="true">
59 To customize behavior, map hostnames and path components to applicationId and other settings.
60 The following provider types are available with the delivered code:
61 type="edu.internet2.middleware.shibboleth.sp.provider.NativeRequestMapProvider"
62 - Web-server-specific plugin that allows native commands (like Apache's
63 ShibRequireSession) to override or supplement the XML syntax. The Apache
64 version also supplies an htaccess authz plugin for all content.
66 type="edu.internet2.middleware.shibboleth.sp.provider.XMLRequestMapProvider"
67 - portable plugin that does not support the older Apache-specific commands and works
68 the same on all web platforms, this plugin does NOT support htaccess files
69 for authz unless you also place an <htaccess/> element somewhere in the map
71 By default, the "native" plugin (the first one above) is used, since it matches older
72 behavior on both Apache and IIS.
74 <RequestMapProvider type="edu.internet2.middleware.shibboleth.sp.provider.NativeRequestMapProvider">
75 <RequestMap applicationId="default">
77 This requires a session for documents in /secure on the containing host with http and
78 https on the default ports. Note that the name and port in the <Host> elements MUST match
79 Apache's ServerName and Port directives or the IIS Site name in the <ISAPI> element
82 <Host name="sp.example.org">
83 <Path name="secure" authType="shibboleth" requireSession="true" exportAssertion="true">
84 <!-- Example shows a subfolder on the SSL port assigned to a separate <Application> -->
85 <Path name="admin" applicationId="foo-admin"/>
92 <ISAPI normalizeRequest="true">
94 Maps IIS Instance ID values to the host scheme/name/port/sslport. The name is
95 required so that the proper <Host> in the request map above is found without
96 having to cover every possible DNS/IP combination the user might enter.
97 The port and scheme can usually be omitted, so the HTTP request's port and
100 <Alias> elements can specify alternate permissible client-specified server names.
101 If a client request uses such a name, normalized redirects will use it, but the
102 request map processing is still based on the default name attribute for the
103 site. This reduces duplicate data entry in the request map for every legal
104 hostname a site might permit. In the example below, only sp.example.org needs a
105 <Host> element in the map, but spalias.example.org could be used by a client
106 and those requests will map to sp.example.org for configuration settings.
108 <Site id="1" name="sp.example.org">
109 <Alias>spalias.example.org</Alias>
116 The Applications section is where most of Shibboleth's SAML bits are defined.
117 Resource requests are mapped in the Local section into an applicationId that
118 points into to this section.
120 <Applications id="default" providerId="https://sp.example.org/shibboleth"
121 homeURL="https://sp.example.org/index.html"
122 xmlns:saml="urn:oasis:names:tc:SAML:1.0:assertion"
123 xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata">
126 Controls session lifetimes, address checks, cookie handling, and the protocol handlers.
127 You MUST supply an effectively unique handlerURL value for each of your applications.
128 The value can be a relative path, a URL with no hostname (https:///path) or a full URL.
129 The system can compute a relative value based on the virtual host. Using handlerSSL="true"
130 will force the protocol to be https. You should also add a cookieProps setting of "; secure"
131 in that case. Note that while we default checkAddress to "false", this has a negative
132 impact on the security of the SP. Stealing cookies/sessions is much easier with this
135 <Sessions lifetime="7200" timeout="3600" checkAddress="false"
136 handlerURL="/Shibboleth.sso" handlerSSL="false" idpHistory="true" idpHistoryDays="7">
139 SessionInitiators handle session requests and relay them to a WAYF or directly
140 to an IdP, if possible. Automatic session setup will use the default or first
141 element (or requireSessionWith can specify a specific id to use). Lazy sessions
142 can be started with any initiator by redirecting to it. The only Binding supported
143 is the "urn:mace:shibboleth:sp:1.3:SessionInit" lazy session profile using query
145 * target the resource to direct back to later (or homeURL will be used)
146 * acsIndex optional index of an ACS to use on the way back in
147 * providerId optional direct invocation of a specific IdP
150 <!-- This default example directs users to a specific IdP's SSO service. -->
151 <SessionInitiator isDefault="true" id="example" Location="/WAYF/idp.example.org"
152 Binding="urn:mace:shibboleth:sp:1.3:SessionInit"
153 wayfURL="https://idp.example.org/shibboleth-idp/SSO"
154 wayfBinding="urn:mace:shibboleth:1.0:profiles:AuthnRequest"/>
156 <!-- This example directs users to a specific federation's WAYF service. -->
157 <SessionInitiator id="IQ" Location="/WAYF/InQueue"
158 Binding="urn:mace:shibboleth:sp:1.3:SessionInit"
159 wayfURL="https://wayf.internet2.edu/InQueue/WAYF"
160 wayfBinding="urn:mace:shibboleth:1.0:profiles:AuthnRequest"/>
163 md:AssertionConsumerService elements replace the old shireURL function with an
164 explicit handler for particular profiles, such as SAML 1.1 POST or Artifact.
165 The isDefault and index attributes are used when sessions are initiated
166 to determine how to tell the IdP where and how to return the response.
168 <md:AssertionConsumerService Location="/SAML/POST" isDefault="true" index="1"
169 Binding="urn:oasis:names:tc:SAML:1.0:profiles:browser-post"/>
170 <md:AssertionConsumerService Location="/SAML/Artifact" index="2"
171 Binding="urn:oasis:names:tc:SAML:1.0:profiles:artifact-01"/>
174 md:SingleLogoutService elements are mostly a placeholder for 2.0, but a simple
175 cookie-clearing option with a ResponseLocation or a return URL parameter is
176 supported via the "urn:mace:shibboleth:sp:1.3:Logout" Binding value.
178 <md:SingleLogoutService Location="/Logout" Binding="urn:mace:shibboleth:sp:1.3:Logout"/>
183 You should customize these pages! You can add attributes with values that can be plugged
184 into your templates. You can remove the access attribute to cause the module to return a
185 standard 403 Forbidden error code if authorization fails, and then customize that condition
186 using your web server.
188 <Errors session="@-PKGSYSCONFDIR-@/sessionError.html"
189 metadata="@-PKGSYSCONFDIR-@/metadataError.html"
190 rm="@-PKGSYSCONFDIR-@/rmError.html"
191 access="@-PKGSYSCONFDIR-@/accessError.html"
192 supportContact="root@localhost"
193 logoLocation="/shibtarget/logo.jpg"
194 styleSheet="/shibtarget/main.css"/>
196 <!-- Indicates what credentials to use when communicating -->
197 <CredentialUse TLS="defcreds" Signing="defcreds">
198 <!-- RelyingParty elements can customize credentials for specific IdPs/sets. -->
200 <RelyingParty Name="urn:mace:inqueue" TLS="inqueuecreds" Signing="inqueuecreds"/>
204 <!-- Use designators to request specific attributes or none to ask for all -->
206 <saml:AttributeDesignator AttributeName="urn:mace:dir:attribute-def:eduPersonScopedAffiliation"
207 AttributeNamespace="urn:mace:shibboleth:1.0:attributeNamespace:uri"/>
210 <!-- AAP can be inline or in a separate file -->
211 <AAPProvider type="edu.internet2.middleware.shibboleth.aap.provider.XMLAAP" uri="@-PKGSYSCONFDIR-@/AAP.xml"/>
213 <!-- Operational config consists of metadata and trust providers. Can be external or inline. -->
215 <!-- Dummy metadata for private testing, delete for production deployments. -->
216 <MetadataProvider type="edu.internet2.middleware.shibboleth.metadata.provider.XMLMetadata"
217 uri="@-PKGSYSCONFDIR-@/example-metadata.xml"/>
219 <!-- InQueue pilot federation, delete for production deployments. -->
220 <MetadataProvider type="edu.internet2.middleware.shibboleth.metadata.provider.XMLMetadata"
221 uri="@-PKGSYSCONFDIR-@/IQ-metadata.xml"/>
223 <!-- The standard trust provider supports SAMLv2 metadata with path validation extensions. -->
224 <TrustProvider type="edu.internet2.middleware.shibboleth.common.provider.ShibbolethTrust"/>
227 Zero or more SAML Audience condition matches (mainly for Shib 1.1 compatibility).
228 If you get "policy mismatch errors, you probably need to supply metadata about
229 your SP to the IdP if it's running 1.2. Adding an element here is only a partial fix.
231 <saml:Audience>urn:mace:inqueue</saml:Audience>
234 You can customize behavior of specific applications here. The default elements inside the
235 outer <Applications> element generally have to be overridden in an all or nothing fashion.
236 That is, if you supply a <Sessions> or <Errors> override, you MUST include all attributes
237 you want to apply, as they will not be inherited. Similarly, if you specify an element such as
238 <MetadataProvider>, it is not additive with the defaults, but replaces them.
240 Note that each application must have a handlerURL that maps uniquely to it and no other
241 application in the <RequestMap>. Otherwise no sessions will reach the application.
242 If each application lives on its own vhost, then a single handler at "/Shibboleth.sso"
243 is sufficient, since the hostname will distinguish the application.
245 The example below shows a special application that requires use of SSL when establishing
246 sessions, restricts the session cookie to SSL and a specific folder, and inherits most other
247 behavior except that it requests only EPPN from the origin instead of asking for all attributes.
248 Note that it will inherit all of the handler endpoints defined for the default application
249 but will append them to the handlerURL defined here.
252 <Application id="foo-admin">
253 <Sessions lifetime="7200" timeout="3600" checkAddress="true"
254 handlerURL="/secure/admin/Shibboleth.sso" handlerSSL="true"
255 cookieProps="; path=/secure/admin; secure"/>
256 <saml:AttributeDesignator AttributeName="urn:mace:dir:attribute-def:eduPersonPrincipalName"
257 AttributeNamespace="urn:mace:shibboleth:1.0:attributeNamespace:uri"/>
263 <!-- Define all the private keys and certificates here that you reference from <CredentialUse>. -->
264 <CredentialsProvider type="edu.internet2.middleware.shibboleth.common.Credentials">
265 <Credentials xmlns="urn:mace:shibboleth:credentials:1.0">
266 <FileResolver Id="defcreds">
268 <Path>@-PKGSYSCONFDIR-@/sp-example.key</Path>
270 <Certificate format="PEM">
271 <Path>@-PKGSYSCONFDIR-@/sp-example.crt</Path>
276 Mostly you can define a single keypair above, but you can define and name a second
277 keypair to be used only in specific cases and then specify when to use it inside a
278 <CredentialUse> element.
281 <FileResolver Id="inqueuecreds">
283 <Path>@-PKGSYSCONFDIR-@/inqueue.key</Path>
285 <Certificate format="PEM">
286 <Path>@-PKGSYSCONFDIR-@/inqueue.crt</Path>
291 </CredentialsProvider>
293 <!-- Specialized attribute handling for cases with complex syntax. -->
294 <AttributeFactory AttributeName="urn:oid:1.3.6.1.4.1.5923.1.1.1.10"
295 type="edu.internet2.middleware.shibboleth.common.provider.TargetedIDFactory"/>