From 7eed38492a44a40dd9e60a8f3b70b5520b8c5c10 Mon Sep 17 00:00:00 2001 From: David Taylor Date: Sun, 15 Nov 2026 19:19:40 -0800 Subject: [PATCH] Add option to not follow redirects for metadata Update get_metadata to support not following redirects from a remote source. For security reasons a caller might want to disallow fetching SSO data from a potentially untrusted source: the simplest way to ensure that the XML you're getting matches the one you want is to not allow any kind of redirecting at all. The default behavior is to follow redirects, so existing callers _should_ be unaffected by this change. Update tests to verify that disallowing redirects don't cause a regression. Added a test mocking a 302 exception to verify the exception gets bubbled up correctly. There should probably be some kind of end-to-end test to validate this, but for now this is probably fine. Ran black on the source & some formatting changes crept in. These are unrelated but shouldn't make a difference. --- src/onelogin/saml2/idp_metadata_parser.py | 31 ++++++++++++++----- .../saml2_tests/idp_metadata_parser_test.py | 30 ++++++++++++++++-- .../src/OneLogin/saml2_tests/settings_test.py | 8 ++--- 3 files changed, 54 insertions(+), 15 deletions(-) diff --git a/src/onelogin/saml2/idp_metadata_parser.py b/src/onelogin/saml2/idp_metadata_parser.py index b3b3d9be..2553d83f 100644 --- a/src/onelogin/saml2/idp_metadata_parser.py +++ b/src/onelogin/saml2/idp_metadata_parser.py @@ -6,7 +6,7 @@ from copy import deepcopy -from urllib.request import Request, urlopen +from urllib.request import Request, build_opener, urlopen, HTTPRedirectHandler, HTTPSHandler import ssl @@ -31,6 +31,8 @@ def get_metadata( capath=None, timeout=None, headers=None, + *, + follow_redirects=True, ): """ Gets the metadata XML from the provided URL @@ -44,6 +46,8 @@ def get_metadata( :type timeout: int :param headers: Extra headers to send in the request :type headers: dict + :param follow_redirects: Whether to follow redirects when fetching metadata, default True + :type follow_redirects: bool :returns: metadata XML :rtype: string @@ -54,16 +58,24 @@ def get_metadata( ctx = None if not validate_cert: if cafile or capath: - raise ValueError( - "Specifying 'cafile' or 'capath' while disabling certificate " - "validation is contradictory." - ) + raise ValueError("Specifying 'cafile' or 'capath' while disabling certificate " "validation is contradictory.") ctx = ssl.create_default_context() ctx.check_hostname = False ctx.verify_mode = ssl.CERT_NONE request = Request(url, headers=headers or {}) - response = urlopen(request, timeout=timeout, cafile=cafile, capath=capath, context=ctx) + if follow_redirects: + response = urlopen(request, timeout=timeout, cafile=cafile, capath=capath, context=ctx) + else: + + class NoRedirect(HTTPRedirectHandler): + def redirect_request(self, req, fp, code, msg, headers, newurl): + pass + + if ctx is None: + ctx = ssl.create_default_context(cafile=cafile, capath=capath) + no_redirect_opener = build_opener(NoRedirect, HTTPSHandler(context=ctx)) + response = no_redirect_opener.open(request, timeout=timeout) xml = response.read() if xml: @@ -81,7 +93,7 @@ def get_metadata( return xml @classmethod - def parse_remote(cls, url, validate_cert=True, entity_id=None, timeout=None, **kwargs): + def parse_remote(cls, url, validate_cert=True, entity_id=None, timeout=None, follow_redirects=True, **kwargs): """ Gets the metadata XML from the provided URL and parse it, returning a dict with extracted data :param url: Url where the XML of the Identity Provider Metadata is published. @@ -97,10 +109,13 @@ def parse_remote(cls, url, validate_cert=True, entity_id=None, timeout=None, **k :param timeout: Timeout in seconds to wait for metadata response :type timeout: int + :param follow_redirects: Follow redirects when fetching metadata, default True + :type follow_redirects: bool + :returns: settings dict with extracted data :rtype: dict """ - idp_metadata = cls.get_metadata(url, validate_cert, timeout, headers=kwargs.pop("headers", None)) + idp_metadata = cls.get_metadata(url, validate_cert, timeout, headers=kwargs.pop("headers", None), follow_redirects=follow_redirects) return cls.parse(idp_metadata, entity_id=entity_id, **kwargs) @classmethod diff --git a/tests/src/OneLogin/saml2_tests/idp_metadata_parser_test.py b/tests/src/OneLogin/saml2_tests/idp_metadata_parser_test.py index 4f352f69..081c2536 100644 --- a/tests/src/OneLogin/saml2_tests/idp_metadata_parser_test.py +++ b/tests/src/OneLogin/saml2_tests/idp_metadata_parser_test.py @@ -1,12 +1,13 @@ # -*- coding: utf-8 -*- - - -from urllib.error import URLError +from email.message import Message +from io import BytesIO +from urllib.error import URLError, HTTPError from copy import deepcopy import json from os.path import dirname, join, exists from lxml.etree import XMLSyntaxError +from unittest.mock import patch import unittest from onelogin.saml2.idp_metadata_parser import OneLogin_Saml2_IdPMetadataParser @@ -32,6 +33,12 @@ def loadSettingsJSON(self, filename="settings1.json"): else: raise Exception("Settings json file does not exist") + @staticmethod + def makeRedirectError(): + headers = Message() + headers["Location"] = "https://www.example.net" + return HTTPError(url="https://www.example.com", code=302, msg="found", hdrs=headers, fp=BytesIO(b"")) + def file_contents(self, filename): f = open(filename, "r") content = f.read() @@ -51,6 +58,13 @@ def testGetMetadata(self): except URLError: pass + # verify that not following redirects works with direct url + try: + data = OneLogin_Saml2_IdPMetadataParser.get_metadata("https://raw.githubusercontent.com/SAML-Toolkits/python3-saml/master/tests/data/metadata/testshib-providers.xml", validate_cert=False, follow_redirects=False) + self.assertTrue(data is not None and data is not {}) + except URLError: + pass + def testGetMetadataWithHeaders(self): data = OneLogin_Saml2_IdPMetadataParser.get_metadata( "https://raw.githubusercontent.com/SAML-Toolkits/python3-saml/master/tests/data/metadata/testshib-providers.xml", validate_cert=False, headers={"User-Agent": "Mozilla/5.0"} @@ -58,6 +72,16 @@ def testGetMetadataWithHeaders(self): self.assertIsNotNone(data) self.assertIn(b"entityID=", data) + @patch("onelogin.saml2.idp_metadata_parser.build_opener") + def testGetMetadataRedirect(self, mocked_build_opener): + redirect_error = self.makeRedirectError() + mock_opener = mocked_build_opener.return_value + mock_opener.open.side_effect = redirect_error + with self.assertRaises(HTTPError) as exc: + OneLogin_Saml2_IdPMetadataParser.get_metadata("https://www.example.com", validate_cert=False, follow_redirects=False) + error = exc.exception + self.assertTrue(error.code == 302) + def testParseRemote(self): """ Tests the parse_remote method of the OneLogin_Saml2_IdPMetadataParser diff --git a/tests/src/OneLogin/saml2_tests/settings_test.py b/tests/src/OneLogin/saml2_tests/settings_test.py index 85386fc3..92a2c4ce 100644 --- a/tests/src/OneLogin/saml2_tests/settings_test.py +++ b/tests/src/OneLogin/saml2_tests/settings_test.py @@ -97,18 +97,18 @@ def testLoadSettingsFromDict(self): # test if the cert-file is loaded correct with the default filename settings_info = self.loadSettingsJSON() - settings_info['security']['nameIdEncrypted'] = True - del settings_info['idp']['x509cert'] + settings_info["security"]["nameIdEncrypted"] = True + del settings_info["idp"]["x509cert"] settings_7 = OneLogin_Saml2_Settings(settings_info) self.assertEqual(len(settings_7.get_errors()), 0) # test if the cert-file is loaded correct with a custom filename - settings_info['idp']['cert_filename'] = "Test_Root_CA.crt" + settings_info["idp"]["cert_filename"] = "Test_Root_CA.crt" settings_8 = OneLogin_Saml2_Settings(settings_info) self.assertEqual(len(settings_8.get_errors()), 0) # test for the correct error, if there is no cert at all - settings_info['idp']['cert_filename'] = "not_existing_file.crt" + settings_info["idp"]["cert_filename"] = "not_existing_file.crt" try: settings_9 = OneLogin_Saml2_Settings(settings_info) self.assertNotEqual(len(settings_9.get_errors()), 0)