Shibboleth Service Provider for IIS

October 14, 2019

by Yunus Shaikh

In this tutorial, we will install Shibboleth server provider for IIS 8.5 server


We will see how to install Shibboleth SP3 in windows using executable. We will examine the Shibboleth SP metadata, Shibboleth2.xml and how to get connected with Shibboleth Identity provider ie. Shibboleth IDP.


Shibboleth is a single sign-on log-in system based on SAML. We will see how Shibboleth.sso handles and protects the confidential information within your web application. Also, we will troubleshoot Shibboleth.sso not found an issue, unable to map IDP.

Here are the steps to install Shibboleth service provider on windows IIS
  • Install Shibboleth SP3 executable
  • Validate Shibboleth service in windows services
  • See Shibboleth.sso status and get metadata information
  • Configure shibboleth2.xml
  • Test Shibboleth service provider with samltest.id
  • How to get a response from Shibboleth Identity Provider (IDP) and how to extract server variables
As a service provider you must need to provide this information to IDP
  • entityID - This is just a unique identity for your site. IDP may provide service to 1000 applications, This entityID will help your IDP to identify you. For example https://blogs.yunus.in/sp/shibboleth . replace my blogs URL with your site URL.
  • Public Key - You can grab this from C:\opt\shibboleth-sp\etc\shibboleth directory. You won't find this at this step. Once you install the Shibboleth SP then it will get automatically generated as shown below. (need to take sp-signing-cert.pem and sp-encrypt-cert.pem, IDP might only need sp-signing-cert.pem )
  • ACS URL this would be your return URL. Once you login from SSO then IDP will redirect the user to this URL. For example https://blogs.yunus.in/Shibboleth.sso
  • SP Metadata - Not required but it would be better to provide this. This is an XML file that has all the necessary information which will be helpful for IDP. To get this visit http://localhost/Shibboleth.sso/Metadata . Again this will be available after you install the Shibboleth service provider.

Let's see Shibboleth SP installation steps in details


1 - Install Shibboleth Service Provider executable

Login to windows server

Connect to Windows server to install shibboleth

Connect to Windows server to install shibboleth

Go to Shibboleth Service provider and download the latest service provider. direct link for SP 3.0.4

install shibboleth step 1

install shibboleth step 1

install shibboleth step 2

install shibboleth step 2

Make sure you checked the configure IIS7 module and let the other as default options. This process will install Shibboleth SP3 in C:\opt\shibboleth-sp\ directory

2 - Validate Shibboleth service in windows services


Verify if Shibboleth Service is running, press on the windows icon in left bottom (Start) and type services.

open services shibboleth-iis

open services shibboleth-iis

Shibboleth service IIS

Shibboleth service IIS

3 - See Shibboleth.sso status and get metadata information

After verifying that Shibboleth Service provider is running in IIS, then visit http://localhost/Shibboleth.sso/Status

Shibboleth.sso status

Shibboleth.sso status

http://localhost/Shibboleth.sso/Status will display XML which will have your shibboleth configuration

