diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml index 0ba60aedc..20ffa70e6 100644 --- a/docker/docker-compose.yml +++ b/docker/docker-compose.yml @@ -81,7 +81,7 @@ services: MF_HTTP_ADAPTER_PORT: 8182 mqtt-adapter: - image: mainflux/mqtt-adapter:latest + image: mainflux/mqtt:latest container_name: mainflux-mqtt depends_on: - manager diff --git a/mqtt/.dockerignore b/mqtt/.dockerignore new file mode 100644 index 000000000..5e726c396 --- /dev/null +++ b/mqtt/.dockerignore @@ -0,0 +1,3 @@ +.git +node_modules +test diff --git a/mqtt/.eslintrc.json b/mqtt/.eslintrc.json new file mode 100644 index 000000000..e43a81fa5 --- /dev/null +++ b/mqtt/.eslintrc.json @@ -0,0 +1,7 @@ +{ + "extends": ["airbnb-base/legacy"], + "rules": { + "func-names": ["error", "never"], + "indent": ["error", 4] + } +} diff --git a/mqtt/.gitignore b/mqtt/.gitignore new file mode 100644 index 000000000..e5e308e89 --- /dev/null +++ b/mqtt/.gitignore @@ -0,0 +1,51 @@ +# Logs +logs +*.log + +# Runtime data +pids +*.pid +*.seed + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directory +# Deployed apps should consider commenting this line out: +# see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git +node_modules +package-lock.json + +# Visual Studio files +*.sln +*.njsproj + +# Vim files +# swap +[._]*.s[a-w][a-z] +[._]s[a-w][a-z] +# session +Session.vim +# temporary +.netrwhist +*~ +# auto-generated tag files +tags + +# Go sources +./src + +# Go tests +*.test + +# Binary +mainflux-mqtt diff --git a/mqtt/.travis.yml b/mqtt/.travis.yml new file mode 100644 index 000000000..1a0714602 --- /dev/null +++ b/mqtt/.travis.yml @@ -0,0 +1,20 @@ +language: node_js +node_js: + - "4.0" + +services: + - mongodb + +addons: + apt: + sources: + - ubuntu-toolchain-r-test + packages: + - g++-4.8 +env: + - CXX=g++-4.8 + +before_script: + - npm install -g gulp + +script: gulp test diff --git a/mqtt/CONTRIBUTING.md b/mqtt/CONTRIBUTING.md new file mode 100644 index 000000000..e69de29bb diff --git a/mqtt/Dockerfile b/mqtt/Dockerfile new file mode 100644 index 000000000..0a142ea91 --- /dev/null +++ b/mqtt/Dockerfile @@ -0,0 +1,18 @@ +### +# Mainflux Dockerfile +### +# Set the base image to Node, onbuild variant: https://registry.hub.docker.com/_/node/ + +FROM node:boron-alpine +MAINTAINER Mainflux + +COPY . . +RUN npm install + +EXPOSE 1883 +EXPOSE 8880 + +### +# Run main command with dockerize +### +CMD ["node", "mqtt.js"] diff --git a/mqtt/LICENSE b/mqtt/LICENSE new file mode 100644 index 000000000..cd8652f96 --- /dev/null +++ b/mqtt/LICENSE @@ -0,0 +1,191 @@ + + Apache License + Version 2.0, January 2004 + https://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2015 Mainflux + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/mqtt/MAINTAINERS b/mqtt/MAINTAINERS new file mode 100644 index 000000000..e69de29bb diff --git a/mqtt/README.md b/mqtt/README.md new file mode 100644 index 000000000..9a7ff65c3 --- /dev/null +++ b/mqtt/README.md @@ -0,0 +1,13 @@ +# Mainflux MQTT Server + +[![License](https://img.shields.io/badge/license-Apache%20v2.0-blue.svg)](LICENSE) [![Join the chat at https://gitter.im/Mainflux/mainflux](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Mainflux/mainflux?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + +MQTT broker microservice of Mainflux IoT platform. + +Based on [Aedes](https://github.com/mcollina/aedes), [extremely fast](http://www.nearform.com/nodecrunch/performance-reaching-ludicrous-speed/) MQTT broker implemented in NodeJS. + +### Documentation +Development documentation can be found on our [Mainflux GitHub Wiki](https://github.com/Mainflux/mainflux/wiki). + +### License +[Apache License, version 2.0](LICENSE) diff --git a/mqtt/examples/paho-js-client/index.html b/mqtt/examples/paho-js-client/index.html new file mode 100644 index 000000000..7eef8bf93 --- /dev/null +++ b/mqtt/examples/paho-js-client/index.html @@ -0,0 +1,72 @@ + + + + + + + + + + + diff --git a/mqtt/message.proto b/mqtt/message.proto new file mode 100644 index 000000000..0dda26b1b --- /dev/null +++ b/mqtt/message.proto @@ -0,0 +1,28 @@ +syntax = "proto3"; +package mainflux; + +// RawMessage represents a message emitted by the Mainflux adapters layer. +message RawMessage { + string Channel = 1; + string Publisher = 2; + string Protocol = 3; + string ContentType = 4; + bytes Payload = 5; +} + +// Message represents a resolved (normalized) raw message. +message Message { + string Channel = 1; + string Publisher = 2; + string Protocol = 3; + string Name = 4; + string Unit = 5; + double Value = 6; + string StringValue = 7; + bool BoolValue = 8; + string DataValue = 9; + double ValueSum = 10; + double Time = 11; + double UpdateTime = 12; + string Link = 13; +} diff --git a/mqtt/mqtt.config.js b/mqtt/mqtt.config.js new file mode 100644 index 000000000..b6c600b40 --- /dev/null +++ b/mqtt/mqtt.config.js @@ -0,0 +1,13 @@ +'use strict'; + +// Service configuration +module.exports = { + mqtt_port: process.env.MQTT_PORT || 1883, + ws_port: process.env.WS_PORT || 8880, + // NATS broker URL + nats_url: process.env.MQTT_ADAPTER_NATS_URL || 'nats://localhost:4222', + // Auth service URL + auth_url: process.env.AUTH_URL || 'http://localhost', + // Auth service port + auth_port: process.env.AUTH_PORT || 8180 +}; diff --git a/mqtt/mqtt.js b/mqtt/mqtt.js new file mode 100644 index 000000000..f6c69e667 --- /dev/null +++ b/mqtt/mqtt.js @@ -0,0 +1,211 @@ +/** + * Copyright (c) Mainflux + * + * Mainflux server is licensed under an Apache license, version 2.0 license. + * All rights not explicitly granted in the Apache license, version 2.0 are reserved. + * See the included LICENSE file for more details. + */ + +'use strict'; + +var http = require('http'); +var websocket = require('websocket-stream'); +var net = require('net'); +var aedes = require('aedes')(); +var logging = require('aedes-logging'); +var request = require('request'); +const util = require('util') + +var config = require('./mqtt.config'); +var nats = require('nats').connect(config.nats_url); + +var protobuf = require('protocol-buffers'); +const fs = require('fs'); + +// pass a proto file as a buffer/string or pass a parsed protobuf-schema object +var message = protobuf(fs.readFileSync('message.proto')); + +var servers = [ + startWs(), + startMqtt() +]; + +logging({ + instance: aedes, + servers: servers +}); + +/** + * WebSocket + */ +function startWs() { + var server = http.createServer(); + websocket.createServer({ + server: server + }, aedes.handle); + server.listen(config.ws_port); + return server; +} +/** + * MQTT + */ +function startMqtt() { + return net.createServer(aedes.handle).listen(config.mqtt_port); +} +/** + * NATS + */ +nats.subscribe('channel.*', function (msg) { + + var m = message.RawMessage.decode(Buffer.from(msg)) + + if (m.Protocol == 'mqtt') { + // Ignore MQTT loopback, + // packet has been already published by MQTT broker + // before sending it to NATS + return; + } + + // Parse and adjust content-type + if (m.ContentType == "application/senml+json") { + m.ContentType = "senml-json" + } + + var packet = { + cmd: 'publish', + qos: 2, + topic: 'mainflux/channels/' + m.Channel + '/messages/' + m.ContentType, + payload: m.Payload, + retain: false + }; + + aedes.publish(packet); +}); + +/** + * Hooks + */ +// AuthZ PUB +aedes.authorizePublish = function (client, packet, callback) { + // Topics are in the form `mainflux/channels//messages/senml-json` + var channel = packet.topic.split('/')[2]; + + /** + * Check if PUB is authorized + */ + var options = { + url: config.auth_url + ':' + config.auth_port + '/channels/' + channel + '/access-grant', + method: 'GET', + headers: { + 'Content-Type': 'application/json', + 'Authorization': client.password + } + }; + + request(options, function (err, res) { + var error = null; + var msg = {}; + if (res && (res.statusCode === 200)) { + console.log('Publish authorized OK'); + + var msg = message.RawMessage.encode({ + /** + * We must publish on NATS here, because on_publish() is also called + * when we receive message from NATS from other adapters (in nats.subscribe()), + * so we must avoid re-publishing on NATS what came from other adapters + */ + Publisher: client.id, + Channel: channel, + Protocol: 'mqtt', + ContentType: packet.topic.split('/')[4], + Payload: packet.payload + }); + + console.log(msg); + + console.log(util.inspect(packet, false, null)) + + // Pub on NATS + nats.publish('channel.' + channel, msg); + } else { + console.log('Publish not authorized'); + error = 4; // Bad username or password + } + callback(error); + }); +}; + +// AuthZ SUB +aedes.authorizeSubscribe = function (client, packet, callback) { + // Topics are in the form `mainflux/channels//messages/senml-json` + var channel = packet.topic.split('/')[2]; + /** + * Check if PUB is authorized + */ + var options = { + url: config.auth_url + ':' + config.auth_port + '/channels/' + channel + '/access-grant', + method: 'GET', + headers: { + 'Content-Type': 'application/json', + 'Authorization': client.password + } + }; + + request(options, function (err, res) { + var error = null; + if (res && (res.statusCode === 200)) { + console.log('Subscribe authorized OK'); + } else { + console.log('Subscribe not authorized'); + error = 4; // Bad username or password + } + callback(error, packet); + }); +}; + +// AuthX +aedes.authenticate = function (client, username, password, callback) { + var c = client; + var options = { + url: config.auth_url + ':' + config.auth_port + '/access-grant', + method: 'GET', + headers: { + 'Content-Type': 'application/json', + 'Authorization': password + } + }; + request(options, function (err, res) { + var error = null; + var success = null; + if (res && (res.statusCode === 200)) { + // Set MQTT client.id to correspond to Mainflux device UUID + c.id = res.headers['x-client-id']; + // Store password for future references + c.password = password; + success = true; + } else { + error = new Error('Auth error'); + error.returnCode = 4; // Bad username or password + success = false; + } + // Respond with auth error and success + callback(error, success); + }); +}; +/** + * Handlers + */ +aedes.on('clientDisconnect', function (client) { + var c = client; + console.log('client disconnect', client.id); + // Remove client password + c.password = null; +}); + +aedes.on('clientError', function (client, err) { + console.log('client error', client.id, err.message, err.stack) +}) + +aedes.on('connectionError', function (client, err) { + console.log('client error', client, err.message, err.stack) +}) diff --git a/mqtt/package.json b/mqtt/package.json new file mode 100644 index 000000000..9e447702f --- /dev/null +++ b/mqtt/package.json @@ -0,0 +1,46 @@ +{ + "name": "mqtt-adapter", + "description": "Mainflux is an open source MIT licensed IoT cloud written in NodeJS", + "main": "mqtt.js", + "repository": { + "type": "git", + "url": "https://github.com/Mainflux/mqtt-adapter" + }, + "license": "Apache-2.0", + "scripts": { + "start": "node mqtt.js", + "test": "node_modules/.bin/mocha", + "lint": "eslint mqtt.js" + }, + "dependencies": { + "aedes": "^0.33.0", + "aedes-logging": "^1.0.1", + "atob": "^2.0.3", + "bunyan": "^1.5.1", + "gulp-exit": "0.0.2", + "gulp-jshint": "^1.12.0", + "gulp-mocha": "^2.2.0", + "gulp-nodemon": "^2.0.7", + "lodash": "~3.10.1", + "mongojs": "^1.4.1", + "nats": "^0.6.8", + "protocol-buffers": "^4.0.4", + "request": "^2.81.0", + "toml": "^2.3.0", + "websocket-stream": "^3.3.2" + }, + "devDependencies": { + "chai": "^3.4.0", + "eslint": "^4.7.2", + "eslint-config-airbnb-base": "^12.0.1", + "eslint-plugin-import": "^2.7.0", + "gulp": "^3.9.0", + "gulp-exit": "0.0.2", + "gulp-jshint": "^1.11.2", + "gulp-mocha": "^2.1.3", + "gulp-nodemon": "^2.0.3", + "jshint-stylish": "^2.0.1", + "mocha": "^2.3.3", + "supertest": "^1.1.0" + } +}