Table of contents
This guide describes the installation of a Shibboleth Service Provider (SP) 3.0 on the supported operating systems below. We did not test the SP on all OS versions, so please report any issue you encounter.
First select the operating system that is used on the host where the Shibboleth Service Provider is installed:
Debian 9.x (stretch) (using SWITCH Package Repository).
Debian 10.x (buster) (using SWITCH Package Repository unless official packages contain latest SP version).
Ubuntu 18.04 LTS (bionic) (using SWITCH Package Repository).
CentOS Linux 5.x/6.x
CentOS Linux 7.x
RedHat Enterprise Linux 5.x/6.x
RedHat Enterprise Linux 7.x
OpenSUSE 13.2.x
SUSE Linux Enterprise Server 10.x/11.x/12.x
macOS 10.10.x or later
Windows Server 2008 and above with IIS
This guide covers only installation but not configuration of the Service Provider. The installation instructions are generic and not federation specific.
If the Service Provider is already installed, please continue to the federation-specific Configuration Guide.
For the following steps it is assumed that the reader is sufficiently experienced to use the command line environment on the operating system of choice.
Please examine the list below and ensure that the system where the Service Provider is going to be installed meets the given requirements.
The following requirements must be met to install and operate the Shibboleth Service Provider.
sudo
. Ensure that you have root privileges on the system.
The following software is optional but recommended to be installed for installation and operation of the Service Provider.
ntp
or use another time synchronisation mechanism.
sudo
for commands that require root privileges. sudo
can be installed with:
apt install sudo
yum install sudo
zypper install sudo
curl
but of course you can also use wget
or another tool. Just replace the curl commands in the following instructions with the tool you prefer using. Curl can be installed with:
sudo apt install curlsudo yum install curl
HTTPS
. By default the Shibboleth messages containing user attributes are encrypted. Therefore, they can also be sent via the insecure HTTP protocol. However, any session-based access to a web page via the insecure HTTP is prone to session hijacking attacks. This also includes the Shibboleth session. Relying on HTTPS mitigates this risk.
Before continuing to the next section, please ensure that the requirements above are met on the system where the Shibboleth Service Provider will be installed.
The Shibboleth project operates its own repository that provides the official Shibboleth Service Provider binaries and its dependencies for RPM-based Linux distributions. This repository contains always up-to-date version of the Shibboleth Service Provider. Therefore, it is recommended to prefer this repository and its packages over packages that may be provided by the OS distribution.
The Shibboleth project only provides official binary packages for RPM-based Linux distributions. As a service to its community members, SWITCH operates a repository with packages for the current Debian stable release. To configure this repository as an additional source for APT, follow these steps:
The Shibboleth project only provides official binary packages for RPM-based Linux distributions. As a service to its community members, SWITCH operates a repository with packages for the current Ubuntu LTS release. To configure this repository as an additional source for APT, follow these steps:
The Shibboleth project maintains the official Shibboleth Service Provider Mac Port packages. Therefore, no specific repository has to be configured for macOS provided Mac Ports is installed.
curl --fail --remote-name https://pkg.switch.ch/switchaai/debian/dists/stretch/main/binary-all/misc/switchaai-apt-source_1.0.0~bpo9+1_all.deb
curl --fail --remote-name https://pkg.switch.ch/switchaai/debian/dists/buster/main/binary-all/misc/switchaai-apt-source_1.0.0_all.deb
curl --fail --remote-name https://pkg.switch.ch/switchaai/ubuntu/dists/bionic/main/binary-all/misc/switchaai-apt-source_1.0.0ubuntu1_all.deb
sudo apt install ./switchaai-apt-source_1.0.0~bpo9+1_all.deb
On Debian 9.x (stretch), the stretch-backports
repository is also required for Shibboleth. Make sure it is enabled in /etc/apt/sources.list
. The SP version 3 requires newer libraries that are only available in stretch-backports.
sudo apt install ./switchaai-apt-source_1.0.0_all.deb
sudo apt install ./switchaai-apt-source_1.0.0ubuntu1_all.deb
Ubuntu's universe
section is also required for Shibboleth. Make sure it is enabled in /etc/apt/sources.list
.
sudo curl --output /etc/yum.repos.d/security:shibboleth.repo http://download.opensuse.org/repositories/security:/shibboleth/CentOS_5/security:shibboleth.repoFor Centos 6.x:
sudo curl --output /etc/yum.repos.d/security:shibboleth.repo http://download.opensuse.org/repositories/security:/shibboleth/CentOS_CentOS-6/security:shibboleth.repo
sudo curl --output /etc/yum.repos.d/security:shibboleth.repo http://download.opensuse.org/repositories/security:/shibboleth/CentOS_7/security:shibboleth.repo
sudo curl --output /etc/yum.repos.d/security:shibboleth.repo http://download.opensuse.org/repositories/security:/shibboleth/RHEL_5/security:shibboleth.repoFor RedHat Enterprise Linux 6.x:
sudo curl --output /etc/yum.repos.d/security:shibboleth.repo http://download.opensuse.org/repositories/security:/shibboleth/RHEL_6/security:shibboleth.repo
sudo curl --output /etc/yum.repos.d/security:shibboleth.repo http://download.opensuse.org/repositories/security:/shibboleth/CentOS_7/security:shibboleth.repo
Importing GPG key 0x7D0A1B3D: Userid : "security:shibboleth OBS Project <security:shibboleth@build.opensuse.org>" Fingerprint: 6519 b5db 7c1c 8340 a954 ed00 73c9 3745 7d0a 1b3d From : http://download.opensuse.org/repositories/security:/shibboleth/CentOS_7//repodata/repomd.xml.key Is this ok [y/N]:Verify that the fingerprint of the repository signing key is
6519 b5db 7c1c 8340 a954 ed00 73c9 3745 7d0a 1b3d
.sudo curl --output /etc/yum.repos.d/security:shibboleth.repo http://download.opensuse.org/repositories/security:/shibboleth/openSUSE_13.2/security:shibboleth.repo
sudo zypper ar -f http://download.opensuse.org/repositories/security:/shibboleth/SLE_10/security:shibboleth.repoFor SUSE Linux 11.x:
sudo zypper ar -f http://download.opensuse.org/repositories/security:/shibboleth/SLE_11/security:shibboleth.repoFor SUSE Linux 11.x SP 1:
sudo zypper ar -f http://download.opensuse.org/repositories/security:/shibboleth/SLE_11_SP1/security:shibboleth.repoFor SUSE Linux 11.x SP 2:
sudo zypper ar -f http://download.opensuse.org/repositories/security:/shibboleth/SLE_11_SP2/security:shibboleth.repoFor SUSE Linux 11.x SP 3:
sudo zypper ar -f http://download.opensuse.org/repositories/security:/shibboleth/SLE_11_SP3/security:shibboleth.repoFor SUSE Linux 12.x:
sudo zypper ar -f http://download.opensuse.org/repositories/security:/shibboleth/SLE_12/security:shibboleth.repo
sudo apt update
sudo zypper ref -s
sudo port sync
https://pkg.switch.ch/switchaai/
is operated for the SWITCH community and support is limited to SPs registered in the SWITCHaai federation. Use of the repository by other parties is permitted, but in this case it is provided as is and without any support.
Install the Service Provider by:
sudo apt update sudo apt install -t stretch-backports init-system-helpers libxerces-c3.2 sudo apt install --install-recommends shibboleth sudo apt upgrade sudo apt autoremove
sudo apt update sudo apt install --install-recommends shibboleth sudo apt autoremoveThe above commands ensure that there are no conflicts because some packages were renamed for SP 3.
sudo apt install --install-recommends shibboleth
sudo yum install shibbolethFor 64-bit OS:
sudo yum install shibboleth.x86_64
sudo port install curl +ssl sudo port install shibbolethIf asked to confirm whether you really want to install Shibboleth and all dependencies, answer with 'Y' for yes.
If a previous version of the Service Provider from the official repository was installed on this system, this old version might be replaced by the newer version from the SWITCH repository. It is therefore ok to agree that old packages (like libapache2-mod-shib2 libsaml8 libshibsp6 libxmltooling6 opensaml2-schemas shibboleth-sp2-schemas
) are removed.
If asked whether you want to import the GPG key with userid "security:shibboleth OBS Project
shibd
daemon:
sudo service shibd start
After installation of the package, you need to start and enable the shibd
daemon:
sudo systemctl start shibd.service
sudo systemctl enable shibd.service
Shibboleth does not support the SP in conjunction with SELinux. To disable SELinux, configure SELINUX=disabled in /etc/selinux/config
and reboot the system.
If there was an older version of a Service Provider already installed on the system, you might be asked whether to keep the existing configuration files or overwrite them with the package default files. The old configuration files should be kept. You can continue to use the old files in most cases. Generally, it is however recommended to perform a clean configuration as is described in the configuration guide mentioned below.
sudo apt update sudo apt install -t stretch-backports init-system-helpers libxerces-c3.2 sudo apt install --install-recommends shibboleth
sudo apt update sudo apt install --install-recommends shibboleth
sudo launchctl load -Fw /Library/LaunchDaemons/org.macports.shibd.plist
sudo ln -s /opt/local/etc/shibboleth /etc/shibboleth sudo ln -s /opt/local/var/log/shibboleth /var/log/shibboleth sudo ln -s /opt/local/etc/shibboleth/apache22.config /etc/apache2/other/shibboleth.conf
.msi
file from the Shibboleth software repository. Either the 64 bit version or 32 bit version. Please check also the Installation Guide of the Shib Wiki.
C:\opt\shibboleth-sp
Shibboleth 3 Daemon
) should have Status = Started, Startup Type = Automatic, Logon As = Local System
.
Executable = C:\opt\shibboleth-sp\lib\shibboleth\isapi-shib.dll
for a 32-bit install. If the status is unknown, use a web browser to open the URL of your web site. Often this will force the Shibboleth ISAPI filter to be activated./etc/sysconfig/shibd
/etc/default/shibd
export http_proxy=proxy.example.org:8080
/Library/LaunchDaemons/org.macports.shibd.plist
:
... <key>RunAtLoad</key> <false/> <key>OnDemand</key> <true/> <key>StandardErrorPath</key> <string>/dev/null</string> <key>UserName</key> <string>root</string> <key>Umask</key> <string>0022</string> <key>EnvironmentVariables</key> <dict> <key>http_proxy</key> <string>proxy.example.org:8080</string> </dict> </dict> </plist>
The Service Provider should now be installed on the system. Of particular interests are the directories:
/etc/shibboleth
C:\opt\shibboleth-sp\etc\shibboleth
shibboleth2.xml
.
/var/log/shibboleth
C:\opt\shibboleth-sp\var\log\shibboleth
shibd.log
file that should be consulted in case of problems.
/run/shibboleth
/opt/local/var/run/shibboleth
C:\opt\shibboleth-sp\var\run\shibboleth
/var/cache/shibboleth
/opt/local/var/cache/shibboleth
C:\opt\shibboleth-sp\var\cache\shibboleth
/etc/init.d
/Library/LaunchDaemons/
shibd
daemon is stored.
%SYSTEMROOT%\System32\inetsrv\iis.msc
%SYSTEMROOT%\System32\eventvwr.msc
%SYSTEMROOT%\System32\lusrmgr.msc
%SYSTEMROOT%\System32\services.msc
After the installation a quick test shows whether the Service Provider was installed properly.
sudo shibd -t
sudo LD_LIBRARY_PATH=/opt/shibboleth/lib64 shibd -t
C:\opt\shibboleth-sp\sbin\shibd.exe -checkImportant is that the last line of the output is:
overall configuration is loadable, check console for non-fatal problems
ERROR
log entries, it is strongly recommended to have a look at the problem.WARN
are generally not problematic but it is recommended to examine the causes of these warning messages.
sudo apache2ctl configtest
sudo apachectl configtestThe output of this command should be:
Syntax OK
https://
/Shibboleth.sso/Session
. A valid session was not found.This message shows that the Shibboleth module is loaded by the webserver and is communicating with the
shibd
process.
After the above tests were successful, continue to the Shibboleth configuration. Note that the configuration and migration guides are only for SWITCHaai Participants who configure a Service Provider for the SWITCHaai Federation (or the AAI Test Federation). In all other cases refer to the configuration guides of the Shibboleth Consortium.
Copyright: SWITCH Author: aai@switch.ch URL: index.html