SPInstall

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