Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 23 additions & 8 deletions src/onelogin/saml2/idp_metadata_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -31,6 +31,8 @@ def get_metadata(
capath=None,
timeout=None,
headers=None,
*,
follow_redirects=True,
):
"""
Gets the metadata XML from the provided URL
Expand All @@ -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
Expand All @@ -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:
Expand All @@ -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.
Expand All @@ -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
Expand Down
30 changes: 27 additions & 3 deletions tests/src/OneLogin/saml2_tests/idp_metadata_parser_test.py
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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()
Expand All @@ -51,13 +58,30 @@ 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"}
)
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
Expand Down
8 changes: 4 additions & 4 deletions tests/src/OneLogin/saml2_tests/settings_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading