safeStorage
允许访问字符串的简单加密和解密,以便在本地机器上存储。
进程: 主进程
此模块通过使用操作系统提供的加密系统,为存储在磁盘上的数据增加额外的保护。下面概述了每个平台的当前安全语义。
- macOS: 加密密钥存储在您的应用程序的 Keychain Access 中,以防止其他应用程序在没有用户覆盖的情况下加载它们。因此,内容受到同一用户空间中的其他用户和其他应用程序的保护。
- Windows: 加密密钥通过 DPAPI 生成。根据 Windows 文档:“通常,只有与加密数据的用户具有相同登录凭据的用户才能解密数据”。因此,内容受到同一机器上的其他用户的保护,但不受同一用户空间中运行的其他应用程序的保护。
- Linux: 加密密钥在密钥存储中生成和存储,该密钥存储因您的窗口管理器和系统设置而异。当前支持的选项是
kwallet
、kwallet5
、kwallet6
和gnome-libsecret
,但 Electron 的未来版本可能会提供更多选项。因此,通过safeStorage
API 保护的内容的安全语义在窗口管理器和密钥存储之间有所不同。- 请注意,并非所有 Linux 设置都有可用的密钥存储。如果没有可用的密钥存储,则使用
safeStorage
API 存储的项目将不受保护,因为它们是通过硬编码的明文密码加密的。当safeStorage.getSelectedStorageBackend()
返回basic_text
时,您可以检测到这种情况。
- 请注意,并非所有 Linux 设置都有可用的密钥存储。如果没有可用的密钥存储,则使用
请注意,在 Mac 上,需要访问系统 Keychain,并且这些调用可能会阻塞当前线程以收集用户输入。对于 Linux 也是如此,如果密码管理工具可用。
方法
safeStorage
模块具有以下方法
safeStorage.isEncryptionAvailable()
返回 boolean
- 加密是否可用。
在 Linux 上,如果应用程序已发出 ready
事件并且密钥可用,则返回 true。在 MacOS 上,如果 Keychain 可用,则返回 true。在 Windows 上,一旦应用程序发出 ready
事件,则返回 true。
safeStorage.encryptString(plainText)
plainText
字符串
返回 Buffer
- 表示加密字符串的字节数组。
如果加密失败,此函数将抛出错误。
safeStorage.decryptString(encrypted)
encrypted
Buffer
返回 string
- 解密后的字符串。将使用 safeStorage.encryptString
获取的加密缓冲区解密回字符串。
如果解密失败,此函数将抛出错误。
safeStorage.setUsePlainTextEncryption(usePlainText)
usePlainText
boolean
在 Linux 上,当无法为当前活动的桌面环境确定有效的操作系统密码管理器时,此函数将强制模块使用内存密码来创建用于加密/解密功能的对称密钥。此函数在 Windows 和 MacOS 上不起作用。
safeStorage.getSelectedStorageBackend()
Linux
返回 string
- Linux 上选定的密码管理器的用户友好名称。
此函数将返回以下值之一
basic_text
- 当桌面环境无法识别或提供以下命令行标志--password-store="basic"
时。gnome_libsecret
- 当桌面环境为X-Cinnamon
、Deepin
、GNOME
、Pantheon
、XFCE
、UKUI
、unity
或提供以下命令行标志--password-store="gnome-libsecret"
时。kwallet
- 当桌面会话为kde4
或提供以下命令行标志--password-store="kwallet"
时。kwallet5
- 当桌面会话为kde5
或提供以下命令行标志--password-store="kwallet5"
时。kwallet6
- 当桌面会话为kde6
时。unknown
- 当在应用程序发出ready
事件之前调用该函数时。