pgadmin4/web/regression/feature_tests/xss_checks_pgadmin_debugger_test.py
Aditya Toshniwal dcfef154ce
- Set the browser target to ES6 and reduce the JS bundle size considerably
- Upgrade ESLint to v9.x and migrate the .eslintrc.js file to make it work
2024-07-04 18:25:47 +05:30

159 lines
6.1 KiB
Python

##########################################################################
#
# pgAdmin 4 - PostgreSQL Tools
#
# Copyright (C) 2013 - 2024, The pgAdmin Development Team
# This software is released under the PostgreSQL Licence
#
##########################################################################
import secrets
import time
from selenium.webdriver import ActionChains
from selenium.common.exceptions import TimeoutException
from regression.python_test_utils import test_utils
from regression.feature_utils.base_feature_test import BaseFeatureTest
from regression.feature_utils.tree_area_locators import TreeAreaLocators
from selenium.webdriver.support.ui import WebDriverWait
from selenium.webdriver.support import expected_conditions as EC
from selenium.webdriver.common.by import By
from regression.feature_utils.locators import NavMenuLocators
class CheckDebuggerForXssFeatureTest(BaseFeatureTest):
"""Tests to check if Debugger is vulnerable to XSS."""
scenarios = [
("Tests to check if Debugger is vulnerable to XSS", dict())
]
function_name = ""
def before(self):
# Some test function is needed for debugger
self.function_name = "a_test_function" + \
str(secrets.choice(range(10000, 65535)))
test_utils.create_debug_function(
self.server, self.test_db, self.function_name
)
if test_utils.does_function_exist(self.server, self.test_db,
self.function_name) != 'True':
raise RuntimeError("The required function is not found")
def runTest(self):
self.page.wait_for_spinner_to_disappear()
self.page.add_server(self.server)
self._function_node_expandable()
self._debug_function()
def after(self):
self.page.remove_server(self.server)
test_utils.drop_debug_function(self.server, self.test_db,
self.function_name)
def _function_node_expandable(self):
self.page.expand_schema_child_node("Server", self.server['name'],
self.server['db_password'],
self.test_db, 'public', "Functions")
function_node = self.page.check_if_element_exists_with_scroll(
TreeAreaLocators.function_node(self.function_name + "()"))
self.assertTrue(bool(function_node),
self.function_name + ' function node not found.')
function_node.click()
def _debug_function(self):
wait = WebDriverWait(self.page.driver, 2)
self.page.driver.find_element(By.CSS_SELECTOR,
NavMenuLocators.object_menu_css).click()
wait.until(EC.presence_of_element_located(
(By.CSS_SELECTOR, "div[data-label='Debugging']")))
ActionChains(
self.page.driver
).move_to_element(
self.page.driver.find_element(
By.CSS_SELECTOR, "div[data-label='Debugging']")
).perform()
# time.sleep(2)
wait.until(EC.presence_of_element_located(
(By.CSS_SELECTOR, "li[data-label='Debug']")))
self.page.driver.find_element(
By.CSS_SELECTOR, "li[data-label='Debug']").click()
# We need to check if debugger plugin is installed or not
try:
wait = WebDriverWait(self.page.driver, 2)
is_error = wait.until(EC.presence_of_element_located(
(By.XPATH, "//div[contains(@class,'MuiDialogTitle-root')]"
"//div[text()='Debugger Error']")
))
except TimeoutException:
is_error = None
# If debugger plugin is not found
if is_error and is_error.text == "Debugger Error":
click = True
while click:
try:
self.page.click_modal('OK')
wait.until(EC.invisibility_of_element(
(By.XPATH, "//div[@class ='MuiDialogTitle-root']"
"//div[text()='Debugger Error']")
))
click = False
except TimeoutException:
pass
self.skipTest(
"Please make sure that debugger plugin is properly configured"
)
else:
self.page.driver.switch_to.frame(
self.page.driver.find_element(By.TAG_NAME, 'iframe')
)
wait.until(EC.presence_of_element_located(
(By.XPATH, "//span[contains(.,'Hello, pgAdmin4')]"))
)
self.page.click_element(
self.page.driver.find_elements(By.XPATH, "//button")[2]
)
wait.until(EC.presence_of_element_located(
(By.XPATH, "//div[@id='id-results']//td "
"[contains(.,'Hello, pgAdmin4')]"))
)
# Only this tab is vulnerable rest are Code Mirror
# control which are already tested in Query tool test case
self.page.click_tab('Messages')
source_code = self.page.find_by_xpath(
"//div[@id='id-debugger-messages'] //div[@id='debugger-msg']"
).get_attribute('innerHTML')
self.assertIsNotNone(source_code, 'Messages tab is empty.')
self._check_escaped_characters(
source_code,
'NOTICE: <img src="x" onerror="console.log(1)">',
'Debugger'
)
self._close_debugger()
def _close_debugger(self):
self.page.driver.switch_to.default_content()
self.page.find_by_css_selector("div[data-dockid='id-main'] "
".dock-tab.dock-tab-active "
"button[data-label='Close']").click()
def _check_escaped_characters(self, source_code, string_to_find, source):
# For XSS we need to search against element's html code
assert source_code.find(
string_to_find) != -1, "{0} might be vulnerable to XSS ".format(
source)