From 04eca07c8a7f32051d24de73c344359e5bd5fb0c Mon Sep 17 00:00:00 2001 From: John Kalberer Date: Sun, 18 Feb 2024 10:02:07 -0800 Subject: [PATCH] Move particle-collider --- package-lock.json | 56 +- package.json | 3 +- packages/particle-collider/.eslintignore | 13 + packages/particle-collider/.eslintrc | 69 ++ packages/particle-collider/.gitignore | 60 ++ packages/particle-collider/.prettierrc | 6 + packages/particle-collider/LICENSE | 674 ++++++++++++++++++ packages/particle-collider/README.md | 20 + packages/particle-collider/jest.config.js | 8 + packages/particle-collider/package.json | 31 + packages/particle-collider/src/App.ts | 586 +++++++++++++++ .../src/devices/TCPDevice.ts | 588 +++++++++++++++ packages/particle-collider/src/global.d.ts | 35 + packages/particle-collider/src/index.ts | 18 + .../src/lib/ChunkingStream.ts | 123 ++++ .../particle-collider/src/lib/CoapType.ts | 9 + .../particle-collider/src/lib/CoapUriType.ts | 11 + .../src/lib/CryptoManager.ts | 59 ++ .../particle-collider/src/lib/CryptoStream.ts | 54 ++ .../src/lib/NetworkThrottleStream.ts | 30 + .../particle-collider/src/test-webhook.json | 11 + packages/particle-collider/tsconfig.json | 28 + packages/spark-protocol/package.json | 2 +- packages/spark-protocol/src/clients/Device.ts | 2 + src/__tests__/DevicesController.test.ts | 2 +- src/controllers/WebhooksController.ts | 1 + src/managers/WebhookManager.ts | 1 + .../DeviceAttributeDatabaseRepository.ts | 15 +- src/repository/MongoDb.ts | 4 + 29 files changed, 2501 insertions(+), 18 deletions(-) create mode 100644 packages/particle-collider/.eslintignore create mode 100644 packages/particle-collider/.eslintrc create mode 100644 packages/particle-collider/.gitignore create mode 100644 packages/particle-collider/.prettierrc create mode 100644 packages/particle-collider/LICENSE create mode 100644 packages/particle-collider/README.md create mode 100644 packages/particle-collider/jest.config.js create mode 100644 packages/particle-collider/package.json create mode 100644 packages/particle-collider/src/App.ts create mode 100644 packages/particle-collider/src/devices/TCPDevice.ts create mode 100644 packages/particle-collider/src/global.d.ts create mode 100644 packages/particle-collider/src/index.ts create mode 100644 packages/particle-collider/src/lib/ChunkingStream.ts create mode 100644 packages/particle-collider/src/lib/CoapType.ts create mode 100644 packages/particle-collider/src/lib/CoapUriType.ts create mode 100644 packages/particle-collider/src/lib/CryptoManager.ts create mode 100644 packages/particle-collider/src/lib/CryptoStream.ts create mode 100644 packages/particle-collider/src/lib/NetworkThrottleStream.ts create mode 100644 packages/particle-collider/src/test-webhook.json create mode 100644 packages/particle-collider/tsconfig.json diff --git a/package-lock.json b/package-lock.json index 9a4c753a..7ef8f377 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@brewskey/spark-server", - "version": "1.0.1", + "version": "1.0.3", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@brewskey/spark-server", - "version": "1.0.1", + "version": "1.0.3", "license": "AGPL-3.0", "workspaces": [ "packages/*" @@ -18,7 +18,6 @@ "body-parser": "^1.20.2", "bunyan": "^1.8.15", "bunyan-middleware": "^1.0.2", - "chalk": "^5.3.0", "constitute": "^1.6.2", "cors": "^2.8.5", "csv": "^6.3.6", @@ -17512,7 +17511,6 @@ }, "node_modules/supports-color": { "version": "7.2.0", - "dev": true, "license": "MIT", "dependencies": { "has-flag": "^4.0.0" @@ -17523,7 +17521,6 @@ }, "node_modules/supports-color/node_modules/has-flag": { "version": "4.0.0", - "dev": true, "license": "MIT", "engines": { "node": ">=8" @@ -19154,7 +19151,7 @@ "version": "1.0.0", "license": "ISC", "dependencies": { - "chalk": "^5.3.0", + "chalk": "^4", "coap-packet": "^1.1.1", "node-rsa": "^1.1.1", "nodemon": "^3.0.3", @@ -19166,9 +19163,54 @@ "typescript": "^5.3.3" } }, + "packages/particle-collider/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "packages/particle-collider/node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "packages/particle-collider/node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "packages/particle-collider/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" + }, "packages/spark-protocol": { "name": "@brewskey/spark-protocol", - "version": "1.0.1", + "version": "1.0.3", "license": "LGPL-3.0", "dependencies": { "@particle/device-constants": "^3.3.1", diff --git a/package.json b/package.json index ca7c8df0..2067324b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@brewskey/spark-server", - "version": "1.0.2", + "version": "1.0.3", "license": "AGPL-3.0", "repository": { "type": "git", @@ -81,7 +81,6 @@ "body-parser": "^1.20.2", "bunyan": "^1.8.15", "bunyan-middleware": "^1.0.2", - "chalk": "^5.3.0", "constitute": "^1.6.2", "cors": "^2.8.5", "csv": "^6.3.6", diff --git a/packages/particle-collider/.eslintignore b/packages/particle-collider/.eslintignore new file mode 100644 index 00000000..5c7f5de5 --- /dev/null +++ b/packages/particle-collider/.eslintignore @@ -0,0 +1,13 @@ +packages + +# Don't check auto-generated stuff +coverage +build +dist +binaries +node_modules + +# Cruft +.DS_Store +npm-debug.log +.idea diff --git a/packages/particle-collider/.eslintrc b/packages/particle-collider/.eslintrc new file mode 100644 index 00000000..2b3a919a --- /dev/null +++ b/packages/particle-collider/.eslintrc @@ -0,0 +1,69 @@ +{ + "root": true, + "parserOptions": { + "project": "./tsconfig.json", + }, + "plugins": ["@typescript-eslint", "import", "prettier"], + "extends": [ + "airbnb-typescript/base", + "prettier", + "plugin:@typescript-eslint/recommended", + "plugin:import/typescript", + ], + "parser": "@typescript-eslint/parser", + "rules": { + "eol-last": 2, + "import/first": 0, + "import/newline-after-import": 0, + "import/no-duplicates": 0, + "import/no-extraneous-dependencies": 0, + "import/no-named-as-default": 0, + "import/no-unresolved": 2, + "import/prefer-default-export": 0, + "newline-per-chained-call": 0, + "no-confusing-arrow": 0, + "no-console": 0, + "no-duplicate-imports": 0, + "no-mixed-operators": 0, + "no-underscore-dangle": 0, + "no-use-before-define": 0, + "class-methods-use-this": "off", + "no-promise-executor-return": "off", + "quotes": [ + 2, + "single", + { + "avoidEscape": true, + }, + ], + "semi": 2, + "no-unused-vars": "off", + "@typescript-eslint/no-unused-vars": [ + "warn", // or "error" + { + "argsIgnorePattern": "^_", + "varsIgnorePattern": "^_", + "caughtErrorsIgnorePattern": "^_", + }, + ], + "@typescript-eslint/naming-convention": [ + "error", + { + "selector": ["parameter", "variable"], + "leadingUnderscore": "forbid", + "filter": { + // keep this one open for destructuring + "regex": "_*", + "match": false, + }, + "format": null, + }, + { + "selector": "parameter", + "leadingUnderscore": "require", + "format": null, + "modifiers": ["unused"], + }, + ], + }, +} diff --git a/packages/particle-collider/.gitignore b/packages/particle-collider/.gitignore new file mode 100644 index 00000000..fe609ddf --- /dev/null +++ b/packages/particle-collider/.gitignore @@ -0,0 +1,60 @@ +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Bower dependency directory (https://bower.io/) +bower_components + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules/ +jspm_packages/ + +# Typescript v1 declaration files +typings/ + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# dotenv environment variables file +.env + +/data \ No newline at end of file diff --git a/packages/particle-collider/.prettierrc b/packages/particle-collider/.prettierrc new file mode 100644 index 00000000..bbee69b7 --- /dev/null +++ b/packages/particle-collider/.prettierrc @@ -0,0 +1,6 @@ +{ + "tabWidth": 2, + "semi": true, + "singleQuote": true, + "trailingComma": "all" +} \ No newline at end of file diff --git a/packages/particle-collider/LICENSE b/packages/particle-collider/LICENSE new file mode 100644 index 00000000..9cecc1d4 --- /dev/null +++ b/packages/particle-collider/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + {project} Copyright (C) {year} {fullname} + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/packages/particle-collider/README.md b/packages/particle-collider/README.md new file mode 100644 index 00000000..85ac7886 --- /dev/null +++ b/packages/particle-collider/README.md @@ -0,0 +1,20 @@ +
+    ____             __  _      __        ______      _____     __         
+   / __ \____ ______/ /_(_)____/ /__     / ____/___  / / (_)___/ /__  _____
+  / /_/ / __ `/ ___/ __/ / ___/ / _ \   / /   / __ \/ / / / __  / _ \/ ___/
+ / ____/ /_/ / /  / /_/ / /__/ /  __/  / /___/ /_/ / / / / /_/ /  __/ /    
+/_/    \__,_/_/   \__/_/\___/_/\___/   \____/\____/_/_/_/\__,_/\___/_/      
+
+ +This is a stress testing framework for the local cloud (spark-server). It is +a great way to test the stability of your server or cluster of servers. + +Features: +* Generate virtual devices - These will register their public keys on your +server and get claimed under a test account. +* Call functions/variables on virtual devices - This will randomly send off +to your cloud which will communicate with your devices. +* Call webhooks on virtual devices - This will randomly call webhooks from the +virtual devices which will hit your cloud. +* Chaos-Monkey - Randomly run webhooks/functions/variables and continuously add +and remove devices. Use this to really give your server a thrashing. diff --git a/packages/particle-collider/jest.config.js b/packages/particle-collider/jest.config.js new file mode 100644 index 00000000..743b3bb2 --- /dev/null +++ b/packages/particle-collider/jest.config.js @@ -0,0 +1,8 @@ +/** @type {import('ts-jest').JestConfigWithTsJest} */ +module.exports = { + preset: 'ts-jest', + testEnvironment: 'node', + testMatch: ['**/**/*.test.ts'], + setupFilesAfterEnv: ['/src/setup-jest.ts'], + openHandlesTimeout: 1000, +}; diff --git a/packages/particle-collider/package.json b/packages/particle-collider/package.json new file mode 100644 index 00000000..dce851c4 --- /dev/null +++ b/packages/particle-collider/package.json @@ -0,0 +1,31 @@ +{ + "name": "@brewskey/particle-collider", + "version": "1.0.0", + "description": "spark-server stress tester", + "main": "index.js", + "scripts": { + "start": "ts-node ./src/index.ts" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/Brewskey/particle-collider.git" + }, + "author": "Brewskey", + "license": "ISC", + "bugs": { + "url": "https://github.com/Brewskey/particle-collider/issues" + }, + "homepage": "https://github.com/Brewskey/particle-collider#readme", + "dependencies": { + "chalk": "^4", + "coap-packet": "^1.1.1", + "node-rsa": "^1.1.1", + "nodemon": "^3.0.3", + "nullthrows": "^1.1.1", + "particle-api-js": "^10.4.2" + }, + "devDependencies": { + "ts-node": "^10.9.2", + "typescript": "^5.3.3" + } +} diff --git a/packages/particle-collider/src/App.ts b/packages/particle-collider/src/App.ts new file mode 100644 index 00000000..20371567 --- /dev/null +++ b/packages/particle-collider/src/App.ts @@ -0,0 +1,586 @@ +import chalk from 'chalk'; +import fs from 'fs'; +import nullthrows from 'nullthrows'; +import Particle from 'particle-api-js'; +import readline from 'readline'; +import testWebhook from './test-webhook.json'; +import path from 'path'; + +import CryptoManager from './lib/CryptoManager'; +import TCPDevice from './devices/TCPDevice'; + +type ReadlineInterface = { + close: () => void; + question: (question: string, callback: (answer: string) => void) => void; +}; + +type ConfigData = { + configs: Array; + defaultConfigIndex: number; +}; + +type Config = { + serverKeyPath: string; + serverPort: number; + serverUrl: string; +}; + +const USERNAME = '__test__@testaccount.com'; +const PASSWORD = 'password'; +const PARTICLE_API_CONFIG = { + clientId: 'particle-collider', + clientSecret: 'particle-collider', +}; + +const FOLDER_PATH = path.join(process.cwd(), 'data/'); +const CONFIG_FILE_PATH = path.join(FOLDER_PATH, 'configs.json'); + +const formatOption = ( + key: string | number, + description: string, + strikeThrough?: number | boolean, +) => { + if (strikeThrough) { + return; + } + + console.log(`${chalk.bgYellow.black(key)} ${description}`); +}; + +class App { + _accessToken!: string; + _configData!: ConfigData; + _devices: Array = []; + _existingDeviceIDs: Array = []; + _exit: boolean = false; + _functionInterval!: NodeJS.Timeout | null; + _particle!: Particle; + _rl: ReadlineInterface; + _variableInterval!: NodeJS.Timeout | null; + _webhookInterval!: NodeJS.Timeout | null; + + constructor() { + console.log( + ' ____ __ _ __ ______ _____ __ \n / __ \\____ ______/ /_(_)____/ /__ / ____/___ / / (_)___/ /__ _____\n / /_/ / __ `/ ___/ __/ / ___/ / _ \\ / / / __ \\/ / / / __ / _ \\/ ___/\n / ____/ /_/ / / / /_/ / /__/ / __/ / /___/ /_/ / / / / /_/ / __/ / \n/_/ \\__,_/_/ \\__/_/\\___/_/\\___/ \\____/\\____/_/_/_/\\__,_/\\___/_/ \n \n', + ); + + this._rl = readline.createInterface({ input: process.stdin }); + } + + run = async (): Promise => { + this._setupData(); + + let config = this._getConfig(); + if (!config) { + config = await this._setupNewConfig(); + } + try { + await this._setup(config); + } catch (error) { + console.error(error); + console.log(); + console.log(); + config = await this._setupNewConfig(); + await this._setup(config); + } + while (!this._exit) { + const connectedDeviceCount = this._devices.filter((device) => + device.getIsConnected(), + ).length; + console.log(''); + console.log( + chalk.green( + `${connectedDeviceCount} of ${this._devices.length} virtual ` + + `devices currently connected`, + ), + ); + console.log(chalk.green(`${this._existingDeviceIDs.length} claimed`)); + + this._renderMenu(); + + const answer = await this._question(); + switch (answer) { + case '1': { + await this._createDevices(config); + break; + } + + case '2': { + await this._stopDevices(); + break; + } + + case '3': { + await this._setDefaultConfig(); + config = nullthrows(this._getConfig()); + await this._setup(config); + break; + } + + case '4': { + config = await this._setupNewConfig(); + break; + } + + case '5': { + await this._callFunctions(); + break; + } + + case '6': { + await this._callVariables(); + break; + } + + case '7': { + await this._callWebhooks(); + break; + } + + case '8': { + await this._chaosMonkey(); + break; + } + + case 's': { + this._clearIntervals(); + + break; + } + + case 'e': { + await this._stopDevices(); + this._clearIntervals(); + this._exit = true; + break; + } + } + } + + this._rl.close(); + }; + + _clearIntervals = (): void => { + if (this._functionInterval != null) { + clearInterval(this._functionInterval); + } + if (this._variableInterval != null) { + clearInterval(this._variableInterval); + } + if (this._webhookInterval != null) { + clearInterval(this._webhookInterval); + } + this._functionInterval = null; + this._variableInterval = null; + this._webhookInterval = null; + }; + + _setup = async (config: Config): Promise => { + this._setServerKey(config); + await this._login(config); + await this._setupWebhooks(config); + + this._existingDeviceIDs = fs + .readdirSync(path.join(process.cwd(), `data/keys`)) + .map((file) => path.parse(file).name); + }; + + _renderMenu(): void { + console.log(''); + console.log('Choose an option:'); + formatOption(1, 'Start Virtual Device(s)'); + formatOption(2, 'Stop Virtual Device(s)'); + formatOption(3, 'Set default config'); + formatOption(4, 'Create new config'); + formatOption( + 5, + 'Call random device functions', + this._functionInterval != null, + ); + formatOption( + 6, + 'Get random device variables', + this._variableInterval != null, + ); + formatOption(7, 'Call random webhooks', this._webhookInterval != null); + formatOption( + 8, + 'Chaos-Monkey -- run all the things!', + this._functionInterval != null && + this._variableInterval != null && + this._webhookInterval != null, + ); + + if ( + this._functionInterval || + this._variableInterval || + this._webhookInterval + ) { + formatOption('s', 'Stop random calls'); + } + + formatOption('e', 'Exit'); + console.log(''); + } + + _setupNewConfig = async (): Promise => { + const config: Config = { + serverKeyPath: '', + serverPort: 8080, + serverUrl: '', + }; + + const getServerKey = async (): Promise => { + console.log( + 'In order to connect the virtual Particle devices, we need the ' + + 'public key to your local cloud server. What is the relative or ' + + 'absolute path to your server key?\r\n\r\nIt looks like ' + + 'server-key.pub.pem\r\n', + ); + const serverKeyPath = await this._question(); + + if (!fs.existsSync(serverKeyPath)) { + console.log(`Could not find the server key at ${serverKeyPath}`); + await getServerKey(); + return; + } + + config.serverKeyPath = serverKeyPath; + }; + + const getServerUrl = async (): Promise => { + console.log('Now we need the host name or IP address of your server.'); + console.log( + 'It can look like 192.168.0.175 or https://cloud.particle.io', + ); + const serverUrl = await this._question(); + config.serverUrl = serverUrl; + }; + + const getServerPort = async (): Promise => { + console.log('What is your server port? Default is 8080'); + const port = await this._question(); + + if (port && isNaN(Number(port))) { + await getServerPort(); + } + + config.serverPort = port ? parseInt(port, 10) : config.serverPort; + }; + + await getServerKey(); + await getServerUrl(); + await getServerPort(); + + console.log('Your server config has been correctly set.'); + + this._configData.configs.push(config); + this._configData.defaultConfigIndex = this._configData.configs.length - 1; + + fs.writeFileSync(CONFIG_FILE_PATH, JSON.stringify(this._configData)); + + await this._setup(config); + + return config; + }; + + _setDefaultConfig = async (): Promise => { + console.log('Pick a default config'); + const configs = this._configData.configs; + configs.map((config, index) => + console.log(`${chalk.green(index + 1)} ${config.serverUrl}`), + ); + const answer = await this._question(); + if (!answer) { + return; + } + + if (isNaN(Number(answer))) { + console.log('Input must be a number'); + await this._setDefaultConfig(); + return; + } + + const configIndex = parseInt(answer, 10) - 1; + if (configIndex < 0 || configIndex >= configs.length) { + console.log('Not a valid config.'); + await this._setDefaultConfig(); + return; + } + + if (this._configData.defaultConfigIndex !== configIndex) { + this._killDevices(this._devices.length); + } + + this._configData.defaultConfigIndex = configIndex; + this._saveConfig(); + }; + + _createDevices = async (config: Config): Promise => { + console.log('How many devices do you want to create?'); + const amountString = await this._question(); + + if (isNaN(Number(amountString))) { + return; + } + + const amount = parseInt(amountString, 10); + for (let ii = 0; ii < amount; ii++) { + const index = this._devices.length; + let deviceID = + this._existingDeviceIDs.length > index + ? this._existingDeviceIDs[index] + : null; + + if ( + deviceID && + !fs.existsSync(path.join(process.cwd(), `data/keys/${deviceID}.pem`)) + ) { + this._existingDeviceIDs.splice(ii, 1); + deviceID = null; + } + + const device = new TCPDevice({ + deviceID, + // Simulate devices that take longer to send data + networkDelay: Math.floor(Math.random() * 1000), + serverAddress: config.serverUrl, + }); + + // If the device doesn't already exist, we need to send the key and + // claim the device. + if (!deviceID) { + deviceID = device.getDeviceID(); + this._existingDeviceIDs.push(deviceID); + await this._particle.sendPublicKey({ + auth: this._accessToken, + deviceId: deviceID, + key: device.getPublicKey(), + }); + } + + console.log(`Adding ${this._devices.length}: ${deviceID}`); + this._devices.push(device); + } + + this._devices + .filter((device) => !device.getIsConnected()) + .map((device) => device.connect()); + + console.time('Time To Connect Devices'); + new Promise((resolve: (_: void) => void) => + setInterval(() => { + if (this._devices.every((device) => device.getIsConnected())) { + resolve(); + } + }), + ).then(() => console.timeEnd('Time To Connect Devices')); + }; + + _stopDevices = async (): Promise => { + console.log('How many devices do you want to stop?'); + const amountString = await this._question(); + + if (isNaN(Number(amountString))) { + return; + } + + let amount = parseInt(amountString, 10); + this._killDevices(amount); + }; + + _killDevices(amount: number): void { + const idsToAdd = []; + while (amount) { + amount -= 1; + const index = Math.floor(Math.random() * this._devices.length); + const device = this._devices[index]; + if (!device) { + continue; + } + const deviceID = device.getDeviceID(); + this._devices = this._devices.filter( + (device) => device.getDeviceID() !== deviceID, + ); + idsToAdd.push(deviceID); + this._existingDeviceIDs = this._existingDeviceIDs.filter( + (id) => id !== deviceID, + ); + + device.disconnect(); + } + + console.log(this._devices.length); + + this._existingDeviceIDs = this._existingDeviceIDs.concat(idsToAdd); + } + + _login = async (config: Config): Promise => { + this._particle = new Particle({ + ...PARTICLE_API_CONFIG, + baseUrl: config.serverUrl + `:${config.serverPort}`, + }); + + const credentials = { + password: PASSWORD, + username: USERNAME, + }; + const login = () => this._particle.login(credentials); + let loginData = null; + try { + loginData = await login(); + } catch (error) {} + + if (!loginData) { + await this._particle.createUser(credentials); + loginData = await login(); + } + + this._accessToken = loginData.body.access_token; + }; + + // Runs server actions with 10% of devices + _runServerAction( + callback: (device: TCPDevice) => void, + ): NodeJS.Timeout | null { + if (!this._devices.length) { + console.log(); + console.log(chalk.red("You don't have any devices running. Start some")); + return null; + } + + const INTERVAL = 5000; + const callAction = () => { + let devices = this._devices.filter((device) => device.getIsConnected()); + devices = devices.slice(0, Math.ceil(devices.length * 0.1)); + devices.forEach((device) => + setTimeout(() => callback(device), Math.random() * INTERVAL), + ); + }; + + callAction(); + return setInterval(callAction, INTERVAL); + } + + _callFunctions = async (): Promise => { + if (this._functionInterval) { + return; + } + + this._functionInterval = this._runServerAction((device) => + this._particle.callFunction({ + auth: this._accessToken, + deviceId: device.getDeviceID(), + name: 'testFn', + argument: Math.random(), + }), + ); + }; + + _callVariables = async (): Promise => { + if (this._variableInterval) { + return; + } + + this._variableInterval = this._runServerAction((device) => + this._particle.getVariable({ + auth: this._accessToken, + deviceId: device.getDeviceID(), + name: 'testVar', + }), + ); + }; + + _callWebhooks = async (): Promise => { + if (this._webhookInterval) { + return; + } + + this._webhookInterval = this._runServerAction((device) => + device.sendWebhook(), + ); + }; + + _chaosMonkey = async (): Promise => { + this._callFunctions(); + this._callVariables(); + this._callWebhooks(); + }; + + _setupWebhooks = async (config: Config): Promise => { + const webhooks = await this._particle.listWebhooks({ + auth: this._accessToken, + }); + if (webhooks && webhooks.body.length) { + const promises = webhooks.body.map((webhook) => + this._particle.deleteWebhook({ + auth: this._accessToken, + hookId: webhook.id, + }), + ); + await Promise.all(promises); + } + + let pingUrl = config.serverUrl.replace(/(^\w+:|^)\/\//, ''); + + await this._particle.createWebhook({ + ...testWebhook, + auth: this._accessToken, + url: `${config.serverPort === 443 ? 'https' : 'http'}://${pingUrl}:${config.serverPort}/v1/ping1`, + }); + }; + + _question = async (): Promise => { + return new Promise((resolve, reject) => { + this._rl.question('', (answer) => resolve(answer)); + }); + }; + + _setupData(): void { + if (!fs.existsSync(FOLDER_PATH)) { + fs.mkdirSync(FOLDER_PATH); + } + + if (!fs.existsSync(`${FOLDER_PATH}/keys`)) { + fs.mkdirSync(`${FOLDER_PATH}/keys`); + } + + if (!fs.existsSync(CONFIG_FILE_PATH)) { + this._configData = { + configs: [ + { + serverKeyPath: '../../../data/default_key.pub.pem', + serverPort: 8080, + serverUrl: 'http://localhost', + }, + ], + defaultConfigIndex: 0, + }; + this._saveConfig(); + } else { + this._configData = JSON.parse(fs.readFileSync(CONFIG_FILE_PATH, 'utf8')); + } + } + + _getConfig(): Config | null { + const { configs, defaultConfigIndex } = this._configData; + if (defaultConfigIndex === -1 || defaultConfigIndex >= configs.length) { + return null; + } + return configs[defaultConfigIndex]; + } + + _setServerKey(config: Config): void { + const keyString = fs.readFileSync( + path.join(FOLDER_PATH, config.serverKeyPath), + 'utf8', + ); + CryptoManager.setServerKey(keyString); + } + + _saveConfig(): void { + fs.writeFileSync(CONFIG_FILE_PATH, JSON.stringify(this._configData)); + } +} + +export default App; diff --git a/packages/particle-collider/src/devices/TCPDevice.ts b/packages/particle-collider/src/devices/TCPDevice.ts new file mode 100644 index 00000000..3d75fc02 --- /dev/null +++ b/packages/particle-collider/src/devices/TCPDevice.ts @@ -0,0 +1,588 @@ +import CoapPacket, { ParsedPacket } from 'coap-packet'; +import EventEmitter from 'events'; +import fs from 'fs'; +import { Socket } from 'net'; +import NodeRSA from 'node-rsa'; +import path from 'path'; + +import ChunkingStream from '../lib/ChunkingStream'; +import CoapUriType from '../lib/CoapUriType'; +import CryptoManager from '../lib/CryptoManager'; +import CryptoStream from '../lib/CryptoStream'; +import NetworkThrottleStream from '../lib/NetworkThrottleStream'; +import testWebhook from '../test-webhook.json'; + +const DEVICE_KEY_LENGTH = 12; +const COUNTER_MAX = 65536; +const RESPONSE_TIMEOUT = 10000; + +// TODO - Fill in real values here. We can just use whatever is in the photon. +const PRODUCT_ID = 0; +const PRODUCT_FIRMWARE_VERSION = 0; +const PLATFORM_ID = 0; +const COAP_VERSION = 1; + +const DESCRIBE_APPLICATION = 1 << 1; +const DESCRIBE_SYSTEM = 1 << 0; +const DESCRIBE_ALL = DESCRIBE_APPLICATION | DESCRIBE_SYSTEM; + +type DeviceState = 'next' | 'nonce' | 'set-session-key'; + +type TCPDeviceOptions = { + deviceID: string | null | undefined; + networkDelay: number; + serverAddress: string; +}; + +class TCPDevice { + _cipherStream!: CryptoStream; + _decipherStream!: CryptoStream; + _deviceID: Buffer; + _eventEmitter: EventEmitter = new EventEmitter(); + _helloTimeout: NodeJS.Timeout | null = null; + _isConnected: boolean = false; + _isConnecting: boolean = false; + _messageID: number = 0; + _networkDelay: number; + _pingInterval: NodeJS.Timeout | null = null; + _port: number; + _privateKey: NodeRSA; + _serverAddress: string; + _serverKey: NodeRSA; + _socket!: Socket; + _state: DeviceState; + _token!: Buffer; + + constructor({ deviceID, networkDelay, serverAddress }: TCPDeviceOptions) { + this._state = 'nonce'; + this._port = 5683; + this._networkDelay = networkDelay; + this._serverAddress = serverAddress; + this._serverKey = CryptoManager.getServerKey(); + + const index = serverAddress.indexOf('://'); + if (index >= 0) { + this._serverAddress = serverAddress.substr(index + 3); + } + + if (!deviceID) { + // Generate random device key + deviceID = CryptoManager.randomBytes(DEVICE_KEY_LENGTH) + .toString('hex') + .toLowerCase(); + const privateKey = CryptoManager.createKey(); + fs.writeFileSync( + path.join(process.cwd(), `data/keys/${deviceID}.pem`), + privateKey.exportKey('pkcs1-private-pem'), + ); + } + + this._privateKey = CryptoManager.loadPrivateKey( + fs.readFileSync( + path.join(process.cwd(), `data/keys/${deviceID}.pem`), + 'utf8', + ), + ); + this._deviceID = Buffer.from(deviceID, 'hex'); + } + + connect(): void { + if (this._isConnecting) { + return; + } + this._isConnecting = true; + this._socket = new Socket(); + + this._socket.connect({ + host: this._serverAddress, + port: this._port, + }); + this._socket.setTimeout(31000); + + this._socket.on('data', this._onReadData); + + this._socket.on('error', (error: Error) => this._reconnect(error)); + this._socket.on('close', () => this._reconnect(new Error('Socket close'))); + this._socket.on('timeout', () => + this._reconnect(new Error('Socket timeout')), + ); + } + + getDeviceID(): string { + return this._deviceID.toString('hex').toLowerCase(); + } + + getPublicKey(): string { + return this._privateKey.exportKey('pkcs8-public-pem'); + } + + getIsConnected(): boolean { + return this._isConnected; + } + + sendWebhook = (): void => { + this._sendEvent( + testWebhook.event, + Buffer.from(`{"payload": "${Math.random()}"}`), + ); + }; + + on = (event: string, callback: (arg1: TValue) => void) => + this._eventEmitter.on(event, callback); + + removeEventListener = ( + event: string, + callback: (arg1: TValue) => void, + ) => this._eventEmitter.removeListener(event, callback); + + disconnect = (): void => { + this._disconnect(); + this._isConnected = false; + }; + + _disconnect = (): void => { + if (!this._isConnected) { + return; + } + + this._isConnecting = false; + this._isConnected = false; + this._state = 'nonce'; + if (this._decipherStream) { + this._decipherStream.removeAllListeners(); + } + + this._socket.removeAllListeners(); + if (!this._socket.destroyed) { + this._socket.destroy(); + this._socket.on('error', () => {}); + } + + if (this._pingInterval) { + clearInterval(this._pingInterval); + this._pingInterval = null; + } + }; + + _reconnect = (error: Error): void => { + if (error) { + console.error(error); + } + if (!this._isConnected) { + return; + } + + this._disconnect(); + setTimeout(() => this.connect(), 15000); + }; + + _sleep = async (time = 100): Promise => + new Promise((resolve) => setTimeout(resolve, time)); + + _onReadData = async (data: Buffer): Promise => { + await this._sleep(); + switch (this._state) { + case 'nonce': { + const payload = this._prepareDevicePublicKey(data); + if (!this._socket.destroyed) { + this._socket.write(this._serverKey.encrypt(payload)); + } + this._state = 'set-session-key'; + break; + } + + case 'set-session-key': { + const cipherText = data.slice(0, 128); + const signedHMAC = data.slice(128); + + const sessionKey = this._privateKey.decrypt(cipherText); + // Server creates a 20-byte HMAC of the ciphertext using SHA1 and the 40 + // bytes generated in the previous step as the HMAC key. + const hash = CryptoManager.createHmacDigest(cipherText, sessionKey); + + const decryptedHMAC = this._serverKey.decryptPublic(signedHMAC); + + if (hash.compare(decryptedHMAC) === -1) { + throw new Error('HMAC did not match'); + } + + // The random session key has everything we need to create the crypto + // streams + const key = sessionKey.slice(0, 16); + const iv = sessionKey.slice(16, 32); + const salt = sessionKey.slice(32); // not sure what this is for... + + this._messageID = (sessionKey[32] << 8) | sessionKey[33]; + this._token = sessionKey.slice(34); + + // Create the crypto streams + this._decipherStream = new CryptoStream({ + iv, + key, + streamType: 'decrypt', + }); + this._cipherStream = new CryptoStream({ + iv, + key, + streamType: 'encrypt', + }); + + const chunkingIn = new ChunkingStream({ outgoing: false }); + const chunkingOut = new ChunkingStream({ outgoing: true }); + + const inputDelayStream = new NetworkThrottleStream(this._networkDelay); + const outputDelayStream = new NetworkThrottleStream(this._networkDelay); + + // What I receive gets broken into message chunks, and goes into the + // decrypter + this._socket + .pipe(inputDelayStream) + .pipe(chunkingIn) + .pipe(this._decipherStream); + + // What I send goes into the encrypter, and then gets broken into message + // chunks + this._cipherStream + .pipe(outputDelayStream) + .pipe(chunkingOut) + .pipe(this._socket); + + this._socket.removeListener('data', this._onReadData); + this._decipherStream.on('data', this._onNewCoapMessage); + + this._sendHello(); + + this._helloTimeout = setTimeout(() => { + throw new Error('Did not get hello response in 2 seconds'); + }, 3000); + + this._state = 'next'; + + // Ping every 10 seconds + this._pingInterval = setInterval(() => this._pingServer(), 15000); + this._isConnected = true; + + break; + } + + default: { + console.log('do the next thing', data); + } + } + }; + + _onNewCoapMessage = async (data: Buffer): Promise => { + const packet = CoapPacket.parse(data); + if (packet.code === '0.00' && packet.ack) { + this._eventEmitter.emit('ACK', packet); + } + + const uriOption = packet.options.find( + (option) => option.name === 'Uri-Path', + ); + if (!uriOption) { + return; + } + const path = uriOption.value.toString('utf8'); + const messageType = path.substring(0, path.indexOf('/')) || path; + const payload = packet.payload; + switch (messageType) { + case CoapUriType.Describe: { + let descriptionFlags = DESCRIBE_ALL; + if (payload.length > 8 && payload[8] <= DESCRIBE_ALL) { + descriptionFlags = payload[8]; + } else if (payload.length > 8) { + console.error(`Invalid DESCRIBE flags ${payload[8]}`); + } + + this._sendDescribe(descriptionFlags, packet); + + // Fully set up - we can register webhooks + await this._subscribeWebhooks(); + + break; + } + + case CoapUriType.Function: { + this._sendFunctionResult(packet); + break; + } + + case CoapUriType.Hello: { + // spark-server says hi + if (this._helloTimeout) { + clearTimeout(this._helloTimeout); + } + this._helloTimeout = null; + break; + } + + case CoapUriType.PrivateEvent: + case CoapUriType.PublicEvent: { + const uris = packet.options + .filter((o) => o.name === 'Uri-Path') + .map((o) => o.value.toString('utf8')); + uris.shift(); // Remove E or e + uris.pop(); // Remove index of the packet 0-X in the data buffer + this._eventEmitter.emit(uris.join('/'), packet); + break; + } + + case CoapUriType.Variable: { + this._sendVariable(packet); + break; + } + + default: { + console.warn(`Coap URI ${path} is not supported: ${packet}`); + } + } + }; + + _prepareDevicePublicKey(nonce: Buffer): Buffer { + // Concat a bunch of data that we will send over encrypted with the + // server public key. + return Buffer.concat([ + nonce, + this._deviceID, + this._privateKey.exportKey('pkcs8-public-der'), + ]); + } + + _nextMessageID(): number { + this._messageID += 1; + if (this._messageID >= COUNTER_MAX) { + this._messageID = 0; + } + + return this._messageID; + } + + _coapMessageHeader(type: number, tokenLength: number) { + return (COAP_VERSION << 6) | (type << 4) | (tokenLength & 0xf); + } + + _sendHello(): void { + const data = [ + PRODUCT_ID >> 8, + PRODUCT_ID & 0xff, + PRODUCT_FIRMWARE_VERSION >> 8, + PRODUCT_FIRMWARE_VERSION & 0xff, + 0, // Reserved flag + 0, // Flags -- newly upgraded. We probably won't use this + PLATFORM_ID >> 8, + PLATFORM_ID & 0xff, + this._deviceID.length >> 8, + this._deviceID.length & 0xff, + ]; + this._deviceID.forEach((bit) => data.push(bit)); + + const packet = CoapPacket.generate({ + code: 'POST', + messageId: this._nextMessageID(), + options: [ + { + name: 'Uri-Path', + value: Buffer.from('h'), + }, + ], + payload: Buffer.from(data), + }); + + this._writeData(packet); + } + + _sendDescribe(descriptionFlags: number, serverPacket: ParsedPacket): void { + // TODO: make this a bit more fancy + + const description = JSON.stringify({ + f: ['testfn'], + v: { testVar: 'INT' }, + // Copypasta'd from a real device + p: 6, + m: [ + { s: 16384, l: 'm', vc: 30, vv: 30, f: 'b', n: '0', v: 11, d: [] }, + { s: 262144, l: 'm', vc: 30, vv: 30, f: 's', n: '1', v: 105, d: [] }, + { + s: 262144, + l: 'm', + vc: 30, + vv: 30, + f: 's', + n: '2', + v: 105, + d: [{ f: 's', n: '1', v: 105, _: '' }], + }, + { + s: 131072, + l: 'm', + vc: 30, + vv: 30, + u: '2BA4E71E840F596B812003882AAE7CA6496F1590CA4A049310AF76EAF11C943A', + f: 'u', + n: '1', + v: 2, + d: [{ f: 's', n: '2', v: 1, _: '' }], + }, + { s: 131072, l: 'f', vc: 30, vv: 0, d: [] }, + ], + }); + + const packet = CoapPacket.generate({ + code: '2.05', // Content + messageId: this._nextMessageID(), + payload: Buffer.from(description), + token: serverPacket.token, + }); + + this._writeData(packet); + } + + _pingServer(): void { + if (!this._isConnected) { + return; + } + + const packet = CoapPacket.generate({ + code: '0', + confirmable: true, + messageId: this._nextMessageID(), + }); + + this._writeData(packet); + } + + _sendFunctionResult(serverPacket: ParsedPacket): void { + if (!this._isConnected) { + return; + } + + const returnValue = Math.ceil(Math.random() * 100000); // Success! + + const packet = CoapPacket.generate({ + code: '2.04', + messageId: this._nextMessageID(), + token: serverPacket.token, + payload: Buffer.from([ + returnValue >> 24, + (returnValue >> 16) & 0xff, + (returnValue >> 8) & 0xff, + returnValue & 0xff, + ]), + }); + + this._writeData(packet); + } + + _sendVariable(serverPacket: ParsedPacket): void { + if (!this._isConnected) { + return; + } + + const returnValue = 1; // Success! + + const result = Math.ceil(Math.random() * 100000); + const packet = CoapPacket.generate({ + code: '2.05', + messageId: this._nextMessageID(), + token: serverPacket.token, + payload: Buffer.from([ + result >> 24, + (result >> 16) & 0xff, + (result >> 8) & 0xff, + result & 0xff, + ]), + }); + + this._writeData(packet); + } + + _subscribeWebhooks = async (): Promise => { + await this._subscribe( + `hook-response/test-webhook/${this.getDeviceID()}`, + (packet: ParsedPacket) => {}, + ); + }; + + _subscribe = async ( + eventName: string, + callback: (packet: ParsedPacket) => void, + ): Promise => { + if (!this._isConnected) { + return; + } + + this._eventEmitter.on(eventName, callback); + + const messageID = this._nextMessageID(); + const packet = CoapPacket.generate({ + code: 'GET', + confirmable: true, + messageId: messageID, + options: [ + { + name: 'Uri-Path', + value: Buffer.from(`e/${eventName}`), + }, + ], + }); + + this._writeData(packet); + try { + await this._waitForResponse('ACK'); + } catch (error: any) { + console.log(`No ACK for ${eventName}`); + } + }; + + _sendEvent(eventName: string, payload: Buffer): void { + if (!this._isConnected) { + return; + } + + const packet = CoapPacket.generate({ + code: 'POST', + confirmable: true, + messageId: this._nextMessageID(), + options: [ + { + name: 'Uri-Path', + value: Buffer.from(`e/${eventName}`), + }, + ], + payload, + }); + + this._writeData(packet); + } + + _waitForResponse = async ( + event: string, + messageID?: number, + ): Promise => { + messageID = messageID || this._messageID; + return new Promise( + (resolve: (packet: ParsedPacket) => void, reject: () => void) => { + let timeout = setTimeout(() => reject(), RESPONSE_TIMEOUT); + const handler = (packet: ParsedPacket) => { + if (packet.messageId === messageID) { + if (timeout) { + clearTimeout(timeout); + } + this._eventEmitter.removeListener(event, handler); + resolve(packet); + } + }; + this._eventEmitter.on(event, handler); + }, + ); + }; + + _writeData = (packet: any): void => { + try { + !this._socket.destroyed && this._cipherStream.write(packet); + } catch (ignore: any) {} + }; +} + +export default TCPDevice; diff --git a/packages/particle-collider/src/global.d.ts b/packages/particle-collider/src/global.d.ts new file mode 100644 index 00000000..ddbeb2bf --- /dev/null +++ b/packages/particle-collider/src/global.d.ts @@ -0,0 +1,35 @@ +declare module 'particle-api-js' { + class Particle { + constructor(params: { + clientId: string; + clientSecret: string; + baseUrl: string; + }); + + login(params: { + username: string; + password: string; + }): Promise<{ body: { access_token: string } }>; + createUser(params: { username: string; password: string }): Promise; + sendPublicKey(params: { + auth: string; + deviceId: string; + key: string; + }): Promise; + listWebhooks(params: { auth: string }): Promise<{ body: { id: string }[] }>; + createWebhook(params: Record): Promise; + deleteWebhook(params: { auth: string; hookId: string }): Promise; + callFunction({ + auth: string, + deviceId: string, + name: string, + argument: unknown, + }): Promise; + getVariable({ + auth: string, + deviceId: string, + name: string, + }): Promise; + } + export = Particle; +} diff --git a/packages/particle-collider/src/index.ts b/packages/particle-collider/src/index.ts new file mode 100644 index 00000000..ca81d3af --- /dev/null +++ b/packages/particle-collider/src/index.ts @@ -0,0 +1,18 @@ +import App from './App'; + +process.on('uncaughtException', (exception: Error) => { + console.error( + 'uncaughtException', + { message: exception.message, stack: exception.stack }, + ); // logging with MetaData +}); + +const app = new App(); +app.run(); + +// const serverUrl = '192.168.0.175'; +// +// const device = new TCPDevice(serverUrl, 5683); +// +// device.connect(); +// console.log('foobar'); diff --git a/packages/particle-collider/src/lib/ChunkingStream.ts b/packages/particle-collider/src/lib/ChunkingStream.ts new file mode 100644 index 00000000..e66d6a3c --- /dev/null +++ b/packages/particle-collider/src/lib/ChunkingStream.ts @@ -0,0 +1,123 @@ +import { Transform } from 'stream'; + +/** + Our job here is to accept messages in whole chunks, and put their length in front + as we send them out, and parse them back into those size chunks as we read them in. + **/ +/* eslint-disable no-bitwise */ + +const MSG_LENGTH_BYTES = 2; +const messageLengthBytes = ( + message: Buffer | string, +): Buffer | null | undefined => { + // assuming a maximum encrypted message length of 65K, lets write an + // unsigned short int before every message, so we know how much to read out. + if (!message) { + return null; + } + + const length = message.length; + const lengthBuffer = Buffer.alloc(MSG_LENGTH_BYTES); + + lengthBuffer[0] = length >>> 8; + lengthBuffer[1] = length & 255; + + return lengthBuffer; +}; + +type ChunkingStreamOptions = { + outgoing?: boolean; +}; + +class ChunkingStream extends Transform { + _expectedLength!: number; + _incomingBuffer: Buffer | null | undefined = null; + _incomingIndex: number = -1; + _outgoing: boolean; + + constructor(options: ChunkingStreamOptions) { + super(); + + this._outgoing = !!options.outgoing; + } + + process = (chunk: Buffer | null | undefined, callback: any) => { + if (!chunk) { + return; + } + + const isNewMessage = this._incomingIndex === -1; + let startIndex = 0; + if (isNewMessage) { + this._expectedLength = (chunk[0] << 8) + chunk[1]; + + // if we don't have a buffer, make one as big as we will need. + this._incomingBuffer = Buffer.alloc(this._expectedLength); + this._incomingIndex = 0; + startIndex = 2; // skip the first two. + } + + const bytesLeft = this._expectedLength - this._incomingIndex; + let endIndex = startIndex + bytesLeft; + if (endIndex > chunk.length) { + endIndex = chunk.length; + } + + if (startIndex < endIndex && this._incomingBuffer) { + if (this._incomingIndex >= this._incomingBuffer.length) { + throw new Error("hmm, shouldn't end up here."); + } + + chunk.copy( + this._incomingBuffer, + this._incomingIndex, + startIndex, + endIndex, + ); + } + + this._incomingIndex += endIndex - startIndex; + + let remainder: Buffer | null = null; + if (endIndex < chunk.length) { + remainder = Buffer.alloc(chunk.length - endIndex); + chunk.copy(remainder, 0, endIndex, chunk.length); + } + + if (this._incomingIndex === this._expectedLength && this._incomingBuffer) { + this.push(this._incomingBuffer); + this._incomingBuffer = null; + this._incomingIndex = -1; + this._expectedLength = -1; + if (!remainder && callback) { + process.nextTick(callback); + } else { + process.nextTick((): void => this.process(remainder, callback)); + } + } else { + process.nextTick(callback); + } + }; + + _transform = (chunk: Buffer | string, _encoding: string, callback: any) => { + const buffer = Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk); + + if (this._outgoing) { + // we should be passed whole messages here. + // write our length first, then message, then bail. + const lengthChunk = messageLengthBytes(chunk); + this.push(Buffer.concat(lengthChunk ? [lengthChunk, buffer] : [buffer])); + process.nextTick(callback); + } else { + // Collect chunks until we hit an expected size, and then trigger a + // readable + try { + process.nextTick((): void => this.process(buffer, callback)); + } catch (error: any) { + throw new Error(`ChunkingStream error!: ${error}`); + } + } + }; +} + +export default ChunkingStream; diff --git a/packages/particle-collider/src/lib/CoapType.ts b/packages/particle-collider/src/lib/CoapType.ts new file mode 100644 index 00000000..b2da697e --- /dev/null +++ b/packages/particle-collider/src/lib/CoapType.ts @@ -0,0 +1,9 @@ +const CoapType = { + CON: 0, + NON: 1, + ACK: 2, + RESET: 3, + ERROR: 4, +} as const; + +export default CoapType; diff --git a/packages/particle-collider/src/lib/CoapUriType.ts b/packages/particle-collider/src/lib/CoapUriType.ts new file mode 100644 index 00000000..43e32eb6 --- /dev/null +++ b/packages/particle-collider/src/lib/CoapUriType.ts @@ -0,0 +1,11 @@ +const CoapUriType = { + Describe: 'd', + Function: 'f', + Hello: 'h', + PrivateEvent: 'E', + PublicEvent: 'e', + Subscribe: 'e', + Variable: 'v', +} as const; + +export default CoapUriType; diff --git a/packages/particle-collider/src/lib/CryptoManager.ts b/packages/particle-collider/src/lib/CryptoManager.ts new file mode 100644 index 00000000..87c19269 --- /dev/null +++ b/packages/particle-collider/src/lib/CryptoManager.ts @@ -0,0 +1,59 @@ +import crypto from 'crypto'; +import NodeRSA from 'node-rsa'; + +import nullthrows from 'nullthrows'; + +const HASH_TYPE = 'sha1'; + +class CryptoManager { + _privateKey: NodeRSA; + + static _serverKey: NodeRSA | null | undefined; + + constructor(privateKey: NodeRSA) { + this._privateKey = privateKey; + } + + static getServerKey(): NodeRSA { + return nullthrows(CryptoManager._serverKey); + } + + static setServerKey(keyString: string): void { + CryptoManager._serverKey = new NodeRSA(keyString, 'pkcs8-public-pem', { + encryptionScheme: 'pkcs1', + signingScheme: 'pkcs1', + }); + } + + static loadPrivateKey(keyString: string): NodeRSA { + return new NodeRSA(keyString, undefined, { + encryptionScheme: 'pkcs1', + signingScheme: 'pkcs1', + }); + } + + static createKey(): NodeRSA { + return new NodeRSA({ + b: 1024, + }); + } + + static randomBytes(count: number): Buffer { + return crypto.randomBytes(count); + } + + static createHmacDigest = ( + ciphertext: Buffer, + sessionKey: Buffer, + ): Buffer => { + const hmac = crypto.createHmac(HASH_TYPE, sessionKey); + hmac.update(ciphertext); + return hmac.digest(); + }; + + encrypt(buffer: Buffer): Buffer { + return this._privateKey.encryptPrivate(buffer); + } +} + +export default CryptoManager; diff --git a/packages/particle-collider/src/lib/CryptoStream.ts b/packages/particle-collider/src/lib/CryptoStream.ts new file mode 100644 index 00000000..0a47de2f --- /dev/null +++ b/packages/particle-collider/src/lib/CryptoStream.ts @@ -0,0 +1,54 @@ +import crypto from 'crypto'; +import { Transform } from 'stream'; + +export type CryptoStreamType = 'decrypt' | 'encrypt'; + +type CryptoStreamOptions = { + iv: Buffer; + key: Buffer; + streamType: CryptoStreamType; +}; + +class CryptoStream extends Transform { + _key: Buffer; + _iv: Buffer; + _streamType: CryptoStreamType; + + constructor(options: CryptoStreamOptions) { + super(); + + this._key = options.key; + this._iv = options.iv; + this._streamType = options.streamType; + } + + _transform = (chunk: Buffer | string, encoding: string, callback: any) => { + if (!chunk.length) { + throw new Error( + `CryptoStream transform error: Chunk didn't have any length`, + ); + } + + try { + chunk = chunk as Buffer; + const cipherParams = ['aes-128-cbc', this._key, this._iv] as const; + const cipher = + this._streamType === 'encrypt' + ? crypto.createCipheriv(...cipherParams) + : crypto.createDecipheriv(...cipherParams); + + const output = Buffer.concat([cipher.update(chunk), cipher.final()]); + + const ivContainer = this._streamType === 'encrypt' ? output : chunk; + this._iv = Buffer.alloc(16); + ivContainer.copy(this._iv, 0, 0, 16); + + this.push(output); + } catch (error: any) { + throw new Error(`CryptoStream transform error: ${error}`); + } + callback(); + }; +} + +export default CryptoStream; diff --git a/packages/particle-collider/src/lib/NetworkThrottleStream.ts b/packages/particle-collider/src/lib/NetworkThrottleStream.ts new file mode 100644 index 00000000..edf9c30b --- /dev/null +++ b/packages/particle-collider/src/lib/NetworkThrottleStream.ts @@ -0,0 +1,30 @@ +import {Transform} from 'stream'; + +class NetworkThrottleStream extends Transform { + _millisecondDelay: number; + + constructor(millisecondDelay: number) { + super(); + + this._millisecondDelay = millisecondDelay; + } + + _transform = ( + chunk: Buffer | string, + encoding: string, + callback: any, + ) => { + const action = () => { + this.push(chunk); + callback(); + }; + if (!this._millisecondDelay) { + action(); + return; + } + + setTimeout(action, this._millisecondDelay); + } +} + +export default NetworkThrottleStream; diff --git a/packages/particle-collider/src/test-webhook.json b/packages/particle-collider/src/test-webhook.json new file mode 100644 index 00000000..b4a8eba2 --- /dev/null +++ b/packages/particle-collider/src/test-webhook.json @@ -0,0 +1,11 @@ +{ + "event": "test-webhook", + "requestType": "POST", + "responseTopic": "hook-response/test-webhook/{{PARTICLE_DEVICE_ID}}", + "json": { + "PARTICLE_DEVICE_ID": "{{PARTICLE_DEVICE_ID}}", + "PARTICLE_EVENT_VALUE": "{{PARTICLE_EVENT_VALUE}}", + "PARTICLE_PUBLISHED_AT": "{{PARTICLE_PUBLISHED_AT}}", + "payload": "{{payload}}" + } +} diff --git a/packages/particle-collider/tsconfig.json b/packages/particle-collider/tsconfig.json new file mode 100644 index 00000000..ab95b10b --- /dev/null +++ b/packages/particle-collider/tsconfig.json @@ -0,0 +1,28 @@ +{ + "compilerOptions": { + "module": "CommonJS", + "baseUrl": "./src", + "outDir": "./dist", + "typeRoots": ["node_modules/@types", "src/types"], + "esModuleInterop": true, + "forceConsistentCasingInFileNames": true, + "strict": true, + "skipLibCheck": true, + "declaration": true, + "allowSyntheticDefaultImports": true, + "noImplicitAny": true, + "moduleResolution": "node", + "sourceMap": true, + "experimentalDecorators": true, + "resolveJsonModule": true, + "allowJs": true + }, + "include": ["src"], + "exclude": ["node_modules", "dist"], + "ts-node": { + "compilerOptions": { + "module": "CommonJS" + }, + "files": true + } +} diff --git a/packages/spark-protocol/package.json b/packages/spark-protocol/package.json index ae3d81e3..e34d186a 100644 --- a/packages/spark-protocol/package.json +++ b/packages/spark-protocol/package.json @@ -1,6 +1,6 @@ { "name": "@brewskey/spark-protocol", - "version": "1.0.2", + "version": "1.0.3", "main": "./dist/index.js", "repository": { "type": "git", diff --git a/packages/spark-protocol/src/clients/Device.ts b/packages/spark-protocol/src/clients/Device.ts index 952e304b..b270bf67 100644 --- a/packages/spark-protocol/src/clients/Device.ts +++ b/packages/spark-protocol/src/clients/Device.ts @@ -714,6 +714,7 @@ class Device extends EventEmitter { 'URI filter did not match', ); } + reject(new Error('URI filter did not match')); return; } @@ -729,6 +730,7 @@ class Device extends EventEmitter { 'Tokens did not match', ); } + reject(new Error('Tokens did not match')); return; } cleanUpListeners(); diff --git a/src/__tests__/DevicesController.test.ts b/src/__tests__/DevicesController.test.ts index ea6b6acf..329eecf2 100644 --- a/src/__tests__/DevicesController.test.ts +++ b/src/__tests__/DevicesController.test.ts @@ -388,7 +388,7 @@ describe('DevicesController', () => { test('should start device flashing process with known application', async () => { const knownAppName = 'knownAppName'; - const knownAppBuffer = new Buffer(knownAppName); + const knownAppBuffer = Buffer.from(knownAppName); const deviceFirmwareStub = sinon .stub( diff --git a/src/controllers/WebhooksController.ts b/src/controllers/WebhooksController.ts index 57b6f95f..d22ba058 100644 --- a/src/controllers/WebhooksController.ts +++ b/src/controllers/WebhooksController.ts @@ -10,6 +10,7 @@ import { HttpResult } from './types'; const validateWebhookMutator = ( webhookMutator: WebhookMutator, ): HttpError | null | undefined => { + console.error(webhookMutator); if (!webhookMutator.event) { return new HttpError('no event name provided'); } diff --git a/src/managers/WebhookManager.ts b/src/managers/WebhookManager.ts index f957a9b4..76d8ba54 100644 --- a/src/managers/WebhookManager.ts +++ b/src/managers/WebhookManager.ts @@ -320,6 +320,7 @@ class WebhookManager { name: webhook.event, requestOptions, responseBody, + responseEventData, webhook, }, 'Webhook', diff --git a/src/repository/DeviceAttributeDatabaseRepository.ts b/src/repository/DeviceAttributeDatabaseRepository.ts index af176199..c4da96c6 100644 --- a/src/repository/DeviceAttributeDatabaseRepository.ts +++ b/src/repository/DeviceAttributeDatabaseRepository.ts @@ -55,13 +55,14 @@ class DeviceAttributeDatabaseRepository .filter(filterFalsyValues); }; - getByID: (deviceID: string) => Promise = - async (deviceID: string): Promise => - this._parseVariables( - await this._database.findOne(this._collectionName, { - deviceID: deviceID.toLowerCase(), - }), - ); + getByID = async ( + deviceID: string, + ): Promise => + this._parseVariables( + await this._database.findOne(this._collectionName, { + deviceID: deviceID.toLowerCase(), + }), + ); getByName = async (name: string): Promise => this._parseVariables( diff --git a/src/repository/MongoDb.ts b/src/repository/MongoDb.ts index b7852181..596ff5d9 100644 --- a/src/repository/MongoDb.ts +++ b/src/repository/MongoDb.ts @@ -135,6 +135,10 @@ class MongoDb< const resultItem = await collection.findOne( this.__translateQuery(query), ); + + if (!resultItem) { + console.error(new Error(), collectionName, query); + } return nullthrows( this.__translateResultItem(resultItem as unknown as TEntity), );