@dplugin/core 2.0.0 → 2.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +155 -245
- package/package.json +1 -9
package/README.md
CHANGED
|
@@ -1,317 +1,227 @@
|
|
|
1
1
|
# @dplugin/core
|
|
2
2
|
|
|
3
|
-
DPlugin 前端登录与请求 SDK
|
|
3
|
+
DPlugin 前端登录与请求 SDK。零运行时依赖,使用浏览器原生 `fetch` 与 `WebCrypto`。
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## 两种模式
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|---|---|---|---|---|
|
|
9
|
-
| **cookie** | 页面与 `apiBase` **同源** | 服务端下发的 HttpOnly Cookie(`dp_sid` / `dp_ds` / `dp_token`) | **不生成** | 无签名参数,浏览器自动带 Cookie |
|
|
10
|
-
| **sign** | 页面与 `apiBase` 跨源 | `access`(localStorage)+ sso/域私钥 | P-256 ×2 | 每次带一个 `dsign` 信封 |
|
|
7
|
+
按「页面地址」与「接口地址」是否同源自动选择,业务代码不用区分:
|
|
11
8
|
|
|
12
|
-
|
|
9
|
+
| 模式 | 触发条件 | 凭证位置 | 请求形态 |
|
|
10
|
+
|---|---|---|---|
|
|
11
|
+
| **cookie** | 页面与接口**同源** | 服务端下发的 HttpOnly Cookie | 无签名参数,浏览器自动携带 Cookie |
|
|
12
|
+
| **sign** | 页面与接口**跨源** | 浏览器 localStorage | 每次请求多一个 `dsign` 参数 |
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
- `isLogin()` 只是本地标记(HttpOnly 读不到),真正有效性以第一次请求为准
|
|
20
|
-
|
|
21
|
-
**sign 模式**
|
|
22
|
-
- 登录:`submit`(上报 sso 公钥)→ 轮询 `POST /s/verify`(带签名)→ `code` 换 `access`(上报域公钥)
|
|
23
|
-
- 业务:每次请求带 `dsign` 信封(access/设备/时间/签名,域私钥签)
|
|
24
|
-
- 续期:`500900` → 用 sso 私钥走 `VERIFY_SID` 换 code → `TOKEN` 换新 access(**不再有 REFRESH**)
|
|
14
|
+
```js
|
|
15
|
+
setup({apiBase: ''}) // 同源 → cookie
|
|
16
|
+
setup({apiBase: 'https://api.other.com'}) // 跨源 → sign
|
|
17
|
+
setup({apiBase: '', mode: 'sign'}) // 也可以用 mode 强制指定
|
|
18
|
+
```
|
|
25
19
|
|
|
26
|
-
|
|
20
|
+
同源按 **origin 全等**判断:`https://a.com` 与 `https://api.a.com` 算跨源。
|
|
27
21
|
|
|
28
22
|
## 安装
|
|
29
23
|
|
|
30
24
|
```bash
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
25
|
+
npm i @dplugin/core
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
CDN(挂到 `window.DPluginCore`):
|
|
29
|
+
|
|
30
|
+
```html
|
|
31
|
+
<script src="https://unpkg.com/@dplugin/core@2.0.1/dist/index.umd.js"></script>
|
|
32
|
+
<script>
|
|
33
|
+
const {setup, login, request, logout} = window.DPluginCore;
|
|
34
|
+
</script>
|
|
37
35
|
```
|
|
38
36
|
|
|
39
|
-
##
|
|
37
|
+
## 快速上手
|
|
38
|
+
|
|
39
|
+
### 1. 初始化(每个应用调一次)
|
|
40
40
|
|
|
41
41
|
```js
|
|
42
|
-
|
|
43
|
-
import {setup, request, login, logout} from '@dplugin/core';
|
|
42
|
+
import {setup} from '@dplugin/core';
|
|
44
43
|
|
|
45
44
|
setup({
|
|
46
|
-
apiBase: import.meta.env.VITE_API_BASE_URL, // '' = 同源
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
onError: ({code, message}) => Modal.error({title: '操作失败[' + code + ']', content: message}),
|
|
45
|
+
apiBase: import.meta.env.VITE_API_BASE_URL, // '' = 同源
|
|
46
|
+
loginUrl: '/login/',
|
|
47
|
+
onError: ({code, message}) => Modal.error({title: `操作失败[${code}]`, content: message}),
|
|
50
48
|
onLogout: () => router.replace('/login')
|
|
51
49
|
});
|
|
52
50
|
```
|
|
53
51
|
|
|
52
|
+
### 2. 登录
|
|
53
|
+
|
|
54
54
|
```js
|
|
55
|
-
|
|
55
|
+
import {login} from '@dplugin/core';
|
|
56
|
+
|
|
56
57
|
await login('/api/unsafe/dplugin/user/login/pwd/submit', {username, password});
|
|
57
58
|
location.href = '/';
|
|
58
59
|
```
|
|
59
60
|
|
|
61
|
+
传的是某一种登录方式的提交接口,换手机验证码登录只是换接口和参数:
|
|
62
|
+
|
|
60
63
|
```js
|
|
61
|
-
|
|
62
|
-
export function apiUserGet() {
|
|
63
|
-
return request('/api/safe/dplugin/user/get'); // 返回值就是 data
|
|
64
|
-
}
|
|
65
|
-
export function apiUserUpdate(data) {
|
|
66
|
-
return request('/api/safe/dplugin/user/update', data);
|
|
67
|
-
}
|
|
68
|
-
export function apiLoginPageSetting() {
|
|
69
|
-
return request('/api/unsafe/dplugin/login/page/setting', {}, {auth: false}); // 匿名接口
|
|
70
|
-
}
|
|
64
|
+
await login('/api/unsafe/dplugin/user/login/phone/submit', {phone, code});
|
|
71
65
|
```
|
|
72
66
|
|
|
73
|
-
|
|
74
|
-
提示与跳转都由业务处理(登录页无需额外配置)。
|
|
75
|
-
|
|
76
|
-
## 对外 API
|
|
77
|
-
|
|
78
|
-
| 导出 | 说明 |
|
|
79
|
-
|---|---|
|
|
80
|
-
| `setup(options)` | 初始化,见下表 |
|
|
81
|
-
| `request(api, data?, options?)` | 业务请求,返回 `data`;自动静默恢复 / 刷新 / 重试一次 |
|
|
82
|
-
| `upload(api, file, data?, options?)` | multipart 上传(签名参数在 query,文件在 body);`options.timeout` 单独放宽超时 |
|
|
83
|
-
| `login(submitApi, params)` | 完整登录流程,返回 `{loggedIn, sid, ds}` |
|
|
84
|
-
| `logout()` | 退出(access 过期会先续期再退,保证服务端会话被删) |
|
|
85
|
-
| `verifyLogin(options?)` | 页面加载时恢复登录态;`{force:true}` 强制换一次 token |
|
|
86
|
-
| `isLogin()` / `getState()` | `getState()` = `{loggedIn, hasAccess, sid, ds}`,**不暴露 access**;`isLogin()` 是本地提示(有 access 或 sid 即为 true) |
|
|
87
|
-
| `clear()` / `expire(reason?)` | 只清本地 / 清本地并跳登录页 |
|
|
88
|
-
| `auth` | 门面:`{login, logout, isLogin, getState, restore}` |
|
|
89
|
-
| `BizError` / `AuthError` / `CODE` / `isAuthError` | 错误类型与码值常量 |
|
|
90
|
-
| `store` | 登录态存储(access / sid / ds),一般不需要直接用 |
|
|
91
|
-
|
|
92
|
-
### options
|
|
93
|
-
|
|
94
|
-
| 字段 | 默认 | 说明 |
|
|
95
|
-
|---|---|---|
|
|
96
|
-
| `apiBase` | `''` | 接口前缀,`''` = 同源 |
|
|
97
|
-
| `loginUrl` | `/login/` | 仅当 `enableAuth:true` 时由 SDK 跳这里 |
|
|
98
|
-
| `enableAuth` | `false` | **默认不跳转**:会话失效只清本地 + `onLogout` + 抛 `AuthError`,提示/跳转由业务做 |
|
|
99
|
-
| `timeout` | `15000` | 请求超时(毫秒) |
|
|
100
|
-
| `pollInterval` | `2000` | 登录轮询间隔(毫秒) |
|
|
101
|
-
| `pollMax` | `5` | 登录轮询次数,用完还没成功即 `500900` |
|
|
102
|
-
| `nativeGuard` | `'warn'` | 原生能力体检:`warn` / `error` / `off` |
|
|
103
|
-
| `onError` | - | `({code, message, error})`,业务错误提示(每个业务失败都会回调一次) |
|
|
104
|
-
| `onLogin` | - | `(state)` 登录 / 静默恢复成功 |
|
|
105
|
-
| `onLogout` | - | `(reason)` 登出或会话失效 |
|
|
67
|
+
### 3. 请求接口
|
|
106
68
|
|
|
107
|
-
|
|
69
|
+
```js
|
|
70
|
+
import {request} from '@dplugin/core';
|
|
108
71
|
|
|
109
|
-
|
|
110
|
-
|
|
72
|
+
const user = await request('/api/safe/dplugin/user/get');
|
|
73
|
+
await request('/api/safe/dplugin/user/update', {nickname: 'x'});
|
|
111
74
|
|
|
75
|
+
// 不需要登录态的接口
|
|
76
|
+
const setting = await request('/api/unsafe/dplugin/login/page/setting', {}, {auth: false});
|
|
112
77
|
```
|
|
113
|
-
OP \n METHOD \n PATH \n ORIGIN(小写) \n DS \n TS(毫秒) \n SUBJECT \n DNA \n REDIRECT
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
固定 9 段,**缺失的段写 `-`**。
|
|
117
78
|
|
|
118
|
-
|
|
119
|
-
|---|---|---|---|---|---|
|
|
120
|
-
| `BIZ` | 业务接口(网关验) | 实际值 | access | `-` | domain |
|
|
121
|
-
| `VERIFY` | 临时 token 轮询换 code(login 验) | 实际值 | 临时 token | 都有 | sso |
|
|
122
|
-
| `VERIFY_SID` | 已登录用 sid 换 code(login 验) | 实际值 | sid | 都有 | sso |
|
|
123
|
-
| `TOKEN` | code 换 access(login 验) | `-` | 一次性 code | dna | domain |
|
|
79
|
+
返回值就是接口的 `data`;失败抛 `BizError`,同时触发一次 `onError`。
|
|
124
80
|
|
|
125
|
-
###
|
|
81
|
+
### 4. 上传文件
|
|
126
82
|
|
|
127
|
-
|
|
83
|
+
```js
|
|
84
|
+
import {upload} from '@dplugin/core';
|
|
128
85
|
|
|
86
|
+
await upload('/api/safe/dplugin/storage/upload', file, {bizType: 'avatar'}, {timeout: 60000});
|
|
129
87
|
```
|
|
130
|
-
|
|
88
|
+
|
|
89
|
+
### 5. 退出
|
|
90
|
+
|
|
91
|
+
```js
|
|
92
|
+
import {logout} from '@dplugin/core';
|
|
93
|
+
await logout();
|
|
131
94
|
```
|
|
132
95
|
|
|
133
|
-
|
|
134
|
-
|---|---|---|
|
|
135
|
-
| 业务 `/api/**` `/mgr/**` | URL query `dsign` | body 就是业务参数 |
|
|
136
|
-
| `logout` | URL query `dsign` | 无 body |
|
|
137
|
-
| `verify` | body `dsign` | `dna`、`redirect` |
|
|
138
|
-
| `token` | body `dsign` | `pk` |
|
|
96
|
+
## 判断登录态
|
|
139
97
|
|
|
140
|
-
|
|
98
|
+
```js
|
|
99
|
+
import {isLogin, getState, verifyLogin} from '@dplugin/core';
|
|
141
100
|
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
101
|
+
isLogin(); // 同步、不发请求
|
|
102
|
+
getState(); // {mode, loggedIn, hasAccess, sid, ds}
|
|
103
|
+
await verifyLogin(); // 可选:向服务端确认一次,返回 boolean
|
|
104
|
+
```
|
|
145
105
|
|
|
146
|
-
|
|
106
|
+
`isLogin()` 只是本地提示,不代表一定有效:
|
|
147
107
|
|
|
148
|
-
|
|
149
|
-
|
|
108
|
+
- sign:本地有凭证即为 true,过期后第一次请求会自动换新的
|
|
109
|
+
- cookie:凭证在 HttpOnly Cookie 内,脚本读不到,只代表登录过
|
|
150
110
|
|
|
151
|
-
|
|
152
|
-
所以 `text/plain` 里放 JSON 完全正常。
|
|
111
|
+
真正是否有效,以第一次 `request()` 的结果为准。
|
|
153
112
|
|
|
154
|
-
|
|
155
|
-
所以「单参数信封」放在 query 上是和「无预检」配套的设计,不是随意选的。
|
|
113
|
+
## 会话过期会自动处理
|
|
156
114
|
|
|
157
|
-
|
|
115
|
+
接口返回 `500900` 时,SDK 会自动续期一次并重发这次请求,业务侧不需要写续期逻辑:
|
|
158
116
|
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
117
|
+
```js
|
|
118
|
+
try {
|
|
119
|
+
const data = await request('/api/safe/xxx');
|
|
120
|
+
} catch (e) {
|
|
121
|
+
if (isAuthError(e)) {
|
|
122
|
+
// 需要重新登录(onLogout 已回调过)
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
```
|
|
165
126
|
|
|
166
|
-
##
|
|
127
|
+
## 配置项
|
|
167
128
|
|
|
168
|
-
|
|
|
129
|
+
| 字段 | 默认 | 说明 |
|
|
169
130
|
|---|---|---|
|
|
170
|
-
| `
|
|
171
|
-
| `
|
|
172
|
-
| `
|
|
173
|
-
| `
|
|
174
|
-
| `
|
|
175
|
-
| `
|
|
176
|
-
| `
|
|
177
|
-
|
|
178
|
-
|
|
131
|
+
| `apiBase` | `''` | 接口前缀,`''` 表示同源 |
|
|
132
|
+
| `mode` | `'auto'` | `'auto'` / `'cookie'` / `'sign'` |
|
|
133
|
+
| `loginUrl` | `'/login/'` | 仅在 `enableAuth: true` 时用于跳转 |
|
|
134
|
+
| `enableAuth` | `false` | 默认不跳转:失效只回调 `onLogout` 并抛 `AuthError` |
|
|
135
|
+
| `timeout` | `15000` | 请求超时(毫秒) |
|
|
136
|
+
| `pollInterval` | `2000` | 登录轮询间隔(毫秒) |
|
|
137
|
+
| `pollMax` | `5` | 登录轮询次数 |
|
|
138
|
+
| `nativeGuard` | `'warn'` | 浏览器能力自检:`warn` / `error` / `off` |
|
|
139
|
+
| `onError` | - | `({code, message, error})` |
|
|
140
|
+
| `onLogin` | - | `(state)` |
|
|
141
|
+
| `onLogout` | - | `(reason)`,`'logout'` 或 `'expired'` |
|
|
179
142
|
|
|
180
|
-
##
|
|
143
|
+
## API
|
|
181
144
|
|
|
182
|
-
|
|
|
183
|
-
|---|---|---|
|
|
184
|
-
| `access` | localStorage `dplugin.access` | 业务接口信封的 SUBJECT,30 分钟 |
|
|
185
|
-
| `sid` | localStorage `dplugin.sid` | 页面刷新后用来自动恢复登录态 |
|
|
186
|
-
| `ds` | localStorage `dplugin.ds` | 设备凭证,服务端下发,**不要自己生成**;退出登录**不清**它(设备不是会话) |
|
|
187
|
-
| `exp` | localStorage `dplugin.exp` | access 到期时间,仅用于本地展示/判断 |
|
|
188
|
-
| sso 私钥 | IndexedDB `dplugin-auth/keys.sso` | 签 `verify` 的 sid 分支 |
|
|
189
|
-
| 域私钥 | IndexedDB `dplugin-auth/keys.domain` | 签所有业务请求 |
|
|
190
|
-
|
|
191
|
-
- 私钥 `extractable = false`,只能以 CryptoKey 形式存在 IndexedDB,JS 导不出原始字节。
|
|
192
|
-
- 每次登录重新生成 sso 密钥,每次换 token 重新生成域密钥(多账号不会串)。
|
|
193
|
-
- 清过 IndexedDB 后:业务请求会检测到缺私钥 → 用 `sid` 强制换一次 token(自愈);连 `sid` 都没了才回登录页。
|
|
194
|
-
|
|
195
|
-
## 行为约定(多标签页 / 失败回滚)
|
|
196
|
-
|
|
197
|
-
1. **同一页面内续期单飞**:N 个并发 500900 只发一次 VERIFY_SID,其余复用同一结果。
|
|
198
|
-
2. **跨标签页续期**:`/s/token` 有按 sso 的锁,A 标签页抢到时 B 会拿到 `500 重复请求`;
|
|
199
|
-
SDK 不会把自己登出,而是等 A 把新 access 写进 localStorage(最多 1.2 秒)后直接采用。
|
|
200
|
-
3. **登录失败会回滚密钥**:`login()` 会先生成新的 sso/domain 密钥,失败(密码错、轮询超时)
|
|
201
|
-
会把上一个会话的密钥写回去,避免"输错一次密码"把已有会话的私钥冲掉。
|
|
202
|
-
4. **`isLogin()` 只是提示**:access 过期但 sid 还在时它仍返回 true,第一次 `request()` 会自动
|
|
203
|
-
用 sid 静默换回 access;两条路都断了才跳登录页。
|
|
204
|
-
|
|
205
|
-
## 已知取舍(有意为之,不是待办)
|
|
206
|
-
|
|
207
|
-
| 取舍 | 原因 |
|
|
145
|
+
| 导出 | 说明 |
|
|
208
146
|
|---|---|
|
|
209
|
-
|
|
|
210
|
-
|
|
|
211
|
-
| `
|
|
212
|
-
|
|
|
213
|
-
|
|
|
214
|
-
|
|
|
147
|
+
| `setup(options)` | 初始化 |
|
|
148
|
+
| `login(submitApi, params)` | 登录,返回 `Promise<state>` |
|
|
149
|
+
| `logout()` | 退出 |
|
|
150
|
+
| `request(api, data?, options?)` | 请求接口,返回 `data` |
|
|
151
|
+
| `upload(api, file, data?, options?)` | 上传文件 |
|
|
152
|
+
| `isLogin()` | 本地登录态(同步) |
|
|
153
|
+
| `getState()` | `{mode, loggedIn, hasAccess, sid, ds}` |
|
|
154
|
+
| `verifyLogin({force?})` | 向服务端确认登录态 |
|
|
155
|
+
| `getMode()` | 当前模式 |
|
|
156
|
+
| `clear()` | 只清本地状态 |
|
|
157
|
+
| `expire(reason?)` | 判定失效:清本地 + 回调(可选跳转) |
|
|
158
|
+
| `auth` | `{login, logout, isLogin, getState, restore}` |
|
|
159
|
+
| `BizError` / `AuthError` / `CODE` / `isAuthError` | 错误类型与码值 |
|
|
160
|
+
|
|
161
|
+
续期由 SDK 内部处理,`refresh` 不对外导出。
|
|
162
|
+
|
|
163
|
+
## 错误码
|
|
164
|
+
|
|
165
|
+
| code | 含义 | SDK 行为 |
|
|
166
|
+
|---|---|---|
|
|
167
|
+
| `200` | 成功 | 返回 `data` |
|
|
168
|
+
| `202` | 登录中 | 自动轮询,业务不用管 |
|
|
169
|
+
| `500900` | 登录态失效 | 自动续期一次并重发;仍失败抛 `AuthError` 并触发 `onLogout('expired')` |
|
|
170
|
+
| `500` | 业务错误(如密码错误、重复提交) | 抛 `BizError` + `onError`,不登出 |
|
|
171
|
+
| `401001` | 没有权限 | 抛 `BizError`,登录态仍有效 |
|
|
172
|
+
| `403` | 来源不被允许 | 抛 `BizError` |
|
|
173
|
+
| `404` | 接口不存在 | 抛 `BizError` |
|
|
174
|
+
| `NETWORK` / `TIMEOUT` | 网络异常 / 超时 | 抛 `BizError`,不登出 |
|
|
175
|
+
|
|
176
|
+
```js
|
|
177
|
+
import {BizError, isAuthError} from '@dplugin/core';
|
|
215
178
|
|
|
216
|
-
|
|
179
|
+
try {
|
|
180
|
+
await request('/api/safe/xxx');
|
|
181
|
+
} catch (e) {
|
|
182
|
+
if (isAuthError(e)) { /* 重新登录 */ }
|
|
183
|
+
else if (e instanceof BizError) { /* e.code / e.message */ }
|
|
184
|
+
}
|
|
185
|
+
```
|
|
217
186
|
|
|
218
|
-
|
|
219
|
-
1. 把 `fetch`、`indexedDB.open`、`crypto.subtle.{generateKey,exportKey,importKey,sign,verify,digest}`
|
|
220
|
-
绑定成局部引用 —— 之后页面再替换全局,也影响不到 SDK;
|
|
221
|
-
2. 顺手给这份引用做**指纹校验**,`setup()` 时报告(`nativeGuard: 'warn' | 'error' | 'off'`)。
|
|
187
|
+
## 常见问题
|
|
222
188
|
|
|
223
|
-
|
|
189
|
+
**报「crypto.subtle 不存在」**
|
|
224
190
|
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
| 原生 | `[]` | `function fetch() { [native code] }` |
|
|
228
|
-
| JS 包装(转发原生) | `["fetch"]` | 源码变成 `async function fetch(input, init) {…}` |
|
|
229
|
-
| **Proxy 包原生** | `["fetch"]` | Proxy 的源码是 `function () { [native code] }` —— **没有函数名** |
|
|
230
|
-
| 自造 fetch(不校验参数) | `["fetch"]` | 源码里没有 `[native code]` |
|
|
231
|
-
| `indexedDB.open` 被包 | `["indexedDB.open"]` | 源码形态 + **无参调用必须同步抛缺参数 TypeError** |
|
|
232
|
-
| 全部还原 | `[]` | - |
|
|
233
|
-
|
|
234
|
-
关键细节(实测踩出来的):
|
|
235
|
-
- **`fetch()` 无参在 Chrome 里是返回 rejected promise,不是同步抛**。所以 fetch 只用「源码形态」
|
|
236
|
-
判,不能做同步异常指纹,否则会把原生误报成被替换。
|
|
237
|
-
- `indexedDB.open()` 是同步 WebIDL 方法,无参会同步抛
|
|
238
|
-
`TypeError: Failed to execute 'open' on 'IDBFactory': 1 argument required…`,
|
|
239
|
-
所以它额外多一道异常指纹。`crypto.subtle.*` 同理是异步 reject,只比源码。
|
|
240
|
-
- 检测只对浏览器生效:Node / SSR 里 fetch、subtle 本身就是 JS 实现,必然误报。
|
|
241
|
-
|
|
242
|
-
**挡不住的**:在本模块加载之前就用 Proxy 冒充并同步伪造 `name` / 源码,或者干脆接管整个 `window`
|
|
243
|
-
(同源 XSS)。同源脚本本来就能自己开 IndexedDB、读 localStorage,patch 只是省事,所以这里是
|
|
244
|
-
「提高门槛」,真正的边界是:私钥不可导出 + 签名绑路径/设备/时间/token + 网关 lockSign + 30 分钟 TTL。
|
|
245
|
-
|
|
246
|
-
> 要更硬的隔离只有换 realm:一次性 same-origin iframe(或 Worker)取 `contentWindow.fetch` /
|
|
247
|
-
> `contentWindow.indexedDB.open`,页面对主 realm 的 patch 影响不到它。代价:CSP 放行 `frame-src`、
|
|
248
|
-
> iframe 生命周期、跨 realm 传对象。默认没做。
|
|
249
|
-
|
|
250
|
-
浏览器自检页:`test/native-check.html`(起静态服务打开,逐项替换 → 看返回)。
|
|
251
|
-
|
|
252
|
-
## 部署要求
|
|
253
|
-
|
|
254
|
-
1. **必须 https 或 localhost**:`crypto.subtle` 在非安全上下文不存在,SDK 会直接抛错。
|
|
255
|
-
2. **登录页和应用必须同源**(同 scheme+host+port):
|
|
256
|
-
- `localStorage` / `IndexedDB` 不跨源,跨子域登录拿不到会话;
|
|
257
|
-
- 后端 `sso.domain` 取的是登录时的 Origin 主机名(不是可注册域),所以每个子域各自登录。
|
|
258
|
-
把登录页放在 `login.xxx.com`、应用在 `app.xxx.com`,会变成「登录成功 → 跳应用 → 没会话 → 回登录页」的死循环。
|
|
259
|
-
3. **网关 CORS 白名单**要包含前端的 origin(`dplugin.cors.allowed_origins`)。
|
|
260
|
-
4. **登录相关接口必须在 api 表登记**(网关 `AuthFilter` 查不到就 404)。
|
|
261
|
-
5. 反向代理不要改写 `/api/**` 的路径和 query —— `dsignn` 的签名原文包含路径。
|
|
262
|
-
|
|
263
|
-
## 与旧版的差异(迁移清单)
|
|
264
|
-
|
|
265
|
-
| 旧 | 新 |
|
|
266
|
-
|---|---|
|
|
267
|
-
| `request(api, {data, loading, noToken})` | `request(api, data, options)` |
|
|
268
|
-
| `auth.setAuthData(data)` | 不需要,`login()` 内部落库 |
|
|
269
|
-
| `auth.jump(token)` / `jumpGenerate()` | **删除**(后端 jump 接口已删) |
|
|
270
|
-
| `setup({publicKey})` | 不需要(改用 WebCrypto 每次生成) |
|
|
271
|
-
| `onError(data)` | `onError({code, message, error})`,签名兼容 |
|
|
272
|
-
| 页面里 `localStorage.token` | `store.access`(键名 `dplugin.access`) |
|
|
273
|
-
| `utils/device.js` 里的 `platform` 依赖 | SDK 内置 `deviceInfo()`,`login()` 自动带 |
|
|
191
|
+
sign 模式依赖 WebCrypto,它只在安全上下文里存在:`https://`、`file://`、`http://localhost`、`http://127.0.0.1`。
|
|
192
|
+
用内网 IP(`http://192.168.x.x`)调试时拿不到,换 localhost 或本地 https 即可。cookie 模式不受影响。
|
|
274
193
|
|
|
275
|
-
|
|
194
|
+
**跨源时请求变慢**
|
|
276
195
|
|
|
277
|
-
|
|
278
|
-
npm run build # index.mjs(ESM) + index.umd.js(UMD/DPluginCore) + index.cjs(CJS)
|
|
279
|
-
npm test # 流程自检(mock fetch,25 次请求 / 7 个场景)
|
|
280
|
-
```
|
|
196
|
+
SDK 发的是 CORS「简单请求」,不会触发 OPTIONS 预检。业务侧不要给这些请求额外加自定义请求头,否则预检又回来了。
|
|
281
197
|
|
|
282
|
-
|
|
198
|
+
**`a.com` 调用 `api.a.com` 用哪个模式**
|
|
283
199
|
|
|
284
|
-
|
|
200
|
+
sign。同源要求协议、主机、端口完全一致。
|
|
285
201
|
|
|
286
|
-
|
|
202
|
+
**退出后 Cookie 还在**
|
|
287
203
|
|
|
288
|
-
|
|
289
|
-
node test/interop.mjs # 输出 {pk, text, sign}
|
|
290
|
-
```
|
|
204
|
+
不要手动清。退出接口负责清理,脚本自己清会留下无效会话。
|
|
291
205
|
|
|
292
|
-
|
|
206
|
+
**登录成功、跳转后却没有登录态**
|
|
293
207
|
|
|
294
|
-
|
|
295
|
-
python3 -m http.server 8765 --bind 127.0.0.1 # 在本目录起静态服务
|
|
296
|
-
# 打开 http://127.0.0.1:8765/test/browser.html → 生成并写入 IndexedDB
|
|
297
|
-
# 开一个新标签页 .../test/browser.html#read → 从 IndexedDB 读回并签名
|
|
298
|
-
# 两边 pk 必须一致、extractable 必须为 false
|
|
299
|
-
```
|
|
208
|
+
登录页与应用必须在同一个 origin。放在两个不同域名下,浏览器存储不共享,会形成「登录 → 跳转 → 无会话 → 回登录页」。
|
|
300
209
|
|
|
301
|
-
|
|
210
|
+
## 环境要求
|
|
302
211
|
|
|
303
|
-
|
|
304
|
-
|
|
212
|
+
1. sign 模式需要 `https` 或 `localhost`(WebCrypto 的要求)。
|
|
213
|
+
2. cookie 模式要求页面与接口同源。
|
|
214
|
+
3. 跨源部署时,接口侧需允许该页面的 origin(CORS)。
|
|
215
|
+
4. 反向代理不要改写接口路径和查询参数。
|
|
305
216
|
|
|
306
|
-
|
|
307
|
-
public static void main(String[] a) {
|
|
308
|
-
System.out.println(EcdsaUtils.verify(a[0], a[1], a[2]) ? "VERIFY_OK" : "VERIFY_FAIL");
|
|
309
|
-
}
|
|
310
|
-
}
|
|
311
|
-
```
|
|
217
|
+
## 开发
|
|
312
218
|
|
|
313
219
|
```bash
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
220
|
+
npm install
|
|
221
|
+
npm run build # dist/index.mjs + index.cjs + index.umd.js
|
|
222
|
+
npm test
|
|
317
223
|
```
|
|
224
|
+
|
|
225
|
+
## License
|
|
226
|
+
|
|
227
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dplugin/core",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.2",
|
|
4
4
|
"description": "DPlugin 前端登录与请求 SDK(同域 Cookie + 跨域 ECDSA 双模式)",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -34,14 +34,6 @@
|
|
|
34
34
|
"engines": {
|
|
35
35
|
"node": ">=18"
|
|
36
36
|
},
|
|
37
|
-
"repository": {
|
|
38
|
-
"type": "git",
|
|
39
|
-
"url": "git+https://github.com/dplugin/dplugin-login.git"
|
|
40
|
-
},
|
|
41
|
-
"homepage": "https://github.com/dplugin/dplugin-login/tree/main/dplugin-login-umdjs-core",
|
|
42
|
-
"bugs": {
|
|
43
|
-
"url": "https://github.com/dplugin/dplugin-login/issues"
|
|
44
|
-
},
|
|
45
37
|
"publishConfig": {
|
|
46
38
|
"access": "public"
|
|
47
39
|
},
|