docs: record D4 integration inputs

This commit is contained in:
wlx committed 2026-08-23 18:12:21 +08:00
1 parent fdf3a328ce
commit 78ed3c1103
11 files changed
+162 -29

No files matched your search

+1 -1
View File
@@ -6,6 +6,6 @@ DATABASE_URL=postgresql://moyi:replace-with-a-long-random-password@127.0.0.1:543
SESSION_TTL_HOURS=168
AUTH_PASSWORD_PEPPER=replace-with-a-long-random-secret
ADMIN_ACCOUNT=admin@moyi.local
ADMIN_ACCOUNT=adimin
ADMIN_PASSWORD=replace-with-a-strong-initial-password
ADMIN_DISPLAY_NAME=平台管理员
+11
View File
@@ -0,0 +1,11 @@
NODE_ENV=development
CONTROL_PLANE_HOST=127.0.0.1
CONTROL_PLANE_PORT=8787
CONTROL_PLANE_CORS_ORIGINS=http://localhost:5173
SESSION_TTL_HOURS=168
AUTH_PASSWORD_PEPPER=replace-with-a-long-random-secret
# 内存联调模式:不要设置 DATABASE_URL
ADMIN_ACCOUNT=adimin
ADMIN_PASSWORD=replace-with-a-strong-initial-password
ADMIN_DISPLAY_NAME=平台管理员
+28 -12
View File
@@ -4,33 +4,49 @@ D3 的身份与权限服务,负责邀请码注册、登录会话、用户角
## 本地开发
\`\`\`powershell
### 内存联调
如果暂时只验证登录、邀请码和权限,可以使用内存仓库,不需要 PostgreSQL:
```powershell
cd control-plane
Copy-Item .env.memory.example .env
# 在 .env 中设置 ADMIN_PASSWORD,且不要设置 DATABASE_URL
pnpm install
pnpm dev
```
内存仓库重启后会清空用户、邀请码和会话,只适合开发联调。
### PostgreSQL 持久化
```powershell
cd control-plane
Copy-Item .env.example .env
pnpm install
pnpm migrate
pnpm seed:admin
pnpm dev
\`\`\`
```
默认监听 \`http://127.0.0.1:8787\`。没有设置 \`DATABASE_URL\` 时,服务可以使用内存仓库启动,用于接口联调;正式开发和测试应使用 PostgreSQL。
默认监听 `http://127.0.0.1:8787`。没有设置 `DATABASE_URL` 时,服务可以使用内存仓库启动,用于接口联调;正式开发和测试应使用 PostgreSQL。
## 接口
- \`POST /api/auth/register\`:邀请码注册,账号支持邮箱或手机号。
- \`POST /api/auth/login\`:账号密码登录,返回 HttpOnly 会话 Cookie。
- \`GET /api/auth/me\`:读取当前会话用户。
- \`POST /api/auth/logout\`:撤销当前会话。
- \`GET /api/admin/users\`:管理员用户列表。
- \`GET|POST /api/admin/invitations\`:管理员查看或生成邀请码。
- \`POST /api/admin/invitations/:id/revoke\`:停用邀请码。
- \`GET /api/admin/audit\`:管理员查看认证审计。
- `POST /api/auth/register`:邀请码注册,账号支持邮箱或手机号。
- `POST /api/auth/login`:账号密码登录,返回 HttpOnly 会话 Cookie。
- `GET /api/auth/me`:读取当前会话用户。
- `POST /api/auth/logout`:撤销当前会话。
- `GET /api/admin/users`:管理员用户列表。
- `GET|POST /api/admin/invitations`:管理员查看或生成邀请码。
- `POST /api/admin/invitations/:id/revoke`:停用邀请码。
- `GET /api/admin/audit`:管理员查看认证审计。
第一版暂不实现短信/邮件真实验证码;注册页面保留验证码入口但不以它作为后端注册条件,邀请码、邮箱/手机号和账号密码是当前有效的注册条件。
## 安全约束
- 数据库仅保存密码哈希、邀请码摘要和会话摘要,不保存明文密码、明文邀请码或会话 Token。
- 生产环境必须设置随机的 \`AUTH_PASSWORD_PEPPER\`、强管理员密码和 HTTPS。
- 生产环境必须设置随机的 `AUTH_PASSWORD_PEPPER`、强管理员密码和 HTTPS。
- 管理员接口由 Control Plane 服务端角色校验保护,隐藏前端菜单不构成权限控制。
- 迁移文件只创建认证相关表,额度、模型和 Key 表在后续 D4 节点加入。
+1 -1
View File
@@ -1,7 +1,7 @@
CREATE TABLE IF NOT EXISTS users (
id uuid PRIMARY KEY,
account varchar(320) NOT NULL UNIQUE,
account_kind varchar(16) NOT NULL CHECK (account_kind IN ('email', 'phone')),
account_kind varchar(16) NOT NULL CHECK (account_kind IN ('email', 'phone', 'username')),
password_hash text NOT NULL,
display_name varchar(80) NOT NULL,
role varchar(16) NOT NULL DEFAULT 'user' CHECK (role IN ('user', 'admin')),
+4 -2
View File
@@ -8,7 +8,7 @@ import {
export type UserRole = 'user' | 'admin'
export type UserStatus = 'active' | 'disabled'
export type AccountKind = 'email' | 'phone'
export type AccountKind = 'email' | 'phone' | 'username'
export interface UserRecord {
id: string
@@ -368,7 +368,9 @@ export function normalizeAccount(value: string) {
}
export function accountKind(account: string): AccountKind {
return account.includes('@') ? 'email' : 'phone'
if (account.includes('@')) return 'email'
if (/^\+?[0-9][0-9\s-]{6,19}$/.test(account)) return 'phone'
return 'username'
}
export function validateAccount(account: string) {
+10
View File
@@ -79,3 +79,13 @@ test('stored invitation values are hashes rather than plaintext', async () => {
assert.equal(stored?.codeHash, hashSecret(created.code))
assert.notEqual(stored?.codeHash, created.code)
})
test('development administrator can use a username account', async () => {
const { auth, repository } = createHarness()
await auth.ensureAdmin('adimin', 'test-admin-password', '平台管理员')
const login = await auth.login({ account: 'adimin', password: 'test-admin-password' }, {})
const stored = await repository.findUserByAccount('adimin')
assert.equal(login.user.role, 'admin')
assert.equal(stored?.accountKind, 'username')
})