Instalación Shibboleth SP¶

Actualizado: 2018-02-06

Escenario: En esta guia se describe la instalación de Shibboleth SP en un equipo con Debian 8 y Apache 2.4. En los pasos siguientes se considera que la instalación se realiza en en el host <mihost-ejemplo.edu.uy>, se debe ajustar el nombre al que corresponda.

Otros sistemas:

CentOS: ver
https://www.switch.ch/aai/guides/sp/installation/?os=centos7
https://spaces.at.internet2.edu/pages/viewpage.action?pageId=148570224

Ubuntu 18: ver
https://www.switch.ch/aai/guides/sp/installation/?os=ubuntu

Referencias:

https://wiki.shibboleth.net/confluence/display/SP3/Home
https://www.switch.ch/aai/guides/sp/
https://www.switch.ch/aai/guides/sp/installation/

https://wiki.shibboleth.net/confluence/display/SP3/Apache

1. Agregar repositorio e instalar Shibboleth SP¶

La versión de Shibboleth SP disponible en los repositorios de Debian puede ser un poco obsoleta.
El repositorio de SWITCH (red académica de Suiza) tiene una versión mas actualizada.
(En Debian 10 está disponible el SP versión 3, pero en versiones anteriores de Debian se recomienda usar el paquete de SWITCH.)

Instalación usando el repositorio de SWITCH:

apt-get install curl
curl -k -O http://pkg.switch.ch/switchaai/SWITCHaai-swdistrib.asc
gpg --with-fingerprint  SWITCHaai-swdistrib.asc
# verificar que el fingerprint de la clave del repositorio sea 294E 37D1 5415 6E00 FB96 D7AA 26C3 C469 15B7 6742
apt-key add SWITCHaai-swdistrib.asc
echo 'deb http://pkg.switch.ch/switchaai/debian jessie main' | tee /etc/apt/sources.list.d/SWITCHaai-swdistrib.list > /dev/null
apt-get update
apt-get install --install-recommends shibboleth

Notas para debian 9 con sp v3: (20190412)

De acuerdo al sitio de Switch, se debe habilitar el repositorio debian-backports, para eso se puede agregar en el sources.list:

deb http://deb.debian.org/debian stretch-backports main

luego:

sudo apt update
sudo apt install -t stretch-backports init-system-helpers libxerces-c3.2
sudo apt install --install-recommends shibboleth

2. Habilitar un Virtual Host con HTTPS¶

En forma obligatoria un SP debe ejecutar con HTTPS. Si no se tiene hablitado se puede crear un Virtual Host de la siguiente manera:

a2enmod ssl 
cd /etc/apache2/sites-available
cp default-ssl.conf shibsp1.conf
a2ensite shibsp1.conf
service apache2 reload

Sugerencia: verificar que cargue una pagina con HTTPS en un navegador.

También se puede ejecutar:

apache2ctl configtest

La salida deberia ser: Syntax OK

3. Verificación de estado¶

El SP tiene una página de estado.

Para verificar el estado se puede ejecutar:

curl -k https://127.0.0.1/Shibboleth.sso/Status

Por defecto solo permite el acceso a la pagina de estado desde localhost. Para habilitar el acceso desde otro equipo, se puede agregar la IP desde la que se quiere acceder. Para esto, editar /etc/shibboleth/shibboleth2.xml, y agregar la ip en el elemento Handler. Ejemplo:

1 <Handler type="Status" Location="/Status" acl="127.0.0.1 ::1 164.73.129.60"/>

Ante cualquier cambio en la configuración de Shibboleth se debe reiniciar el proceso con los siguientes comando:

service shibd stop
service shibd start

Luego accediendo a la dirección https://<mihost-ejemplo.edu.uy>/Shibboleth.sso/Status se puede ver una página xml con información del SP.
También puede ser con wget en localhost: wget https://localhost:443//Shibboleth.sso/Status --no-check-certificate

Otros chequeos:

Acceder a
https://<mihost-ejemplo.edu.uy>/Shibboleth.sso/Session

Deberia verse una pagina que dice "A valid session was not found"

Este mensaje indica que el módulo Shibboleth ha sido cargado correctamente por el webserver.

4. Generar claves¶

En sp v3 el archivo shibboleth2.xml viene con configuracion para usar dos certificados distintos (signing y encryption), shib-keygen genera uno solo pero se pueden generar dos o usar el mismo para las dos cosas.

Ref: https://tuakiri.ac.nz/confluence/display/Tuakiri/Install+Shibboleth+SP+on+Debian+Based+linux

