Merge pull request #8 from mlmitch/testing

Corrections before submission to extension store

Author: mlmitch

NOTICES

@@ -1 +1,20 @@
-# Weaklayer Sensor
+This is the source for the Weaklayer Sensor. 
+It is a browser extension designed to act endpoint detection and response (EDR), except in the browser.
+This is why I use the term 'browser detection and response'.
+
+Firefox (>= 57.0) is currently supported (desktop only). 
+Unfortunately Firefox on Android does not work because it is missing the [managed storage API](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage/managed).
+Support for other browsers with the WebExtensions API is in the works.
+
+# Building the Extension
+This requires you have the `npm` command line utility.
+
+```
+git clone https://github.com/weaklayer/sensor.git
+cd sensor
+npm install
+npm run build-firefox
+```
+
+The result is a minified browser extension identical to our extension store submissions (firefox in this case).
+The `dist` directory contains the extension that you can load as a temporary add-on in Firefox developer edition.

README.md

@@ -53,7 +53,7 @@
         },
         "installKey": {
             "type": "object",
-            "description": "The installation secret that the sensor uses to enroll.",
+            "description": "The key that the sensor uses to install.",
             "required": [
                 "group",
                 "secret",
@@ -62,12 +62,12 @@
             "properties": {
                 "group": {
                     "type": "string",
-                    "description": "The group that the sensor will enroll under.",
+                    "description": "The group that the sensor will install under.",
                     "format": "uuid"
                 },
                 "secret": {
                     "type": "string",
-                    "description": "Base64 encoded 512-bit secret that acts as a password for the sensor to enroll in the above group.",
+                    "description": "Base64 encoded 512-bit secret that acts as a password for the sensor to install in the above group.",
                     "pattern": "^[A-Za-z0-9+/]{86}==$"
                 },
                 "checksum": {

manifests/chromium/managed-storage-schema.json

@@ -2,12 +2,12 @@
     "browser_specific_settings": {
         "gecko": {
             "id": "[email protected]",
-            "strict_min_version": "54.0"
+            "strict_min_version": "57.0"
         }
     },
     "name": "Weaklayer Sensor",
     "author": "Weaklayer",
-    "version": "1.0.0",
+    "version": "0.0.1",
     "description": "Browser Detection and Response",
     "manifest_version": 2,
     "icons": {

manifests/firefox/manifest.json

@@ -35,8 +35,8 @@
     "webpack-cli": "^3.3.12"
   },
   "dependencies": {
-    "base64-js": "^1.3.1",
-    "uuid": "^8.2.0",
-    "webextension-polyfill": "^0.6.0"
+    "base64-js": "1.3.1",
+    "uuid": "8.2.0",
+    "webextension-polyfill": "0.6.0"
   }
-}
+}

package.json

@@ -23,32 +23,25 @@ import { BackgroundHub } from './BackgroundHub'
 import { EventCollector } from './EventCollector'
 
 console.info(`
-This is Weaklayer Sensor.
+Weaklayer Sensor is available under the terms of the GNU Affero General Public License (GNU AGPL).
+Please see the program source for the exact GNU AGPL version.
 
-Weaklayer Sensor is free software: you can redistribute it and/or modify
-it under the terms of the GNU Affero General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
+The Weaklayer Sensor source is available at https://github.com/weaklayer/sensor
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Affero General Public License for more details.
-
-You should have received a copy of the GNU Affero General Public License
-along with this program.  If not, see <https://www.gnu.org/licenses/>.
+The Weaklayer Gateway source is available at https://github.com/weaklayer/gateway
 
+For more information, please see https://weaklayer.com
 `)
 
-const enroller = new Installer()
-const sensorEventApi = new SensorEventAPI(enroller)
+const installer = new Installer()
+const sensorEventApi = new SensorEventAPI(installer)
 
 const eventCollector = new EventCollector((es) => sensorEventApi.submit(es))
 const eventHub = new BackgroundHub((e) => eventCollector.comsumeEvent(e))
 
 // Manually trigger an auth token get on startup
 // This will force any required network calls
 // So the token is present locally when it is needed.
-enroller.getAuthorizationToken().then(() => {
+installer.getAuthorizationToken().then(() => {
     console.info('Authorization token present.')
 })

src/background/background.ts

@@ -30,6 +30,7 @@ module.exports = {
     new CopyWebpackPlugin({
       patterns: [
         { from: 'LICENSE' },
+        { from: 'NOTICES' },
         { from: 'node_modules/webextension-polyfill/dist/browser-polyfill.min.js' },
         { from: 'node_modules/webextension-polyfill/dist/browser-polyfill.min.js.map' },
         { from: 'icon16.png' },