@sendsafely/sendsafely 1.1.6 → 1.1.7

package/examples/CreateNewPackage/CreateNewPackage.js

@@ -0,0 +1,138 @@
+var fs = require('fs');
+var SendSafely = require('@sendsafely/sendsafely');
+
+var fileArray = [];
+var fileUploadCount = 0;
+var recipientAddedCount = 0;
+var newPackageId;
+var newServerSecret;
+var newPackageCode;
+var newKeyCode;
+
+var filesToUpload = ["test1.txt", "test2.txt"];
+var recipientsToAdd = ["user+one@example.com", "user+two@example.com", "user+three@example.com"];
+var publicKeys = [];
+var fileIds = [];
+
+var privateKey = ""
+var publicKeyId = "";
+var files = [];
+	
+//var sendSafely = new SendSafely("https://demo.sendsafely.com", "exAPIkeyxyz", "exAPIsecretxyz");
+var sendSafely = new SendSafely("https://ORGANIZATION_HOST", "API_KEY", "API_SECRET");
+
+sendSafely.verifyCredentials(function(email) {
+	initEvents();
+    console.log("Connected to SendSafely as user " + email);
+    getFiles();
+});
+
+function initEvents() {
+	sendSafely.on('save.file',function(data) {
+		var fileName = files.find(f=>{ return f.fileId === data.fileId }).fileId;
+		fs.writeFile(fileName, data.file, (err) => {
+			  if(err) {
+				  throw err;
+			  }
+			  console.log('The file has been saved! ' + data.fileId);
+		});		
+	});
+	
+	sendSafely.on('sendsafely.error', function(error, errorMsg) {
+	    console.log(error)
+	});
+}
+
+function getFiles() {
+    if (fileArray.length == filesToUpload.length) {
+        step1();
+    } else {
+        console.log("Reading file " + filesToUpload[fileArray.length]);
+        fs.readFile(filesToUpload[fileArray.length], function(err, data) {
+            if (err) {
+                throw err
+            }
+            var file = {
+                size: data.length,
+                name: filesToUpload[fileArray.length],
+                data: data
+            };
+            fileArray.push(file);
+            getFiles();
+        })
+    }
+}
+
+function step1() {
+	console.log("Generate new key pair")
+	sendSafely.generateKeyPair("Node example",false,function(privateKey, publicKey){
+		console.log("New key pair generated");
+		newPrivateKey = privateKey;
+		newPublicKey = publicKey;
+		publicKeyId = publicKey.id
+		step2();
+	});
+}
+
+function step2() {
+    sendSafely.createPackage(function(packageId, serverSecret, packageCode, keyCode) {
+        newPackageId = packageId;
+        newServerSecret = serverSecret;
+        newPackageCode = packageCode;
+        newKeyCode = keyCode;
+        console.log("Created new Package ID: " + packageId);
+        console.log("KeyCode: " + keyCode);
+        console.log("Server Secret: " + serverSecret);
+        console.log("Package Code: " + packageCode);
+        sendSafely.encryptAndUploadFiles(newPackageId, newKeyCode, newServerSecret, fileArray, "js", function(packageId,fileId, fileSize,fileName) {
+            fileUploadCount++;
+            fileIds.push(fileId);
+            console.log("Upload Complete - File " + fileUploadCount + " - " + fileName);
+            if (fileUploadCount == filesToUpload.length) {
+                console.log("All Uploads Complete");
+                step3();
+            }
+        })
+    })
+}
+
+function step3() {
+	console.log("Encrypting and Uploading Message");
+    sendSafely.encryptAndUploadMessage(newPackageId, newKeyCode, newServerSecret, "This is a test package from Node.js", function(encryptedMessage) {
+        console.log("Message Added");
+        console.log("Adding Recipients");
+        for (var i = 0; i < recipientsToAdd.length; i++) {
+            sendSafely.addRecipient(newPackageId, recipientsToAdd[i], undefined, function(finished) {
+                recipientAddedCount++;
+                console.log("Recipient " + recipientAddedCount + " added");
+                if (recipientAddedCount == recipientsToAdd.length) {
+                	console.log("Finalizing Package");
+                    sendSafely.finalizePackage(newPackageId, newPackageCode, newKeyCode, function(done) {
+                        console.log("Secure Link: " + done);
+                        step4();
+                    });
+                }
+            })
+        }
+    });
+}
+
+function step4() {
+	console.log("Getting keycode");
+	sendSafely.getKeycode(newPrivateKey,publicKeyId,newPackageId,function(keycode){
+		console.log('Decrypted keycode from private key : ' + keycode);
+		console.log('Keycode from package : ' + newKeyCode);
+		step5();
+	});
+}
+
+function step5() {
+	sendSafely.packageInformation(newPackageId,function(res){
+		files = res.files;
+		for(var i = 0; i < res.files.length; i++) {
+			var file = res.files[i];
+			console.log('Downloading file ' + file.fileName);
+			sendSafely.downloadFile(newPackageId,file.fileId,newKeyCode);
+		}	
+	});
+}