4 - Configure shibboleth2.xml

        
             <SPConfig xmlns="urn:mace:shibboleth:3.0:native:sp:config"
     xmlns:conf="urn:mace:shibboleth:3.0:native:sp:config"
     clockSkew="180">
 
     <OutOfProcess tranLogFormat="%u|%s|%IDP|%i|%ac|%t|%attr|%n|%b|%E|%S|%SS|%L|%UA|%a" />
 
     <!--
     The InProcess section contains settings affecting web server modules.
     Required for IIS, but can be removed when using other web servers.
     -->
     <InProcess>
         <ISAPI normalizeRequest="true" safeHeaderNames="true">
             <!--
             Maps IIS Instance ID values to the host scheme/name/port. The name is
             required so that the proper <Host> in the request map above is found without
             having to cover every possible DNS/IP combination the user might enter.
               -->
                 <Site id="1" name=sp.example.org/>
                 <!--
             When the port and scheme are omitted, the HTTP request's port and scheme are used.
             If these are wrong because of virtualization, they can be explicitly set here to
             ensure proper redirect generation.
             -->
             <!--
             <Site id="42" name=virtual.example.org scheme="https" port="443"/>
             -->
         </ISAPI>
     </InProcess>
 
     <!--
     By default, in-memory StorageService, ReplayCache, ArtifactMap, and SessionCache
     are used. See example-shibboleth2.xml for samples of explicitly configuring them.
     -->
 
     <!--
     To customize behavior for specific resources on IIS, use the XML syntax below.
     Apache users should rely on web server options/commands in most cases, and can remove the
     RequestMapper element.
     -->
     <RequestMapper type=Native>
         <RequestMap>
             <!--
             The example requires a session for documents in /secure on the containing host with http and
             https on the default ports. Note that the name and port in the <Host> elements MUST match
             Apache's ServerName and Port directives or the IIS Site name in the <ISAPI> element above.
             
                 -->
             <Host name=sp.example.org>
                 <Path name=secure authType="shibboleth" requireSession="true"/>
             </Host>
             <!-- Example of a second vhost mapped to a different applicationId. -->
             <!--
             <Host name=admin.example.org applicationId="admin" authType="shibboleth" requireSession="true"/>
             -->
             
 
         </RequestMap>
     </RequestMapper>
 
     <!--
     The ApplicationDefaults element is where most of Shibboleth's SAML bits are defined.
     With IIS, resource requests are mapped by the RequestMapper to an applicationId that
     points into to this section (or to the defaults here).
     -->
     <ApplicationDefaults entityID="https://sp.example.org/shibboleth"
         REMOTE_USER="eppn subject-id pairwise-id persistent-id"
         cipherSuites="DEFAULT:!EXP:!LOW:!aNULL:!eNULL:!DES:!IDEA:!SEED:!RC4:!3DES:!kRSA:!SSLv2:!SSLv3:!TLSv1:!TLSv1.1">
 
         <!--
         Controls session lifetimes, address checks, cookie handling, and the protocol handlers.
         Each Application has an effectively unique handlerURL, which defaults to "/Shibboleth.sso"
         and should be a relative path, with the SP computing the full value based on the virtual
         host. Using handlerSSL="true" will force the protocol to be https. You should also set
         cookieProps to "https" for SSL-only sites. Note that while we default checkAddress to
         "true", this makes an assertion stolen in transit easier for attackers to misuse.
         -->
         <Sessions lifetime="28800" timeout="3600" relayState="ss:mem"
                   checkAddress="true" handlerSSL="true" cookieProps="https">
 
             <!--
             Configures SSO for a default IdP. To properly allow for >1 IdP, remove
             entityID property and adjust discoveryURL to point to discovery service.
             You can also override entityID on /Login query string, or in RequestMap/htaccess.
             -->
             <SSO entityID="https://idp.example.org/idp/shibboleth"
                  discoveryProtocol="SAMLDS" discoveryURL="https://ds.example.org/DS/WAYF">
               SAML2
             </SSO>
 
             <!-- SAML and local-only logout. -->
             <Logout>SAML2 Local</Logout>
 
             <!-- Administrative logout. -->
             <LogoutInitiator type=Admin Location="/Logout/Admin" acl="127.0.0.1 ::1" />
 
             <!-- Extension service that generates "approximate" metadata based on SP configuration. -->
             <Handler type=MetadataGenerator Location="/Metadata" signing="false"/>
 
             <!-- Status reporting service. -->
             <Handler type=Status Location="/Status" acl="127.0.0.1 ::1"/>
 
             <!-- Session diagnostic service. -->
             <Handler type=Session Location="/Session" showAttributeValues="false"/>
 
             <!-- JSON feed of discovery information. -->
             <Handler type=DiscoveryFeed Location="/DiscoFeed"/>
         </Sessions>
 
         <!--
         Allows overriding of error template information/filenames. You can
         also add your own attributes with values that can be plugged into the
         templates, e.g., helpLocation below.
         -->
         <Errors supportContact="root@localhost"
             helpLocation="/about.html"
             styleSheet="/shibboleth-sp/main.css"/>
 
         <!-- Example of locally maintained metadata. -->
          <!--
             <MetadataProvider type=XML validate="true" path="partner-metadata.xml"/>
             -->
 
 
         <!-- Example of remotely supplied batch of signed metadata. -->
         <!--
         <MetadataProvider type=XML validate="true"
 	            url="http://federation.org/federation-metadata.xml"
               backingFilePath="federation-metadata.xml" maxRefreshDelay="7200">
             <MetadataFilter type=RequireValidUntil maxValidityInterval="2419200"/>
             <MetadataFilter type=Signature certificate="fedsigner.pem" verifyBackup="false"/>
             <DiscoveryFilter type=Blacklist matcher="EntityAttributes" trimTags="true"
               attributeName="http://macedir.org/entity-category"
               attributeNameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
               attributeValue="http://refeds.org/category/hide-from-discovery" />
         </MetadataProvider>
         -->
 
         <!-- Example of remotely supplied "on-demand" signed metadata. -->
         <!--
         <MetadataProvider type=MDQ validate="true" cacheDirectory="mdq"
 	            baseUrl="http://mdq.federation.org" ignoreTransport="true">
             <MetadataFilter type=RequireValidUntil maxValidityInterval="2419200"/>
             <MetadataFilter type=Signature certificate="mdqsigner.pem" />
         </MetadataProvider>
         -->
 
       <!-- Map to extract attributes from SAML assertions. -->
         <AttributeExtractor type=XML validate="true" reloadChanges="false" path="attribute-map.xml"/>
 
         <!-- Default filtering policy for recognized attributes, lets other data pass. -->
         <AttributeFilter type=XML validate="true" path="attribute-policy.xml"/>
         
             <!-- Simple file-based resolvers for separate signing/encryption keys. -->
             <CredentialResolver type=File use="signing"
                 key="sp-signing-key.pem" certificate="sp-signing-cert.pem"/>
             <CredentialResolver type=File use="encryption"
                 key="sp-encrypt-key.pem" certificate="sp-encrypt-cert.pem"/>
         
        
 
     </ApplicationDefaults>
 
     <!-- Policies that determine how to process and authenticate runtime messages. -->
     <SecurityPolicyProvider type=XML validate="true" path="security-policy.xml"/>
 
     <!-- Low-level configuration about protocols and bindings available for use. -->
     <ProtocolProvider type=XML validate="true" reloadChanges="false" path="protocols.xml"/>
 
 </SPConfig>
 
         
     

