Skip to content

A modern terminal with a built-in multiplexer: close it and your sessions keep running. Run shells and tons of AI agents across your machines, then pick them up from desktop, browser, TUI and more. Written in Rust with no UI framework: interface drawn straight on the GPU. No Electron, GPUI or webview.

docs(security): add a security policy

RoversXc51923ab1b77
diff --git a/.gitignore b/.gitignore
index cf6ef8ea..33eec384 100644
--- a/.gitignore
+++ b/.gitignore
@@ -92,6 +92,9 @@ __pycache__/
# Keep the contributor agreement visible in new pull requests.
!/.github/pull_request_template.md
+# Keep the security policy where GitHub looks for it.
+!/SECURITY.md
+
# Keep ThinkTerm-specific design documentation under version control.
!/docs/
/docs/*
diff --git a/SECURITY.md b/SECURITY.md
new file mode 100644
index 00000000..200035da
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,52 @@
+# Security Policy
+
+## Reporting a vulnerability
+
+Please report security vulnerabilities privately. Do not open a public issue,
+discussion, or pull request for them.
+
+Use GitHub's private vulnerability reporting: open the repository's
+**Security** tab and choose **Report a vulnerability**, or go directly to
+<https://github.com/RoversX/ThinkTerm/security/advisories/new>.
+
+Include as much of the following as you can:
+
+- the ThinkTerm version (`thinkterm -V`) and your operating system;
+- the part involved, such as the desktop app, the mux server, browser access,
+ SSH and Mosh connections, the plugin server, or the mobile apps;
+- steps to reproduce it, or a proof of concept;
+- what an attacker can do, and what they need first.
+
+## What happens next
+
+You should get an acknowledgement within a week. ThinkTerm is a small
+project, so a fix for a complex issue can take longer; you will hear how it is
+going. When the fix is released, the advisory is published and credits you,
+unless you would rather not be named. Please keep the details private until
+then.
+
+## Supported versions
+
+Security fixes go into the main branch and the next release. Only the latest
+release is supported, so please check that a problem still occurs there before
+reporting it.
+
+## Scope
+
+The code in this repository is in scope, including the code ThinkTerm
+inherits from WezTerm. If an issue also affects WezTerm, say so in your report
+so that it can be reported upstream as well.
+
+These are not vulnerabilities in ThinkTerm:
+
+- What an installed plugin can do. A plugin is a program you installed, and it
+ runs as you, with your permissions; see the
+ [plugin guide](docs/thinkterm/plugins.md#security).
+- Access by someone who already holds a valid browser access token, can read
+ your ThinkTerm data directory, or can log in as you. Access tokens and the
+ key that protects saved SSH passwords are credentials, as
+ [Configuration and privacy](README.md#configuration-and-privacy) explains.
+- Problems in software that ThinkTerm only runs, such as your shell, `ssh`, or
+ `mosh`.
+
+For how ThinkTerm handles your data, see [PRIVACY.md](PRIVACY.md).