Skip to content
Merged
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
33 changes: 28 additions & 5 deletions src/steve_desktop/diagnostics.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,16 @@
_lock = threading.RLock()


def _redact(text, secrets=()):
def _redact_secrets(text, secrets=()):
"""The exact secrets this app holds, longest first."""
text = str(text)
for secret in sorted((str(s) for s in secrets if s and len(str(s)) >= 4), key=len, reverse=True):
text = text.replace(secret, '[redacted]')
return text


def _redact(text, secrets=()):
text = _redact_secrets(text, secrets)
text = re.sub(r'https?://[^\s<>\"\']+', '[URL omitted]', text)
text = re.sub(r'data:image/[^\s\"\']+', '[image omitted]', text)
text = re.sub(r'(?i)(bearer\s+)[^\s,;\"\']+', r'\1[redacted]', text)
Expand Down Expand Up @@ -47,21 +53,38 @@ def redact_report(text, secrets=(), home=None, user=None):
user = getpass.getuser()
except Exception:
user = ''
text = _redact(text, secrets)
# Known secrets first, while they're still exactly as held: the home, email and
# account-name passes below could change part of one so it no longer matches.
text = _redact_secrets(text, secrets)
# Apply home / email / username before the long-token wipe so absolute paths that
# are ≥80 characters (common under macOS /var/folders/…) become [home] instead of
# [long value omitted]. Keep both the lexical and resolved forms: on Darwin,
# /var is a symlink to /private/var, so tempfile paths and Path.resolve() disagree.
text = EMAIL.sub('[email]', text)
for pattern, replacement in HOME_FOLDERS:
text = pattern.sub(replacement, text)
homes = []
if home and len(home) > 3: # A home folder outside the usual locations.
homes.append(home)
home_path = Path(home)
try:
# Tracebacks often contain the resolved path when the home directory
# itself is a symlink (another disk, or a bind mount).
resolved = str(Path(home).resolve())
resolved = str(home_path.resolve())
except OSError:
resolved = ''
if resolved and len(resolved) > 3 and resolved not in homes:
if resolved and len(resolved) > 3:
homes.append(resolved)
# /private/var/… ↔ /var/… (and the same for /tmp).
if resolved.startswith('/private/'):
homes.append(resolved[len('/private'):])
try:
if home_path.is_symlink():
link = home_path.readlink()
target = link if link.is_absolute() else home_path.parent / link
homes.append(str(target))
except OSError:
pass
forms = []
for item in homes:
forms.extend((item, item.replace('\\', '/'), item.replace('\\', '\\\\')))
Expand All @@ -70,7 +93,7 @@ def redact_report(text, secrets=(), home=None, user=None):
text = re.sub(re.escape(form) + r'(?![A-Za-z0-9._-])', '[home]', text, flags=re.I)
if user and len(user) >= 3:
text = re.sub(r'(?<![A-Za-z0-9])' + re.escape(user) + r'(?![A-Za-z0-9])', '[user]', text, flags=re.I)
return text
return _redact(text)


def tail_bytes(text, limit):
Expand Down
57 changes: 57 additions & 0 deletions tests/test_desktop_feedback.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,63 @@ def test_resolved_home_and_hyphenated_api_keys_are_removed(self):
self.assertIn('api-key: [redacted]', result)
self.assertEqual(redact_report(result, home=str(home), user='alex'), result)

def test_symlinked_home_redacts_lexical_and_resolved_forms(self):
# Build a symlink in a temp dir so this reproduces on Linux too, not only Mac.
# Embed both the lexical target and home.resolve() — on Darwin those differ
# (/var vs /private/var). Both must become [home], even when the path is ≥80 chars.
with tempfile.TemporaryDirectory() as folder:
base = Path(folder)
resolved = base / 'data' / 'disk' / 'mount' / 'volume' / 'users' / 'u-9f3a-extra-padding-xxxxxxxx'
resolved.mkdir(parents=True)
home = base / 'homes' / 'alex'
home.parent.mkdir()
home.symlink_to(resolved, target_is_directory=True)
lexical = str(resolved)
real = str(home.resolve())
text = (
f'open {lexical}/bracket.step\n'
f'also {real}/other.step\n'
'short-token ok\n'
'note: hello world stays\n'
)
self.assertGreaterEqual(len(f'{lexical}/bracket.step'), 80)
result = redact_report(text, home=str(home), user='alex')
self.assertNotIn('u-9f3a', result)
self.assertNotIn('[long value omitted]', result)
self.assertIn('[home]/bracket.step', result)
self.assertIn('[home]/other.step', result)
self.assertIn('short-token ok', result)
self.assertIn('note: hello world stays', result)
self.assertEqual(redact_report(result, home=str(home), user='alex'), result)

def test_redaction_keeps_short_text_and_still_scrubs_long_secrets(self):
# Both-ways: ordinary non-path text and short tokens must survive; long secrets
# (and ≥80-char opaque values) must still be scrubbed after the home-first reorder.
long_secret = 'A' * 100
text = (
f'payload={long_secret}\n'
'ok short phrase\n'
'id=ab\n'
f'open /srv/people/morgan/file\n'
)
result = redact_report(text, secrets=['notusedhere'], home='/srv/people/morgan', user='morgan')
self.assertIn('[long value omitted]', result)
self.assertNotIn(long_secret, result)
self.assertIn('ok short phrase', result)
self.assertIn('id=ab', result)
self.assertIn('[home]/file', result)
self.assertNotIn('/srv/people/morgan', result)

def test_secret_holding_the_account_name_is_removed_whole(self):
# Secrets go first: the account-name pass must not change part of a secret
# before it is matched, which would leave the rest of it in the report.
secret = 'tok-alex-9f8e7d6c5b4a'
email_secret = 'pw-alex@example.com-x1'
result = redact_report(f'auth {secret} then {email_secret} done', secrets=[secret, email_secret], home='/srv/people/alex', user='alex')
self.assertNotIn('9f8e7d6c5b4a', result)
self.assertNotIn('x1 done', result.replace('[redacted] done', ''))
self.assertEqual(result, 'auth [redacted] then [redacted] done')

def test_log_is_capped_to_its_most_recent_whole_lines(self):
log = '\n'.join(f'line {n}' for n in range(1000))
kept, truncated = tail_bytes(log, 100)
Expand Down