Skip to content

ci: add linter task "ban unicode" to protect against malicious unicode #9801

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
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
8 changes: 8 additions & 0 deletions .cirrus.yml
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,14 @@ task:
ELECTRUM_LINTERS_IGNORE: ""
allow_failures: true

task:
name: "linter: ban unicode"
container:
image: python:3.10
cpu: 1
memory: 1G
main_script:
- contrib/ban_unicode.py

# Cron jobs configured in https://cirrus-ci.com/settings/...
# - job "nightly" on branch "master" at "0 30 2 * * ?" (every day at 02:30Z)
Expand Down
58 changes: 58 additions & 0 deletions contrib/ban_unicode.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
#!/usr/bin/env python3
#
# Copyright (C) 2025 The Electrum developers
# Distributed under the MIT software license, see the accompanying
# file LICENCE or http://www.opensource.org/licenses/mit-license.php
#
# This script scans the whole codebase for unicode characters and
# errors if it finds any, unless the character is specifically whitelisted below.
# The motivation is to protect against homoglyph attacks, invisible unicode characters,
# bidirectional and other control characters, and other malicious unicode usage.
# Given that we mostly expect to use ASCII characters in the source code,
# the most robust and generic fix seems to be to just ban all unicode usage.

import os.path
import subprocess
import sys

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

EXCLUDE_PATH_PREFIX = {
"electrum/wordlist/",
"fastlane/",
"tests/",
}
EXCLUDE_EXTENSIONS = {
".jpg", ".jpeg", ".png", ".ttf", ".otf", ".pdn", ".icns", ".ico", ".gif",
}
UNICODE_WHITELIST = {
"💬", "🗯", "⚠", chr(0xfe0f), "✓", "▷", "▽", "…", "•", "█", "™", "≈",
"á", "é", "’",
"│", "─", "└", "├",
}

exit_code = 0

bfiles = subprocess.check_output(["git", "ls-files"])
bfiles = bfiles.decode("utf-8")
for file_path in bfiles.splitlines():
if os.path.isdir(file_path):
continue
if any(file_path.startswith(pattern) for pattern in EXCLUDE_PATH_PREFIX):
continue
_fname, ext = os.path.splitext(file_path)
if ext in EXCLUDE_EXTENSIONS:
continue
# open file
try:
with open(file_path, "r", encoding="utf-8") as f:
for line_no, line in enumerate(f.read().splitlines()):
for char in line:
if ord(char)>0x7f and char not in UNICODE_WHITELIST:
print(f"{file_path}:{line_no}. {line=}. hex={hex(ord(char))}. {char=}")
exit_code = 1
except UnicodeDecodeError as e:
raise Exception(f"cannot parse file {file_path=}") from e

sys.exit(exit_code)