Back to Repositories

Validating Trust Anchor Certificate Handling in NW.js

This test suite validates the additional trust anchors functionality in NW.js, focusing on certificate handling and secure HTTPS connections. It implements comprehensive testing for both trusted and untrusted certificate scenarios.

Test Coverage Overview

The test suite provides comprehensive coverage of NW.js’s trust anchor implementation, specifically testing certificate validation behavior.

Key areas tested include:

Certificate validation with additional trust anchors enabled
Certificate validation without trust anchors
Platform-specific certificate handling (Windows vs other platforms)
HTTPS server connections and iframe loading behavior

Implementation Analysis

The testing approach utilizes Selenium WebDriver to automate browser interactions and validate certificate handling scenarios.

The implementation employs:

Dynamic package.json configuration for trust anchor testing
Platform-specific certificate selection logic
Selenium frame switching and element verification
Asynchronous wait patterns for element loading

Technical Details

Testing tools and configuration:

Python with Selenium WebDriver for browser automation
Custom HTTPS server implementation
Dynamic port allocation for test server
Certificate file management utilities
Chrome WebDriver with custom options
Platform-aware test execution logic

Best Practices Demonstrated

The test implementation showcases robust testing practices for security-critical functionality.

Notable practices include:

Proper resource cleanup and process management
Explicit timeout handling and error recovery
Dynamic test data generation
Cross-platform compatibility considerations
Isolated test environments for each scenario

nwjs/nwJs

test/sanity/additional_trust_anchors/test.py

            
import time
import os
import subprocess
import platform
import sys
sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
from nw_util import *

from selenium import webdriver
from selenium.webdriver.chrome.options import Options
from selenium.webdriver.common import utils

chrome_options = Options()
chrome_options.add_argument("nwapp=" + os.path.dirname(os.path.abspath(__file__)))
chrome_options.add_experimental_option("excludeSwitches", ["ignore-certificate-errors"]);

testdir = os.path.dirname(os.path.abspath(__file__))
os.chdir(testdir)

port = str(utils.free_port())
server = subprocess.Popen(['python3', 'https-server.py', port])

def read_ca_cert():
    return read_and_replace_file('ca.crt', '\n', '')

def read_server_cert():
    return read_and_replace_file('cert.pem', '\n', '')

def read_and_replace_file(filename, old, new):
    with open(filename, 'r') as fd:
        content = fd.read().replace(old, new)
    return content

def write_file(filename, content):
    with open(filename, 'w') as fd:
        fd.write(content)

index_html = read_and_replace_file('index.tpl', '{port}', port)
write_file('index.html', index_html)

# test with trust anchors
if platform.system() == 'Windows':
  cert = read_server_cert()
else:
  cert = read_ca_cert()

pkg_with_trust_anchors = '''
{
  "name": "test_additional_trust_anchors",
  "main": "index.html",
  "additional_trust_anchors": ["%s"]
}
''' % cert
write_file('package.json', pkg_with_trust_anchors)

try:
    driver = webdriver.Chrome(executable_path=os.environ['CHROMEDRIVER'], chrome_options=chrome_options, service_log_path="log", service_args=["--verbose"])
    driver.implicitly_wait(5)
    try:
        print(driver.current_url)
        timeout = 5
        ret = ''
        elem_id = 'result'
        while timeout > 0:
            try:
                driver.switch_to.frame(driver.find_element_by_tag_name("iframe"))
                ret = driver.find_element_by_id(elem_id).get_attribute('innerHTML')
                break
            except selenium.common.exceptions.NoSuchElementException:
                pass
            time.sleep(1)
            timeout = timeout - 1
            if timeout <= 0:
                raise Exception('Timeout when waiting for element' + elem_id)
        title = driver.execute_script('return document.title')
        print(title)
        print(ret)
        assert('success' in ret)
        driver.close()
    finally:
        driver.quit()

    # test without trust anchors
    pkg_without_trust_anchors = '''
{
    "name": "test_additional_trust_anchors",
    "main": "index.html"
}
'''
    write_file('package.json', pkg_without_trust_anchors)

    driver = webdriver.Chrome(executable_path=os.environ['CHROMEDRIVER'], chrome_options=chrome_options, service_log_path="log", service_args=["--verbose"])
    driver.implicitly_wait(5)
    try:
        print(driver.current_url)
        driver.switch_to.frame(driver.find_element_by_id('test-frame'))
        title = driver.execute_script('return document.title')
        print(title)
        assert(not 'test.html' in title)
        driver.close()
    finally:
        driver.quit()

finally:
    print("killing child process", server.pid)
    server.kill()