Aller au contenu principal

safeStorage

Permet d'accéder à des cryptage et décryptage simples de chaînes de caractères pour le stockage sur la machine locale.

Process: Main

Ce module ajoute une protection supplémentaire aux données stockées sur disque en utilisant des systèmes de cryptographie fournis par le système d'exploitation. La sémantique de sécurité actuelle pour chaque plate-forme est décrite ci-dessous.

  • macOS : les clés de chiffrement sont stockées pour votre application selon Keychain Access de manière à empêcher d’autres applications de les charger sans outrepasser les droits de l’utilisateur. Par conséquent, le contenu est protégé contre d’autres utilisateurs et d’autres applications fonctionnant dans le même espace utilisateur.
  • Windows : les clés de chiffrement sont générées via DPAPI. Selon la documentation de Windows : "Typiquement, seul un utilisateur avec le même identifiant de connexion que l’utilisateur qui a chiffré les données peut déchiffrer les données". Par conséquent, le contenu est protégé contre d'éventuels autres utilisateurs sur la même machine, mais pas des autres applications fonctionnant dans le même espace utilisateur.
  • Linux: Encryption keys are generated and stored in a secret store that varies depending on your window manager and system setup. Options currently supported are kwallet, kwallet5, kwallet6 and gnome-libsecret, but more may be available in future versions of Electron. As such, the security semantics of content protected via the safeStorage API vary between window managers and secret stores.
    • Note that not all Linux setups have an available secret store. If no secret store is available, items stored in using the safeStorage API will be unprotected as they are encrypted via hardcoded plaintext password. You can detect when this happens when safeStorage.getSelectedStorageBackend() returns basic_text.

Notez que sur Mac, l’accès au Keychain du système est requis et que ces appels peuvent bloquer le thread actuel pour collecter les entrées utilisateur. Il en va de même pour Linux, si un outil de gestion des mots de passe est disponible.

Méthodes​

Le module safeStorage possède les méthodes suivantes :

safeStorage.isEncryptionAvailable()​

Retourne boolean - Indique si le cryptage est disponible.

Sous Linux, retourne vrai si l'application a émis l'événement ready et que la clé secrète est disponible. Sur MacOS, retourne true si Keychain est disponible. Sous Windows, renvoie true une fois que l’application a émis l’événement ready .

safeStorage.encryptString(plainText)​

  • plainText string

Retourne Buffer - Un tableau d'octets représentant la chaîne chiffrée.

Cette fonction déclenchera une erreur en cas d'échec du cryptage.

safeStorage.decryptString(encrypted)​

  • encrypted Buffer

Retourne string - la chaîne décryptée. Décrypte dans une chaîne le tampon crypté obtenu avec safeStorage.encryptString.

Cette fonction déclenchera une erreur en cas d'échec du cryptage.

safeStorage.setUsePlainTextEncryption(usePlainText)​

  • usePlainText boolean

This function on Linux will force the module to use an in memory password for creating symmetric key that is used for encrypt/decrypt functions when a valid OS password manager cannot be determined for the current active desktop environment. This function is a no-op on Windows and MacOS.

safeStorage.getSelectedStorageBackend() Linux​

Returns string - User friendly name of the password manager selected on Linux.

This function will return one of the following values:

  • basic_text - When the desktop environment is not recognised or if the following command line flag is provided --password-store="basic".
  • gnome_libsecret - When the desktop environment is X-Cinnamon, Deepin, GNOME, Pantheon, XFCE, UKUI, unity or if the following command line flag is provided --password-store="gnome-libsecret".
  • kwallet - When the desktop session is kde4 or if the following command line flag is provided --password-store="kwallet".
  • kwallet5 - When the desktop session is kde5 or if the following command line flag is provided --password-store="kwallet5".
  • kwallet6 - When the desktop session is kde6.
  • unknown - When the function is called before app has emitted the ready event.