Skip to content

r266-tech/wxkey

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

wxkey

wxkey is the companion CLI used by wechat-local-mcp to initialize local WeChat 4.x WCDB keys on macOS.

It reads the local WeChat process memory, finds candidate WCDB key material, and verifies candidates against local DB page-1 SQLCipher HMACs. It writes the resulting per-DB key map to ~/.config/wxcli/config.json, where wechat-local-mcp can read it later.

Install

go install github.com/r266-tech/wxkey/cmd/wxkey@latest

Usage

wxkey bootstrap
wxkey doctor
wxkey setup
wxkey scan --quiet
wxkey resign-wechat

Recommended first-run path:

wxkey bootstrap

bootstrap checks existing config, prepares an ad-hoc signed wx-mcp shadow copy of WeChat when needed, asks for the Mac admin password once, stores that password in the user's macOS Keychain, then runs setup and prints only a summary. It does not print raw key material.

Agent boundary: agents should run wxkey doctor and wxkey setup themselves. If key coverage is partial, the agent should inspect the missing DB list, ask the user only to open the corresponding chat/page inside WeChat, then rerun wxkey setup. Do not hand these commands back to the user unless the user is explicitly operating without an agent.

wxkey doctor is intentionally lightweight by default: it compares the cached key map in ~/.config/wxcli/config.json against local DB salts and lists missing DBs without starting another memory scan. Use wxkey doctor --scan only when an agent needs to re-check live task_for_pid access or current heap key coverage.

SIP

SIP should stay enabled. First-time key extraction uses one supported path: an ad-hoc signed WeChat process plus wxkey with administrator privileges. Bootstrap signs a wx-mcp-managed shadow copy when the installed WeChat app is protected by App Store app-management controls. The admin password is stored in Keychain by wxkey bootstrap so later wxkey setup runs can refresh missing DB keys unattended. Disabling SIP is not a supported setup step.

Security

Do not paste raw ~/.config/wxcli/config.json, DB keys, WeChat DBs, or message contents into public issues.


If wxkey helped you set things up

wxkey is a small bootstrap companion. The actual product you'll use day-to-day is wechat-local-mcp — that's the repo to star if you want to support continued maintenance. Part of babata.

About

WeChat 4.x local WCDB key bootstrap CLI for wx-mcp

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages