Merge pull request #745 from particle-iot/feature/device-protection

Add Device Protection feature

Author: keeramis

npm-shrinkwrap.json

@@ -53,7 +53,7 @@
   ],
   "dependencies": {
     "@particle/device-constants": "^3.4.0",
-    "binary-version-reader": "^2.3.1",
+    "binary-version-reader": "^2.4.0",
     "chalk": "^2.4.2",
     "cli-progress": "^3.12.0",
     "cli-spinner": "^0.2.10",
@@ -67,10 +67,10 @@
     "lodash": "^4.17.15",
     "moment": "^2.24.0",
     "node-wifiscanner2": "^1.2.1",
-    "particle-api-js": "^10.3.0",
+    "particle-api-js": "^10.5.1",
     "particle-commands": "^1.0.1",
     "particle-library-manager": "^0.1.15",
-    "particle-usb": "^3.1.0",
+    "particle-usb": "^3.4.0",
     "request": "https://github.com/particle-iot/request/releases/download/v2.75.1-relativepath.1/request-2.75.1-relativepath.1.tgz",
     "safe-buffer": "^5.2.0",
     "semver": "^7.5.2",
@@ -143,6 +143,7 @@
     "test:e2e:ci": "npm run test:e2e:no-device -- --forbid-only",
     "test:e2e:no-device": "npm run test:e2e -- --grep @device --invert",
     "test:e2e:wifi": "npm run test:e2e -- --grep @device,@wifi",
+    "test:e2e:device-protection": "npm run test:e2e -- --grep @device,@device-protection",
     "test:e2e:watch": "npm run test:e2e -- --watch --watch-extensions js,json",
     "test:e2e:inspect": "npm test:e2e -- --inspect-brk",
     "test:e2e:silent": "PARTICLE_NOOP=$(npm run test:e2e:ci)",

package.json

@@ -12,5 +12,21 @@ module.exports = ({ commandProcessor, root }) => {
 		}
 	});
 
+	commandProcessor.createCommand(binary, 'enable-device-protection', 'Create a protected bootloader binary', {
+		params: '<file>',
+		options: {
+			'saveTo': {
+				description: 'Specify the filename for the protected binary'
+			}
+		},
+		handler: (args) => {
+			const BinaryCommand = require('../cmd/binary');
+			return new BinaryCommand().createProtectedBinary({ saveTo: args.saveTo, file: args.params.file, verbose: true });
+		},
+		examples: {
+			'$0 $command bootloader.bin': 'Provide bootloader binary to protect'
+		}
+	});
+
 	return binary;
 };

src/cli/binary.js

@@ -0,0 +1,43 @@
+module.exports = ({ commandProcessor, root }) => {
+	const deviceProtection = commandProcessor.createCategory(root, 'device-protection', 'Manage device protection');
+
+	commandProcessor.createCommand(deviceProtection, 'status', 'Gets the current device protection status', {
+		handler: () => {
+			const DeviceProtectionCommands = require('../cmd/device-protection');
+			return new DeviceProtectionCommands().getStatus();
+		},
+		examples: {
+			'$0 $command': 'Gets the current device protection status'
+		}
+	});
+
+	commandProcessor.createCommand(deviceProtection, 'disable', 'Disables device protection', {
+
+		handler: () => {
+			const DeviceProtectionCommands = require('../cmd/device-protection');
+			return new DeviceProtectionCommands().disableProtection();
+		},
+		examples: {
+			'$0 $command': 'Puts a Protected Device to Service Mode',
+		},
+		epilogue: 'A Protected Device in Service Mode allows any command to be performed on it that can be performed on an Open Device like flashing firmware or serial monitor.'
+	});
+
+	commandProcessor.createCommand(deviceProtection, 'enable', 'Enables device protection', {
+		options: {
+			file: {
+				description: 'File to use for device protection'
+			}
+		},
+		handler: (args) => {
+			const DeviceProtectionCommands = require('../cmd/device-protection');
+			return new DeviceProtectionCommands().enableProtection(args);
+		},
+		examples: {
+			'$0 $command': 'Turns an Open Device into a Protected Device'
+		}
+	});
+
+	return deviceProtection;
+};
+

src/cli/device-protection.js

@@ -5,6 +5,7 @@ const bundle = require('./bundle');
 const cloud = require('./cloud');
 const config = require('./config');
 const doctor = require('./doctor');
+const protection = require('./device-protection');
 const flash = require('./flash');
 const func = require('./function');
 const keys = require('./keys');
@@ -50,6 +51,7 @@ module.exports = function registerAllCommands(context) {
 	cloud(context);
 	config(context);
 	doctor(context);
+	protection(context);
 	flash(context);
 	func(context);
 	keys(context);

src/cli/index.js

@@ -274,6 +274,21 @@ module.exports = class ParticleApi {
 		}));
 	}
 
+	unprotectDevice({ deviceId, product, action, serverNonce, deviceNonce, deviceSignature, devicePublicKeyFingerprint, auth, headers, context }) {
+		return this._wrap(this.api.unprotectDevice({
+			deviceId,
+			product,
+			action,
+			serverNonce,
+			deviceNonce,
+			deviceSignature,
+			devicePublicKeyFingerprint,
+			auth,
+			headers,
+			context
+		}));
+	}
+
 	createLogicFunction({ org, logicFunction }) {
 		return this._wrap(this.api.createLogicFunction({
 			auth: this.accessToken,
@@ -282,6 +297,15 @@ module.exports = class ParticleApi {
 		}));
 	}
 
+	getProduct({ product, auth, headers, context }) {
+		return this._wrap(this.api.getProduct({
+			product,
+			auth,
+			headers,
+			context
+		}));
+	}
+
 	_wrap(promise){
 		return Promise.resolve(promise)
 			.then(result => result.body || result)