safeStorage

允许访问简单的字符串加密和解密，用于在本地机器上存储。

进程：主进程

此模块通过使用操作系统提供的加密系统，为存储在磁盘上的数据添加额外保护。下面概述了每个平台的当前安全语义。

• macOS：加密密钥存储在应用的 Keychain Access 中，其方式可以防止其他应用程序在没有用户覆盖的情况下加载它们。因此，内容受到保护，不会被同一用户空间中的其他用户和其他应用访问。
• Windows：加密密钥通过 DPAPI 生成。根据 Windows 文档：“通常，只有与加密数据的用户拥有相同登录凭据的用户才能解密数据”。因此，内容受到保护，不会被同一台机器上的其他用户访问，但不能防止同一用户空间中运行的其他应用访问。
• Linux：加密密钥在密钥存储中生成和存储，具体取决于你的窗口管理器和系统设置。当前支持的选项包括 kwallet、kwallet5、kwallet6 和 gnome-libsecret，但未来版本的 Electron 中可能会提供更多选项。因此，通过 safeStorage API 保护的内容的安全语义在不同的窗口管理器和密钥存储之间有所不同。
  • 请注意，并非所有 Linux 设置都提供可用的密钥存储。如果密钥存储不可用，使用 safeStorage API 存储的项目将不受保护，因为它们是通过硬编码的明文密码加密的。当 safeStorage.getSelectedStorageBackend() 返回 basic_text 时，可以检测到这种情况。

请注意，在 Mac 上，需要访问系统 Keychain，并且这些调用可能会阻塞当前线程以收集用户输入。对于 Linux 也是如此，如果提供了密码管理工具的话。

方法

safeStorage 模块具有以下方法

safeStorage.isEncryptionAvailable()

返回 boolean - 加密是否可用。

在 Linux 上，如果应用程序发出了 ready 事件且密钥可用，则返回 true。在 MacOS 上，如果 Keychain 可用，则返回 true。在 Windows 上，一旦应用程序发出了 ready 事件，则返回 true。

safeStorage.encryptString(plainText)

• plainText string

返回 Buffer - 表示加密字符串的字节数组。

如果加密失败，此函数将抛出错误。

safeStorage.decryptString(encrypted)

• encrypted Buffer

返回 string - 解密的字符串。将使用 safeStorage.encryptString 获得的加密 Buffer 解密回字符串。

如果解密失败，此函数将抛出错误。

safeStorage.setUsePlainTextEncryption(usePlainText)

• usePlainText boolean

在 Linux 上，当无法确定当前活动桌面环境的有效操作系统密码管理器时，此函数将强制模块使用内存中的密码来创建用于加密/解密对称密钥。此函数在 Windows 和 MacOS 上是空操作 (no-op)。

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 事件之前调用此函数时。