Skip to content

Commit

Permalink
Merge pull request #45 from rciam/develop
Browse files Browse the repository at this point in the history
Added support for IdP Discovery pages based on thiss.io in login checks
  • Loading branch information
NicolasLiampotis committed Sep 3, 2024
2 parents 8ea2e42 + 823e2e8 commit 39ad4cc
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 21 deletions.
4 changes: 3 additions & 1 deletion rciam_probes.spec
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
Name: rciam_probes
Summary: RCIAM related probes - Complete
Group: grnet/rciam
Version: 2.2.0
Version: 2.3.0
Release: %(echo $GIT_COMMIT_DATE).%(echo $GIT_COMMIT_HASH)%{?dist}
Url: https://github.com/rciam/%{name}
License: Apache-2.0
Expand Down Expand Up @@ -135,6 +135,8 @@ rm -rf $RPM_BUILD_ROOT
#fi

%changelog
* Wed Sep 3 2024 Nicolas Liampotis <[email protected]> 2.3.0
- Added support for IdP Discovery pages based on thiss.io in login checks
* Wed Aug 7 2024 Nicolas Liampotis <[email protected]> 2.2.0
- Added support for varying XML namespace prefixes in SAML metadata health checks
- Added support for skipping the IdP Discovery page during login checks
Expand Down
86 changes: 67 additions & 19 deletions rciam_probes/probes/checkhealth/checkhealth.py
Original file line number Diff line number Diff line change
Expand Up @@ -127,29 +127,75 @@ def __sp_redirect_disco_n_click(self):
self.__logger.debug('Skipping IdP discovery page')
return

# In case i have a list of hops
# Detect the discovery type (ssp, thiss)
disco_type = self.__detect_disco_type()
self.__logger.debug(f'Discovery Service type detected: {disco_type}')

# In case I have a list of IdPs
idp_list = self.__args.identity.split(',')
idp_name_list = self.__args.idp_name.split(',') if self.__args.idp_name else []

try:
for idp in idp_list:
# Log the title of the view
self.__logger.debug(self.__browser.title)
# urlencode idpentityid
idp_entity_id_url_enc = quote(idp, safe='')
self.__logger.debug('Safe URL IdP entity ID: ' + idp_entity_id_url_enc)
selector_callable = "a[href*='%s']" % (idp_entity_id_url_enc)
# Find the hyperlink
self.__wait.until(EC.presence_of_element_located((By.CSS_SELECTOR, selector_callable)))
# Wait until it is clickable
self.__wait.until(EC.element_to_be_clickable((By.CSS_SELECTOR, selector_callable)))
self.__wait_for_spinner()
self.__hide_cookie_policy()
# Cache cookies
self.__cached_cookies = self.__browser.get_cookies()
# Select IdP defined in the params
self.__browser.find_element_by_css_selector(selector_callable).click()
# Handle SimpleSAMLphp (SSP) discovery service
if disco_type == "ssp":
for idp in idp_list:
# Log the title of the view
self.__logger.debug(self.__browser.title)
# URL-encode IdP entityID
idp_entity_id_url_enc = quote(idp, safe='')
self.__logger.debug('Safe URL IdP entity ID: ' + idp_entity_id_url_enc)
selector_callable = "a[href*='%s']" % (idp_entity_id_url_enc)
# Find the hyperlink
self.__wait.until(EC.presence_of_element_located((By.CSS_SELECTOR, selector_callable)))
# Wait until it is clickable
self.__wait.until(EC.element_to_be_clickable((By.CSS_SELECTOR, selector_callable)))
self.__wait_for_spinner()
self.__hide_cookie_policy()
# Cache cookies
self.__cached_cookies = self.__browser.get_cookies()
# Select IdP defined in the params
self.__browser.find_element_by_css_selector(selector_callable).click()

# Handle thiss.io discovery service
elif disco_type == "thiss":
for i, idp in enumerate(idp_list):
if idp_name_list and i < len(idp_name_list):
search_term = idp_name_list[i]
else:
search_term = urlparse(idp).hostname

self.__logger.debug(f'Searching for IdP: {search_term}')
search_box = self.__browser.find_element(By.ID, "searchinput")
# Ensure the element is clickable or interactable
self.__wait.until(EC.element_to_be_clickable((By.ID, "searchinput")))
search_box.clear()
search_box.send_keys(search_term)

# Wait for the search results to appear
self.__wait.until(EC.presence_of_element_located((By.ID, "ds-search-list")))

# Locate the desired result based on the IdP entity ID
result_selector = f"li.institution.identityprovider[data-href*='{idp}']"
self.__wait.until(EC.element_to_be_clickable((By.CSS_SELECTOR, result_selector)))

# Click the search result
self.__browser.find_element(By.CSS_SELECTOR, result_selector).click()

else:
raise RuntimeError('Unsupported Discovery Service type')

except TimeoutException:
raise RuntimeError('Discovery Service timeout')

def __detect_disco_type(self):
"""Detect whether the discovery type is thiss.io or SimpleSAMLphp."""
try:
# Check for elements unique to thiss.io
self.__browser.find_element(By.ID, "searchinput")
return "thiss"
except:
# Fallback to SSP if thiss.io element is not found
return "ssp"

def __accept_all_ssp_modules(self):
"""
Expand Down Expand Up @@ -467,8 +513,10 @@ def parse_arguments(args):
parser.add_argument('--rs', '-r', dest="rs",
help='Service Provider Landing Page URL. If not provided the prove will assume that the landing page is the same as the Authentication URL. This is true for the case of SimpleSamlPHP Dummy SPs.')
parser.add_argument('--idp', '-i', dest="identity",
help='AuthnAuthority URL, e.g. https://idp.admin.grnet.gr/idp/shibboleth',
help='Comma-separated list of Identity Provider entity IDs, e.g. "https://idp.example.org,https://idp2.example.org"',
required=True)
parser.add_argument('--idp-name', dest="idp_name",
help='Comma-separated list of Identity Provider display names to search during discovery, e.g. "My University,Another University". When provided, these will be used instead of the IdP entity IDs')
parser.add_argument('--hostname', '-H', dest="hostname", required=True,
help='Domain, protocol assumed to be https, e.g. example.com')
parser.add_argument('--logowner', '-o', dest="logowner", default=ParamDefaults.LOG_OWNER.value,
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
from os import path

__name__ = 'rciam_probes'
__version__ = '2.2.0'
__version__ = '2.3.0'

here = path.abspath(path.dirname(__file__))

Expand Down

0 comments on commit 39ad4cc

Please sign in to comment.