Tweak Errors comment.
[shibboleth/sp.git] / configs / shibboleth2.xml
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     clockSkew="180">
7
8     <!--
9     By default, in-memory StorageService, ReplayCache, ArtifactMap, and SessionCache
10     are used. See example-shibboleth2.xml for samples of explicitly configuring them.
11     -->
12
13     <!--
14     To customize behavior for specific resources on Apache, and to link vhosts or
15     resources to ApplicationOverride settings below, use web server options/commands.
16     See https://spaces.internet2.edu/display/SHIB2/NativeSPConfigurationElements for help.
17     
18     For examples with the RequestMap XML syntax instead, see the example-shibboleth2.xml
19     file, and the https://spaces.internet2.edu/display/SHIB2/NativeSPRequestMapHowTo topic.
20     -->
21
22     <!-- The ApplicationDefaults element is where most of Shibboleth's SAML bits are defined. -->
23     <ApplicationDefaults entityID="https://sp.example.org/shibboleth"
24                          REMOTE_USER="eppn persistent-id targeted-id">
25
26         <!--
27         Controls session lifetimes, address checks, cookie handling, and the protocol handlers.
28         You MUST supply an effectively unique handlerURL value for each of your applications.
29         The value defaults to /Shibboleth.sso, and should be a relative path, with the SP computing
30         a relative value based on the virtual host. Using handlerSSL="true", the default, will force
31         the protocol to be https. You should also add a cookieProps setting of "; path=/; secure"
32         in that case. Note that while we default checkAddress to "false", this has a negative
33         impact on the security of the SP. Stealing cookies/sessions is much easier with this disabled.
34         -->
35         <Sessions lifetime="28800" timeout="3600" checkAddress="false" relayState="ss:mem" handlerSSL="false">
36
37             <!--
38             Configures SSO for a default IdP. To allow for >1 IdP, remove
39             entityID property and adjust discoveryURL to point to discovery service.
40             (Set discoveryProtocol to "WAYF" for legacy Shibboleth WAYF support.)
41             You can also override entityID on /Login query string, or in RequestMap/htaccess.
42             -->
43             <SSO entityID="https://idp.example.org/shibboleth"
44                  discoveryProtocol="SAMLDS" discoveryURL="https://ds.example.org/DS/WAYF">
45               SAML2 SAML1
46             </SSO>
47
48             <!-- SAML and local-only logout. -->
49             <Logout>SAML2 Local</Logout>
50             
51             <!-- Extension service that generates "approximate" metadata based on SP configuration. -->
52             <Handler type="MetadataGenerator" Location="/Metadata" signing="false"/>
53
54             <!-- Status reporting service. -->
55             <Handler type="Status" Location="/Status" acl="127.0.0.1"/>
56
57             <!-- Session diagnostic service. -->
58             <Handler type="Session" Location="/Session" showAttributeValues="false"/>
59
60         </Sessions>
61
62         <!--
63         Allows overriding of error template information/filenames. You can
64         also add attributes with values that can be plugged into the templates.
65         -->
66         <Errors supportContact="root@localhost"
67             logoLocation="/shibboleth-sp/logo.jpg"
68             styleSheet="/shibboleth-sp/main.css"/>
69         
70         <!-- Example of remotely supplied batch of signed metadata. -->
71         <!--
72         <MetadataProvider type="XML" uri="http://federation.org/federation-metadata.xml"
73               backingFilePath="federation-metadata.xml" reloadInterval="7200">
74             <MetadataFilter type="RequireValidUntil" maxValidityInterval="2419200"/>
75             <MetadataFilter type="Signature" certificate="fedsigner.pem"/>
76         </MetadataProvider>
77         -->
78
79         <!-- Example of locally maintained metadata. -->
80         <!--
81         <MetadataProvider type="XML" file="partner-metadata.xml"/>
82         -->
83
84         <!-- Map to extract attributes from SAML assertions. -->
85         <AttributeExtractor type="XML" validate="true" path="attribute-map.xml"/>
86         
87         <!-- Use a SAML query if no attributes are supplied during SSO. -->
88         <AttributeResolver type="Query" subjectMatch="true"/>
89
90         <!-- Default filtering policy for recognized attributes, lets other data pass. -->
91         <AttributeFilter type="XML" validate="true" path="attribute-policy.xml"/>
92
93         <!-- Simple file-based resolver for using a single keypair. -->
94         <CredentialResolver type="File" key="sp-key.pem" certificate="sp-cert.pem"/>
95
96         <!--
97         The default settings can be overridden by creating ApplicationOverride elements (see
98         the https://spaces.internet2.edu/display/SHIB2/NativeSPApplicationOverride topic).
99         Resource requests are mapped by web server commands, or the RequestMapper, to an
100         applicationId setting.
101         
102         Example of a second application (for a second vhost) that has a different entityID.
103         Resources on the vhost would map to an applicationId of "admin":
104         -->
105         <!--
106         <ApplicationOverride id="admin" entityID="https://admin.example.org/shibboleth"/>
107         -->
108     </ApplicationDefaults>
109     
110     <!-- Policies that determine how to process and authenticate runtime messages. -->
111     <SecurityPolicyProvider type="XML" validate="true" path="security-policy.xml"/>
112
113     <!-- Low-level configuration about protocols and bindings available for use. -->
114     <ProtocolProvider type="XML" validate="true" reloadChanges="false" path="protocols.xml"/>
115
116 </SPConfig>