README.md 11.4 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
11
12
13
14
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)
   * [Install Python 3.8.x](#install-python-38x)
     + [CentOS 7 requirements](#centos-7-requirements)
     + [Debian requirements](#debian-requirements)
     + [Python 3.8](#python-38)
Marco Malavolti's avatar
Marco Malavolti committed
15
16
17
9. [Install Selenium and Chromedriver](#install-selenium-and-chromedriver)
10. [Install Chromium needed by Selenium](#install-chromium-needed-by-selenium)
11. [ECCS2](#eccs2)
Marco Malavolti's avatar
Marco Malavolti committed
18
19
20
    * [Install](#install)
    * [Configure](#configure)
    * [Execute](#execute)
Marco Malavolti's avatar
Marco Malavolti committed
21
12. [Install requirements for uWSGI used by ECCS2 API](#install-requirements-for-uwsgi-used-by-eccs2-api)    
Marco Malavolti's avatar
Marco Malavolti committed
22
23
24
25
26
27
28
13. [ECCS2 API Development Server](#eccs2-api-development-server)
14. [ECCS2 API JSON](#eccs2-api-json)
15. [Utility for web interface](#utility-for-web-interface)
16. [Authors](#authors)

# Introduction

Marco Malavolti's avatar
Marco Malavolti committed
29
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

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.
The SPs used for the check are "Test SP shib 2.4" (https://sp24-test.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.
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

55
56
57
58
59
60
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
61
62
63

# On-line interface

Marco Malavolti's avatar
Marco Malavolti committed
64
The test eduGAIN Connectivity Check web pages is available at: https://dev-mm.aai-test.garr.it/eccs2
Marco Malavolti's avatar
Marco Malavolti committed
65
66
67
68
69
70
71
72

The tool uses following status for IdPs:

* ERROR (red):
  * The IdP's response contains an HTTP Error or the web page returned does not look like a login page. The most probable causes for this error are HTTP errors (e.g.: 404 error)
  * The IdP most likely does not consume the eduGAIN metadata correctly or it hasn't does not return a web page that looks like a login form. 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".
* 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
73
* DISABLED (white)
Marco Malavolti's avatar
Marco Malavolti committed
74
75
  * The IdP is excluded from checks because it cannot be checked reliably (see limitations below) affected by some problems that prevent them to consume correctly eduGAIN metadata. The "Page Source" column, when an entity is disabled, shows the reason of the disabling.

76
77
# Requirements Hardware

Marco Malavolti's avatar
Marco Malavolti committed
78
* OS: Debian 9, CentOS 7.8 (tested)
79
80
81
82
83
84
85
* HDD: 10 GB
* RAM: 4 GB
* CPU: >= 2 vCPU

# Requirements Software

* Apache Server + WSGI
86
* Python 3.8 (tested with v3.8.3)
87
88
89
90
* Selenim + Chromium Web Brower

# HOWTO Install and Configure

Marco Malavolti's avatar
Marco Malavolti committed
91
92
93
94
95
96
97
98
99
100
101
102
103
104
## Install Python 3.8.x

### 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`

### Debian requirements
105
106
107
108
109
110
111

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
112
### Python 3.8
113

Marco Malavolti's avatar
Marco Malavolti committed
114
1. Download the last version of Python 3.8.x from https://www.python.org/downloads/source/:
Marco Malavolti's avatar
Marco Malavolti committed
115
   * `sudo wget https://www.python.org/ftp/python/3.8.3/Python-3.8.3.tgz -O /usr/local/src/Python-3.8.3.tar.gz`
116

Marco Malavolti's avatar
Marco Malavolti committed
117
118
2. Extract Python source package:
   * `cd /usr/local/src/`
Marco Malavolti's avatar
Marco Malavolti committed
119
   * `sudo tar xzf Python-3.8.3.tar.gz`
120

Marco Malavolti's avatar
Marco Malavolti committed
121
122
3. Build Python from the source package:
   * `cd /usr/local/src/Python-3.8.3`
Marco Malavolti's avatar
Marco Malavolti committed
123
124
   * `sudo ./configure --enable-optimizations`
   * `sudo make -j 4`
Marco Malavolti's avatar
Marco Malavolti committed
125
126

4. Install Python 3.8.x (without replacing the system `python3` command) under `/usr/local/bin/python3.8`:
127
128
129
   * `sudo make altinstall`
   * `python3.8 --version`

Marco Malavolti's avatar
Marco Malavolti committed
130
5. Create link of Python3.8 for scripts:
131
132
   * `sudo ln -s /usr/local/bin/python3.8 /usr/bin/python3.8`

Marco Malavolti's avatar
Marco Malavolti committed
133
# Install Chromium needed by Selenium
134

Marco Malavolti's avatar
Marco Malavolti committed
135
* Debian:
Marco Malavolti's avatar
Marco Malavolti committed
136
137
  * `sudo apt install chromium git jq`

Marco Malavolti's avatar
Marco Malavolti committed
138
* CentOS:
Marco Malavolti's avatar
Marco Malavolti committed
139
140
  * `sudo yum install -y epel-release`
  * `sudo yum install -y chromium git jq`
141

Marco Malavolti's avatar
Marco Malavolti committed
142
# Install Selenium and Chromedriver
143

Marco Malavolti's avatar
Marco Malavolti committed
144
145
* `sudo python3.8 -m pip install --upgrade pip`
* `sudo python3.8 -m pip install selenium virtualenv`
Marco Malavolti's avatar
Marco Malavolti committed
146
147
148
* `sudo wget https://chromedriver.storage.googleapis.com/83.0.4103.39/chromedriver_linux64.zip -O /usr/local/src/chromedriver_linux64.zip`
* `cd /usr/bin/`
* `sudo unzip /usr/local/src/chromedriver_linux64.zip`
149

Marco Malavolti's avatar
Marco Malavolti committed
150
151
152
153
154
Note: Pay attetion on the chromedriver version:
* Debian 9 (stretch):
  * `chromium -version` => Chromium 73.0.3683.75 => https://chromedriver.storage.googleapis.com/73.0.3683.68/chromedriver_linux64.zip
* CentOS 7.8:
  * `chromium-browser -version` => Chromium 83.0.4103.116 => https://chromedriver.storage.googleapis.com/83.0.4103.39/chromedriver_linux64.zip
155

Marco Malavolti's avatar
Marco Malavolti committed
156
157
158
159
160
161

# ECCS2

## Install

* `cd /opt ; git clone https://github.com/malavolti/eccs2.git`
162
* `cd eccs2`
Marco Malavolti's avatar
Marco Malavolti committed
163
* `virtualenv --python=/usr/bin/python3.8 eccs2venv`
164
* `source eccs2venv/bin/activate`   (`deactivate` to exit Virtualenv)
Marco Malavolti's avatar
Marco Malavolti committed
165
166
  * `python3.8 -m pip install --upgrade pip uwsgi`
  * `python3.8 -m pip install -r requirements.txt`
167

Marco Malavolti's avatar
Marco Malavolti committed
168
## Configure
169

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

173
2. Configure ECCS2 cron job for your local user (`debian` into this example):
Marco Malavolti's avatar
Marco Malavolti committed
174
   * `sudo crontab -u debian -e` (Debian) or `sudo crontab -u centos -e` (CentOS)
175

176
177
178
     ```bash
     0 4 * * * /bin/bash /opt/eccs2/cleanAndRunEccs2.sh > /opt/eccs2/logs/eccs2cron.log 2>&1  
     ```
Marco Malavolti's avatar
Marco Malavolti committed
179

180
3. Configure the ECCS2 systemd service to enable its API:
Marco Malavolti's avatar
Marco Malavolti committed
181
182
183
   * `vim /opt/eccs2/eccs2.ini` (and change the "`User`" and the "`Group`" values)
   * `vim /opt/eccs2/eccs2.service` (and change the "`User`" and the "`Group`" values)
   * `sudo cp /opt/eccs2/eccs2.service /etc/systemd/system/eccs2.service`
184
185
186
   * `sudo systemctl daemon-reload`
   * `sudo systemctl enable eccs2.service`
   * `sudo systemctl start eccs2.service`
187

188
4. Configure Apache for the ECCS2 Web side:
Marco Malavolti's avatar
Marco Malavolti committed
189
190
191
192
193
   * Debian:
     * `sudo cp /opt/eccs2/eccs2-debian.conf /etc/apache2/conf-available/eccs2.conf`
     * `sudo a2enconf eccs2.conf`
     * `sudo systemctl restart apache2.service`
   * CentOS:
Marco Malavolti's avatar
Marco Malavolti committed
194
     * `sudo cp /opt/eccs2/eccs2-centos.conf /etc/httpd/conf.d/eccs2.conf`
Marco Malavolti's avatar
Marco Malavolti committed
195
     * `sudo systemctl restart httpd.service`
196

Marco Malavolti's avatar
Marco Malavolti committed
197
## Execute
198

Marco Malavolti's avatar
Marco Malavolti committed
199
  * `cd /opt/eccs2`
200
201
202
  * `./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
203
  * `./runEccs2.py --test` (to run a full check without effects)
204
  * `./runEccs2.py --idp <IDP-ENTITYID> --test` (to run check on a single IdP without effects)
205

Marco Malavolti's avatar
Marco Malavolti committed
206
207
  The check will run a second time for those IdPs that failed the first execution of the script.
  If something prevent the good execution of the ECCS2's check, the `/opt/eccs2/logs/failed-cmd.sh` file will be not empty at the end of the execution.
Marco Malavolti's avatar
Marco Malavolti committed
208

Marco Malavolti's avatar
Marco Malavolti committed
209
  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.
Marco Malavolti's avatar
Marco Malavolti committed
210

Marco Malavolti's avatar
Marco Malavolti committed
211
212
213
214
215
216
217
218
219
220
# Install requirements for uWSGI used by ECCS2 API

* 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`
  * Enable ECCS2 for SELinux:
    * `sudo semanage fcontext -a -t httpd_sys_content_t "/opt/eccs2(/.*)?"`
    * `sudo restorecon -R -e /opt/eccs2/`

221
222
# ECCS2 API Development Server

Marco Malavolti's avatar
Marco Malavolti committed
223
* `cd /opt/eccs2 ; ./api.py`
224

225
226
227
228
# ECCS2 API JSON

* `/api/test` (Trivial Test)
* `/api/eccsresults` (Return the results of the last check ready for ECCS Gui)
Marco Malavolti's avatar
Marco Malavolti committed
229
* `/api/eccsresults?<parameter1>=<value1>&<parameter2>=<value2>`:
230
  * `date=2020-02-20` (select date)
Marco Malavolti's avatar
Marco Malavolti committed
231
  * `idp=https://idp.example.org/idp/shibboleth` (select a specific idp)
232
233
234
235
236
237
238
  * `status=` (select specific ECCS2 status)
    * 'OK'
    * 'ERROR'
    * 'DISABLED'
  * `reg_auth=https://reg.auth.example.org` (select a specific Registration Authority)
* `/api/fedstats`
* `/api/fedstats?reg_auth=https://reg.auth.example.org`:
239

240

Marco Malavolti's avatar
Marco Malavolti committed
241
# Utility for web interface
242
243

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

To clean the ECCS2 results from files older than last 7 days use:

Marco Malavolti's avatar
Marco Malavolti committed
247
* `clean7daysOldFiles.sh`
Marco Malavolti's avatar
Marco Malavolti committed
248
249
250
251
252
253

# Authors

## Original Author

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