HOWTO Install and Configure a Shibboleth IdP v3.2.1 on Ubuntu Linux LTS 16.04 with Apache2 + Jetty9

Requirements Hardware

CPU: 2 Core
RAM: 4 GB
HDD: 20 GB

Software that will be installed

ca-certificates
ntp
vim
default-jdk (openjdk 1.8.0)
jetty 9.3.x
apache2 (>= 2.4)
expat
openssl
mysql-server
libmysql-java
libcommons-dbcp-java
libcommons-pool-java

Other Requirements

Place the HTTPS Server Certificate and the HTTPS Server Key inside /tmp directory

Installation Instructions

Install software requirements

Become ROOT:
- sudo su -
Change the default mirror with the GARR ones:
- nano /etc/apt/sources.list
- CTRL+W (search)
- CTRL+R (replace)
- Text to search: 'it.archive.ubuntu.com'
- Text to replace: 'ubuntu.mirror.garr.it'
- CTRL+X (save and exit)
- apt-get update && apt-get upgrade
Install the packages required:
- apt-get install vim default-jdk ca-certificates openssl apache2 ntp expat
Check that Java is working:
- update-alternatives --config java

Configure the environment

Modify your /etc/hosts:
- vim /etc/hosts
```
127.0.1.1 idp.example.org idp
```
(Replace idp.example.org with your IdP Full Qualified Domain Name)
Be sure that your firewall doesn't block the traffic on port 443 (or you can't access to your IdP)
Define the costant JAVA_HOME and IDP_SRC inside /etc/environment:
- vim /etc/environment
```
JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64/jre
IDP_SRC=/usr/local/src/shibboleth-identity-provider-3.2.1
```
- source /etc/environment
- export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64/jre
- export IDP_SRC=/usr/local/src/shibboleth-identity-provider-3.2.1
Move the Certificate and the Key file for HTTPS server from /tmp/ to /root/certificates:
- mkdir /root/certificates
- mv /tmp/idp-cert-server.crt /root/certificates
- mv /tmp/idp-key-server.key /root/certificates
- mv /tmp/DigiCertCA.crt /root/certificates
- chmod 400 /root/certificates/idp-key-server.key
- chmod 644 /root/certificates/idp-cert-server.crt
- chmod 644 /root/certificates/DigiCertCA.crt
(OPTIONAL) Create a Certificate and a Key self-signed for HTTPS if you don't have the official ones provided by DigiCert:
- openssl req -x509 -newkey rsa:4096 -keyout /root/certificates/idp-key-server.key -out /root/certificates/idp-cert-server.crt -nodes -days 1095
Configure /etc/default/jetty:
- update-alternatives --config java (copy the path without /bin/java)
- update-alternatives --config javac
- vim /etc/default/jetty
```
JETTY_HOME=/usr/local/src/jetty-src
JETTY_BASE=/opt/jetty
JETTY_USER=jetty
JETTY_LOGS=/var/log/jetty
TMPDIR=/opt/jetty/tmp
JAVA_OPTIONS="-Djava.awt.headless=true -XX:+DisableExplicitGC -XX:+UseParallelOldGC -Xms256m -Xmx2g -Djava.security.egd=file:/dev/./urandom -Didp.home=/opt/shibboleth-idp"
```
  (This settings configure the memory of the JVM that will host the IdP Web Application. The Memory value depends on the phisical memory installed on the machine. Set the "Xmx" (max heap space available to the JVM) at least to 2GB)

Install Jetty 9 Web Server

Become ROOT:
- sudo su -
Download and Extract Jetty:
- cd /usr/local/src
- wget http://repo1.maven.org/maven2/org/eclipse/jetty/jetty-distribution/9.3.11.v20160721/jetty-distribution-9.3.11.v20160721.tar.gz
- tar xzvf jetty-distribution-9.3.11.v20160721.tar.gz
Create an useful-for-updates jetty-src folder:
- ln -s jetty-distribution-9.3.11.v20160721 jetty-src
Create the user jetty that can run the web server:
- useradd -r -m jetty

Create your custom Jetty configuration that override the default ones:

mkdir /opt/jetty
cd /opt/jetty

vim /opt/jetty/start.ini

#===========================================================
# Jetty Startup
#
# Starting Jetty from this {jetty.home} is not recommended.
#
# A proper {jetty.base} directory should be configured, instead
# of making changes to this {jetty.home} directory.
#
# See documentation about {jetty.base} at
# http://www.eclipse.org/jetty/documentation/current/startup.html
#
# A demo-base directory has been provided as an example of
# this sort of setup.
#
# $ cd demo-base
# $ java -jar ../start.jar
#
#===========================================================

# To disable the warning message, comment the following line
--module=home-base-warning

# ---------------------------------------
# Module: ext
--module=ext