package/examples/CreateNewPackage/README.md

@@ -0,0 +1,27 @@
+
+# Node.js SendSafely Sample Application
+
+CreateNewPackage.js is a sample application demonstrating core SendSafely secure data transfer capabilities using the Sendsafely JavaScript API for Node.js. 
+
+## Quickstart
+Install the @sendsafely/sendsafely Node module 
+```console
+npm install
+```
+
+Update the SendSafely object in CreateNewPackage.js with your SendSafely organization hostname and a API Key and Secret.
+
+```javascript
+//var sendSafely = new SendSafely("https://demo.sendsafely.com", "exAPIkeyxyz", "exAPIsecretxyz");
+var sendSafely = new SendSafely("https://ORGANIZATION_HOST", "API_KEY", "API_SECRET");
+```
+
+*You can generate your own API_KEY and API_SECRET from the API Keys section of your Profile page when logged into your SendSafely portal.*
+
+Run CreateNewPackage sample application using Node
+```console
+node CreateNewPackage.js
+``` 
+
+## Support
+For support, please contact support@sendsafely.com. 

package/examples/CreateNewPackage/package.json

@@ -0,0 +1,15 @@
+{
+  "dependencies": {
+    "@sendsafely/sendsafely": "^1.x.x"
+  },
+  "name": "createnewpackage",
+  "version": "1.0.0",
+  "main": "CreateNewPackage.js",
+  "devDependencies": {},
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "",
+  "description": ""
+}

package/examples/CreateNewPackage/test1.txt

@@ -0,0 +1 @@
+Hello World 1

package/examples/CreateNewPackage/test2.txt

@@ -0,0 +1 @@
+Hello World 2

package/lib/SendSafely.js

@@ -916,6 +916,21 @@ function SendSafely(url, apiKeyId, apiKeySecret, requestAPI){
     handler.execute(ciphertext, packageId, keyCode, serverSecret, finished);
   };
 
+  /**
+   * Gets a given package's message for use based on package id and checksum provided 
+   * @param packageId {String} The package id of the package.
+   * @param packageCode {String} The package code value for the given package
+   * @param keyCode {String} The package key code value
+   * @param finished {function} function ()
+   * @fires {sendsafely#error}
+   * @returns {void}
+   */
+  this.getPackageMessage = function (packageId, packageCode, keyCode, finished) {
+    try { this.checkAPIInitialized();}
+    catch (err) {myself.eventHandler.raiseError(myself.NOT_INITIALIZED_ERROR, err.message); return;}
+    new GetPackageMessage(myself.eventHandler, myself.request).execute(packageId, packageCode, keyCode, myself.async, finished);
+  };
+
   /*
    * INTERNAL FUNCTIONS BELOW THIS POINT
    */
@@ -4797,6 +4812,40 @@ function VerifyVersion (eventHandler, request) {
 
 }
 
+function GetPackageMessage (eventHandler, request) {
+  this.request = request;
+  this.endpoint = { "url": '/package/{packageId}/message/{checksum}', "HTTPMethod" : "GET", "mimetype": "application/json"};
+  this.eventHandler = eventHandler;
+  this.customErrorEvent = 'package.message.failed';
+  this.responseParser = new ResponseParser(eventHandler);
+  var myself = this;
+  this.execute = function (packageId, packageCode, keyCode, async, finished) {
+    var checksum = createChecksum(keyCode, packageCode);
+    if (packageId === undefined) {
+      throw new Error("Unable to get package message without package ID");
+    } else if (checksum === undefined) {
+      throw new Error("Unable to get package message without checksum");
+    } else {
+      var endpoint = myself.request.extend({}, myself.endpoint);
+      endpoint.url = endpoint.url.replace("{packageId}", packageId);
+      endpoint.url = endpoint.url.replace("{checksum}", checksum);
+      var response = myself.request.sendRequest(endpoint, null, async);
+      myself.responseParser.processAjaxData(response, function (res) {
+        var data = {};
+        data.message = res.message;
+        finished(data);
+      }, myself.customErrorEvent);
+    }
+  }
+
+  function createChecksum(keyCode, packageCode) {
+    keyCode = sjcl.codec.utf8String.toBits(urlSafeBase64(keyCode));
+    packageCode = sjcl.codec.utf8String.toBits(urlSafeBase64(packageCode));
+
+    return sjcl.codec.hex.fromBits(sjcl.misc.pbkdf2(keyCode, packageCode, 1024, 256));
+  }
+}
+
 SendSafely.SendSafelyDropzone = function SendSafelyDropzone(url, dropzoneId) {
 	const myself = new SendSafely(url, dropzoneId, null);
 	myself.notifyRecipients = false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sendsafely/sendsafely",
-  "version": "1.1.6",
+  "version": "1.1.7",
   "main": "./lib/SendSafely.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"