ctrlweb Site Portrait
| 开发者 | ctrlwebinc |
|---|---|
| 更新时间 | 2026年10月29日 01:53 |
| PHP版本: | 7.4 及以上 |
| WordPress版本: | 7.1 |
| 版权: | GPL-2.0-or-later |
| 版权网址: | 版权信息 |
详情介绍:
- Off by default. Nothing happens and nothing is sent until you enter the address of a service and approve the connection.
- Any compatible service. The plugin is not tied to any company, including its author. It implements Site Portrait, an open protocol documented in
docs/PROTOCOL.md(included in the plugin), so anyone can build a compatible service. - You choose what is shared. Seven categories (WordPress core, plugins, themes, server, database, content volumes, user counts) can be ticked or unticked at any time.
- Read-only and minimised. The service can never change your site. The plugin never shares passwords, keys,
wp-config.phpvalues, user names or email addresses, post content, file paths, the database prefix or server IP addresses. - No password to leak. Instead of a password, the site and the service exchange public keys. Every request is signed (HTTP Message Signatures, RFC 9421, with Ed25519) and can only be used once. Even a copy of your database does not let anyone impersonate the service.
- Transparent. An access log shows every request (date, IP address, categories). Optional IP allow-list, rate limiting, one-click disconnection and key rotation.
- Multisite ready. On a network, a super admin connects the whole network from the Network Admin.
- In Settings → Site Portrait, enter the address given by the service (for example
https://service.example). - The plugin reads the service description (
/.well-known/site-portrait) and shows you its name, privacy policy and the data it asks for. Tick the categories you agree to share. - Click Connect: you are sent to the service to sign in and approve, then back to your dashboard.
- The service can now request the portrait. You can change the categories or disconnect at any time.
docs/PROTOCOL.md and docs/schema/. The filter site_portrait_scope_data lets other plugins add data to a category.
Licenses
The plugin code is licensed under the GPL, version 2 or later (GPL-2.0-or-later). The protocol specification and JSON schemas in docs/ are licensed under Creative Commons Attribution 4.0 (CC-BY-4.0), so that anyone can implement a compatible service.
常见问题:
Can the service change my site?
No. The API is read-only. The only thing a service can do besides reading is end the connection.
What if someone steals my database?
The site only stores the service's public key, which cannot be used to send requests. The site's own private key is also stored; it only allows signing answers as your site and can be replaced from the settings page (Generate a new site key) or by disconnecting.
Why not use an application password?
An application password gives a service every permission of the user who created it, and it can be reused by anyone who obtains it. This plugin gives read access to the chosen categories only, with signed, single-use requests.
My site is on localhost or uses HTTP.
HTTPS is required. For local development only, define SITE_PORTRAIT_DEV_MODE as true with a local or development environment type and a .test, .localhost or loopback host.
How do I build a compatible service?
Read docs/PROTOCOL.md. It lists what a service must implement, with examples and test vectors.
更新日志:
- First version: discovery, pairing with PKCE and Ed25519 keys, signed REST API, seven data categories, access log, IP allow-list, rate limiting, key rotation, multisite network mode.