OctoC2 - GitHub-native command-and-control framework for au

项目说明

<!--
╔═══════════════════════════════════════╗
║ OctoC2 — GitHub-Native C2 Framework ║
╚═══════════════════════════════════════╝
-->

<p align="center">
<img src="docs-site/public/logo.png" alt="OctoC2" width="360" />
</p>

<p align="center">
GitHub-nati for authorized security research, with encrypted multi-channel transport and resilient failover.
</p>

> [!IMPORTANT]
> Authorized use only. Run OctoC2 only on systems and repositories you own
> or ha permission to test. Use private test infrastructure,
> least-pri credentials, trusted TLS, and private listener bindings.

OctoC2 combines a TypeScript beacon, durable controller, local operator
dashboard, and CLI. GitHub-backed and direct transports share one signed task
protocol, one identity model, and the same result-ownership rules.

Documentation: Browse the complete manual or open the
documentation site.

Start here

| I want to… | Read or run |
|---|---|
| Browse all documentation | Documentation index |
| Understand the system | Architecture guide |
| Install the toolchain and binaries | Installation |
| Configure the GitHub App, repos, and PATs | GitHub setup |
| Complete a first local run | Quickstart |
| Configure every channel | Channel guide |
| Use operator commands | CLI reference |
| Look up an en | Configuration reference |
| Configure listeners and certificates | Operations and assurance |
| Configure GitHub App recovery | Recovery guide |
| Diagnose a failure | Troubleshooting |
| Contribute a change | De guide |
| Review implementation and li | traceability |
| Use the dashboard | Dashboard guide |

Architecture

Every transport uses the canonical contracts in shared/. The controller
persists identities, credentials, tasks, results, delivery leases, replay
records, and channel cursors in SQLite. The beacon persists its Ed25519
identity and task ledger so a delivered task cannot be executed twice after a
restart.

Workspaces

| Workspace | Responsibility |
|---|---|
| implant/ | Beacon runtime, task lifecycle, recovery, and transport clients |
| server/ | Controller services, durable state, channel polling, HTTP, and gRPC |
| dashboard/ | Local operator interface for beacon and task activity |
| octoctl/ | Keys, enrollment, builds, task submission, and proxy pro |
| shared/ | Task catalog, channel catalog, en, identities, and signatures |
| proxy/ | Relay workflow build and |
| docs-site/ | Public documentation site |

Transport paths

OctoC2 can exchange the same task protocol through several en
paths:

Transport a depends on its declared GitHub permissions, identity
material, and network prerequisites. See the quickstart
for exact credential roles and traceability record
for test e.

Quick setup

Requirements

Install the pinned dependency graph and generate the protocol bindings:

Generate the operator encryption keypair:

Keep the secret key and all repository credentials outside source control.

Optional local HTTPS listener

Controller listeners remain disabled until explicitly enabled. A minimal
loopback HTTPS/WSS configuration is:

The certificate SAN must cover the hostname clients use. Install an internal
CA in each client trust store; there is no certificate- bypass.

Start the controller and dashboard in separate terminals:

The dashboard binds to .

Identity and credential boundaries

Do not reuse across these roles:

| Role | Configuration | Used by |
|---|---|---|
| Controller GitHub API | OCTOC2_SER | Ser GitHub channels |
| Operator controller API | OCTOC2_OPERATOR_API_TOKEN | Dashboard and CLI REST/SSE calls |
| Beacon controller API | OCTOC2_BEACON_API_TOKENS / S | HTTPS and gRPC beacon routes |
| Operator encryption | OCTOC2_OPERATOR_SECRET | Task sealing and result decryption |
| GitHub App private key | OCTOC2_GITHUB_APP_PRI | Ser token minting |
| Codespaces user access | SEN | Runtime Codespaces API/SSH discovery |

Direct gRPC additionally requires a trusted CA, a distinct client certificate
per beacon, and an exact SHA-256 certificate fingerprint binding. Gist uses
separate controller and beacon credentials for the same dedicated account.

Security model

Repository permissions are still an operational boundary: a broad repository
writer may delete, delay, or reorder artifacts even when it cannot forge their
authenticated contents. Separate repositories and narrowly scoped credentials
provide stronger isolation.

a change

Run repository policy checks first:

Then run tests and strict type checks in every affected workspace:

Build beacon targets and smoke-test distributable artifacts:

Li is a separate, explicitly authorized exercise. Record the
re, en, credential roles, observed task/result path, and cleanup
result alongside the test e.

项目信息

开发语言：TypeScript

Star 数：228

技术要点

该项目属于红蓝攻防方向的开源资源，代码结构清晰，适合安全研究人员学习参考。项目围绕GitHub-native command-and-control framework for authorized security research, with encrypted multi-channel transport and resilient failover.展开，提供了可运行的实现，对理解相关安全机制、工具原理与攻防技术具有较高的研究价值。

从技术实现角度看，此类项目的核心在于对底层原理的深入理解与工程化落地。开发者在研究过程中可以结合官方文档与社区讨论，梳理项目的初始化流程、核心模块职责与数据流转，逐步掌握其中的技术细节与设计思路。

使用与学习建议

1. 下载源码压缩包，解压到本地环境。

2. 根据项目类型准备对应的运行环境与依赖。

3. 按照 README 中的步骤完成配置与部署。

4. 在隔离的测试环境中运行验证，避免影响生产系统。

免责声明

本资源来源于开源社区，仅供安全研究、技术学习与合法授权范围内的攻防演练使用，请勿用于任何非法或侵害他人权益的用途。使用本项目产生的一切后果由使用者自行承担。