Updating comments

Author: rossphelan

lib/mcapi/crypto/jwe-crypto.js

@@ -5,9 +5,9 @@ const nodeCrypto = require('crypto');
 const base64url = require('base64url');
 
 /**
- * @class Crypto
+ * @class JWE Crypto
  *
- * Constructor to create an instance of `Crypto`: provide encrypt/decrypt methods
+ * Constructor to create an instance of `JweCrypto`: provide JWE encrypt/decrypt methods
  *
  * @param config encryption/decryption service configuration
  * @constructor
@@ -24,8 +24,13 @@ function JweCrypto(config) {
 
   this.encryptedValueFieldName = config.encryptedValueFieldName;
 
-  this.encryptedKeyFieldName = config.encryptedKeyFieldName;
-
+  /**
+   * Perform data encryption
+   *
+   * @public
+   * @param options {Object} parameters
+   * @param options.data {string} json string to encrypt
+   */
   this.encryptData = function (options) {
     const data = utils.jsonToString(options.data);
 
@@ -67,6 +72,12 @@ function JweCrypto(config) {
     return { [this.encryptedValueFieldName] : encryptedData};
   };
 
+  /**
+   * Perform data decryption
+   *
+   * @public
+   * @param encryptedData encrypted data
+   */
   this.decryptData = function (encryptedData) {
     if (!encryptedData || encryptedData.length <= 1) {
       throw new Error('Input not valid');
@@ -158,6 +169,9 @@ function getPrivateKey(config) {
   return null;
 }
 
+/**
+ * @private
+ */
 function getPrivateKey12(p12Path, alias, password) {
   const p12Content = fs.readFileSync(p12Path, 'binary');
 
@@ -192,6 +206,9 @@ function getPrivateKey12(p12Path, alias, password) {
   return forge.pki.privateKeyToPem(keyObj.key);
 }
 
+/**
+ * @private
+ */
 function loadPrivateKey(privateKeyPath) {
   const privateKeyContent = fs.readFileSync(privateKeyPath, 'binary');
 
@@ -208,6 +225,9 @@ function loadPrivateKey(privateKeyPath) {
   return privateKey;
 }
 
+/**
+ * @private
+ */
 function getPrivateKeyPem(pemPath) {
   const pemContent = fs.readFileSync(pemPath, 'binary');
 
@@ -221,6 +241,9 @@ function getPrivateKeyPem(pemPath) {
   return privateKey;
 }
 
+/**
+ * @private
+ */
 function getPrivateKeyDer(derPath) {
   const derContent = fs.readFileSync(derPath, 'binary');
 
@@ -316,6 +339,9 @@ function isValidConfig(config) {
   validateRootMapping(config);
 }
 
+/**
+ * @private
+ */
 function validateFingerprint(config, contains) {
   const propertiesFingerprint = ["publicKeyFingerprintType"];
   const propertiesOptionalFingerprint = ["publicKeyFingerprint"];
@@ -325,6 +351,9 @@ function validateFingerprint(config, contains) {
   }
 }
 
+/**
+ * @private
+ */
 function validateRootMapping(config) {
   function multipleRoots(elem) {
     return elem.length !== 1 && elem.some((item) => {

lib/mcapi/crypto/legacy-crypto.js

@@ -3,9 +3,9 @@ const fs = require('fs');
 const utils = require('../utils/utils');
 
 /**
- * @class LegacyCrypto
+ * @class Legacy Crypto
  *
- * Constructor to create an instance of `Crypto`: provide encrypt/decrypt methods
+ * Constructor to create an instance of `LegacyCrypto`: provide encrypt/decrypt methods
  *
  * @param config encryption/decryption service configuration
  * @constructor