SPInstall

Versión 33 (Emilio Penna, Viernes, 12 de Abril de 2019 15:49:43 -0300)

1 1
h1. Instalación Shibboleth SP
2 1
3 24 Emilio Penna
Actualizado: 2018-02-06
4 1
5 25 Emilio Penna
*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.
6 3 Emilio Penna
7 24 Emilio Penna
*Otros sistemas:*  En caso de utilizar CentOS, es similar, ver https://spaces.internet2.edu/pages/viewpage.action?pageId=30245422
8 29 Emilio Penna
*REVISAR LINK*
9 1
10 4 Emilio Penna
Referencias:
11 4 Emilio Penna
12 4 Emilio Penna
https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPLinuxInstall
13 4 Emilio Penna
https://www.switch.ch/aai/guides/sp/
14 4 Emilio Penna
https://www.switch.ch/aai/guides/sp/installation/
15 4 Emilio Penna
16 1
17 1
18 20 Emilio Penna
19 24 Emilio Penna
h3. 1. Agregar repositorio e instalar Shibboleth SP
20 1
21 15 Emilio Penna
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.
22 1
23 1
<pre>
24 1
apt-get install curl
25 1
curl -k -O http://pkg.switch.ch/switchaai/SWITCHaai-swdistrib.asc
26 20 Emilio Penna
gpg --with-fingerprint  SWITCHaai-swdistrib.asc
27 20 Emilio Penna
# verificar que el fingerprint de la clave del repositorio sea 294E 37D1 5415 6E00 FB96 D7AA 26C3 C469 15B7 6742
28 1
apt-key add SWITCHaai-swdistrib.asc
29 20 Emilio Penna
echo 'deb http://pkg.switch.ch/switchaai/debian jessie main' | tee /etc/apt/sources.list.d/SWITCHaai-swdistrib.list > /dev/null
30 20 Emilio Penna
apt-get update
31 21 Emilio Penna
apt-get install --install-recommends shibboleth
32 1
</pre>
33 1
34 33 Emilio Penna
*Notas para debian 9 con sp v3: (20190412)*
35 31 Emilio Penna
36 31 Emilio Penna
De acuerdo al sitio de Switch, se debe habilitar el repositorio debian-backports, para eso se puede agregar en el sources.list:
37 31 Emilio Penna
38 32 Emilio Penna
<pre>
39 31 Emilio Penna
deb http://deb.debian.org/debian stretch-backports main
40 32 Emilio Penna
</pre>
41 31 Emilio Penna
42 31 Emilio Penna
luego:
43 31 Emilio Penna
44 31 Emilio Penna
<pre>
45 31 Emilio Penna
sudo apt update
46 31 Emilio Penna
sudo apt install -t stretch-backports init-system-helpers libxerces-c3.2
47 31 Emilio Penna
sudo apt install --install-recommends shibboleth
48 1
</pre>
49 33 Emilio Penna
50 33 Emilio Penna
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.
51 33 Emilio Penna
Ref: https://tuakiri.ac.nz/confluence/display/Tuakiri/Install+Shibboleth+SP+on+Debian+Based+linux
52 31 Emilio Penna
53 1
54 1
h3. 2. Habilitar un Virtual Host con HTTPS
55 1
56 1
En forma obligatoria un SP debe ejecutar con HTTPS. Si no se tiene hablitado se puede crear un Virtual Host de la siguiente manera:
57 1
58 1
<pre>
59 1
a2enmod ssl 
60 23 Emilio Penna
cd /etc/apache2/sites-available
61 23 Emilio Penna
cp default-ssl.conf shibsp1.conf
62 23 Emilio Penna
a2ensite shibsp1.conf
63 1
service apache2 reload
64 23 Emilio Penna
</pre>
65 1
66 24 Emilio Penna
Sugerencia: verificar que cargue una pagina con HTTPS en un navegador.
67 1
68 24 Emilio Penna
También se puede ejecutar:
69 24 Emilio Penna
<pre>
70 24 Emilio Penna
apache2ctl configtest
71 24 Emilio Penna
</pre>
72 24 Emilio Penna
La salida deberia ser: Syntax OK
73 24 Emilio Penna
74 24 Emilio Penna
75 1
h3. 3. Verificación de estado
76 1
77 15 Emilio Penna
El SP tiene una página de estado.
78 1
79 24 Emilio Penna
Para verificar el estado se puede ejecutar:
80 1
81 1
<pre>
82 1
curl -k https://127.0.0.1/Shibboleth.sso/Status
83 1
</pre>
84 1
85 1
86 1
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:
87 1
88 1
<pre>
89 1
<code class="xml">
90 1
<Handler type="Status" Location="/Status" acl="127.0.0.1 ::1 164.73.129.60"/>
91 1
</code>
92 1
</pre>
93 1
94 1
95 1
Ante cualquier cambio en la configuración de Shibboleth se debe reiniciar el proceso con los siguientes comando:
96 1
97 1
<pre>
98 1
service shibd stop
99 1
service shibd start
100 1
</pre>
101 1
102 25 Emilio Penna
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.
103 24 Emilio Penna
También puede ser con wget en localhost:  wget https://localhost:443//Shibboleth.sso/Status --no-check-certificate 
104 24 Emilio Penna
105 24 Emilio Penna
106 1
Otros chequeos:
107 1
108 25 Emilio Penna
Acceder a 
109 25 Emilio Penna
https://<mihost-ejemplo.edu.uy>/Shibboleth.sso/Session
110 1
111 25 Emilio Penna
Deberia verse una pagina que dice "A valid session was not found"
112 1
113 25 Emilio Penna
Este mensaje indica que el módulo Shibboleth ha sido cargado correctamente por el webserver.
114 25 Emilio Penna
115 25 Emilio Penna
116 25 Emilio Penna
117 25 Emilio Penna
h3. 4. Generar claves
118 25 Emilio Penna
119 14 Emilio Penna
<pre>
120 25 Emilio Penna
shib-keygen -f -u _shibd -h <mihost-ejemplo.edu.uy> -y 3 -e https://<mihost-ejemplo.edu.uy>/shibboleth -o /etc/shibboleth/
121 1
</pre>
122 1
123 1
h3. 5. Configuracion de entityID
124 1
125 1
en shibboleth2.xml
126 1
127 1
Setear identificador de la entidad: entityID. Ejemplo:
128 1
129 1
<pre><code class="xml">
130 25 Emilio Penna
    <ApplicationDefaults entityID="https://<mihost-ejemplo.edu.uy>/shibboleth"
