kotlin-electron/electron.core/SafeStorage

SafeStorage

external interface SafeStorage(source)

Functions

abstract external fun decryptString(encrypted: Buffer<*>): String

the decrypted string. Decrypts the encrypted buffer obtained with safeStorage.encryptString back into a string.

decryptStringAsync

abstract external fun decryptStringAsync(encrypted: Buffer<*>): Promise<DecryptStringAsyncReturnValue>

Resolve with an object containing the following:

abstract external fun encryptString(plainText: String): Buffer<*>

An array of bytes representing the encrypted string.

encryptStringAsync

abstract external fun encryptStringAsync(plainText: String): Promise<Buffer<*>>

An array of bytes representing the encrypted string.

getSelectedStorageBackend

abstract external fun getSelectedStorageBackend(): SafeStorageGetSelectedStorageBackendResult

User friendly name of the password manager selected on Linux.

isAsyncEncryptionAvailable

abstract external fun isAsyncEncryptionAvailable(): Promise<Boolean>

Whether encryption is available for asynchronous safeStorage operations.

isEncryptionAvailable

abstract external fun isEncryptionAvailable(): Boolean

Whether encryption is available.

setUsePlainTextEncryption

abstract external fun setUsePlainTextEncryption(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.