Skip to content

docs: 优化 README 品牌头部与工作流展示 #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kairowan merged 1 commit into from
Nov 4, 2026
Merged

docs: 优化 README 品牌头部与工作流展示 #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 33 additions & 8 deletions README.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
# Shellsmith — Android and iOS App Hardening

[简体中文](README.md) | English

[![Latest Release](https://img.shields.io/github/v/release/kairowan/Shellsmith?style=flat-square&label=release&color=6366f1)](https://github.com/kairowan/Shellsmith/releases/latest)
[![CI](https://img.shields.io/github/actions/workflow/status/kairowan/Shellsmith/ci.yml?branch=main&style=flat-square&label=CI)](https://github.com/kairowan/Shellsmith/actions/workflows/ci.yml)
[![License](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-green?style=flat-square)](#license)
<div align="center">
<img src="docs/assets/brand/shellsmith-icon.png" width="96" alt="Shellsmith logo">
<h1>Shellsmith</h1>
<p><strong>Android and iOS App Hardening</strong></p>
<p>Local-first · Offline hardening · Integrated signing</p>
<p><a href="README.md">简体中文</a> | English</p>
<p>
<a href="https://github.com/kairowan/Shellsmith/releases/latest"><img src="https://img.shields.io/github/v/release/kairowan/Shellsmith?style=flat-square&label=release&color=6366f1" alt="Latest release"></a>
<a href="https://github.com/kairowan/Shellsmith/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/kairowan/Shellsmith/ci.yml?branch=main&style=flat-square&label=CI" alt="CI"></a>
<a href="#license"><img src="https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-green?style=flat-square" alt="License"></a>
</p>
</div>

Shellsmith is a local-first desktop hardening tool. It protects Android APK/AAB outputs and iOS source projects, signs them, and verifies the results entirely on your machine; APKs, certificates, and signing materials are never uploaded. When BYOS out-of-package keys are explicitly enabled, the artifact IKM is sent only to the self-hosted HTTPS service you configure, never to Shellsmith maintainers.

A desktop GUI is available for Windows, macOS, and Linux, with Chinese and English interfaces. The CLI is built from source for automation.

> Use only with applications you own or are authorized to protect. Do not bypass third-party protections or use this tool for unauthorized purposes.

**Quick navigation** · [Capabilities](#core-capabilities) · [Quick Start](#quick-start) · [Compatibility](#compatibility-and-limitations) · [BYOS](#byos-out-of-package-keys) · [Security Scope](#how-it-works-and-security-scope) · [Documentation](#documentation-and-development)

## Core Capabilities

- **Android DEX hardening:** encrypt application DEX files and bind them to the original certificate, then repackage, align, and optionally sign. Baseline anti-debugging and optional strict checks are included.
Expand Down Expand Up @@ -80,7 +87,9 @@ This removes quarantine; it does not mean the application is notarized by Apple.

## Preview

![Shellsmith protection page illustration](docs/assets/screenshots/readme-protect-main.png)
<p align="center">
<img src="docs/assets/screenshots/readme-protect-main.png" width="860" alt="Shellsmith protection page illustration">
</p>

The screenshot illustrates the layout; available options depend on the current version. More screens and instructions are in the [usage guide](docs/usage.md).

Expand Down Expand Up @@ -158,6 +167,22 @@ Shellsmith does not host the BYOS service. The repository documents a separately

## How It Works and Security Scope

```mermaid
flowchart TB
subgraph Android[Android]
A1[APK / AAB] --> A2[Preflight]
A2 --> A3[DEX hardening]
A3 --> A4[Repackage / align]
A4 --> A5[Sign]
end
subgraph iOS[iOS]
I1[Xcode project] --> I2[Check]
I2 --> I3[Source protection]
I3 --> I4[Archive / Export]
I4 --> I5[Signature verification]
end
```

### Android

Protection reads the original certificate, compresses and encrypts DEX files, injects the stub, then rebuilds, aligns, and optionally signs the APK. At runtime, the stub checks the environment, validates or decrypts the DEX cache, loads code, and starts the original application.
Expand Down
41 changes: 33 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
# Shellsmith — Android 与 iOS 应用加固工具

简体中文 | [English](README.en.md)

[![最新版本](https://img.shields.io/github/v/release/kairowan/Shellsmith?style=flat-square&label=最新版本&color=6366f1)](https://github.com/kairowan/Shellsmith/releases/latest)
[![CI](https://img.shields.io/github/actions/workflow/status/kairowan/Shellsmith/ci.yml?branch=main&style=flat-square&label=CI)](https://github.com/kairowan/Shellsmith/actions/workflows/ci.yml)
[![许可证](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-green?style=flat-square)](#许可证)
<div align="center">
<img src="docs/assets/brand/shellsmith-icon.png" width="96" alt="Shellsmith logo">
<h1>Shellsmith</h1>
<p><strong>Android 与 iOS 应用加固工具</strong></p>
<p>本地优先 · 离线加固 · 签名一体化</p>
<p>简体中文 | <a href="README.en.md">English</a></p>
<p>
<a href="https://github.com/kairowan/Shellsmith/releases/latest"><img src="https://img.shields.io/github/v/release/kairowan/Shellsmith?style=flat-square&label=%E6%9C%80%E6%96%B0%E7%89%88%E6%9C%AC&color=6366f1" alt="最新版本"></a>
<a href="https://github.com/kairowan/Shellsmith/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/kairowan/Shellsmith/ci.yml?branch=main&style=flat-square&label=CI" alt="CI"></a>
<a href="#许可证"><img src="https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-green?style=flat-square" alt="许可证"></a>
</p>
</div>

Shellsmith 是一款本地优先的桌面加固工具：Android APK/AAB 与 iOS 源码工程的加固、签名和产物验证都在本机完成，APK、证书和签名材料不会上传。显式启用 BYOS 包外密钥时，产物 IKM 只会发送到你配置的自建 HTTPS 服务，不经过 Shellsmith 维护者。

提供 Windows、macOS、Linux 桌面 GUI（中英文界面），CLI 可从源码构建用于自动化和本地开发。

> 仅用于保护你拥有合法权利的 Android 与 iOS 应用，请勿用于绕过第三方保护或其他未授权场景。

**快速导航** · [核心能力](#核心能力) · [快速开始](#快速开始) · [兼容性](#兼容性与限制) · [BYOS](#byos-包外密钥) · [安全边界](#工作原理与安全边界) · [文档](#文档与开发)

## 核心能力

- **Android DEX 加固**：加密业务 DEX 并绑定原签名证书，重新打包、对齐并按需签名；提供基础反调试和可选的严格保护。
Expand Down Expand Up @@ -80,7 +87,9 @@ xattr -rd com.apple.quarantine /Applications/Shellsmith.app

## 界面预览

![Shellsmith 加固页示意](docs/assets/screenshots/readme-protect-main.png)
<p align="center">
<img src="docs/assets/screenshots/readme-protect-main.png" width="860" alt="Shellsmith 加固页示意">
</p>

截图用于展示页面布局，具体选项以当前版本为准。更多页面与操作说明见[使用指南](docs/usage.md)。

Expand Down Expand Up @@ -158,6 +167,22 @@ Shellsmith 不托管 BYOS 服务端。仓库提供一份可独立部署的 Go/Po

## 工作原理与安全边界

```mermaid
flowchart TB
subgraph Android[Android]
A1[APK / AAB] --> A2[预检]
A2 --> A3[DEX 加固]
A3 --> A4[重打包 / 对齐]
A4 --> A5[签名]
end
subgraph iOS[iOS]
I1[Xcode 工程] --> I2[检查]
I2 --> I3[源码保护]
I3 --> I4[Archive / Export]
I4 --> I5[签名验证]
end
```

### Android

加固时读取原签名证书，压缩并加密 DEX，注入壳资源，再重新打包、对齐并按需签名。运行时由壳执行安全检查、校验或解密 DEX 缓存，加载业务代码并启动原应用。
Expand Down