From 0c45bde84c27b736f158dee07f77ef5cc9654730 Mon Sep 17 00:00:00 2001
From: Marvin Borner
Date: Wed, 23 Jan 2019 18:11:19 +0100
Subject: Added documentation to some functions

---
 public/scripts/2_encryption.js | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'public')

diff --git a/public/scripts/2_encryption.js b/public/scripts/2_encryption.js
index b678606..05b4b69 100644
--- a/public/scripts/2_encryption.js
+++ b/public/scripts/2_encryption.js
@@ -23,6 +23,12 @@ async function generateKeys(userId, passphrase) {
     });
 }
 
+/**
+ * Encrypts the data with a public key (e.g the one of the person with which you're chatting)
+ * @param data
+ * @param publicKey
+ * @returns {Promise<void>}
+ */
 async function encrypt(data, publicKey) {
     //const privateKeyObj = (await openpgp.key.readArmored(privateKey)).keys[0];
     //await privateKeyObj.decrypt(passphrase);
@@ -40,6 +46,14 @@ async function encrypt(data, publicKey) {
     })
 }
 
+/**
+ * Decrypts encrypted data with own encrypted private key and verifies the data with the public key
+ * @param data
+ * @param publicKey
+ * @param privateKey
+ * @param passphrase
+ * @returns {Promise<void>}
+ */
 async function decrypt(data, publicKey, privateKey, passphrase) {
     const privateKeyObj = (await openpgp.key.readArmored(privateKey)).keys[0];
     await privateKeyObj.decrypt(passphrase);
@@ -57,6 +71,9 @@ async function decrypt(data, publicKey, privateKey, passphrase) {
     })
 }
 
+/**
+ * Just a general test case
+ */
 function testEncryption() {
     generateKeys('test_id', 'supersecure').then(() => {
         encrypt('The meaning of life', localStorage.getItem('public_key')).then(() => {
-- 
cgit v1.2.3