aboutsummaryrefslogtreecommitdiff
path: root/scripts/verify_suspicious_keys.py
blob: 99a41439d31fc3a7fb4b4e2701b97e397e97c3fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
#!/usr/bin/env python3
"""Interactive verifier for suspicious terminal key captures.

Self-contained Python 3 script.
Prompts a short list of suspicious keys, captures each multiple times,
and writes a TSV file for easy comparison.

Usage:
    python3 verify_suspicious_keys.py
"""

from __future__ import annotations

import re
import select
import sys
import termios
import time
import tty
from pathlib import Path

IDLE_TIMEOUT_S = 0.025
ABORT_CAPTURE = b"\x07"  # Ctrl+G
REPETITIONS = 2

SUSPICIOUS_KEYS: list[tuple[str, str]] = [
    ("home", "Press Home"),
    ("end", "Press End"),
    ("pageup", "Press Page Up"),
    ("pagedown", "Press Page Down"),
    ("shift+enter", "Press Shift+Enter"),
    ("alt+left", "Press Alt+Left Arrow"),
    ("alt+right", "Press Alt+Right Arrow"),
]


def to_hex(data: bytes) -> str:
    return data.hex()


def escaped(data: bytes) -> str:
    parts: list[str] = []
    for byte in data:
        if byte == 0x1B:
            parts.append("\\x1b")
        elif byte == 0x7F:
            parts.append("\\x7f")
        elif byte == 0x0D:
            parts.append("\\r")
        elif byte == 0x0A:
            parts.append("\\n")
        elif byte == 0x09:
            parts.append("\\t")
        elif 0x20 <= byte <= 0x7E:
            parts.append(chr(byte))
        else:
            parts.append(f"\\x{byte:02x}")
    return "".join(parts)


def sanitize(value: str) -> str:
    value = value.strip().lower()
    value = re.sub(r"[^a-z0-9._-]+", "-", value)
    value = re.sub(r"-+", "-", value).strip("-._")
    return value or "terminal"


def read_sequence() -> bytes:
    first = sys.stdin.buffer.read1(1)
    if not first:
        return b""

    chunks = [first]
    while True:
        ready, _, _ = select.select([sys.stdin], [], [], IDLE_TIMEOUT_S)
        if not ready:
            break
        chunk = sys.stdin.buffer.read1(1024)
        if not chunk:
            break
        chunks.append(chunk)
    return b"".join(chunks)


class RawMode:
    def __enter__(self) -> "RawMode":
        self.fd = sys.stdin.fileno()
        self.old = termios.tcgetattr(self.fd)
        tty.setraw(self.fd)
        return self

    def __exit__(self, exc_type, exc, tb) -> None:
        termios.tcsetattr(self.fd, termios.TCSADRAIN, self.old)


def prompt(text: str, default: str | None = None) -> str:
    suffix = f" [{default}]" if default else ""
    value = input(f"{text}{suffix}: ").strip()
    if not value and default is not None:
        return default
    return value


def choose_output_path(terminal_name: str) -> Path:
    stamp = time.strftime("%Y%m%d-%H%M%S")
    default_name = f"key-verify-{sanitize(terminal_name)}-{stamp}.tsv"
    raw = prompt("Output file path", default_name)
    return Path(raw).expanduser().resolve()


def capture_one(display: str, repetition: int) -> bytes | None:
    print()
    print(f"=== {display} (capture {repetition}/{REPETITIONS}) ===")
    print("Press the key now. Ctrl+G aborts the session.")
    sys.stdout.flush()
    with RawMode():
        data = read_sequence()
    if data == ABORT_CAPTURE:
        return None
    return data


def confirm_capture(data: bytes) -> str:
    print(f"Captured: hex={to_hex(data)} escaped={escaped(data)!r}")
    while True:
        choice = input("Enter=accept, r=retry, s=skip, q=quit: ").strip().lower()
        if choice in {"", "r", "s", "q"}:
            return choice
        print("Please enter one of: Enter, r, s, q")


def write_tsv(path: Path, rows: list[dict[str, str]]) -> None:
    path.parent.mkdir(parents=True, exist_ok=True)
    with path.open("w", encoding="utf-8", newline="") as f:
        f.write("terminal\tkey\trepetition\tnotes\tbytes_hex\tescaped\n")
        for row in rows:
            f.write(
                "\t".join(
                    [
                        row["terminal"],
                        row["key"],
                        row["repetition"],
                        row["notes"],
                        row["bytes_hex"],
                        row["escaped"],
                    ]
                )
                + "\n"
            )


def main() -> int:
    print("Suspicious terminal key verifier")
    print("This captures a short list of keys multiple times for consistency checking.")
    print()

    terminal_name = prompt("Terminal name")
    if not terminal_name:
        print("Terminal name is required.", file=sys.stderr)
        return 1

    notes = prompt("Optional notes", "")
    output_path = choose_output_path(terminal_name)

    print()
    print(f"Terminal: {terminal_name}")
    print(f"Notes:    {notes or '-'}")
    print(f"Output:   {output_path}")
    print()
    input("Press Enter to start verifier...")

    rows: list[dict[str, str]] = []

    for key_id, display in SUSPICIOUS_KEYS:
        for repetition in range(1, REPETITIONS + 1):
            while True:
                data = capture_one(display, repetition)
                if data is None:
                    print("Aborted by Ctrl+G.")
                    write_tsv(output_path, rows)
                    print(f"Wrote partial capture to {output_path}")
                    return 1

                choice = confirm_capture(data)
                if choice == "r":
                    continue
                if choice == "s":
                    rows.append(
                        {
                            "terminal": terminal_name,
                            "key": key_id,
                            "repetition": str(repetition),
                            "notes": notes,
                            "bytes_hex": "",
                            "escaped": "SKIPPED",
                        }
                    )
                    break
                if choice == "q":
                    write_tsv(output_path, rows)
                    print(f"Wrote partial capture to {output_path}")
                    return 0

                rows.append(
                    {
                        "terminal": terminal_name,
                        "key": key_id,
                        "repetition": str(repetition),
                        "notes": notes,
                        "bytes_hex": to_hex(data),
                        "escaped": escaped(data),
                    }
                )
                break

    write_tsv(output_path, rows)
    print()
    print(f"Done. Wrote {len(rows)} rows to {output_path}")
    return 0


if __name__ == "__main__":
    raise SystemExit(main())