README.md 14.5 KB
Newer Older
1
# EduGAIN Connectivity Check Service 2 - ECCS2
Marco Malavolti's avatar
Marco Malavolti committed
2

Marco Malavolti's avatar
Marco Malavolti committed
3
4
5
6
7
8
9
10
1. [Introduction](#introduction)
2. [Check Performed on the IdPs](#check-performed-on-the-idps)
3. [Limitations](#limitations)
4. [Disable Checks](#disable-checks)
5. [On-line interface](#on-line-interface)
6. [Requirements Hardware](#requirements-hardware)
7. [Requirements Software](#requirements-software)
8. [HOWTO Install and Configure](#howto-install-and-configure)
Marco Malavolti's avatar
Marco Malavolti committed
11
   * [Install Python 3.9.x](#install-python-39x)
Marco Malavolti's avatar
Marco Malavolti committed
12
13
     + [CentOS 7 requirements](#centos-7-requirements)
     + [Debian requirements](#debian-requirements)
Marco Malavolti's avatar
Marco Malavolti committed
14
     + [Python 3.9](#python-39)
Marco Malavolti's avatar
Marco Malavolti committed
15
9. [Install the Chromedriver](#install-the-chromedriver)
Marco Malavolti's avatar
Marco Malavolti committed
16
10. [Install Google Chrome needed by Selenium](#install-google-chrome-needed-by-selenium)
17
11. [ECCS2 Script](#eccs2-script)
Marco Malavolti's avatar
Marco Malavolti committed
18
19
    * [Install](#install)
    * [Configure](#configure)
20
    * [Execute](#execute)    
Marco Malavolti's avatar
Marco Malavolti committed
21
12. [ECCS2 API Server (UWSGI)](#eccs2-api-server-uwsgi)
Marco Malavolti's avatar
Marco Malavolti committed
22
23
    * [Install](#install-1)
    * [Configure](#configure-1)
24
    * [Utility](#utility)
Marco Malavolti's avatar
Marco Malavolti committed
25
26
27
13. [ECCS2 API JSON](#eccs2-api-json)
14. [Utility for web interface](#utility-for-web-interface)
15. [Utility for developers](#utility-for-developers)
28
    * [ECCS2 API Development Server](#eccs2-api-development-server)
Marco Malavolti's avatar
Marco Malavolti committed
29
16. [Authors](#authors)
Marco Malavolti's avatar
Marco Malavolti committed
30
31
32

# Introduction

Marco Malavolti's avatar
Marco Malavolti committed
33
The purpose of the eduGAIN Connectivity Check is to identify eduGAIN Identity Providers (IdP) that are not properly configured. In particular it checks if an IdP properly loads and consumes SAML2 metadata which contains the eduGAIN Service Providers (SP). The check results are published on the public eduGAIN Connectivity Check web page (### NOT-AVAILABLE-YET ###). The main purpose is to increase the service overall quality and user experience of the eduGAIN interfederation service by making federation and Identity Provider operators aware of configuration problems.
Marco Malavolti's avatar
Marco Malavolti committed
34
35
36
37
38
39
40
41
42
43
44
45

The check is performed by sending a SAML authentication request to each eduGAIN IdP and then follow the various HTTP redirects. The expected result is a login form that allows users to authenticate (typically with username/password) or an error message of some form. For those Identity Providers that output an error message, it can be assumed that they don't consume eduGAIN metadata properly or that they suffer from another configuration problem. There are some cases where the check will generate false positives, therefore IdPs can be excluded from checks as is described below.

The Identity Providers are checked once per day. Therefore, the login requests should not have any significant effect on the log entries/statistics of an Identity Provider. Also, no actual login is performed because the check cannot authenticate users due to missing username and password for the IdPs. Only Identity Providers are checked but not the Service Providers.

# Check Performed on the IdPs

The check executed by the service follows these steps:

1. It retrieves the eduGAIN IdPs from eduGAIN Operator Team database via a JSON interface

2. For each IdP that is was not manually disabled by the eduGAIN Operations Team, the check creates a Wayfless URL for each SP involved and retrieves the IdP login page. It expects to find the HTML form with a username and password field. Therefore, no complete login will happen at the Identity Provider because the check stops at the login page.
Marco Malavolti's avatar
Marco Malavolti committed
46
The SPs used for the check are "SP Demo provided by GARR" (https://sp-demo.idem.garr.it/shibboleth) from IDEM GARR AAI and the "AAI Viewer Interfederation Test" (https://attribute-viewer.aai.switch.ch/interfederation-test/shibboleth) from SWITCHaai. These SPs might change in the future if needed.
Marco Malavolti's avatar
Marco Malavolti committed
47
48
49
50
51
52
53
54
55
56
57
58
The SAML authenticatin request is not signed. Therefore, authentication request for any eduGAIN SP could be created because the SP's private key is not needed.

# Limitations

There are some situations where the check cannot work reliably. In those cases it is possible to disable the check for a particular IdP. The so far known cases where the check might generate a false negative are:

* IdP does not support HTTP or HTTPS with at least SSLv3 or TLS1 or newer (these IdPs are insecure anyway)
* IdP is part of a Hub & Spoke federation (some of them manually have to first approve eduGAIN SPs)
* IdP does not use web-based login form (e.g. HTTP Basic Authentication or X.509 login)

# Disable Checks

59
60
61
62
63
64
In cases where an IdP cannot be reliably checked, it is necessary to create or enrich the `robots.txt` file on the IdP's web root with:

```bash
User-agent: ECCS
Disallow: /
```
Marco Malavolti's avatar
Marco Malavolti committed
65
66
67

# On-line interface

Marco Malavolti's avatar
Marco Malavolti committed
68
The test eduGAIN Connectivity Check web pages is available at: https://technical-test.edugain.org/eccs2
Marco Malavolti's avatar
Marco Malavolti committed
69
70
71
72

The tool uses following status for IdPs:

* ERROR (red):
Marco Malavolti's avatar
Marco Malavolti committed
73
74
75
76
77
78
79
80
81
  * The IdP's response contains an HTTP Error or the web page returned does not look like a login page.
    * **Invalid-Form**: considers those IdPs that do not load a standard username/password login page and do not return messages like "No return endpoint available for relying party" or "No metadata found for relying party".
    * **Timeout**: considers those IdPs that do not load a standard username/password login page within 60 seconds.
    * **Connection-Error**: considers those IdPs that are not reachable due to a connection problem. View the "Page Source" value to discover which problem the IdP has. 
  * The IdP most likely does not consume the eduGAIN metadata correctly.
    A typical case that falls into this category is when an IdP returns a message "No return endpoint available for relying party" or "No metadata found for relying party":
    * **No-eduGAIN-Metadata**
  * The IdP has a problem with its SSL certificate:
    * **SSL-Error**
Marco Malavolti's avatar
Marco Malavolti committed
82
83
* OK (green):
  * The IdP most likely correctly consumes eduGAIN metadata and returns a valid login page. This is no guarantee that login on this IdP works for all eduGAIN services but if the check is passed for an IdP, this is probable.
Marco Malavolti's avatar
Marco Malavolti committed
84
* DISABLED (white)
Marco Malavolti's avatar
Marco Malavolti committed
85
  * The IdP is excluded because it cannot be checked reliably. The "Page Source" column, when an entity is disabled, shows the reason of the disabling.
Marco Malavolti's avatar
Marco Malavolti committed
86

87
88
# Requirements Hardware

Marco Malavolti's avatar
Marco Malavolti committed
89
* OS: Debian 9, CentOS 7.8 (tested)
90
91
* HDD: 10 GB
* RAM: 4 GB
92
* CPU: >= 2 vCPU (suggested)
Marco Malavolti's avatar
Marco Malavolti committed
93
* ARCH: 64 Bit
94
95
96
97

# Requirements Software

* Apache Server + WSGI
98
* Python 3.9 (tested with v3.9.1)
Marco Malavolti's avatar
Marco Malavolti committed
99
100
101
* Selenim + Google Chrome Web Brower (tested with v91.0.4472.164)
* Chromedriver (tested with v91.0.4472.101)
* Git
102
103
104

# HOWTO Install and Configure

105
106
107
108
## Download ECCS2 Repository

* `cd $HOME ; git clone https://github.com/malavolti/eccs2.git`

Marco Malavolti's avatar
Marco Malavolti committed
109
## Install Python 3.9.x
Marco Malavolti's avatar
Marco Malavolti committed
110
111
112
113
114
115
116
117
118
119
120
121

### CentOS 7 requirements

1. Update the system packages:
   * `sudo yum -y update`

2. Install the Development Tools:
   * `sudo yum -y groupinstall "Development Tools"`

3. Install needed packages to build python:
   * `sudo yum -y install openssl-devel bzip2-devel libffi-devel wget`

Marco Malavolti's avatar
Marco Malavolti committed
122
123
124
4. Install Git:
   * `sudo yum -y install git`

Marco Malavolti's avatar
Marco Malavolti committed
125
### Debian requirements
126
127
128
129
130
131
132

1. Update the system packages:
   * `sudo apt update ; sudo apt upgrade -y`

2. Install needed packages to build python:
   * `sudo apt install build-essential zlib1g-dev libncurses5-dev libgdbm-dev libnss3-dev libssl-dev libreadline-dev libffi-dev`

Marco Malavolti's avatar
Marco Malavolti committed
133
134
135
136
3. Install Git:
   * `sudo apt install git`

### Python 3.9
137

Marco Malavolti's avatar
Marco Malavolti committed
138
1. Download the last version of Python 3.9.x from https://www.python.org/downloads/source/ into your home:
139
   * `wget https://www.python.org/ftp/python/3.9.1/Python-3.9.1.tgz -O $HOME/eccs2/Python-3.9.1.tgz`
140

Marco Malavolti's avatar
Marco Malavolti committed
141
2. Extract Python source package:
142
   * `cd $HOME/eccs2/`
143
   * `tar xzf Python-3.9.1.tgz`
144

Marco Malavolti's avatar
Marco Malavolti committed
145
3. Build Python from the source package:
146
   * `cd $HOME/eccs2/Python-3.9.1`
147
148
149
   * `./configure --prefix=$HOME/eccs2/python`
   * `make`

Marco Malavolti's avatar
Marco Malavolti committed
150
4. Install Python 3.9.x under `$HOME/eccs2/python`:
151
   * `make install`
Marco Malavolti's avatar
Marco Malavolti committed
152
   * `$HOME/eccs2/python/bin/python3.9 --version`
153
154
155
156
 
   This will install python under your $HOME directory.
   
5. Remove useless things:
157
   * `rm -Rf $HOME/eccs2/Python-3.9.1 $HOME/eccs2/Python-3.9.1.tgz`
158

Marco Malavolti's avatar
Marco Malavolti committed
159
# Install Google Chrome needed by Selenium
160

Marco Malavolti's avatar
Marco Malavolti committed
161
162
163
* Debian (64 bit):
  * `sudo wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb`
  * `sudo apt install ./google-chrome-stable_current_amd64.deb`
Marco Malavolti's avatar
Marco Malavolti committed
164

Marco Malavolti's avatar
Marco Malavolti committed
165
166
167
* CentOS (64 bit):
  * `sudo wget https://dl.google.com/linux/direct/google-chrome-stable_current_x86_64.rpm`
  * `sudo yum install ./google-chrome-stable_current_x86_64.rpm`
168

Marco Malavolti's avatar
Marco Malavolti committed
169
# Install the Chromedriver
170

Marco Malavolti's avatar
Marco Malavolti committed
171
172
1. Find out which version of Chromium you are using:
   * Debian 9 (stretch):
Marco Malavolti's avatar
Marco Malavolti committed
173
     * `google-chrome -version` => Google Chrome 91.0.4472.164
Marco Malavolti's avatar
Marco Malavolti committed
174
   * CentOS 7.8:
Marco Malavolti's avatar
Marco Malavolti committed
175
     * `google-chrome -version` => Google Chrome 91.0.4472.164
Marco Malavolti's avatar
Marco Malavolti committed
176
177
178
179
180
181

2. Take the Chrome version number, remove the last part, and append the result to URL "`https://chromedriver.storage.googleapis.com/LATEST_RELEASE_`". For example, with Chrome version 73.0.3683.75, you'd get a URL "`https://chromedriver.storage.googleapis.com/LATEST_RELEASE_73.0.3683`".

3. Use the URL created in the last step to discover the version of ChromeDriver to use. For example, the above URL will get your a file containing "73.0.3683.68".

4. Use the version number retrieved from the previous step to construct the URL to download ChromeDriver. With version `72.0.3626.69`, the URL would be "https://chromedriver.storage.googleapis.com/index.html?path=73.0.3683.68/"
182

Marco Malavolti's avatar
Marco Malavolti committed
183
184
185
186
187
188
189
190
5. Download the Chromedriver and extract it with:
   * `wget https://chromedriver.storage.googleapis.com/73.0.3683.75/chromedriver_linux64.zip -O $HOME/eccs2/chromedriver_linux64.zip`
   * `cd $HOME/eccs2`
   * `unzip chromedriver_linux64.zip`
   * `rm chromedriver_linux64.zip`

**Note:**
After the initial download, it is recommended that you occasionally go through the above process again to see if there are any bug fix releases.
191

192
# ECCS2 Script
Marco Malavolti's avatar
Marco Malavolti committed
193
194
195

## Install

196
* `cd $HOME/eccs2`
Marco Malavolti's avatar
Marco Malavolti committed
197
198
* `./python/bin/python3.9 -m pip install virtualenv`
* `$HOME/eccs2/python/bin/virtualenv --python=$HOME/eccs2/python/bin/python3.9 eccs2venv`
199
* `source eccs2venv/bin/activate`   (`deactivate` to exit Virtualenv)
200
  * `python -m pip install -r requirements.txt`
201

Marco Malavolti's avatar
Marco Malavolti committed
202
## Configure
203

Marco Malavolti's avatar
Marco Malavolti committed
204
1. Configure ECCS2 properties:
Marco Malavolti's avatar
Marco Malavolti committed
205
   * `vim eccs2properties.py` (and change it upon your needs)
206

207
2. Change `PATH` by adding the virtualenv Python `bin` dir:
208
209
   * CentOS:
     * `vim $HOME/.bash_profile`
Marco Malavolti's avatar
Marco Malavolti committed
210
211
212
213
214
215
216
217
218
     * Add the following lines at the tail:
       
       ```bash
       # set PATH for ECCS2
       if [ -d "$HOME/eccs2" ] ; then
          PATH="$HOME/eccs2/eccs2venv/bin:$PATH"
       fi
       ```

219
220
   * Debian:
     * `vim $HOME/.profile`
Marco Malavolti's avatar
Marco Malavolti committed
221
222
223
224
225
226
227
228
229
     * Add the following lines at the tail:
       
       ```bash
       # set PATH for ECCS2
       if [ -d "$HOME/eccs2" ] ; then
          PATH="$HOME/eccs2/eccs2venv/bin:$PATH"
       fi
       ```

230
231
3. Configure ECCS2 cron job for the local user:
   * `crontab -e`
232

233
     ```bash
Marco Malavolti's avatar
Marco Malavolti committed
234
235
     SHELL=/bin/bash

236
     0 4 * * * /bin/bash $HOME/eccs2/cleanAndRunEccs2.sh > $HOME/eccs2/logs/eccs2cron.log 2>&1
237
     ```
Marco Malavolti's avatar
Marco Malavolti committed
238

Marco Malavolti's avatar
Marco Malavolti committed
239
## Execute
240

241
  * `cd $HOME/eccs2`
242
243
244
  * `./cleanAndRunEccs2.py` (to run a full and clean check)
  * `./runEccs2.py` (to run a full check on the existing inputs)
  * `./runEccs2.py --idp <IDP-ENTITYID>` (to run check on a single IdP)
Marco Malavolti's avatar
Marco Malavolti committed
245
  * `./runEccs2.py --test` (to run a full check without effects)
246
  * `./runEccs2.py --idp <IDP-ENTITYID> --test` (to run check on a single IdP without effects)
Marco Malavolti's avatar
Marco Malavolti committed
247
  * `./runEccs2.py --idp <IDP-ENTITYID> --replace` (to run check on a single IdP and replace, or add, a result)
248

249
  If something prevent the good execution of the ECCS2's check, the `logs/failed-cmd.sh` file will be not empty at the end of the execution.
Marco Malavolti's avatar
Marco Malavolti committed
250

Marco Malavolti's avatar
Marco Malavolti committed
251
  The "--test" parameter will not change the result of ECCS2, but will write the output on the `logs/stdout_idp_YYYY-MM-DD.log`,`logs/stderr_idp_YYYY-MM-DD.log` and `logs/failed-cmd-idp.sh` files if the argument "--test" will be used.
Marco Malavolti's avatar
Marco Malavolti committed
252

253
# ECCS2 API Server (uWSGI)
Marco Malavolti's avatar
Marco Malavolti committed
254

255
## Install
Marco Malavolti's avatar
Marco Malavolti committed
256

257
258
259
260
261
262
263
264
265
266
1. Install requirements:
   * Debian:
     * `sudo apt-get install libpcre3 libpcre3-dev libapache2-mod-proxy-uwsgi build-essentials python3-dev unzip`
   * CentOS:
     * `sudo yum install mod_proxy_uwsgi unzip`
     * Configure SElinux to enable ECCS2:
       * `sudo semanage fcontext -a -t httpd_sys_content_t "$HOME/eccs2(/.*)?"`
       * `sudo restorecon -R -e $HOME/eccs2/`
       * `sudo setsebool -P httpd_can_network_connect 1`
 
Marco Malavolti's avatar
Marco Malavolti committed
267
268
269
## Configure

1. Add the systemd service to enable ECCS2 API:
270
   * `cd $HOME/eccs2`
Marco Malavolti's avatar
Marco Malavolti committed
271
272
   * `cp eccs2.ini.template eccs2.ini`
   * `cp eccs2.service.template eccs2.service`
273
274
275
276
277
278
   * `vim eccs2.ini` (and change "`uid`", "`gid`" and "`base`" values opportunely)
   * `vim eccs2.service` (and change "`User`","`Group`","`WorkingDirectory`","`RuntimeDirectory`","`ExecStart`" values opportunely)
   * `sudo cp $HOME/eccs2/eccs2.service /etc/systemd/system/eccs2.service`
   * `sudo systemctl daemon-reload`
   * `sudo systemctl enable eccs2.service`
   * `sudo systemctl start eccs2.service`
279

Marco Malavolti's avatar
Marco Malavolti committed
280
2. Configure Apache for ECCS2 web side:
281
282
283
284
285
286
287
288
289
   * Debian:
     * `sudo cp $HOME/eccs2/eccs2-debian.conf /etc/apache2/conf-available/eccs2.conf`
     * `sudo a2enconf eccs2.conf`
     * `sudo chgrp www-data $HOME ; sudo chmod g+rx $HOME` (Apache needs permission to access the $HOME dir)
     * `sudo systemctl restart apache2.service`
   * CentOS:
     * `sudo cp $HOME/eccs2/eccs2-centos.conf /etc/httpd/conf.d/eccs2.conf`
     * `sudo chgrp apache $HOME ; sudo apache g+rx $HOME` (Apache needs permission to access the $HOME dir)
     * `sudo systemctl restart httpd.service`
290

291
292
293
294
295
296
297
298
299
3. Restart API WSGI server each day to update the datetime:
   * `crontab -e`

   ```bash
   SHELL=/bin/bash

   0 3 * * * /usr/bin/touch $HOME/eccs2/eccs2.ini
   ```

300
301
302
303
304
305
## Utility

To perform a restart after an API change use the following command:

* `touch $HOME/eccs2/eccs2.ini`

306
307
# ECCS2 API JSON

308
* `/api/eccsresults` (Return the results of the last check ready for ECCS web interface)
Marco Malavolti's avatar
Marco Malavolti committed
309
* `/api/eccsresults?<parameter1>=<value1>&<parameter2>=<value2>`:
310
  * `date=2020-02-20` (select date)
Marco Malavolti's avatar
Marco Malavolti committed
311
  * `idp=https://idp.example.org/idp/shibboleth` (select a specific idp)
312
313
314
315
316
  * `status=` (select specific ECCS2 status)
    * 'OK'
    * 'ERROR'
    * 'DISABLED'
  * `reg_auth=https://reg.auth.example.org` (select a specific Registration Authority)
317
  * `format=simple` (retrieve results in a simple format)
318
319
* `/api/fedstats`
* `/api/fedstats?reg_auth=https://reg.auth.example.org`:
320

Marco Malavolti's avatar
Marco Malavolti committed
321
# Utility for web interface
322
323

The available dates are provided by the first and the last file created into the `output/` directory
324

325
To clean the ECCS2 results from files older than last 7 days use (modify it on your needs):
326

Marco Malavolti's avatar
Marco Malavolti committed
327
328
329
330
331
* `crontab -e`

  ```bash
  SHELL=/bin/bash

332
  0 10 * * * /bin/bash $HOME/eccs2/clean7daysOldFiles.sh > $HOME/eccs2/logs/clean7daysOldFiles.log 2>&1  
Marco Malavolti's avatar
Marco Malavolti committed
333
  ```
Marco Malavolti's avatar
Marco Malavolti committed
334

335
336
337
338
339
340
# Utility for developers

## ECCS2 API Development Server

* `cd $HOME/eccs2 ; ./api.py`

Marco Malavolti's avatar
Marco Malavolti committed
341
342
343
344
345
# Authors

## Original Author

 * Marco Malavolti (marco.malavolti@garr.it)