131 1
                       REMOTE_USER="eppn persistent-id targeted-id">
132 1
</code></pre>
133 1
134 1
Ajustes en elemento Sessions:
135 1
136 1
Poner handlerSSL="true", y agregar propiedades seguras para cookies en cookieProps. Ejemplo:
137 1
138 1
<pre><code class="xml">
139 1
      <Sessions lifetime="28800" timeout="3600" relayState="ss:mem"
140 1
             checkAddress="false" handlerSSL="true" cookieProps="; path=/; secure; HttpOnly">
141 1
</code></pre>
142 1
143 30 Emilio Penna
*CAMBIAR:* cookieProps="https" hace el mismo efecto
144 30 Emilio Penna
145 27 Emilio Penna
Luego se debe reiniciar el proceso de Shibboleth (shibd stop/ shibd start).
146 1
147 1
Para verificar la configuración se puede ejecutar el siguiente comando: 
148 1
149 1
<pre>
150 1
shibd -t.
151 1
</pre>
152 1
153 1
La salida esperada es la siguiente:
154 1
155 1
<pre>
156 1
overall configuration is loadable, check console for non-fatal problems
157 1
</pre>
158 1
159 1
160 8 Pablo Silva
h3. 6. Prueba con TestShib
161 7 Pablo Silva
162 15 Emilio Penna
Si desea verificar la configuración del SP se puede probar con el Proveedor de Identidad público de prueba provisto por TestShib:
163 7 Pablo Silva
164 8 Pablo Silva
https://www.testshib.org/configure.html
165 1
166 9 Pablo Silva
Una vez realizada esta prueba puede continuar con la configuración con el Provedor de Identidad de la Universidad.
167 7 Pablo Silva
168 10 Pablo Silva
h3. 7. Definir y cargar una fuente de metadata
169 1
170 18 Emilio Penna
Obtener metadata del IdP, se adjunta al final la metadata del IdP de test de seciu.
171 1
172 18 Emilio Penna
Guardarla en el directorio metadata de su SP (si no existe crearlo).
173 1
174 18 Emilio Penna
/etc/shibboleth/metadata/metadata-idp-test-udelar.xml
175 1
176 19 Emilio Penna
Registrarla en el SP, para esto, en el archivo shibboleth2.xml, ajustar el path en el elemento <MetadataProvider>:
177 1
178 1
<pre> <code class="xml">
179 18 Emilio Penna
<MetadataProvider type="XML" path="/etc/shibboleth/metadata/metadata-idp-test-udelar.xml" ></MetadataProvider>
180 1
</code> </pre>
181 1
182 1
183 10 Pablo Silva
h3. 8. Configurar Inicio de Sesión
184 1
185 26 Emilio Penna
Se debe configurar elemento SSO dentro del archivo shibboleth2.xml para que use el provedor de identidad de test de Seciu: 
186 1
187 1
<pre> <code class="xml">
188 14 Emilio Penna
<SSO entityID="https://pirapire.seciu.edu.uy/idp/shibboleth"
189 1
</code></pre>
190 1
191 10 Pablo Silva
h3. 9. Configuración del archivo attribute-map.xml
192 1
193 1
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.
194 1
195 1
Se puede utilizar el que viene por defecto, luego se van descomentando o agregando los atributos que se utilicen.
196 1
Al final se adjunta un ejemplo de archivo attribute-map.xml
197 1
198 1
199 10 Pablo Silva
h3. 10. Enviar Metadata de su SP para registro
200 1
201 17 Emilio Penna
Debe obtener la metadata de su SP y contactarse con Seciu para su registro. 
202 1
203 17 Emilio Penna
La información sobre como obtener y ajustar la metadata puede verla en esta pagina: [[SP-Metadata]]
204 1
205 1
206 11 Pablo Silva
h3. 11. Configuracion de Apache para proteger un recurso
207 1
208 1
En Apache, se recomienda setear correctamente el ServerName y también setear "UseCanonicalName On".
209 15 Emilio Penna
También se recomienda fuertemente utilizar el "worker" MPM.
210 1
211 1
Referencia: https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPApacheConfig
212 1
213 15 Emilio Penna
Al instalar el modulo, se agrega mods-available/shib2.load, donde se carga el módulo.
214 1
215 28 Emilio Penna
*---- ESTO NO ES NECESARIO, REVSIAR*
216 1
Luego se debe crear el archivo conf-enabled/shib.conf con las directivas apropiadas:
217 1
218 1
<pre> <code class="xml">
219 1
220 1
# Ensures handler will be accessible.
221 1
#
222 1
<Location /Shibboleth.sso>
223 1
  Satisfy Any