Need to make a change in Site tag. Add your site name i.e you hostname. for example https://blogs.yunus.in . the default side id would be 1. You can find site id in IIS server. Open IIS server management tool and double click on sites menu which is present in the left.

         
             <Site id="1" name=blogs.yunus.in/>
          
      

Need to make a change in Host tag. Add your site name i.e you host name. for example https://blogs.yunus.in. Below snippet will secure https://blogs.yunus.in/blogs

         
             <Host name=blogs.yunus.in>
             <Path name=blogs authType="shibboleth" requireSession="true"/>
         </Host>
          
      

If you need to secure the whole website https://blogs.yunus.in , then use this snippet

         
             <Host name=blogs.yunus.in authType="shibboleth" requireSession="true">
             </Host>
          
 

Update your entityID in ApplicationDefaults . This is just a unique identity for your site. Don't need to be a valid URL but it should be unique in the IDP list. So it's better to put the domain name.

         
             entityID="https://blogs.yunus.in/sp/shibboleth"
          
      

Update your IDP entityID in SSO . You need ask your IDP for their entityID.

         
             <SSO entityID="https://idp.example.org/idp/shibboleth"
             discoveryProtocol="SAMLDS" discoveryURL="https://ds.example.org/DS/WAYF">
          SAML2
        </SSO>         
      

Need to add IDP Metadata. You can add using local file or you can provide URL.

         
             <MetadataProvider type=XML validate="true"
             url="https://samltest.id/saml/idp"
             backingFilePath="SAMLtest.xml">
          <!-- You should always check the signature and freshness of remote
                  metadata.  It's commented out until you get the basics working.
               <MetadataFilter type=RequireValidUntil maxValidityInterval="2419200"/>
               <MetadataFilter type=Signature certificate="signet.crt" verifyBackup="false"/>
             -->
     </MetadataProvider>
      
      

Make sure you have reference to key in CredentialResolver . You need to provide pair of public key to your IDP.

