跳至主要内容

safeStorage

允许访问本地机器上字符串的简单加密和解密以进行存储。

进程：主进程

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

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

请注意，在 Mac 上，需要访问系统密钥链，并且这些调用可能会阻塞当前线程以收集用户输入。如果密码管理工具可用，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 布尔值

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