224 1
  Allow from all
225 1
</Location>
226 1
227 1
#
228 1
# Used for example style sheet in error templates.
229 1
#
230 1
<IfModule mod_alias.c>
231 1
  <Location /shibboleth-sp>
232 1
    Satisfy Any
233 1
    Allow from all
234 1
  </Location>
235 1
  Alias /shibboleth-sp/main.css /usr/share/shibboleth/main.css
236 1
</IfModule>
237 1
238 1
</code> </pre> 
239 28 Emilio Penna
240 28 Emilio Penna
*----FIN NO ES NECEESARIO*
241 28 Emilio Penna
242 1
243 1
Para agregar un recurso (Location) protegido, agregar en shib.conf o en el virtual host:
244 1
245 1
<pre> <code class="xml">
246 1
247 1
# You MUST enable AuthType shibboleth for the module to process
248 1
# any requests, and there MUST be a require command as well.
249 1
250 1
<Location /secure>
251 1
  AuthType shibboleth
252 1
  ShibRequestSetting requireSession 1
253 1
  require shib-session
254 1
</Location>
255 1
</code> </pre>
256 1
257 1
258 1
Ejemplos de reglas para control de acceso:
259 1
https://www.switch.ch/aai/guides/sp/access-rules/
260 1
261 15 Emilio Penna
Por último se debe habilitar la configuración con el siguiente comando:
262 1
263 1
<pre>
264 1
a2enconf shib
265 1
</pre>