This is how your final shibboleth.xml file would look like.

         
             <SPConfig xmlns="urn:mace:shibboleth:3.0:native:sp:config"
     xmlns:conf="urn:mace:shibboleth:3.0:native:sp:config"
     clockSkew="180">
 
     <OutOfProcess tranLogFormat="%u|%s|%IDP|%i|%ac|%t|%attr|%n|%b|%E|%S|%SS|%L|%UA|%a" />
   
     <!--
     The InProcess section contains settings affecting web server modules.
     Required for IIS, but can be removed when using other web servers.
     -->
     <InProcess>
         <ISAPI normalizeRequest="true" safeHeaderNames="true">
             <!--
             Maps IIS Instance ID values to the host scheme/name/port. The name is
             required so that the proper <Host> in the request map above is found without
             having to cover every possible DNS/IP combination the user might enter.
             -->
             <Site id="1" name=blogs.yunus.in/>
             <!--
             When the port and scheme are omitted, the HTTP request's port and scheme are used.
             If these are wrong because of virtualization, they can be explicitly set here to
             ensure proper redirect generation.
             -->
             <!--
             <Site id="42" name=virtual.example.org scheme="https" port="443"/>
             -->
         </ISAPI>
     </InProcess>
 
     <!--
     By default, in-memory StorageService, ReplayCache, ArtifactMap, and SessionCache
     are used. See example-shibboleth2.xml for samples of explicitly configuring them.
     -->
 
     <!--
     To customize behavior for specific resources on IIS, use the XML syntax below.
     Apache users should rely on web server options/commands in most cases, and can remove the
     RequestMapper element.
     -->
     <RequestMapper type=Native>
         <RequestMap>
             <!--
             The example requires a session for documents in /secure on the containing host with http and
             https on the default ports. Note that the name and port in the <Host> elements MUST match
             Apache's ServerName and Port directives or the IIS Site name in the <ISAPI> element above.
             -->
             <Host name=blogs.yunus.in>
                 <Path name=blogs authType="shibboleth" requireSession="true"/>
             </Host>
             <!-- Example of a second vhost mapped to a different applicationId. -->
             <!--
             <Host name=admin.example.org applicationId="admin" authType="shibboleth" requireSession="true"/>
             -->
         </RequestMap>
     </RequestMapper>
 
     <!--
     The ApplicationDefaults element is where most of Shibboleth's SAML bits are defined.
     With IIS, resource requests are mapped by the RequestMapper to an applicationId that
     points into to this section (or to the defaults here).
     -->
     <ApplicationDefaults entityID="https://blogs.yunus.in/sp/shibboleth"
         REMOTE_USER="eppn subject-id pairwise-id persistent-id"
         cipherSuites="DEFAULT:!EXP:!LOW:!aNULL:!eNULL:!DES:!IDEA:!SEED:!RC4:!3DES:!kRSA:!SSLv2:!SSLv3:!TLSv1:!TLSv1.1">
 
         <!--
         Controls session lifetimes, address checks, cookie handling, and the protocol handlers.
         Each Application has an effectively unique handlerURL, which defaults to "/Shibboleth.sso"
         and should be a relative path, with the SP computing the full value based on the virtual
         host. Using handlerSSL="true" will force the protocol to be https. You should also set
         cookieProps to "https" for SSL-only sites. Note that while we default checkAddress to
         "false", this makes an assertion stolen in transit easier for attackers to misuse.
         -->
         <Sessions lifetime="28800" timeout="3600" relayState="ss:mem"
                   checkAddress="false" handlerSSL="true" cookieProps="https">
 
             <!--
             Configures SSO for a default IdP. To properly allow for >1 IdP, remove
             entityID property and adjust discoveryURL to point to discovery service.
             You can also override entityID on /Login query string, or in RequestMap/htaccess.
             -->
             <SSO entityID="https://samltest.id/saml/idp"
                  discoveryProtocol="SAMLDS" discoveryURL="https://ds.example.org/DS/WAYF">
               SAML2
             </SSO>
 
             <!-- SAML and local-only logout. -->
             <Logout>SAML2 Local</Logout>
 
             <!-- Administrative logout. -->
             <LogoutInitiator type=Admin Location="/Logout/Admin" acl="127.0.0.1 ::1" />
 
             <!-- Extension service that generates "approximate" metadata based on SP configuration. -->
             <Handler type=MetadataGenerator Location="/Metadata" signing="false"/>
 
             <!-- Status reporting service. -->
             <Handler type=Status Location="/Status" acl="127.0.0.1 ::1"/>
 
             <!-- Session diagnostic service. -->
             <Handler type=Session Location="/Session" showAttributeValues="false"/>
 
             <!-- JSON feed of discovery information. -->
             <Handler type=DiscoveryFeed Location="/DiscoFeed"/>
         </Sessions>
 
         <!--
         Allows overriding of error template information/filenames. You can
         also add your own attributes with values that can be plugged into the
         templates, e.g., helpLocation below.
         -->
         <Errors supportContact="root@localhost"
             helpLocation="/about.html"
             styleSheet="/shibboleth-sp/main.css"/>
 
 <MetadataProvider type=XML validate="true"
         url="https://samltest.id/saml/idp"
         backingFilePath="SAMLtest.xml">
      <!-- You should always check the signature and freshness of remote
              metadata.  It's commented out until you get the basics working.
           <MetadataFilter type=RequireValidUntil maxValidityInterval="2419200"/>
           <MetadataFilter type=Signature certificate="signet.crt" verifyBackup="false"/>
         -->
 </MetadataProvider>
         <!-- Example of locally maintained metadata. -->
         <!--
         <MetadataProvider type=XML validate="true" path="partner-metadata.xml"/>
         -->
 
         <!-- Example of remotely supplied batch of signed metadata. -->
         <!--
         <MetadataProvider type=XML validate="true"
 	            url="http://federation.org/federation-metadata.xml"
               backingFilePath="federation-metadata.xml" maxRefreshDelay="7200">
             <MetadataFilter type=RequireValidUntil maxValidityInterval="2419200"/>
             <MetadataFilter type=Signature certificate="fedsigner.pem" verifyBackup="false"/>
             <DiscoveryFilter type=Blacklist matcher="EntityAttributes" trimTags="true" 
               attributeName="http://macedir.org/entity-category"
               attributeNameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
               attributeValue="http://refeds.org/category/hide-from-discovery" />
         </MetadataProvider>
         -->
 
         <!-- Example of remotely supplied "on-demand" signed metadata. -->
         <!--
         <MetadataProvider type=MDQ validate="true" cacheDirectory="mdq"
 	            baseUrl="http://mdq.federation.org" ignoreTransport="true">
             <MetadataFilter type=RequireValidUntil maxValidityInterval="2419200"/>
             <MetadataFilter type=Signature certificate="mdqsigner.pem" />
         </MetadataProvider>
         -->
 
       <!-- Map to extract attributes from SAML assertions. -->
         <AttributeExtractor type=XML validate="true" reloadChanges="false" path="attribute-map.xml"/>
         
         <!-- Default filtering policy for recognized attributes, lets other data pass. -->
         <AttributeFilter type=XML validate="true" path="attribute-policy.xml"/>
 
         <!-- Simple file-based resolvers for separate signing/encryption keys. -->
         <CredentialResolver type=File use="signing"
             key="sp-signing-key.pem" certificate="sp-signing-cert.pem"/>
         <CredentialResolver type=File use="encryption"
             key="sp-encrypt-key.pem" certificate="sp-encrypt-cert.pem"/>
         
     </ApplicationDefaults>
     
     <!-- Policies that determine how to process and authenticate runtime messages. -->
     <SecurityPolicyProvider type=XML validate="true" path="security-policy.xml"/>
 
     <!-- Low-level configuration about protocols and bindings available for use. -->
     <ProtocolProvider type=XML validate="true" reloadChanges="false" path="protocols.xml"/>
 
 </SPConfig>
 
      
      

Restart IIS server and restart the shibboleth service

restart shibboleth service

restart shibboleth service

Don't forget to restart IIS server.

That's it !!! try to browse your site or goto http://localhost/Shibboleth.sso/Login . It will redirect you to SSO site. There is one great tool which can be useful to test Service provider. I will show you that along with how can we extract the response from SSO in the next blog

Feel Free to check out Other Blogs or visite Home Page

Featured Posts