Merge pull request #475 from Isabello/472-disable_api

Provide mechanisms to disable APIs and toggle Whitelists
LiskArchive · Mar 14, 2017 · 9fd150c · 9fd150c
2 parents c488b69 + 7a73199
commit 9fd150c
Show file tree

Hide file tree

Showing 16 changed files with 59 additions and 24 deletions.
diff --git a/app.js b/app.js
@@ -327,10 +327,14 @@ d.run(function () {
 
 				if (parts.length > 1) {
 					if (parts[1] === 'api') {
-						if (!checkIpInList(scope.config.api.access.whiteList, ip, true)) {
-							res.sendStatus(403);
-						} else {
+						if (scope.config.api.access.public === true) {
 							next();
+						} else {
+							if (checkIpInList(scope.config.api.access.whiteList, ip, false)) {
+								next();
+							} else {
+								res.sendStatus(403);
+							}
 						}
 					} else if (parts[1] === 'peer') {
 						if (checkIpInList(scope.config.peers.blackList, ip, false)) {

diff --git a/config.json b/config.json
@@ -22,8 +22,10 @@
         ]
     },
     "api": {
+        "enabled": true,
         "access": {
-            "whiteList": []
+            "public": false,
+            "whiteList": ["127.0.0.1"]
         },
         "options": {
             "limits": {
@@ -35,6 +37,7 @@
         }
     },
     "peers": {
+        "enabled": true,
         "list": [
             {
                 "ip": "40.68.214.86",
@@ -77,7 +80,9 @@
                 "port": 8000
             }
         ],
-        "blackList": [],
+        "access": {
+            "blackList": []
+        },
         "options": {
             "limits": {
                 "max": 0,

diff --git a/helpers/router.js b/helpers/router.js
@@ -27,7 +27,7 @@ function Map (root, config) {
  * @overview Router stub
  * @returns {*}
  */
-var Router = function () {
+var Router = function (config) {
 	var router = require('express').Router();
 
 	router.use(function (req, res, next) {
@@ -38,6 +38,12 @@ var Router = function () {
 
 	router.map = Map;
 
+	if (config.enabled === false) {
+		router.use(function (req, res, next) {
+			res.status(500).send({success: false, error: 'API endpoint disabled'});
+		});
+	}
+
 	return router;
 };
 

diff --git a/modules/accounts.js b/modules/accounts.js
@@ -34,7 +34,7 @@ function Accounts (cb, scope) {
 
 // Private methods
 __private.attachApi = function () {
-	var router = new Router();
+	var router = new Router(library.config.api);
 
 	router.use(function (req, res, next) {
 		if (modules) { return next(); }

diff --git a/modules/blocks.js b/modules/blocks.js
@@ -89,7 +89,7 @@ function Blocks (cb, scope) {
 
 // Private methods
 __private.attachApi = function () {
-	var router = new Router();
+	var router = new Router(library.config.api);
 
 	router.use(function (req, res, next) {
 		if (modules) { return next(); }

diff --git a/modules/dapps.js b/modules/dapps.js
@@ -94,7 +94,7 @@ function DApps (cb, scope) {
 }
 
 __private.attachApi = function () {
-	var router = new Router();
+	var router = new Router(library.config.api);
 
 	router.use(function (req, res, next) {
 		if (modules) { return next(); }

diff --git a/modules/delegates.js b/modules/delegates.js
@@ -42,7 +42,7 @@ function Delegates (cb, scope) {
 
 // Private methods
 __private.attachApi = function () {
-	var router = new Router();
+	var router = new Router(library.config.api);
 
 	router.use(function (req, res, next) {
 		if (modules && __private.loaded) { return next(); }

diff --git a/modules/loader.js b/modules/loader.js
@@ -45,7 +45,7 @@ __private.initalize = function () {
 };
 
 __private.attachApi = function () {
-	var router = new Router();
+	var router = new Router(library.config.api);
 
 	router.get('/status/ping', function (req, res) {
 		__private.ping(function (status, body) {

diff --git a/modules/multisignatures.js b/modules/multisignatures.js
@@ -34,7 +34,7 @@ function Multisignatures (cb, scope) {
 
 // Private methods
 __private.attachApi = function () {
-	var router = new Router();
+	var router = new Router(library.config.api);
 
 	router.use(function (req, res, next) {
 		if (modules) { return next(); }

diff --git a/modules/peers.js b/modules/peers.js
@@ -30,7 +30,7 @@ function Peers (cb, scope) {
 
 // Private methods
 __private.attachApi = function () {
-	var router = new Router();
+	var router = new Router(library.config.api);
 
 	router.use(function (req, res, next) {
 		if (modules) { return next(); }

diff --git a/modules/server.js b/modules/server.js
@@ -22,7 +22,7 @@ function Server (cb, scope) {
 
 // Private methods
 __private.attachApi = function () {
-	var router = new Router();
+	var router = new Router({});
 
 	router.use(function (req, res, next) {
 		if (modules) { return next(); }

diff --git a/modules/signatures.js b/modules/signatures.js
@@ -32,7 +32,7 @@ function Signatures (cb, scope) {
 
 // Private methods
 __private.attachApi = function () {
-	var router = new Router();
+	var router = new Router(library.config.api);
 
 	router.use(function (req, res, next) {
 		if (modules) { return next(); }

diff --git a/modules/transactions.js b/modules/transactions.js
@@ -44,7 +44,7 @@ function Transactions (cb, scope) {
 
 // Private methods
 __private.attachApi = function () {
-	var router = new Router();
+	var router = new Router(library.config.api);
 
 	router.use(function (req, res, next) {
 		if (modules) { return next(); }

diff --git a/modules/transport.js b/modules/transport.js
@@ -35,7 +35,7 @@ function Transport (cb, scope) {
 
 // Private methods
 __private.attachApi = function () {
-	var router = new Router();
+	var router = new Router(library.config.peers);
 
 	router.use(function (req, res, next) {
 		res.set(__private.headers);

diff --git a/schema/config.js b/schema/config.js
@@ -76,14 +76,20 @@ module.exports = {
 			api: {
 				type: 'object',
 				properties: {
+					enabled: {
+						type: 'boolean'
+					},
 					access: {
 						type: 'object',
 						properties: {
+							public: {
+								type: 'boolean'
+							},
 							whiteList: {
 								type: 'array'
 							}
 						},
-						required: ['whiteList']
+						required: ['public', 'whiteList']
 					},
 					options: {
 						type: 'object',
@@ -110,16 +116,25 @@ module.exports = {
 						required: ['limits']
 					}
 				},
-				required: ['access', 'options']
+				required: ['enabled', 'access', 'options']
 			},
 			peers: {
 				type: 'object',
 				properties: {
+					enabled: {
+						type: 'boolean'
+					},
 					list: {
 						type: 'array'
 					},
-					blackList: {
-						type: 'array'
+					access: {
+						type: 'object',
+						properties: {
+							blackList: {
+								type: 'array'
+							}
+						},
+						required: ['blackList']
 					},
 					options: {
 						properties: {
@@ -148,7 +163,7 @@ module.exports = {
 						required: ['limits', 'timeout']
 					}
 				},
-				required: ['list', 'blackList', 'options']
+				required: ['enabled', 'list', 'access', 'options']
 			},
 			broadcasts: {
 				type: 'object',

diff --git a/test/config.json b/test/config.json
@@ -22,8 +22,10 @@
         ]
     },
     "api": {
+        "enabled": true,
         "access": {
-            "whiteList": []
+            "public": true,
+            "whiteList": ["127.0.0.1"]
         },
         "options": {
             "limits": {
@@ -35,8 +37,11 @@
         }
     },
     "peers": {
+	"enabled": true,
         "list": [],
-        "blackList": [],
+        "access": {
+            "blackList": []
+        },
         "options": {
             "limits": {
                 "max": 0,