# ---------------------------------------
# Module: resources
--module=resources

# ---------------------------------------
# Module: server
--module=server

# ---------------------------------------
# Module: http
--module=http

### HTTP Connector Configuration

## Connector host/address to bind to
jetty.http.host=localhost

## Connector port to listen on
jetty.http.port=8080

## Connector idle timeout in milliseconds
jetty.http.idleTimeout=30000

## Connector socket linger time in seconds (-1 to disable)
jetty.http.soLingerTime=-1

# ---------------------------------------
# Module: deploy
--module=deploy

# ---------------------------------------
# Module: jsp
--module=jsp

# ---------------------------------------
# Module: websocket
--module=websocket

# ---------------------------------------
# Module: jstl
--module=jstl

# ---------------------------------------
# Module: annotations
--module=annotations

# ---------------------------------------
# Module: logging
--module=logging

# ---------------------------------------
# Module: requestlog
--module=requestlog

# ---------------------------------------
# Module: servlets
--module=servlets

# ---------------------------------------
# Module: plus
--module=plus

# ---------------------------------------
# Mwdule: http-forwarded
--module=http-forwarded

Create the TMPDIR directory used by Jetty:
- mkdir /opt/jetty/tmp ; chown jetty:jetty /opt/jetty/tmp
- chown -R jetty:jetty /opt/jetty/ /usr/local/src/jetty-src
Create the service loadable from command line:
- cd /etc/init.d
- ln -s /usr/local/src/jetty-src/bin/jetty.sh jetty
- update-rc.d jetty defaults
Create the JETTY_LOG folder:
- mkdir /var/log/jetty
- chown jetty:jetty /var/log/jetty
Check if all settings are OK:
- service jetty check
- service jetty start
(If you receive an error likes "Job for jetty.service failed because the control process exited with error code. See "systemctl status jetty.service" and "journalctl -xe" for details.", try this:
- rm /var/run/jetty.pid
- service jetty start

Install Shibboleth Identity Provider v3.2.1

Become ROOT:
- sudo su -
Download the Shibboleth Identity Provider v3.2.1:
- cd /usr/local/src
- wget http://shibboleth.net/downloads/identity-provider/3.2.1/shibboleth-identity-provider-3.2.1.tar.gz
- tar -xzvf shibboleth-identity-provider-3.2.1.tar.gz
- cd shibboleth-identity-provider-3.2.1

Run the installer install.sh:

./bin/install.sh

root@idp:/usr/local/src/shibboleth-identity-provider-3.2.1# ./bin/install.sh
Source (Distribution) Directory: [/usr/local/src/shibboleth-identity-provider-3.2.1]
Installation Directory: [/opt/shibboleth-idp]
Hostname: [localhost.localdomain]
idp.example.org
SAML EntityID: [https://idp.example.org/idp/shibboleth]
Attribute Scope: [localdomain]
example.org
Backchannel PKCS12 Password: ###PASSWORD-FOR-BACKCHANNEL###
Re-enter password:           ###PASSWORD-FOR-BACKCHANNEL###
Cookie Encryption Key Password: ###PASSWORD-FOR-COOKIE-ENCRYPTION###
Re-enter password:              ###PASSWORD-FOR-COOKIE-ENCRYPTION###

From this point the variable idp.home refers to the directory: /opt/shibboleth-idp

Import the JST libraries to visualize the IdP status page:
- cd /opt/shibboleth-idp/edit-webapp/WEB-INF/lib
- wget https://build.shibboleth.net/nexus/service/local/repositories/thirdparty/content/javax/servlet/jstl/1.2/jstl-1.2.jar
- cd /opt/shibboleth-idp/bin ; ./build.sh -Didp.target.dir=/opt/shibboleth-idp
Change the owner to enable jetty user to access on the following directories:
- cd ..
- chown -R jetty logs/ metadata/ credentials/ conf/ system/ war/

Configuration Instructions

Configure SSL on Apache2 (Jetty front-end)

Modify the file /etc/apache2/sites-available/default-ssl.conf as follows:

<IfModule mod_ssl.c>
   SSLStaplingCache        shmcb:/var/run/ocsp(128000)
   <VirtualHost _default_:443>
     ServerName idp.example.org:443
     ServerAdmin admin@example.org
     DocumentRoot /var/www/html
     ...
     SSLEngine On
     
     SSLProtocol All -SSLv2 -SSLv3 -TLSv1 -TLSv1.1
     SSLCipherSuite "EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH"

     SSLHonorCipherOrder on

     # Disable SSL Compression
     SSLCompression Off
     
     # OCSP Stapling, only in httpd/apache >= 2.3.3
     SSLUseStapling          on
     SSLStaplingResponderTimeout 5
     SSLStaplingReturnResponderErrors off
     
     # Enable HTTP Strict Transport Security with a 2 year duration
     Header always set Strict-Transport-Security "max-age=63072000;includeSubDomains;preload"
     ...
     SSLCertificateFile /root/certificates/idp-cert-server.crt
     SSLCertificateKeyFile /root/certificates/idp-key-server.key
     SSLCertificateChainFile /root/certificates/DigiCertCA.pem
     ...
   </VirtualHost>
</IfModule>

Enable proxy_http, SSL and headers Apache2 modules:
- a2enmod proxy_http ssl headers alias include negotiation
- a2ensite default-ssl.conf
- service apache2 restart

Configure Apache2 to open port 80 only for localhost:

vim /etc/apache2/ports.conf

# If you just change the port or add more ports here, you will likely also
# have to change the VirtualHost statement in
# /etc/apache2/sites-enabled/000-default.conf

Listen 127.0.0.1:80

<IfModule ssl_module>
  Listen 443
</IfModule>

<IfModule mod_gnutls.c>
  Listen 443
</IfModule>

Configure Apache2 to redirect all on HTTPS:

vim /etc/apache2/sites-enabled/000-default.conf

<VirtualHost *:80>
     ServerName "idp.example.org"
     Redirect "/" "https://idp.example.org/"
</VirtualHost>

Verify the strength of your IdP's machine on:
- https://www.ssllabs.com/ssltest/analyze.html

Configure Jetty

Become ROOT:
- sudo su -

Create the Apache2 configuration file for IdP:

vim /etc/apache2/sites-available/idp.conf

<IfModule mod_proxy.c>
    ProxyPreserveHost On
    RequestHeader set X-Forwarded-Proto "https"
    ProxyPass /idp http://localhost:8080/idp retry=5
    ProxyPassReverse /idp http://localhost:8080/idp retry=5

    <Location /idp>
       Require all granted
    </Location>
</IfModule>

Enable the new site:
- cd /etc/apache2/sites-available/ ; a2ensite idp.conf
- service apache2 restart

Configure IdP Context Descriptor

vim /opt/jetty/webapps/idp.xml

<Configure class="org.eclipse.jetty.webapp.WebAppContext">
  <Set name="war"><SystemProperty name="idp.home"/>/war/idp.war</Set>
  <Set name="contextPath">/idp</Set>
  <Set name="extractWAR">false</Set>
  <Set name="copyWebDir">false</Set>
  <Set name="copyWebInf">true</Set>
</Configure>

Restart Jetty:
- service jetty restart

Configure Shibboleth Identity Provider v3.2.1 to release the persistent-id (Stored mode)

Become ROOT of the machine:
- sudo su -
Test IdP by opening a terminal and running these commands:
- cd /opt/shibboleth-idp/bin
- ./status.sh (You should see some informations about the IdP installed)
Install MySQL Connector Java and other useful libraries used by Jetty for MySQL DB (if you don't have them already):
- apt-get install mysql-server libmysql-java libcommons-dbcp-java libcommons-pool-java
- cd /opt/jetty/lib/ext
- ln -s /usr/share/java/mysql.jar mysql-connector-java.jar
- ln -s /usr/share/java/commons-pool.jar commons-pool.jar
- ln -s /usr/share/java/commons-dbcp.jar commons-dbcp.jar
Rebuild the idp.war of Shibboleth with the new libraries:
- export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64/jre
- cd /opt/shibboleth-idp/bin ; ./build.sh -Didp.target.dir=/opt/shibboleth-idp
Create and prepare the "shibboleth" MySQL DB to host the values of the several persistent-id and StorageRecords MySQL DB to host other useful information about user consent:
- Modify the shibboleth-db.sql by changing the username and password of the user that has write access to the "shibboleth" DB.
- Import the SQL modified to your MySQL Server: mysql -u root -p##PASSWORD-DB## < shibboleth-db.sql
- Restart mysql service: service mysql restart
Enable the generation of the persistent-id (this replace the deprecated attribute eduPersonTargetedID)
- vim /opt/shibboleth-idp/conf/saml-nameid.properties (the sourceAttribute MUST BE an attribute, or a list of comma-separated attributes, that uniquely identify the subject of the generated persistent-id. It MUST BE: Stable, Permanent and Not-reassignable)
```
idp.persistentId.sourceAttribute = uid
...
idp.persistentId.salt = ### result of 'openssl rand -base64 36'###
...
idp.persistentId.generator = shibboleth.StoredPersistentIdGenerator
...
idp.persistentId.dataSource = MyDataSource
...
idp.persistentId.computed = shibboleth.ComputedPersistentIdGenerator
```
- Enable the SAML2PersistentGenerator:
  - vim /opt/shibboleth-idp/conf/saml-nameid.xml
    - Remove the comment from the line containing:
      <ref bean="shibboleth.SAML2PersistentGenerator" />
  - vim /opt/shibboleth-idp/conf/c14n/subject-c14n.xml
    - Remove the comment to the bean called "c14n/SAML2Persistent".

Enable JPAStorageService for the StorageService of the user consent:

vim /opt/shibboleth-idp/conf/global.xml and add this piece of code to the tail (before </beans> tag):

<!-- A DataSource bean suitable for use in the idp.persistentId.dataSource property. -->
<bean id="MyDataSource" class="org.apache.commons.dbcp.BasicDataSource"
      p:driverClassName="com.mysql.jdbc.Driver"
      p:url="jdbc:mysql://localhost:3306/shibboleth?autoReconnect=true"
      p:username="##USER_DB_NAME##"
      p:password="##PASSWORD##"
      p:maxActive="10"
      p:maxIdle="5"
      p:maxWait="15000"
      p:testOnBorrow="true"
      p:validationQuery="select 1"
      p:validationQueryTimeout="5" />

<bean id="shibboleth.JPAStorageService" class="org.opensaml.storage.impl.JPAStorageService"
      p:cleanupInterval="%{idp.storage.cleanupInterval:PT10M}"
      c:factory-ref="shibboleth.JPAStorageService.entityManagerFactory"/>

<bean id="shibboleth.JPAStorageService.entityManagerFactory"
      class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
      <property name="packagesToScan" value="org.opensaml.storage.impl"/>
      <property name="dataSource" ref="MyDataSource"/>
      <property name="jpaVendorAdapter" ref="shibboleth.JPAStorageService.JPAVendorAdapter"/>
      <property name="jpaDialect">
        <bean class="org.springframework.orm.jpa.vendor.HibernateJpaDialect" />
      </property>
</bean>

<bean id="shibboleth.JPAStorageService.JPAVendorAdapter" class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter">
      <property name="database" value="MYSQL" />
</bean>

(and modify the "##USER_DB_NAME##" and "##PASSWORD##" for your "shibboleth" DB)

Modify the IdP configuration file:
- vim /opt/shibboleth-idp/conf/idp.properties
```
idp.consent.StorageService = shibboleth.JPAStorageService
idp.replayCache.StorageService = shibboleth.JPAStorageService
idp.artifact.StorageService = shibboleth.JPAStorageService
```
  (This will indicate to IdP to store the data collected by User Consent into the "StorageRecords" table)

Connect the openLDAP to the IdP to allow the authentication of the users:

vim /opt/shibboleth-idp/conf/ldap.properties

(with TLS solutions we consider to have the LDAP certificate into /opt/shibboleth-idp/credentials).

Solution 1: LDAP + STARTTLS:

idp.authn.LDAP.authenticator = bindSearchAuthenticator
idp.authn.LDAP.ldapURL = ldap://ldap.example.org:389
idp.authn.LDAP.useStartTLS = true
idp.authn.LDAP.useSSL = false
idp.authn.LDAP.sslConfig = certificateTrust
idp.authn.LDAP.trustCertificates = %{idp.home}/credentials/ldap-server.crt
idp.authn.LDAP.baseDN = ou=people,dc=example,dc=org
idp.authn.LDAP.userFilter = (uid={user})
idp.authn.LDAP.bindDN = cn=admin,dc=example,dc=org
idp.authn.LDAP.bindDNCredential = ###LDAP_ADMIN_PASSWORD###

Solution 2: LDAP + TLS:

idp.authn.LDAP.authenticator = bindSearchAuthenticator
idp.authn.LDAP.ldapURL = ldaps://ldap.example.org:636
idp.authn.LDAP.useStartTLS = false
idp.authn.LDAP.useSSL = true
idp.authn.LDAP.sslConfig = certificateTrust
idp.authn.LDAP.trustCertificates = %{idp.home}/credentials/ldap-server.crt
idp.authn.LDAP.baseDN = ou=people,dc=example,dc=org
idp.authn.LDAP.userFilter = (uid={user})
idp.authn.LDAP.bindDN = cn=admin,dc=example,dc=org
idp.authn.LDAP.bindDNCredential = ###LDAP_ADMIN_PASSWORD###

Solution 3: plain LDAP

idp.authn.LDAP.authenticator = bindSearchAuthenticator
idp.authn.LDAP.ldapURL = ldap://ldap.example.org:389
idp.authn.LDAP.useStartTLS = false
idp.authn.LDAP.useSSL = false
idp.authn.LDAP.baseDN = ou=people,dc=example,dc=org
idp.authn.LDAP.userFilter = (uid={user})
idp.authn.LDAP.bindDN = cn=admin,dc=example,dc=org
idp.authn.LDAP.bindDNCredential = ###LDAP_ADMIN_PASSWORD###

(If you decide to use the Solution 3, you have to remove (or comment out) the following code from your Attribute Resolver file:

</dc:FilterTemplate>
<!--
<dc:StartTLSTrustCredential id="LDAPtoIdPCredential" xsi:type="sec:X509ResourceBacked">
  <sec:Certificate>%
    {idp.attribute.resolver.LDAP.trustCertificates}</sec:Certificate>
  </dc:StartTLSTrustCredential>
-->
</resolver:DataConnector>

UTILITY FOR OPENLDAP ADMINISTRATOR:

ldapsearch -H ldap:// -x -b "dc=example,dc=it" -LLL dn
- the baseDN ==> ou=people, dc=example,dc=org (branch containing the registered users)
- the bindDN ==> cn=admin,dc=example,dc=org (distinguished name for the user that can made queries on the LDAP)

Enrich IDP logs with the authentication error occurred on LDAP:

vim /opt/shibboleth-idp/conf/logback.xml

<!-- Logs LDAP related messages -->
<logger name="org.ldaptive" level="${idp.loglevel.ldap:-WARN}"/>

<!-- Logs on LDAP user authentication -->
<logger name="org.ldaptive.auth.Authenticator" level="INFO" />

Define which attributes your IdP can manage into your Attribute Resolver file. Here you can find the attribute-resolver-v3-idem.xml provided by IDEM GARR AAI as example:
- Download the attribute resolver provided by IDEM GARR AAI: wget http://www.garr.it/idem-conf/attribute-resolver-v3-idem.xml -O /opt/shibboleth-idp/conf/attribute-resolver-v3-idem.xml
- Modify services.xml file: vim /opt/shibboleth-idp/conf/services.xml
```
<value>%{idp.home}/conf/attribute-resolver.xml</value>
```
  must become:
```
<value>%{idp.home}/conf/attribute-resolver-v3-idem.xml</value>
```

Configure the LDAP Data Connector to be compliant to the values put in ldap.properties. (See above suggestions)

Translate the IdP messages in your language:
- Get the files translated in your language from Shibboleth page for:
  - login page (authn-messages_it.properties)
  - user consent/terms of use page (consent-messages_it.properties)
  - error pages (error-messages_it.properties)
- Put all downloaded files into /opt/shibboleth-idp/messages directory
- Restart Jetty: service jetty restart

Enable the SAML2 support by changing the idp-metadata.xml and disabling the SAML v1.x deprecated support:

vim /opt/shibboleth-idp/metadata/idp-metadata.xml

<IDPSSODescriptor> SECTION:
  – From the list of "protocolSupportEnumeration" remove:
    - urn:oasis:names:tc:SAML:1.1:protocol
    - urn:mace:shibboleth:1.0

  – Remove the endpoint:
    <ArtifactResolutionService Binding="urn:oasis:names:tc:SAML:1.0:bindings:SOAP-binding" Location="https://idp.example.org:8443/idp/profile/SAML1/SOAP/ArtifactResolution" index="1"/>
    (and modify the index value of the next one to “1”)

  – Remove the endpoint:
    <NameIDFormat>urn:mace:shibboleth:1.0:nameIdentifier</NameIDFormat>

  – Add under the line:
    <NameIDFormat>urn:oasis:names:tc:SAML:2.0:nameid-format:transient</NameIDFormat>
    this line:
    <NameIDFormat>urn:oasis:names:tc:SAML:2.0:nameid-format:persistent</NameIDFormat>
    (because the IdP installed with this guide releases persistent SAML NameIDs)

  - Remove the endpoint: 
    <SingleSignOnService Binding="urn:mace:shibboleth:1.0:profiles:AuthnRequest" Location="https://idp.example.org/idp/profile/Shibboleth/SSO"/>        
  - Remove all ":8443" from the existing URL (such port is not used anymore)

<AttributeAuthorityDescriptor> Section:
  – From the list "protocolSupportEnumeration" replace the value of:
    - urn:oasis:names:tc:SAML:1.1:protocol
    with
    - urn:oasis:names:tc:SAML:2.0:protocol

  - Remove the comment from:
    <AttributeService Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP" Location="https://idp.example.org/idp/profile/SAML2/SOAP/AttributeQuery"/>
  - Remove the endpoint: 
    <AttributeService Binding="urn:oasis:names:tc:SAML:1.0:bindings:SOAP-binding" Location="https://idp.example.org:8443/idp/profile/SAML1/SOAP/AttributeQuery"/>

  - Remove all ":8443" from the existing URL (such port is not used anymore)

Obtain your IdP metadata here:
- https://idp.example.org/idp/shibboleth
Register you IdP on IDEM Entity Registry (your entity have to be approved by an IDEM Federation Operator before become part of IDEM Test Federation):
- https://registry.idem.garr.it/

Configure the IdP to retrieve the Federation Metadata:

cd /opt/shibboleth-idp/conf

vim metadata-providers.xml

<MetadataProvider
      id="URLMD-IDEM-Federation"
      xsi:type="FileBackedHTTPMetadataProvider"
      backingFile="%{idp.home}/metadata/idem-test-metadata-sha256.xml"
      metadataURL="http://md.idem.garr.it/metadata/idem-test-metadata-sha256.xml">

      <!--
          Verify the signature on the root element of the metadata aggregate
          using a trusted metadata signing certificate.
      -->
      <MetadataFilter xsi:type="SignatureValidation" requireSignedRoot="true" certificateFile="${idp.home}/metadata/federation-cert.pem"/>

      <!--
          Require a validUntil XML attribute on the root element and
          make sure its value is no more than 10 days into the future.
      -->
      <MetadataFilter xsi:type="RequiredValidUntil" maxValidityInterval="P10D"/>

      <!-- Consume all SP metadata in the aggregate -->
      <MetadataFilter xsi:type="EntityRoleWhiteList">
        <RetainedRole>md:SPSSODescriptor</RetainedRole>
      </MetadataFilter>
</MetadataProvider>

Retrieve the Federation Certificate used to verify its signed metadata:
- wget https://md.idem.garr.it/certs/idem-signer-20220121.pem -O /opt/shibboleth-idp/metadata/federation-cert.pem
Check the validity:
- cd /opt/shibboleth-idp/metadata
- openssl x509 -in federation-cert.pem -fingerprint -sha1 -noout
  
  (sha1: D1:68:6C:32:A4:E3:D4:FE:47:17:58:E7:15:FC:77:A8:44:D8:40:4D)
- openssl x509 -in federation-cert.pem -fingerprint -md5 -noout
  
  (md5: 48:3B:EE:27:0C:88:5D:A3:E7:0B:7C:74:9D:24:24:E0)

Reload service with id shibboleth.MetadataResolverService to retrieve the Federation Metadata:
- cd /opt/shibboleth-idp/bin
- ./reload-service.sh -id shibboleth.MetadataResolverService
The day after the IDEM Federation Operators approval your entity on IDEM Entity Registry, check if you can login with your IdP on the following services:
- https://sp-demo.aai-test.garr.it/secure (Service Provider provided for testing the IDEM Test Federation)
- https://sp24-test.garr.it/secure (Service Provider provided for testing the IDEM Test Federation and IDEM Production Federation)

Configure Attribute Filters to release the mandatory attributes to the IDEM Default Resources:

Make sure that you have the "tmp/httpClientCache" used by "shibboleth.FileCachingHttpClient":
- mkdir -p /opt/shibboleth-idp/tmp/httpClientCache ; chown jetty /opt/shibboleth-idp/tmp/httpClientCache

Modify your services.xml:

vim /opt/shibboleth-idp/conf/services.xml

<bean id="IDEM-Default-Filter" class="net.shibboleth.ext.spring.resource.FileBackedHTTPResource"
      c:client-ref="shibboleth.FileCachingHttpClient"
      c:url="http://www.garr.it/idem-conf/attribute-filter-v3-idem.xml"
      c:backingFile="%{idp.home}/conf/attribute-filter-v3-idem.xml"/>
     
<util:list id ="shibboleth.AttributeFilterResources">
    <value>%{idp.home}/conf/attribute-filter.xml</value>
    <ref bean="IDEM-Default-Filter"/>
</util:list>

Reload service with id shibboleth.AttributeFilterService to refresh the Attribute Filter followed by the IdP:
- cd /opt/shibboleth-idp/bin
- ./reload-service.sh -id shibboleth.AttributeFilterService

Configure Attribute Filters to release the mandatory attributes to the IDEM Production Resources:

Make sure that you have the "tmp/httpClientCache" used by "shibboleth.FileCachingHttpClient":
- mkdir -p /opt/shibboleth-idp/tmp/httpClientCache ; chown jetty /opt/shibboleth-idp/tmp/httpClientCache

Modify your services.xml:

vim /opt/shibboleth-idp/conf/services.xml

<bean id="IDEM-Production-Filter" class="net.shibboleth.ext.spring.resource.FileBackedHTTPResource"
      c:client-ref="shibboleth.FileCachingHttpClient"
      c:url="http://www.garr.it/idem-conf/attribute-filter-v3-required.xml"
      c:backingFile="%{idp.home}/conf/attribute-filter-v3-required.xml"/>
...
<util:list id ="shibboleth.AttributeFilterResources">
    <value>%{idp.home}/conf/attribute-filter.xml</value>
    <ref bean="IDEM-Default-Filter"/>
    <ref bean="IDEM-Production-Filter"/>
</util:list>

Reload service with id shibboleth.AttributeFilterService to refresh the Attribute Filter followed by the IdP:
- cd /opt/shibboleth-idp/bin
- ./reload-service.sh -id shibboleth.AttributeFilterService

Configure Attribute Filters for Research and Scholarship and Data Protection Code of Conduct Entity Category

Make sure that you have the "tmp/httpClientCache" used by "shibboleth.FileCachingHttpClient":
- mkdir -p /opt/shibboleth-idp/tmp/httpClientCache ; chown jetty /opt/shibboleth-idp/tmp/httpClientCache

Modify your services.xml:

vim /opt/shibboleth-idp/conf/services.xml

<bean id="ResearchAndScholarship" class="net.shibboleth.ext.spring.resource.FileBackedHTTPResource"
      c:client-ref="shibboleth.FileCachingHttpClient"
      c:url="http://www.garr.it/idem-conf/attribute-filter-v3-rs.xml"
      c:backingFile="%{idp.home}/conf/attribute-filter-v3-rs.xml"/>
     
<bean id="CodeOfConduct" class="net.shibboleth.ext.spring.resource.FileBackedHTTPResource"
      c:client-ref="shibboleth.FileCachingHttpClient"
      c:url="http://www.garr.it/idem-conf/attribute-filter-v3-coco.xml"
      c:backingFile="%{idp.home}/conf/attribute-filter-v3-coco.xml"/>

<util:list id ="shibboleth.AttributeFilterResources">
    <value>%{idp.home}/conf/attribute-filter.xml</value>
    <ref bean="IDEM-Default-Filter"/>
    <ref bean="IDEM-Production-Filter"/>
    <ref bean="ResearchAndScholarship"/>
    <ref bean="CodeOfConduct"/>
 </util:list>

Reload service with id shibboleth.AttributeFilterService to refresh the Attribute Filter followed by the IdP:
- cd /opt/shibboleth-idp/bin
- ./reload-service.sh -id shibboleth.AttributeFilterService

Appendix A: Import metadata from previous IDP v2.x

Store into /tmp directory the following files:
- idp-metadata.xml
- idp.crt
- idp.key
Follow the steps on your IdP v3.x:
- sudo su -
- mv /tmp/idp-metadata.xml /opt/shibboleth-idp/metadata
- mv /tmp/idp.crt /tmp/idp.key /opt/shibboleth-idp/credentials
- cd /opt/shibboleth-idp/credentials/
- rm idp-encryption.crt idp-backchannel.crt idp-encryption.key idp-signing.crt idp-signing.key
- ln -s idp.crt idp-encryption.crt
- ln -s idp.key idp-encryption.key
- ln -s idp.key idp-signing.key
- ln -s idp.crt idp-signing.crt
- ln -s idp.crt idp-backchannel.crt
- openssl pkcs12 -export -in idp-encryption.crt -inkey idp-encryption.key -out idp-backchannel.p12 -password pass:#YOUR.BACKCHANNEL.CERT.PASSWORD#
Check if the idp.entityID property value is equal to the entityID value inside the idp-metadata.xml on the file /opt/shibboleth-idp/conf/idp.properties.

Enable the SAML2 support by changing the idp-metadata.xml and disabling the SAML v1.x deprecated support:

vim /opt/shibboleth-idp/metadata/idp-metadata.xml

<IDPSSODescriptor> SECTION:
  – From the list of "protocolSupportEnumeration" remove:
    - urn:oasis:names:tc:SAML:1.1:protocol
    - urn:mace:shibboleth:1.0

  – Remove the endpoint:
    <ArtifactResolutionService Binding="urn:oasis:names:tc:SAML:1.0:bindings:SOAP-binding" Location="https://idp.example.org:8443/idp/profile/SAML1/SOAP/ArtifactResolution" index="1"/>
    (and modify the index value of the next one to “1”)

  – Remove the endpoint:
    <NameIDFormat>urn:mace:shibboleth:1.0:nameIdentifier</NameIDFormat>

  – Add under the line:
    <NameIDFormat>urn:oasis:names:tc:SAML:2.0:nameid-format:transient</NameIDFormat>
    this line:
    <NameIDFormat>urn:oasis:names:tc:SAML:2.0:nameid-format:persistent</NameIDFormat>
    (because the IdP installed with this guide releases persistent SAML NameIDs)

  - Remove the endpoint: 
    <SingleSignOnService Binding="urn:mace:shibboleth:1.0:profiles:AuthnRequest" Location="https://idp.example.org/idp/profile/Shibboleth/SSO"/>        
  - Remove all ":8443" from the existing URL (such port is not used anymore)

<AttributeAuthorityDescriptor> Section:
  – From the list "protocolSupportEnumeration" replace the value of:
    - urn:oasis:names:tc:SAML:1.1:protocol
    with
    - urn:oasis:names:tc:SAML:2.0:protocol

  - Remove the comment from:
    <AttributeService Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP" Location="https://idp.example.org/idp/profile/SAML2/SOAP/AttributeQuery"/>
  - Remove the endpoint: 
    <AttributeService Binding="urn:oasis:names:tc:SAML:1.0:bindings:SOAP-binding" Location="https://idp.example.org:8443/idp/profile/SAML1/SOAP/AttributeQuery"/>

  - Remove all ":8443" from the existing URL (such port is not used anymore)

Restart Jetty:
- service jetty restart
Don't forget to update your IdP Metadata on IDEM Entity Registry to apply changes on the federation IDEM! For any help write to idem-help@garr.it

Appendix B: Import persistent-id from a previous database

Create a DUMP of shibpid table from the previous DB userdb on the OLD IdP:
- cd /tmp
- mysqldump --complete-insert --no-create-db --no-create-info -u root -p userdb shibpid > /tmp/userdb_shibpid.sql
Move the /tmp/userdb_shibpid.sql of old IdP into /tmp/userdb_shibpid.sql on the new IdP.
Import the content of /tmp/userdb_shibpid.sql into the DB of the new IDP:
- cd /tmp ; mysql -u root -p shibboleth < /tmp/userdb_shibpid.sql
Delete /tmp/userdb_shibpid.sql:
- rm /tmp/userdb_shibpid.sql

Appendix C: Useful logs to find problems

Jetty Logs:
- cd /opt/jetty/logs
- ls -l *.stderrout.log
Shibboleth IdP Logs:
- cd /opt/shibboleth-idp/logs
- Audit Log: vim idp-audit.log
- Consent Log: vim idp-consent-audit.log
- Warn Log: vim idp-warn.log
- Process Log: vim idp-process.log

Appendix D: Issues

The <ResultCache>, an LDAP Data Connector child element, in IdP versions before 3.3.0 has a serious security issue, as described in security advisory 20161027.

If you are using a vulnerable version of the IdP then you should not use this element in new deployments, and you should remove it from existing deployments.

The element can be used safely starting with IdP version 3.3.0.

Authors

Original Author

Marco Malavolti (marco.malavolti@garr.it)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

HOWTO Install and Configure a Shibboleth IdP v3.2.1 on Ubuntu Linux LTS 16.04 with Apache2 + Jetty9.md

HOWTO Install and Configure a Shibboleth IdP v3.2.1 on Ubuntu Linux LTS 16.04 with Apache2 + Jetty9.md

HOWTO Install and Configure a Shibboleth IdP v3.2.1 on Ubuntu Linux LTS 16.04 with Apache2 + Jetty9

Table of Contents

Requirements Hardware

Software that will be installed

Other Requirements

Installation Instructions

Install software requirements

Configure the environment

Install Jetty 9 Web Server

Install Shibboleth Identity Provider v3.2.1

Configuration Instructions

Configure SSL on Apache2 (Jetty front-end)

Configure Jetty

Configure Shibboleth Identity Provider v3.2.1 to release the persistent-id (Stored mode)

Configure Attribute Filters to release the mandatory attributes to the IDEM Default Resources:

Configure Attribute Filters to release the mandatory attributes to the IDEM Production Resources:

Configure Attribute Filters for Research and Scholarship and Data Protection Code of Conduct Entity Category

Appendix A: Import metadata from previous IDP v2.x

Appendix B: Import persistent-id from a previous database

Appendix C: Useful logs to find problems

Appendix D: Issues

Authors

Original Author

Files

HOWTO Install and Configure a Shibboleth IdP v3.2.1 on Ubuntu Linux LTS 16.04 with Apache2 + Jetty9.md

Latest commit

History

HOWTO Install and Configure a Shibboleth IdP v3.2.1 on Ubuntu Linux LTS 16.04 with Apache2 + Jetty9.md

File metadata and controls

HOWTO Install and Configure a Shibboleth IdP v3.2.1 on Ubuntu Linux LTS 16.04 with Apache2 + Jetty9

Table of Contents

Requirements Hardware

Software that will be installed

Other Requirements

Installation Instructions

Install software requirements

Configure the environment

Install Jetty 9 Web Server

Install Shibboleth Identity Provider v3.2.1

Configuration Instructions

Configure SSL on Apache2 (Jetty front-end)

Configure Jetty

Configure Shibboleth Identity Provider v3.2.1 to release the persistent-id (Stored mode)

Configure Attribute Filters to release the mandatory attributes to the IDEM Default Resources:

Configure Attribute Filters to release the mandatory attributes to the IDEM Production Resources:

Configure Attribute Filters for Research and Scholarship and Data Protection Code of Conduct Entity Category

Appendix A: Import metadata from previous IDP v2.x

Appendix B: Import persistent-id from a previous database

Appendix C: Useful logs to find problems

Appendix D: Issues

Authors

Original Author