Encryption

[phuze]

I've supplied an encryption key when creating a new store, but nothing happens. Could you please elaborate on whats required / how this works?

[sindresorhus]

What did you expect to happen and what didn't?

[phuze]

That's a great question. The documentation doesn't really specify what, if anything, should happen and so I didn't expect anything to happen. Never-the-less, based on the documentation, I had guessed that I would open the .json store file and find the contents encrypted -- this was not the case.

var store = new Store({ name: "myExample", encryptionKey: "oiV32mVp5lOwYneFESjrWq2xFByNOvNj" })

Edit:

By providing an encryption key, the file will be obfuscated, which should hopefully deter any users from doing so. When specified, the store will be encrypted using the aes-256-cbc encryption algorithm.

[sindresorhus]

I'm not sure why you expected an empty store to produce an encrypted file. Just follow the usage example in the readme and you'll get your encrypted file.

[phuze]

I'm not sure why you assume my store file is empty. Following the usage example does not result in an encrypted file, contrary to your assumption and to your documentation.

Let me quote the extent of your documentation, in case you've forgotten:

By providing an encryption key, the file will be obfuscated, which should hopefully deter any users from doing so. When specified, the store will be encrypted using the aes-256-cbc encryption algorithm.

Here, let me help you visualize a non-empty store file, configured using a valid 256-bit encryption key:

var store = new Store({
    name: "myExample",
    encryptionKey: "oiV32mVp5lOwYneFESjrWq2xFByNOvNj"
})

store.set("this_is_a_key", "this_is_a_value")

And the result, a non-encrypted store file:

{
    "this_is_a_key": "this_is_a_value"
}