Skip to content

Commit ba16f84

Browse files
authored
trivial
1 parent ee82495 commit ba16f84

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ var rawObj = ea.decryptAll(partiallyEncryptedObj)
199199

200200
| Option | Type | Required? | Details |
201201
|:-----------|----------------|:---------------|:---------------------------------------------------------------------|
202-
| keyId | ((string )) | Required(ish) | The id of the key to use for all **new encryptions**. This is _not_ necessarily the only key that will be used for decryptions though, because the key id you choose gets embedded into the encrypted string itself. Then before that string is decrypted, this module simply unpacks that key id and uses it to determine the appropriate decryption key. This approach allows for using multiple keys. (Note that this option is only _technically_ required if you need to encrypt new data. If you are only decrypting existing data, you needn't pass it in.) |
202+
| keyId | ((string)) | Required(ish) | The id of the key to use for all **new encryptions**. This is _not_ necessarily the only key that will be used for decryptions though, because the key id you choose gets embedded into the encrypted string itself. Then before that string is decrypted, this module simply unpacks that key id and uses it to determine the appropriate decryption key. This approach allows for using multiple keys. (Note that this option is only _technically_ required if you need to encrypt new data. If you are only decrypting existing data, you needn't pass it in.) |
203203
| keys | ((dictionary)) | Required | A dictionary of all relevant data encryption keys (DEKs). Since encrypted strings _contain the key id that was used to encrypt them_, it's important that `keys` contain the appropriate keys for any past key ids it might run across when attempting to decrypt those strings.
204204
| verifyId | ((boolean)) | _Optional._ | Whether or not to (A) use the `id` property of a provided source object as an additional piece of metadata during encryption, and (B) expect that metadata to be embedded in encrypted strings during decryption, and throw an error if the expected idea does not match. Defaults to `false`.
205205

0 commit comments

Comments
 (0)