configs/shibboleth.xml.in

   1 <ShibbolethTargetConfig 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">
   5
   6     <Extensions>
   7         <Library path="@-LIBEXECDIR-@/xmlproviders.so" fatal="true"/>
   8     </Extensions>
   9
  10     <SHAR logger="@-PKGSYSCONFDIR-@/shar.logger">
  11
  12                 <!--
  13         <Extensions>
  14             <Library path="@-LIBEXECDIR-@/shib-mysql-ccache.so" fatal="false"/>
  15         </Extensions>
  16         -->
  17
  18         <!-- only one listener can be defined. -->
  19         <UnixListener address="/tmp/shar-socket"/>
  20
  21         <!-- <TCPListener address="127.0.0.1" port="12345" acl="127.0.0.1"/> -->
  22
  23         <!--
  24         See deploy guide for details, but:
  25                 cacheTimeout - how long before expired sessions are purged from the cache
  26                 AATimeout - how long to wait for an AA to respond
  27                 AAConnectTimeout - how long to wait while connecting to an AA
  28                 defaultLifetime - if attributes come back without guidance, how long should they last?
  29                 strictValidity - if we have expired attrs, and can't get new ones, keep using them?
  30                 propagateErrors - suppress errors while getting attrs or let user see them?
  31                 retryInterval - if propagateErrors is false and query fails, how long to wait before trying again
  32         -->
  33         <MemorySessionCache cleanupInterval="300" cacheTimeout="3600" AATimeout="30" AAConnectTimeout="15"
  34             defaultLifetime="1800" retryInterval="300" strictValidity="false" propagateErrors="true"/>
  35         <!--
  36         <MySQLSessionCache cleanupInterval="300" cacheTimeout="3600" AATimeout="30" AAConnectTimeout="15"
  37                defaultLifetime="1800" retryInterval="300" strictValidity="false" propagateErrors="true"
  38                mysqlTimeout="14400">
  39             <Argument>&#x2D;&#x2D;language=@-PREFIX-@/share/english</Argument>
  40             <Argument>&#x2D;&#x2D;datadir=@-PREFIX-@/data</Argument>
  41         </MySQLSessionCache>
  42         -->
  43     </SHAR>
  44
  45     <SHIRE logger="@-PKGSYSCONFDIR-@/shire.logger">
  46         <!--
  47         To customize behavior, map hostnames and path components to applicationId and other settings.
  48         Can be either a pointer to an external file or an inline configuration.
  49         -->
  50         <!--
  51         <RequestMapProvider type="edu.internet2.middleware.shibboleth.target.provider.XMLRequestMap"
  52             uri="@-PKGSYSCONFDIR-@/applications.xml"/>
  53         -->
  54
  55         <RequestMapProvider type="edu.internet2.middleware.shibboleth.target.provider.XMLRequestMap">
  56             <RequestMap applicationId="default">
  57                 <!--
  58                 This requires a session for documents in /secure on the containing host with http and
  59                 https on the default ports. Note that the name and port in the <Host> elements MUST match
  60                 Apache's ServerName and Port directives or the IIS Site mapping in the <ISAPI> element
  61                 below.
  62                 -->
  63                 <Host name="localhost">
  64                     <Path name="secure" requireSession="true" exportAssertion="true">
  65                         <!-- Example shows a subfolder on the SSL port assigned to a separate <Application> -->
  66                             <Path name="admin" applicationId="foo-admin"/>
  67                         </Path>
  68                 </Host>
  69             </RequestMap>
  70         </RequestMapProvider>
  71
  72         <Implementation>
  73             <ISAPI normalizeRequest="true">
  74                 <!--
  75                 Maps IIS IID values to the host scheme/name/port. The name is required so that
  76                 the proper <Host> in the request map above is found without having to cover every
  77                 possible DNS/IP combination the user might enter. The port and scheme can
  78                 usually be omitted, so the HTTP request's port and scheme will be used.
  79                 -->
  80                 <Site id="1" name="localhost"/>
  81             </ISAPI>
  82         </Implementation>
  83     </SHIRE>
  84
  85     <Applications xmlns:saml="urn:oasis:names:tc:SAML:1.0:assertion"
  86         id="default" providerId="https://example.org/shibboleth/target">
  87
  88         <!--
  89         Controls session lifetimes, address checks, cookie handling, WAYF, and the SHIRE location.
  90         You MUST supply a unique shireURL value (and a wayfURL that can be the same) for each of your
  91         applications. The value can be a relative path, a URL with no hostname (https:///path) or a
  92         full URL. The system will compute the value that applies based on the resource. Using
  93         shireSSL="true" will force the protocol to be https. You should also add a cookieProps
  94         setting of "; secure" in that case. The default wayfURL is the InQueue federation's service.
  95         Change to https://localhost/shibboleth/HS for internal testing against your own origin.
  96         -->
  97         <Sessions lifetime="7200" timeout="3600" checkAddress="true"
  98                 wayfURL="https://wayf.internet2.edu/InQueue/WAYF"
  99             shireURL="/Shibboleth.shire" shireSSL="false"/>
 100
 101         <!--
 102         You should customize these pages! You can add attributes with values that can be plugged
 103         into your templates.
 104         -->
 105         <Errors shire="@-PKGSYSCONFDIR-@/shireError.html"
 106             rm="@-PKGSYSCONFDIR-@/rmError.html"
 107             access="@-PKGSYSCONFDIR-@/accessError.html"
 108             supportContact="root@localhost"
 109             logoLocation="/shibtarget/logo.jpg"
 110             styleSheet="/shibtarget/main.css"/>
 111
 112                 <!-- Indicates what credentials to use when communicating -->
 113         <CredentialUse TLS="defcreds" Signing="defcreds">
 114             <!-- RelyingParty elements customize credentials for specific origins or federations -->
 115             <!--
 116             <RelyingParty Name="urn:mace:inqueue" TLS="inqueuecreds" Signing="inqueuecreds"/>
 117             -->
 118         </CredentialUse>
 119
 120         <!-- Use designators to request specific attributes or none to ask for all -->
 121         <!--
 122         <saml:AttributeDesignator AttributeName="urn:mace:dir:attribute-def:eduPersonScopedAffiliation"
 123             AttributeNamespace="urn:mace:shibboleth:1.0:attributeNamespace:uri"/>
 124         <saml:AttributeDesignator AttributeName="urn:mace:dir:attribute-def:eduPersonTargetedID"
 125             AttributeNamespace="urn:mace:shibboleth:1.0:attributeNamespace:uri"/>
 126         -->
 127
 128         <!-- AAP can be inline or in a separate file -->
 129         <AAPProvider type="edu.internet2.middleware.shibboleth.target.provider.XMLAAP" uri="@-PKGSYSCONFDIR-@/AAP.xml"/>
 130         <!--
 131         <AAPProvider type="edu.internet2.middleware.shibboleth.target.provider.XMLAAP"
 132             <AttributeAcceptancePolicy xmlns="urn:mace:shibboleth:aap:1.0">
 133                 <AttributeRule Name="urn:mace:dir:attribute-def:eduPersonPrincipalName" Header="REMOTE_USER" Alias="user">
 134                     <AnySite>
 135                         <AnyValue/>
 136                     </AnySite>
 137                 </AttributeRule>
 138             </AttributeAcceptancePolicy>
 139         </AAPProvider>
 140         -->
 141
 142         <!-- Metadata consists of site/operational metadata, trust, revocation providers. Can be external or inline. -->
 143         <FederationProvider type="edu.internet2.middleware.shibboleth.common.provider.XMLMetadata"
 144             uri="@-PKGSYSCONFDIR-@/IQ-sites.xml"/>
 145         <FederationProvider type="edu.internet2.middleware.shibboleth.common.provider.XMLMetadata">
 146                         <SiteGroup Name="https://example.org/shibboleth" xmlns="urn:mace:shibboleth:1.0">
 147                                 <OriginSite Name="https://example.org/shibboleth/origin">
 148                                         <Alias>Localhost Test Deployment</Alias>
 149                                         <Contact Type="technical" Name="Your Name Here" Email="root@localhost"/>
 150                                         <HandleService Location="https://localhost/shibboleth/HS" Name="localhost"/>
 151                                         <AttributeAuthority Location="https://localhost/shibboleth/AA" Name="localhost"/>
 152                                         <Domain>localhost</Domain>
 153                                 </OriginSite>
 154                         </SiteGroup>
 155         </FederationProvider>
 156
 157         <TrustProvider type="edu.internet2.middleware.shibboleth.common.provider.XMLTrust"
 158             uri="@-PKGSYSCONFDIR-@/IQ-trust.xml"/>
 159
 160                 <!--
 161                 Revocation using X.509 CRLs is an optional feature in some trust metadata or you may
 162                 supply your own revocation information locally.
 163                 -->
 164         <!--
 165         <RevocationProvider type="edu.internet2.middleware.shibboleth.common.provider.XMLRevocation"
 166             uri="@-PKGSYSCONFDIR-@/IQ-trust.xml"/>
 167         -->
 168
 169         <!-- zero or more SAML Audience condition matches -->
 170         <saml:Audience>urn:mace:inqueue</saml:Audience>
 171
 172         <!--
 173         You can customize behavior of specific applications here. You must supply a complete <Sessions>
 174         element to inidicate a distinct shireURL and wayfURL for this application, along with any other
 175         non-default settings you require. None will be inherited. The wayfURL can be the same as the
 176         default above, but the shireURL MUST be different and MUST map to this application in the
 177         RequestMap. The default elements inside the outer <Applications> element generally have to be
 178         overridden in an all or nothing fashion. That is, if you supply an <Errors> override, you MUST
 179         include all attributes you want to apply, as they will not be inherited. Similarly, if you
 180         specify an element such as <FederationProvider>, it is not additive with the defaults, but
 181         replaces them.
 182
 183         The example below shows a special application that requires use of SSL when establishing
 184         sessions, restricts the session cookie to SSL and a specific folder, and inherits most other
 185         behavior except that it requests only EPPN from the origin instead of asking for all attributes.
 186         -->
 187         <!--
 188         <Application id="foo-admin">
 189                 <Sessions lifetime="7200" timeout="3600" checkAddress="true"
 190                     shireURL="/secure/admin/Shibboleth.shire" shireSSL="true" cookieProps="; path=/secure/admin; secure"
 191                     wayfURL="https://wayf.internet2.edu/InQueue/WAYF"/>
 192             <saml:AttributeDesignator AttributeName="urn:mace:dir:attribute-def:eduPersonPrincipalName"
 193                 AttributeNamespace="urn:mace:shibboleth:1.0:attributeNamespace:uri"/>
 194         </Application>
 195         -->
 196
 197     </Applications>
 198
 199     <!-- Define all the private keys and certificates here that you reference from <CredentialUse>. -->
 200     <CredentialsProvider type="edu.internet2.middleware.shibboleth.common.Credentials">
 201         <Credentials xmlns="urn:mace:shibboleth:credentials:1.0">
 202             <FileResolver Id="defcreds">
 203                 <Key format="PEM">
 204                     <Path>@-PKGSYSCONFDIR-@/shar.key</Path>
 205                 </Key>
 206                 <Certificate format="PEM">
 207                     <Path>@-PKGSYSCONFDIR-@/shar.crt</Path>
 208                 </Certificate>
 209             </FileResolver>
 210
 211             <!--
 212             <FileResolver Id="inqueuecreds">
 213                 <Key format="PEM" password="handsoff">
 214                     <Path>@-PKGSYSCONFDIR-@/inqueue.key</Path>
 215                 </Key>
 216                 <Certificate format="PEM">
 217                     <Path>@-PKGSYSCONFDIR-@/inqueue.crt</Path>
 218                 </Certificate>
 219             </FileResolver>
 220             -->
 221         </Credentials>
 222     </CredentialsProvider>
 223
 224 </ShibbolethTargetConfig>
 225