configs/example-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     logger="syslog.logger" clockSkew="180">
   7
   8     <!-- The OutOfProcess section contains properties affecting the shibd daemon. -->
   9     <OutOfProcess logger="shibd.logger">
  10         <!--
  11         <Extensions>
  12             <Library path="odbc-store.so" fatal="true"/>
  13         </Extensions>
  14         -->
  15     </OutOfProcess>
  16
  17     <!--
  18     The InProcess section contains settings affecting web server modules.
  19     Required for IIS, but can be removed when using other web servers.
  20     -->
  21     <InProcess logger="native.logger">
  22         <ISAPI normalizeRequest="true" safeHeaderNames="true">
  23             <!--
  24             Maps IIS Instance ID values to the host scheme/name/port. The name is
  25             required so that the proper <Host> in the request map above is found without
  26             having to cover every possible DNS/IP combination the user might enter.
  27             -->
  28             <Site id="1" name="sp.example.org"/>
  29             <!--
  30             When the port and scheme are omitted, the HTTP request's port and scheme are used.
  31             If these are wrong because of virtualization, they can be explicitly set here to
  32             ensure proper redirect generation.
  33             -->
  34             <!--
  35             <Site id="42" name="virtual.example.org" scheme="https" port="443"/>
  36             -->
  37         </ISAPI>
  38     </InProcess>
  39
  40     <!-- Only one listener can be defined, to connect in-process modules to shibd. -->
  41     <UnixListener address="shibd.sock"/>
  42     <!-- <TCPListener address="127.0.0.1" port="1600" acl="127.0.0.1"/> -->
  43
  44     <!-- This set of components stores sessions and other persistent data in daemon memory. -->
  45     <StorageService type="Memory" id="mem" cleanupInterval="900"/>
  46     <SessionCache type="StorageService" StorageService="mem" cacheAssertions="false"
  47                   cacheAllowance="900" inprocTimeout="900" cleanupInterval="900"/>
  48     <ReplayCache StorageService="mem"/>
  49     <ArtifactMap artifactTTL="180"/>
  50
  51     <!-- This set of components stores sessions and other persistent data in an ODBC database. -->
  52     <!--
  53     <StorageService type="ODBC" id="db" cleanupInterval="900">
  54         <ConnectionString>
  55         DRIVER=drivername;SERVER=dbserver;UID=shibboleth;PWD=password;DATABASE=shibboleth;APP=Shibboleth
  56         </ConnectionString>
  57     </StorageService>
  58     <SessionCache type="StorageService" StorageService="db" cacheAssertions="false"
  59                   cacheTimeout="3600" inprocTimeout="900" cleanupInterval="900"/>
  60     <ReplayCache StorageService="db"/>
  61     <ArtifactMap StorageService="db" artifactTTL="180"/>
  62     -->
  63
  64     <!--
  65     To customize behavior for specific resources on Apache, and to link vhosts or
  66     resources to ApplicationOverride settings below, use web server options/commands.
  67     See https://spaces.internet2.edu/display/SHIB2/NativeSPConfigurationElements for help.
  68
  69     For examples with the RequestMap XML syntax instead, see the example-shibboleth2.xml
  70     file, and the https://spaces.internet2.edu/display/SHIB2/NativeSPRequestMapHowTo topic.
  71     -->
  72     <RequestMapper type="Native">
  73         <RequestMap>
  74             <!--
  75             The example requires a session for documents in /secure on the containing host with http and
  76             https on the default ports. Note that the name and port in the <Host> elements MUST match
  77             Apache's ServerName and Port directives or the IIS Site name in the <ISAPI> element above.
  78             -->
  79             <Host name="sp.example.org">
  80                 <Path name="secure" authType="shibboleth" requireSession="true"/>
  81             </Host>
  82             <!-- Example of a second vhost mapped to a different applicationId. -->
  83             <!--
  84             <Host name="admin.example.org" applicationId="admin" authType="shibboleth" requireSession="true"/>
  85             -->
  86         </RequestMap>
  87     </RequestMapper>
  88
  89     <!--
  90     The ApplicationDefaults element is where most of Shibboleth's SAML bits are defined.
  91     Resource requests are mapped by the RequestMapper to an applicationId that
  92     points into to this section (or to the defaults here).
  93     -->
  94     <ApplicationDefaults entityID="https://sp.example.org/shibboleth"
  95                          REMOTE_USER="eppn persistent-id targeted-id"
  96                          signing="false" encryption="false">
  97
  98         <!--
  99         Controls session lifetimes, address checks, cookie handling, and the protocol handlers.
 100         You MUST supply an effectively unique handlerURL value for each of your applications.
 101         The value defaults to /Shibboleth.sso, and should be a relative path, with the SP computing
 102         a relative value based on the virtual host. Using handlerSSL="true", the default, will force
 103         the protocol to be https. You should also add a cookieProps setting of "; path=/; secure; HttpOnly"
 104         in that case. Note that while we default checkAddress to "false", this has a negative
 105         impact on the security of the SP. Stealing cookies/sessions is much easier with this disabled.
 106         -->
 107         <Sessions lifetime="28800" timeout="3600" checkAddress="false"
 108             handlerURL="/Shibboleth.sso" handlerSSL="false" relayState="ss:mem"
 109             exportLocation="http://localhost/Shibboleth.sso/GetAssertion" exportACL="127.0.0.1"
 110             idpHistory="false" idpHistoryDays="7">
 111
 112             <!--
 113             The "stripped down" files use the shorthand syntax for configuring handlers.
 114             This uses the old "every handler specified directly" syntax. You can replace
 115             or supplement the new syntax following these examples.
 116             -->
 117
 118             <!--
 119             SessionInitiators handle session requests and relay them to a Discovery page,
 120             or to an IdP if possible. Automatic session setup will use the default or first
 121             element (or requireSessionWith can specify a specific id to use).
 122             -->
 123
 124             <!-- Default directs to a specific IdP (favoring SAML 2 over Shib 1). -->
 125             <SessionInitiator type="Chaining" Location="/Login" isDefault="true" id="Login"
 126                               entityID="https://idp.example.org/shibboleth">
 127
 128                 <SessionInitiator type="SAML2" template="bindingTemplate.html"/>
 129                 <SessionInitiator type="Shib1"/>
 130                 <!--
 131                 To allow for >1 IdP, remove entityID property from Chaining element and add
 132                 *either* of the SAMLDS or WAYF handlers below:
 133
 134                 <SessionInitiator type="SAMLDS" URL="https://ds.example.org/DS/WAYF"/>
 135                 <SessionInitiator type="WAYF" URL="https://wayf.example.org/WAYF"/>
 136                 -->
 137             </SessionInitiator>
 138
 139             <!--
 140             md:AssertionConsumerService locations handle specific SSO protocol bindings,
 141             such as SAML 2.0 POST or SAML 1.1 Artifact. The isDefault and index attributes
 142             are used when sessions are initiated to determine how to tell the IdP where and
 143             how to return the response.
 144             -->
 145             <md:AssertionConsumerService Location="/SAML2/POST" index="1"
 146                 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"/>
 147             <md:AssertionConsumerService Location="/SAML2/POST-SimpleSign" index="2"
 148                 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST-SimpleSign"/>
 149             <md:AssertionConsumerService Location="/SAML2/Artifact" index="3"
 150                 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact"/>
 151             <md:AssertionConsumerService Location="/SAML2/ECP" index="4"
 152                 Binding="urn:oasis:names:tc:SAML:2.0:bindings:PAOS"/>
 153             <md:AssertionConsumerService Location="/SAML/POST" index="5"
 154                 Binding="urn:oasis:names:tc:SAML:1.0:profiles:browser-post"/>
 155             <md:AssertionConsumerService Location="/SAML/Artifact" index="6"
 156                 Binding="urn:oasis:names:tc:SAML:1.0:profiles:artifact-01"/>
 157
 158             <!-- LogoutInitiators enable SP-initiated local or global/single logout of sessions. -->
 159             <LogoutInitiator type="Chaining" Location="/Logout">
 160                 <LogoutInitiator type="SAML2" template="bindingTemplate.html"/>
 161                 <LogoutInitiator type="Local"/>
 162             </LogoutInitiator>
 163
 164             <!-- md:SingleLogoutService locations handle single logout (SLO) protocol messages. -->
 165             <md:SingleLogoutService Location="/SLO/SOAP"
 166                 Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP"/>
 167             <md:SingleLogoutService Location="/SLO/Redirect" conf:template="bindingTemplate.html"
 168                 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"/>
 169             <md:SingleLogoutService Location="/SLO/POST" conf:template="bindingTemplate.html"
 170                 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"/>
 171             <md:SingleLogoutService Location="/SLO/Artifact" conf:template="bindingTemplate.html"
 172                 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact"/>
 173
 174             <!-- md:ManageNameIDService locations handle NameID management (NIM) protocol messages. -->
 175             <md:ManageNameIDService Location="/NIM/SOAP"
 176                 Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP"/>
 177             <md:ManageNameIDService Location="/NIM/Redirect" conf:template="bindingTemplate.html"
 178                 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"/>
 179             <md:ManageNameIDService Location="/NIM/POST" conf:template="bindingTemplate.html"
 180                 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"/>
 181             <md:ManageNameIDService Location="/NIM/Artifact" conf:template="bindingTemplate.html"
 182                 Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact"/>
 183
 184             <!--
 185             md:ArtifactResolutionService locations resolve artifacts issued when using the
 186             SAML 2.0 HTTP-Artifact binding on outgoing messages, generally uses SOAP.
 187             -->
 188             <md:ArtifactResolutionService Location="/Artifact/SOAP" index="1"
 189                 Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP"/>
 190
 191             <!-- Extension service that generates "approximate" metadata based on SP configuration. -->
 192             <Handler type="MetadataGenerator" Location="/Metadata" signing="false"/>
 193
 194             <!-- Status reporting service. -->
 195             <Handler type="Status" Location="/Status" acl="127.0.0.1"/>
 196
 197             <!-- Session diagnostic service. -->
 198             <Handler type="Session" Location="/Session" showAttributeValues="false"/>
 199
 200             <!-- JSON feed of discovery information. -->
 201             <Handler type="DiscoveryFeed" Location="/DiscoFeed"/>
 202         </Sessions>
 203
 204         <!--
 205         Allows overriding of error template information/filenames. You can
 206         also add attributes with values that can be plugged into the templates.
 207         -->
 208         <Errors supportContact="root@localhost"
 209             logoLocation="/shibboleth-sp/logo.jpg"
 210             styleSheet="/shibboleth-sp/main.css"/>
 211
 212         <!--
 213         Uncomment and modify to tweak settings for specific IdPs or groups. Settings here
 214         generally match those allowed by the <ApplicationDefaults> element.
 215         -->
 216         <!--
 217         <RelyingParty Name="SpecialFederation" keyName="SpecialKey"/>
 218         -->
 219
 220         <!-- Example of remotely supplied batch of signed metadata. -->
 221         <!--
 222         <MetadataProvider type="XML" uri="http://federation.org/federation-metadata.xml"
 223               backingFilePath="federation-metadata.xml" reloadInterval="7200">
 224             <MetadataFilter type="RequireValidUntil" maxValidityInterval="2419200"/>
 225             <MetadataFilter type="Signature" certificate="fedsigner.pem"/>
 226         </MetadataProvider>
 227         -->
 228
 229         <!-- Example of locally maintained metadata. -->
 230         <!--
 231         <MetadataProvider type="XML" file="partner-metadata.xml"/>
 232         -->
 233
 234         <!-- TrustEngines run in order to evaluate peer keys and certificates. -->
 235         <TrustEngine type="ExplicitKey"/>
 236         <TrustEngine type="PKIX"/>
 237
 238         <!-- Map to extract attributes from SAML assertions. -->
 239         <AttributeExtractor type="XML" validate="true" path="attribute-map.xml"/>
 240
 241         <!-- Use a SAML query if no attributes are supplied during SSO. -->
 242         <AttributeResolver type="Query" subjectMatch="true"/>
 243
 244         <!-- Default filtering policy for recognized attributes, lets other data pass. -->
 245         <AttributeFilter type="XML" validate="true" path="attribute-policy.xml"/>
 246
 247         <!-- Simple file-based resolver for using a single keypair. -->
 248         <CredentialResolver type="File" key="sp-key.pem" certificate="sp-cert.pem"/>
 249
 250         <!--
 251         The default settings can be overridden by creating ApplicationOverride elements (see
 252         the https://spaces.internet2.edu/display/SHIB2/NativeSPApplicationOverride topic).
 253         Resource requests are mapped by web server commands, or the RequestMapper, to an
 254         applicationId setting.
 255
 256         Example of a second application (for a second vhost) that has a different entityID.
 257         Resources on the vhost would map to an applicationId of "admin":
 258         -->
 259         <!--
 260         <ApplicationOverride id="admin" entityID="https://admin.example.org/shibboleth"/>
 261         -->
 262     </ApplicationDefaults>
 263
 264     <!-- Policies that determine how to process and authenticate runtime messages. -->
 265     <SecurityPolicyProvider type="XML" validate="true" path="security-policy.xml"/>
 266
 267     <!-- Low-level configuration about protocols and bindings available for use. -->
 268     <ProtocolProvider type="XML" validate="true" reloadChanges="false" path="protocols.xml"/>
 269
 270 </SPConfig>