shib-keygen -f -u _shibd -h <mihost-ejemplo.edu.uy> -y 3 -e https://<mihost-ejemplo.edu.uy>/shibboleth -o /etc/shibboleth/

5. Configuracion de entityID¶

en shibboleth2.xml

Setear identificador de la entidad: entityID. Ejemplo:

1     <ApplicationDefaults entityID="https://<mihost-ejemplo.edu.uy>/shibboleth" 
2                        REMOTE_USER="eppn persistent-id targeted-id">

Ajustes en elemento Sessions:

Poner handlerSSL="true", y agregar propiedades seguras para cookies en cookieProps. Ejemplo:

1       <Sessions lifetime="28800" timeout="3600" relayState="ss:mem" 
2              checkAddress="false" handlerSSL="true" cookieProps="; path=/; secure; HttpOnly">

CAMBIAR: cookieProps="https" hace el mismo efecto

Luego se debe reiniciar el proceso de Shibboleth (shibd stop/ shibd start).

Para verificar la configuración se puede ejecutar el siguiente comando:

shibd -t.

La salida esperada es la siguiente:

overall configuration is loadable, check console for non-fatal problems

6. Prueba con TestShib¶

Si desea verificar la configuración del SP se puede probar con el Proveedor de Identidad público de prueba provisto por TestShib:

https://www.testshib.org/configure.html

Una vez realizada esta prueba puede continuar con la configuración con el Provedor de Identidad de la Universidad.

7. Definir y cargar una fuente de metadata¶

Obtener metadata del IdP, se adjunta al final la metadata del IdP de test de seciu.

Guardarla en el directorio metadata de su SP (si no existe crearlo).

/etc/shibboleth/metadata/metadata-idp-test-udelar.xml

Registrarla en el SP, para esto, en el archivo shibboleth2.xml, ajustar el path en el elemento <MetadataProvider>:

 1 <MetadataProvider type="XML" path="/etc/shibboleth/metadata/metadata-idp-test-udelar.xml" ></MetadataProvider>
 

8. Configurar Inicio de Sesión¶

Se debe configurar elemento SSO dentro del archivo shibboleth2.xml para que use el provedor de identidad de test de Seciu:

 1 <SSO entityID="https://pirapire.seciu.edu.uy/idp/shibboleth" 

9. Configuración del archivo attribute-map.xml¶

Shibboleth SP extrae los atributos del Assertion SAML que le envia el IdP, y almacena los valores en variables del servidor web. El mapeo entre los atributos recibidos y las variables se define en el archivo attribute-map.xml.

Se puede utilizar el que viene por defecto, luego se van descomentando o agregando los atributos que se utilicen.
Al final se adjunta un ejemplo de archivo attribute-map.xml

10. Enviar Metadata de su SP para registro¶

Debe obtener la metadata de su SP y contactarse con Seciu para su registro.

La información sobre como obtener y ajustar la metadata puede verla en esta pagina: SP-Metadata

11. Configuracion de Apache para proteger un recurso¶

En Apache, se recomienda setear correctamente el ServerName y también setear "UseCanonicalName On".
También se recomienda fuertemente utilizar el "worker" MPM.

Referencia: https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPApacheConfig

Al instalar el modulo, se agrega mods-available/shib2.load, donde se carga el módulo.

---- shib.conf ESTO NO ES NECESARIO AGREGARLO, YA SE AGREGA AL INSTALAR EL MODULO (20190425)
El archivo conf-enabled/shib.conf deberia tener estas directivas:

  1 
 2 # Ensures handler will be accessible.
 3 #
 4 <Location /Shibboleth.sso>
 5   Satisfy Any
 6   Allow from all
 7 </Location>
 8 
 9 #
10 # Used for example style sheet in error templates.
11 #
12 <IfModule mod_alias.c>
13   <Location /shibboleth-sp>
14     Satisfy Any
15     Allow from all
16   </Location>
17   Alias /shibboleth-sp/main.css /usr/share/shibboleth/main.css
18 </IfModule>
19 
 

----FIN shib.conf

Para agregar un recurso (Location) protegido, agregar en shib.conf o en el virtual host:

  1 
 2 # You MUST enable AuthType shibboleth for the module to process
 3 # any requests, and there MUST be a require command as well.
 4 
 5 <Location /secure>
 6   AuthType shibboleth
 7   ShibRequestSetting requireSession 1
 8   require shib-session
 9 </Location>
 

Ejemplos de reglas para control de acceso:
https://www.switch.ch/aai/guides/sp/access-rules/

Por último se debe habilitar la configuración con el siguiente comando:

a2enconf shib