Index
- Introduction
- Check performed on the IdPs
- Statuses and results
- Common reasons for check failure
- Limits
- Disable Checks
- User interface
- API interface
- GIT repository
- Presentations
- FAQ - Frequently Ask Questions
Introduction
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 (https://technical.edugain.org/eccs/). 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.
The check is performed by sending a SAML authentication request to each eduGAIN IdP and then following the various HTTP redirects until the user login form. The expected result is a login form that allows users to authenticate themselves (typically with username/password) or an error message of some form. For those Identity Providers that return 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.
The eduGAIN Connectivity Check is configured to maintain a history of 7 days of the results collected.
If this page does not answer your questions or you need some more information about this service, please contact us at support@edugain.org.
Check performed on the IdPs
The check performed by the service follows these steps:
- It retrieves the eduGAIN IdPs from eduGAIN Operator Team database via access API.
- For each IdP the ECCS script:
- doesn't check disabled IdP (added manually by an eduGAIN Operations Team via Python dictionary or dynamically by the IdP administrator via "robots.txt");
- verifies the SSL certificate of the SSO HTTP-Redirect endpoint used;
- creates the SAML Authentication Request for two selected NREN SP and for a random generated fake SP;
- tries to reach the IdP login page for all SPs without performing any authentication.
It expects to find an HTML form with username and password fields in the answer. Therefore, no complete login will happen at the Identity Provider because the check stops at the login page or at SSL validation.
The SPs used for the check are: "SP Demo" (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 it will be needed.
The SAML authentication request sent is not signed. Therefore, an authentication request for any eduGAIN SP could be created because the SP's private key is not needed.
- At the end of the execution, the script is run again for those IdPs that have failed the check due to a problem with the headless Webdriver(Google Chrome) and writes each problem on the log file.
Statuses and results
The tool uses the following statuses for IdPs:
| Status | UI Color | Description and results |
|---|---|---|
| ERROR | Red |
|
| 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.
|
| UNKNOWN | Yellow | The IdP can't be checked because the returned Login Page content is not recognized or the Login Page is always returned, also for the fake SP.
|
| DISABLED | White | The IdP is excluded because it cannot be checked reliably. The Page Source column, when an entity is disabled, is populated with the reason for the disabling.
|
Common reasons for check failure
- Verify that you have a valid SSL certificate matching your IdP hostname and with a valid chain.
You can test it yourself with the SSL Labs checker: https://www.ssllabs.com/ssltest/
An "SSL-Error" may be related to a missing update of the CAs used by ECCS.
If you suspect that this is the case, please contact eduGAIN support at support@edugaing.org. - Verify that the IP used by the client that is performing the checks, is permitted to reach your IdP: any firewall in-between must be configured to let pass TCP packets with:
- source IP X.X.X.X, source port 1024-65535
- destination YOUR-IDP-IP destination port 443
- Verify that your IdP Login page contains a text that matches the following regular expression:
pattern_password = '<input[\s]+[^>]*((type|name)=\s*"password|email|user|text|name"|password|email|user|text|name)[^>]*>|<form[\s]+[^>]*(action)=\s*"/idp/module.php/multiauth/selectsource.php"[^>]*>';
- Verify that your robots.txt is not unintentionally disabling ECCS.
Limits
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. Account Chooser Authentication or X.509 login)
- IdP does not allow requests coming from the ECCS servers:
technical-test.edugain.org/technical.edugain.org - IdP that uses more than one nested
<iframe>inside the login page
Disable Checks
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:
User-agent: ECCS Disallow: /
If it is not possible to create the robots.txt under the IdP web root directory, the check can be disabled by an operator of the federation, where the IdP is a member, with an email to support@edugain.org.
User interface
The eduGAIN Connectivity Check Service web page is available at https://technical.edugain.org/eccs
User interface parameters
| Parameter name | Parameter description | Example |
|---|---|---|
date | Show all the service results for a specific date | date=2020-02-20 |
reg_auth | Show all the service results for a specific Registration Authority | reg_auth=https://reg.auth.example.org |
idp | Show all the service results for a specific Identity Provider | idp=https://idp.example.org/idp/shibboleth |
status | Show all the service results for a specific Status:
| status=ERROR |
check_result | Show all the service results for a specific result of check:
| check_result=SSL-Error |
Example:
- https://technical.edugain.org/eccs?reg_auth=http://www.idem.garr.it/&status=ERROR
- https://technical.edugain.org/eccs?reg_auth=http://www.idem.garr.it/&check_result=SSL-Error
API interface
The eduGAIN Connectivity Check has an API interface that provides access to the monitoring results in JSON format.
The table below describes the actions that can be performed by replacing "##ACTION##" in the URL:
https://technical.edugain.org/eccs/api/##ACTION##
| Action Name (JSON) | Action Description |
|---|---|
eccsresults | Returns all the eduGAIN Connectivity Check service results |
fedstats | Returns all the federation statistics collected by the eduGAIN Connectivity Check service. |
The table below, instead, describes the JSON parameters that actions can use:
https://technical.edugain.org/eccs/api/##ACTION##?##PARAMETER##=<value>
| Action Name (JSON) | Parameter Name (JSON) | Parameter Description | Example |
|---|---|---|---|
| date | Returns all the service results for a specific date. | date=2020-02-20 |
| reg_auth | Returns all the service results for a specific Registration Authority. | reg_auth=https://reg.auth.example.org |
| idp | Returns the service results for a specific IdP by its entityID. | idp=https://idp.example.org/idp/shibboleth |
| status | Returns all the service results for a specific Status:
| status=ERROR |
| check_result | Returns all the service results for a specific result of check:
| check_result=SSL-Error |
| format | Formats the service results in a simple way | format=simple |
Example URL:
- https://technical.edugain.org/eccs/api/eccsresults?reg_auth=http://www.idem.garr.it/&status=ERROR&format=simple
- https://technical.edugain.org/eccs/api/eccsresults?reg_auth=http://www.idem.garr.it/&status=ERROR
- https://technical.edugain.org/eccs/api/fedstats?reg_auth=http://www.idem.garr.it/
- https://technical.edugain.org/eccs/api/fedstats?reg_auth=http://www.idem.garr.it/&date=YYYY-MM-DD
GIT repository
https://gitlab.software.geant.org/edugain/eccs