aboutsummaryrefslogtreecommitdiffstats
path: root/app/scripts/edge-encryptor.js
diff options
context:
space:
mode:
authorbitpshr <mail@bitpshr.net>2018-04-20 03:12:04 +0800
committerbitpshr <mail@bitpshr.net>2018-04-20 03:14:00 +0800
commit8636f3bae547ace7d099a3ed516bf013dfe3858e (patch)
tree179fd228bbf833709d70ed68b54cbb33c089ebda /app/scripts/edge-encryptor.js
parent9c7eafc86f1d9d06dd6a5b66ecd2154b09299d03 (diff)
downloadtangerine-wallet-browser-8636f3bae547ace7d099a3ed516bf013dfe3858e.tar.gz
tangerine-wallet-browser-8636f3bae547ace7d099a3ed516bf013dfe3858e.tar.zst
tangerine-wallet-browser-8636f3bae547ace7d099a3ed516bf013dfe3858e.zip
Clean up JSDoc for background scripts
Diffstat (limited to 'app/scripts/edge-encryptor.js')
-rw-r--r--app/scripts/edge-encryptor.js16
1 files changed, 8 insertions, 8 deletions
diff --git a/app/scripts/edge-encryptor.js b/app/scripts/edge-encryptor.js
index d2e985790..dcb06873b 100644
--- a/app/scripts/edge-encryptor.js
+++ b/app/scripts/edge-encryptor.js
@@ -7,11 +7,11 @@ const Unibabel = require('browserify-unibabel')
*/
class EdgeEncryptor {
/**
- * Encrypts an arbitrary JavaScript object to ciphertext
+ * Encrypts an arbitrary object to ciphertext
*
* @param {string} password Used to generate a key to encrypt the data
* @param {Object} dataObject Data to encrypt
- * @returns {Promise<Object>} Promise resolving to an object with ciphertext
+ * @returns {Promise<string>} Promise resolving to an object with ciphertext
*/
encrypt (password, dataObject) {
var salt = this._generateSalt()
@@ -34,11 +34,11 @@ class EdgeEncryptor {
}
/**
- * Decrypts an arbitrary JavaScript object from ciphertext
+ * Decrypts an arbitrary object from ciphertext
*
* @param {string} password Used to generate a key to decrypt the data
- * @param {string} text Ciphertext of an encrypted JavaScript object
- * @returns {Promise<Object>} Promise resolving to copy of decrypted JavaScript object
+ * @param {string} text Ciphertext of an encrypted object
+ * @returns {Promise<Object>} Promise resolving to copy of decrypted object
*/
decrypt (password, text) {
const payload = JSON.parse(text)
@@ -67,7 +67,7 @@ class EdgeEncryptor {
*
* @private
* @param {string} password Password used to unlock a cryptographic key
- * @param {string} salt Random base-64 data
+ * @param {string} salt Random base64 data
* @returns {Promise<Object>} Promise resolving to a derived key
*/
_keyFromPassword (password, salt) {
@@ -81,10 +81,10 @@ class EdgeEncryptor {
}
/**
- * Generates random base-64 encoded data
+ * Generates random base64 encoded data
*
* @private
- * @returns {string} Randomized base-64 encoded data
+ * @returns {string} Randomized base64 encoded data
*/
_generateSalt (byteCount = 32) {
var view = new Uint8Array(byteCount)