Skip to content

An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作

:bug: Synchronize encrypted notebook system lock settings https://github.com/siyuan-note/siyuan/issues/20419

Daniel151d3e997835
diff --git a/app/src/config/setting/sync.test.ts b/app/src/config/setting/sync.test.ts
index b071a1ea81..91a130f9e4 100644
--- a/app/src/config/setting/sync.test.ts
+++ b/app/src/config/setting/sync.test.ts
@@ -250,9 +250,9 @@ for (const mobile of [false, true]) {
{MOBILE: mobile, BROWSER: mobile}, false, true), {
compilerOptions: {module: ModuleKind.CommonJS, target: ScriptTarget.ES2021},
}).outputText;
- const config = {system: {autoLaunch2: 0}, api: {token: "old-token"}, oidc: {enabled: false, clientSecret: "old"},
+ const config = {system: {autoLaunch2: 0, encryptedNotebookFollowSystemLock: false}, api: {token: "old-token"}, oidc: {enabled: false, clientSecret: "old"},
accessAuthCode: "old-mask", editor: {}, appearance: {}, keymap: {}, ai: {}, sync: {enabled: true}};
- let next = {...config, system: {autoLaunch2: 1}, api: {token: "new-token"},
+ let next = {...config, system: {autoLaunch2: 1, encryptedNotebookFollowSystemLock: false}, api: {token: "new-token"},
oidc: {enabled: true, clientSecret: "******"}, accessAuthCode: "******"};
let failed = false;
const remounted: string[] = [];
@@ -275,6 +275,11 @@ for (const mobile of [false, true]) {
await exports.refreshSettingConfig("system");
assert.deepEqual(remounted, mobile ? [] : ["app"]);
remounted.length = 0;
+ next = {...next, system: {...next.system, encryptedNotebookFollowSystemLock: true}};
+ await exports.refreshSettingConfig("system");
+ assert.equal(config.system.encryptedNotebookFollowSystemLock, true);
+ assert.deepEqual(remounted, mobile ? [] : ["app", "access"]);
+ remounted.length = 0;
next = {...next, api: {token: "latest-token"}};
await exports.refreshSettingConfig();
assert.equal(config.api.token, "latest-token");
diff --git a/app/src/config/setting/sync.ts b/app/src/config/setting/sync.ts
index cbe71eee2b..bad7b9c414 100644
--- a/app/src/config/setting/sync.ts
+++ b/app/src/config/setting/sync.ts
@@ -68,6 +68,8 @@ export const refreshSettingConfig = (namespace = "*"): Promise<void> => {
}
let accessChanged = false;
if (includes("system")) {
+ accessChanged = window.siyuan.config.system?.encryptedNotebookFollowSystemLock !==
+ next.system?.encryptedNotebookFollowSystemLock;
// 系统设置通知同时同步访问授权的顶层配置,值以内核返回的脱敏配置为准。
for (const key of ["api", "oidc", "accessAuthCode"] as const) {
accessChanged ||= !objEquals(window.siyuan.config[key], next[key]);
diff --git a/app/src/config/tabs/accessTab.test.ts b/app/src/config/tabs/accessTab.test.ts
index 606a62d09e..76adfac873 100644
--- a/app/src/config/tabs/accessTab.test.ts
+++ b/app/src/config/tabs/accessTab.test.ts
@@ -20,17 +20,22 @@ test("encrypted notebook system lock is offered only for supported local desktop
] as const) {
const switches: Array<{id: string, save: (value: unknown) => void}> = [];
const requests: Array<{url: string, enabled: boolean}> = [];
+ const system = {os, encryptedNotebookFollowSystemLock: false};
+ let confirmSave: () => void;
const dependencies = {
isBrowser: () => browser,
isMobile: () => mobile,
getHostCapabilities: () => ({ownsKernel, importExport: ownsKernel}),
- fetchPost: (url: string, data: {enabled: boolean}) => requests.push({url, enabled: data.enabled}),
+ fetchPost: (url: string, data: {enabled: boolean}, callback: () => void) => {
+ requests.push({url, enabled: data.enabled});
+ confirmSave = callback;
+ },
};
const exports = {} as {registerEncryptedNotebookGroup: (tab: unknown) => void};
runInNewContext(compiled, {
exports,
require: () => dependencies,
- window: {siyuan: {config: {readonly: false, system: {os}}, languages: {}}},
+ window: {siyuan: {config: {readonly: false, system}, languages: {}}},
});
exports.registerEncryptedNotebookGroup({group: () => ({
slot: () => {},
@@ -42,7 +47,13 @@ test("encrypted notebook system lock is offered only for supported local desktop
if (expected) {
assert.equal(switches[0].id, "system.encryptedNotebookFollowSystemLock");
switches[0].save(true);
+ assert.equal(system.encryptedNotebookFollowSystemLock, false);
+ confirmSave();
+ assert.equal(system.encryptedNotebookFollowSystemLock, true);
switches[0].save(false);
+ assert.equal(system.encryptedNotebookFollowSystemLock, true);
+ confirmSave();
+ assert.equal(system.encryptedNotebookFollowSystemLock, false);
switches[0].save("true");
assert.deepEqual(requests, [
{url: "/api/notebook/setEncryptedNotebookFollowSystemLock", enabled: true},
diff --git a/app/src/config/tabs/accessTab.ts b/app/src/config/tabs/accessTab.ts
index 9c3bfd03b6..d082abab48 100644
--- a/app/src/config/tabs/accessTab.ts
+++ b/app/src/config/tabs/accessTab.ts
@@ -791,7 +791,9 @@ const registerEncryptedNotebookGroup = (tab: SettingTabBuilder) => {
desc: window.siyuan.languages.encryptedNotebookFollowSystemLockDesc,
save: (value) => {
if (typeof value === "boolean") {
- fetchPost("/api/notebook/setEncryptedNotebookFollowSystemLock", {enabled: value});
+ fetchPost("/api/notebook/setEncryptedNotebookFollowSystemLock", {enabled: value}, () => {
+ window.siyuan.config.system.encryptedNotebookFollowSystemLock = value;
+ });
}
},
});
diff --git a/app/src/types/api/index.d.ts b/app/src/types/api/index.d.ts
index 1a90c9b78d..0eac2e39b1 100644
--- a/app/src/types/api/index.d.ts
+++ b/app/src/types/api/index.d.ts
@@ -5834,6 +5834,9 @@ export interface APIPOSTRoutes {
/** 服务器路由要求;资源权限与笔记本租约仍由内核校验 */
authorization?: readonly ["authenticated","admin","writable"];
};
+ /**
+ * 保存本机加密笔记本锁屏策略,成功后广播 system 设置变更通知,供其他客户端重新读取配置。
+ */
"/api/notebook/setEncryptedNotebookFollowSystemLock": {
request: EncryptedNotebookFollowSystemLockRequestInput;
response: { "code": 0; "data": null; "msg": string; } | { "code": -1; "data": { "closeTimeout": number; } | null; "msg": string; };
diff --git a/kernel/api/contract_notebook_system_lock_test.go b/kernel/api/contract_notebook_system_lock_test.go
index a584940c65..2f5fc24e35 100644
--- a/kernel/api/contract_notebook_system_lock_test.go
+++ b/kernel/api/contract_notebook_system_lock_test.go
@@ -4,6 +4,7 @@ import (
"bytes"
"context"
"encoding/json"
+ "fmt"
"net/http"
"net/http/httptest"
"os"
@@ -186,3 +187,37 @@ func TestAPIContractNotebookSystemLock(t *testing.T) {
}
model.Unmount(boxIDs[0])
}
+
+func TestAPIContractNotebookSystemLockNotifications(t *testing.T) {
+ setupAssetContractWorkspace(t)
+ model.Conf.System = conf.NewSystem()
+ previousConfDir := util.ConfDir
+ util.ConfDir = t.TempDir()
+ t.Cleanup(func() { util.ConfDir = previousConfDir })
+ engine := gin.New()
+ path := "/api/notebook/setEncryptedNotebookFollowSystemLock"
+ engine.POST(path, setEncryptedNotebookFollowSystemLock)
+ connection := connectOCRNotifications(t, engine)
+ for _, enabled := range []bool{true, false} {
+ recorder := httptest.NewRecorder()
+ engine.ServeHTTP(recorder, httptest.NewRequest("POST", path, strings.NewReader(fmt.Sprintf(`{"enabled":%t}`, enabled))))
+ requireAPIContract(t, "POST", path, recorder)
+ var response struct{ Code int }
+ if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil || response.Code != 0 || model.Conf.System.EncryptedNotebookFollowSystemLock != enabled {
+ t.Fatalf("system lock update failed: %s, %v", recorder.Body.String(), err)
+ }
+ if err := connection.SetReadDeadline(time.Now().Add(5 * time.Second)); err != nil {
+ t.Fatal(err)
+ }
+ var event struct {
+ Cmd string
+ Data struct{ Namespace string }
+ }
+ if err := connection.ReadJSON(&event); err != nil {
+ t.Fatal(err)
+ }
+ if event.Cmd != "settingChanged" || event.Data.Namespace != "system" {
+ t.Fatalf("system lock update notification: %+v", event)
+ }
+ }
+}
diff --git a/kernel/api/setting_patch.go b/kernel/api/setting_patch.go
index ad37af3527..b13b920ce4 100644
--- a/kernel/api/setting_patch.go
+++ b/kernel/api/setting_patch.go
@@ -67,6 +67,7 @@ func additionalSettingNamespace(path string) string {
case "/api/system/importConf":
return "*"
case "/api/system/setAutoLaunch", "/api/system/setFollowSystemLockScreen",
+ "/api/notebook/setEncryptedNotebookFollowSystemLock",
"/api/system/setDownloadInstallPkg", "/api/system/setSettingsWindow", "/api/system/setUpdateChannel",
"/api/system/setNetworkProxy", "/api/system/setAPIToken", "/api/system/setAccessAuthCode", "/api/system/setOIDC":
return "system"
diff --git a/kernel/apicontract/contracts.go b/kernel/apicontract/contracts.go
index 8301db45c5..58f99c2906 100644
--- a/kernel/apicontract/contracts.go
+++ b/kernel/apicontract/contracts.go
@@ -344,12 +344,13 @@ var (
)
var (
- EnableEncryptedNotebooks = define[NotebookPasswordRequest, Null]("enableEncryptedNotebooks", "/api/notebook/enableEncryptedNotebooks", AuthenticatedAccess|AdminAccess|WritableAccess, JSONBody, ResponseOptions{}, "POST")
- DisableEncryptedNotebooks = define[EmptyRequest, Null]("disableEncryptedNotebooks", "/api/notebook/disableEncryptedNotebooks", AuthenticatedAccess|AdminAccess|WritableAccess, NoBody, ResponseOptions{}, "POST")
- CreateEncryptedNotebook = define[CreateEncryptedNotebookRequest, CreateNotebookData]("createEncryptedNotebook", "/api/notebook/createEncryptedNotebook", AuthenticatedAccess|AdminAccess|WritableAccess, JSONBody, ResponseOptions{}, "POST")
- UnlockNotebook = define[UnlockNotebookRequest, Null]("unlockNotebook", "/api/notebook/unlockNotebook", AuthenticatedAccess|AdminAccess, JSONBody, ResponseOptions{}, "POST")
- UnlockAndOpenNotebook = define[UnlockNotebookRequest, Null]("unlockAndOpenNotebook", "/api/notebook/unlockAndOpenNotebook", AuthenticatedAccess|AdminAccess|WritableAccess, JSONBody, ResponseOptions{}, "POST")
- LockNotebook = define[NotebookIDRequest, Null]("lockNotebook", "/api/notebook/lockNotebook", AuthenticatedAccess|AdminAccess|WritableAccess, JSONBody, ResponseOptions{}, "POST")
+ EnableEncryptedNotebooks = define[NotebookPasswordRequest, Null]("enableEncryptedNotebooks", "/api/notebook/enableEncryptedNotebooks", AuthenticatedAccess|AdminAccess|WritableAccess, JSONBody, ResponseOptions{}, "POST")
+ DisableEncryptedNotebooks = define[EmptyRequest, Null]("disableEncryptedNotebooks", "/api/notebook/disableEncryptedNotebooks", AuthenticatedAccess|AdminAccess|WritableAccess, NoBody, ResponseOptions{}, "POST")
+ CreateEncryptedNotebook = define[CreateEncryptedNotebookRequest, CreateNotebookData]("createEncryptedNotebook", "/api/notebook/createEncryptedNotebook", AuthenticatedAccess|AdminAccess|WritableAccess, JSONBody, ResponseOptions{}, "POST")
+ UnlockNotebook = define[UnlockNotebookRequest, Null]("unlockNotebook", "/api/notebook/unlockNotebook", AuthenticatedAccess|AdminAccess, JSONBody, ResponseOptions{}, "POST")
+ UnlockAndOpenNotebook = define[UnlockNotebookRequest, Null]("unlockAndOpenNotebook", "/api/notebook/unlockAndOpenNotebook", AuthenticatedAccess|AdminAccess|WritableAccess, JSONBody, ResponseOptions{}, "POST")
+ LockNotebook = define[NotebookIDRequest, Null]("lockNotebook", "/api/notebook/lockNotebook", AuthenticatedAccess|AdminAccess|WritableAccess, JSONBody, ResponseOptions{}, "POST")
+ // 保存本机加密笔记本锁屏策略,成功后广播 system 设置变更通知,供其他客户端重新读取配置。
SetEncryptedNotebookFollowSystemLock = define[EncryptedNotebookFollowSystemLockRequest, Null]("setEncryptedNotebookFollowSystemLock", "/api/notebook/setEncryptedNotebookFollowSystemLock", AuthenticatedAccess|AdminAccess|WritableAccess, JSONBody, ResponseOptions{}, "POST")
LockEncryptedNotebooksOnSystemLock = define[EmptyRequest, Null]("lockEncryptedNotebooksOnSystemLock", "/api/notebook/lockEncryptedNotebooksOnSystemLock", AuthenticatedAccess|AdminAccess|WritableAccess, JSONBody, ResponseOptions{}, "POST")
SetNotebookCryptoAutoLock = define[NotebookCryptoAutoLockRequest, Null]("setNotebookCryptoAutoLock", "/api/notebook/setNotebookCryptoAutoLock", AuthenticatedAccess|AdminAccess|WritableAccess, JSONBody, ResponseOptions{}, "POST")