Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 | 3x 3x 3x 3x 3x 947x 947x 947x 8235x 8235x 8155x 8155x 787x 48x 787x 8235x 48x 48x 8187x 2309x 337x 1972x 657x 1315x 301x 301x 301x 2973x 24x 24x 24x 2949x 2949x 32x 32x 2917x 301x 1163x 24x 1139x 497x 497x 642x 8x 8x 634x 610x 301x 624x 16x 608x 584x 301x 1186x 16x 1170x 497x 497x 673x 8x 8x 665x 8x 8x 657x 657x 8x 8x 649x 649x 649x 649x 665x 665x 665x 649x 16x 16x 16x 16x 16x 16x 16x 8x 8x 8x 16x 16x 649x 617x 301x 301x 301x 301x 3x 3x 341x 341x 341x 1364x 391x 391x 455x 682x 682x 341x 341x 341x 8x 8x 341x 341x 88x 8x 341x 341x 341x 341x 341x 341x 3x 893x 8x 885x 24x 861x 861x 861x 861x 80x 861x 861x 266x 861x 861x 3x 96x 96x 96x 16x 96x 96x 3x | /**
# mqlobber-access-control [](https://travis-ci.org/davedoesdev/mqlobber-access-control) [](https://coveralls.io/r/davedoesdev/mqlobber-access-control?branch=master) [](http://badge.fury.io/js/mqlobber-access-control)
Access control for [mqlobber](https://github.com/davedoesdev/mqlobber) message
queues. Specify to which topics clients can (and can't) subscribe, publish and
receive.
The API is described [here](#api).
## Example:
Here's a server program which listens on a TCP port specified on the command
line. It allows clients to:
- Publish messages to topics matching `foo.bar.#` (i.e. any topic beginning with `foo.bar.`) but _not_ to `foo.bar.reserved`
- Subscribe to messages with topics matching `foo.#` (i.e. any topic beginning with `foo.`)
```javascript
// server.js
var net = require('net'),
QlobberFSQ = require('qlobber-fsq').QlobberFSQ,
MQlobberServer = require('mqlobber').MQlobberServer,
AccessControl = require('mqlobber-access-control').AccessControl,
fsq = new QlobberFSQ();
fsq.on('start', function ()
{
var server = net.createServer().listen(parseInt(process.argv[2]));
server.on('connection', function (c)
{
new AccessControl(
{
publish: { allow: [ 'foo.bar.#' ],
disallow: [ 'foo.bar.reserved' ] },
subscribe: { allow: [ 'foo.#' ] }
}).attach(new MQlobberServer(fsq, c));
});
});
```
Next, a program which connects to the server and subscribes to messages published to a topic:
```javascript
// client_subscribe.js
var assert = require('assert'),
MQlobberClient = require('mqlobber').MQlobberClient,
c = require('net').createConnection(parseInt(process.argv[2])),
mq = new MQlobberClient(c),
topic = process.argv[3];
mq.subscribe(topic, function (s, info)
{
var msg = '';
s.on('readable', function ()
{
var data;
while ((data = this.read()) !== null)
{
msg += data.toString();
}
});
s.on('finish', function ()
{
c.end();
});
s.on('end', function ()
{
console.log('received', info.topic, msg);
assert.equal(msg, 'hello');
});
}, assert.ifError);
```
Finally, a program which connects to the server and publishes a message to a topic:
```javascript
// client_publish.js
var assert = require('assert'),
MQlobberClient = require('mqlobber').MQlobberClient,
c = require('net').createConnection(parseInt(process.argv[2])),
mq = new MQlobberClient(c);
mq.publish(process.argv[3], function (err)
{
assert.ifError(err);
c.end();
}).end('hello');
```
Run two servers listening on ports 8600 and 8601:
```shell
$ node server.js 8600 &
$ node server.js 8601 &
```
Try to subscribe to topic `test`:
```shell
$ node client_subscribe.js 8600 test
[Error: blocked subscribe to topic: test]
assert.js:362
assert.ifError = function(err) { if (err) throw err; };
^
Error: server error
at BPDuplex.<anonymous> (/tmp/wup/node_modules/mqlobber/lib/client.js:423:27)
at emitTwo (events.js:87:13)
at BPDuplex.emit (events.js:172:7)
at BPMux._process_header (/tmp/wup/node_modules/mqlobber/node_modules/bpmux/index.js:652:20)
at null.<anonymous> (/tmp/wup/node_modules/mqlobber/node_modules/bpmux/index.js:514:29)
at emitNone (events.js:67:13)
at emit (events.js:166:7)
at emitReadable_ (_stream_readable.js:419:10)
at emitReadable (_stream_readable.js:413:7)
at readableAddChunk (_stream_readable.js:164:13)
```
Subscribe to two topics, `foo.bar` and wildcard topic `foo.*`, one against each
server:
```shell
$ node client_subscribe.js 8600 foo.bar &
$ node client_subscribe.js 8601 'foo.*' &
```
Try to publish to topic `foo.bar.reserved`:
```shell
$ node client_publish.js 8600 foo.bar.reserved
node client_publish.js 8600 foo.bar.reserved
[Error: blocked publish to topic: foo.bar.reserved]
assert.js:362
assert.ifError = function(err) { if (err) throw err; };
^
Error: server error
at BPDuplex.<anonymous> (/tmp/wup/node_modules/mqlobber/lib/client.js:633:27)
at emitTwo (events.js:87:13)
at BPDuplex.emit (events.js:172:7)
at BPMux._process_header (/tmp/wup/node_modules/mqlobber/node_modules/bpmux/index.js:652:20)
at null.<anonymous> (/tmp/wup/node_modules/mqlobber/node_modules/bpmux/index.js:514:29)
at emitNone (events.js:67:13)
at emit (events.js:166:7)
at emitReadable_ (_stream_readable.js:419:10)
at emitReadable (_stream_readable.js:413:7)
at readableAddChunk (_stream_readable.js:164:13)
```
Then publish a message to the topic `foo.bar`:
```shell
$ node client_publish.js 8600 foo.bar
received foo.bar hello
received foo.bar hello
[3]- Done node client_subscribe.js 8600 foo.bar
[4]+ Done node client_subscribe.js 8601 'foo.*'
```
Only the servers should still be running and you can now terminate them:
```shell
$ jobs
[1]- Running node server.js 8600 &
[2]+ Running node server.js 8601 &
$ kill %1 %2
[1]- Terminated node server.js 8600
[2]+ Terminated node server.js 8601
```
## Installation
```shell
npm install mqlobber-access-control
```
## Licence
[MIT](LICENCE)
## Test
```shell
grunt test
```
## Lint
```shell
grunt lint
```
## Code Coverage
```shell
grunt coverage
```
[Istanbul](http://gotwarlost.github.io/istanbul/) results are available [here](http://rawgit.davedoesdev.com/davedoesdev/mqlobber-access-control/master/coverage/lcov-report/index.html).
Coveralls page is [here](https://coveralls.io/r/davedoesdev/mqlobber-access-control).
# API
*/
"use strict";
var EventEmitter = require('events').EventEmitter,
util = require('util'),
wu = require('wu'),
Transform = require('stream').Transform,
QlobberDedup = require('qlobber').QlobberDedup;
function filter(info, handlers, cb)
{
var access_controls = new Set();
var blocked_handlers = new Set();
cb(null, true, wu(handlers).filter(function (handler)
{
var server = handler.mqlobber_server, access_control;
if (server)
{
access_control = server.mqlobber_access_control;
if (access_control && !access_controls.has(access_control))
{
for (var h of access_control._blocked_matcher.match(info.topic))
{
blocked_handlers.add(h);
}
access_controls.add(access_control);
}
}
if (blocked_handlers.has(handler))
{
access_control.emit('message_blocked', info.topic, server);
return false;
}
return true;
}));
}
function allow(matchers, topic)
{
if (matchers.disallow &&
matchers.disallow.match(topic).size > 0)
{
return false;
}
if (matchers.allow &&
matchers.allow.match(topic).size === 0)
{
return false;
}
return true;
}
/**
Create a new `AccessControl` object for applying access control on publish
and subscribe requests to [`MQlobberServer`](https://github.com/davedoesdev/mqlobber#mqlobberserverfsq-stream-options) objects and messages delivered to
clients.
Calls [`reset`](#accesscontrolprototyperesetoptions) after creating the object.
@constructor
@param {Object} options See [`reset`](#accesscontrolprototyperesetoptions) for valid options.
*/
function AccessControl(options)
{
EventEmitter.call(this);
var ths = this;
this._check_topic = function (topic, done, name, adding)
{
if (ths._max_topic_length && (topic.length > ths._max_topic_length))
{
done(new Error(`${name} topic longer than ` +
ths._max_topic_length));
ths.emit(`${name}_blocked`, topic, this);
return false;
}
try
{
this._blocked_matcher._split(topic, adding);
}
catch (ex)
{
done(new Error(`${name} ${ex.message}`));
return false;
}
return true;
};
this._pre_subscribe_requested = function (topic, done)
{
if (!ths._check_topic(topic, done, 'subscribe', true))
{
return;
}
if (!allow(ths._matchers.subscribe, topic))
{
done(new Error('blocked subscribe to topic: ' + topic));
return ths.emit('subscribe_blocked', topic, this);
}
if (ths._max_subscriptions &&
(this.subs.size >= ths._max_subscriptions) &&
!this.subs.has(topic))
{
done(new Error('subscription limit ' + ths._max_subscriptions +
' already reached: ' + topic));
return ths.emit('subscribe_blocked', topic, this);
}
if (!ths.emit('subscribe_requested', this, topic, done) &&
!this.emit('subscribe_requested', topic, done))
{
this.default_subscribe_requested_handler(topic, done);
}
};
this._pre_unsubscribe_requested = function (topic, done)
{
if (!ths._check_topic(topic, done, 'unsubscribe', false))
{
return;
}
if (!ths.emit('unsubscribe_requested', this, topic, done) &&
!this.emit('unsubscribe_requested', topic, done))
{
this.default_unsubscribe_requested_handler(topic, done);
}
};
this._pre_publish_requested = function (topic, duplex, options, done)
{
if (!ths._check_topic(topic, done, 'publish', false))
{
return;
}
if (!allow(ths._matchers.publish, topic))
{
done(new Error('blocked publish to topic: ' + topic));
return ths.emit('publish_blocked', topic, this);
}
if (ths._disallow_publish_single && options.single)
{
done(new Error('blocked publish (single) to topic: ' + topic));
return ths.emit('publish_blocked', topic, this);
}
if (ths._disallow_publish_multi && !options.single)
{
done(new Error('blocked publish (multi) to topic: ' + topic));
return ths.emit('publish_blocked', topic, this);
}
var server = this;
if (ths._max_publications &&
(server.mqlobber_access_control_publish_count >=
ths._max_publications))
{
done(new Error('publication limit ' + ths._max_publications +
' already reached: ' + topic));
return ths.emit('publish_blocked', topic, this);
}
server.mqlobber_access_control_publish_count += 1;
var decrement = function ()
{
server.mqlobber_access_control_publish_count -= 1;
done.apply(this, arguments);
};
function done2()
{
/*jshint validthis: true */
var dec = decrement;
decrement = done; // only decrement once
dec.apply(this, arguments);
}
if (ths._max_publish_data_length)
{
var t = new Transform(),
count = 0;
t.on('error', this.relay_error);
t.on('error', done2);
t._transform = function (chunk, enc, cont)
{
count += chunk.length;
if (count > ths._max_publish_data_length)
{
return cont(new Error('message data exceeded limit ' +
ths._max_publish_data_length + ': ' +
topic));
}
this.push(chunk);
cont();
};
duplex.pipe(t);
duplex = t;
}
if (!ths.emit('publish_requested', this, topic, duplex, options, done2) &&
!this.emit('publish_requested', topic, duplex, options, done2))
{
this.default_publish_requested_handler(topic, duplex, options, done2);
}
};
this._blocked_topics = [];
this._blocked_handlers = new Set();
this._blocked_matcher = new QlobberDedup(options);
this.reset(options);
}
util.inherits(AccessControl, EventEmitter);
/**
Reset the access control applied by this object to client publish and subscribe
requests on attached [`MQlobberServer`](https://github.com/davedoesdev/mqlobber#mqlobberserverfsq-stream-options) objects and messages delivered to clients.
@param {Object} options Specifies to which topics clients should be allowed and disallowed to publish, subscribe and receive messages. It supports the following properties:
- `{Object} [publish]` Allowed and disallowed topics for publish requests, with the following properties:
- `{Array} [allow]` Clients can publish messages to these topics.
- `{Array} [disallow]` Clients cannot publish messages to these topics.
- `{Integer} [max_data_length]` Maximum number of bytes allowed in a published message.
- `{Integer} [max_publications]` Maximum number of messages each client can publish at any one time.
- `{Boolean} [disallow_single]` Whether to allow messages to be published to a single subscriber.
- `{Boolean} [disallow_multi]` Whether to allow messages to be published to multiple subscribers.
- `{Object} [subscribe]` Allowed and disallowed topics for subscribe requests, with the following properties:
- `{Array} [allow]` Clients can subscribe to messages published to these topics.
- `{Array} [disallow]` Clients cannot subscribe to messages published to these topics.
- `{Integer} [max_subscriptions]` Maximum number of topics to which each client can be subscribed at any one time.
- `{Array} [block]` Clients cannot receive messages published to these topics. This is useful if `subscribe.allow` is a superset of `subscribe.disallow` but you don't want messages matching (a subset of) `subscribe.disallow` sent to clients.
- `{Integer} [max_topic_length]` Maximum topic length for publish, subscribe and unsubscribe requests.
Topics are the same as [`mqlobber` topics](https://github.com/davedoesdev/mqlobber#mqlobberclientprototypesubscribetopic-handler-cb) and [`qlobber-fsq` topics](
https://github.com/davedoesdev/qlobber-fsq#qlobberfsqprototypesubscribetopic-handler-cb). They're split into words using `.` as the separator. You can use `*`
to match exactly one word in a topic or `#` to match zero or more words.
For example, `foo.*` would match `foo.bar` whereas `foo.#` would match `foo`,
`foo.bar` and `foo.bar.wup`.
Note these are the default separator and wildcard characters. They can be
changed when [constructing the `QlobberFSQ` instance](https://github.com/davedoesdev/qlobber-fsq#qlobberfsqoptions) or [`QlobberPG` instance](https://github.com/davedoesdev/qlobber-pg) passed to
[`MQlobberServer`'s constructor](https://github.com/davedoesdev/mqlobber#mqlobberserverfsq-stream-options). If you do change them, make sure you specify the
changed values in `options` too.
There's also a limit on the number of words and `#` words, imposed by
`Qlobber`. For defaults, see `max_words` and `max_wildcard_somes`
[here](https://github.com/davedoesdev/qlobber#qlobberoptions). You can change
the limits by specifying `max_words` and/or `max_wildcard_somes` in `options`.
Note also that for subscribe requests, `AccessControl` matches topics you
specify here against topics in the requests, which can themselves contain
wildcard specifiers.
Disallowed topics take precedence over allowed ones. So if a topic in a
publish or subscribe request matches a disallowed topic specifier, it's blocked
even if it also matches an allowed topic specifier.
Access control is only applied where topics are specified.
*/
AccessControl.prototype.reset = function (options)
{
var ths = this, topic, handler;
options = Object.assign({}, options);
this._matchers = {
publish: {},
subscribe: {}
};
function make(type, access)
{
if (options[type] && options[type][access])
{
ths._matchers[type][access] = new QlobberDedup(options);
for (topic of options[type][access])
{
ths._matchers[type][access].add(topic, true);
}
}
}
function setup(type)
{
make(type, 'allow');
make(type, 'disallow');
}
setup('publish');
setup('subscribe');
for (topic of this._blocked_topics)
{
for (handler of this._blocked_handlers)
{
this._blocked_matcher.remove(topic, handler);
}
}
this._blocked_topics = options.block || [];
for (topic of this._blocked_topics)
{
for (handler of this._blocked_handlers)
{
this._blocked_matcher.add(topic, handler);
}
}
this._max_topic_length = options.max_topic_length;
this._max_subscriptions = options.subscribe ?
options.subscribe.max_subscriptions : 0;
this._max_publish_data_length = options.publish ?
options.publish.max_data_length : 0;
this._max_publications = options.publish ?
options.publish.max_publications : 0;
this._disallow_publish_single = options.publish ?
options.publish.disallow_single : false;
this._disallow_publish_multi = options.publish ?
options.publish.disallow_multi : false;
};
/**
Start applying access control to a [`MQlobberServer`](https://github.com/davedoesdev/mqlobber#mqlobberserverfsq-stream-options) object.
Only one `AccessControl` object can be attached to a `MQlobberServer` object at
a time. Trying to attach more than one will throw an exception.
If a conflict is detected between `server`'s configuration and the
`AccessControl` object's configuration (for example different separators or
different word limit) then an exception will be thrown.
@param {MQlobberServer} server Object to which to apply access control.
*/
AccessControl.prototype.attach = function (server)
{
if (server.mqlobber_access_control)
{
throw new Error('server has access control');
}
if ((server.fsq._matcher._separator !== this._blocked_matcher._separator) ||
(server.fsq._matcher._wildcard_one !== this._blocked_matcher._wildcard_one) ||
(server.fsq._matcher._wildcard_some !== this._blocked_matcher._wildcard_some) ||
(server.fsq._matcher._max_words !== this._blocked_matcher._max_words) ||
(server.fsq._matcher._max_wildcard_somes !== this._blocked_matcher._max_wildcard_somes))
{
throw new Error('options mismatch');
}
server.on('pre_subscribe_requested', this._pre_subscribe_requested);
server.on('pre_unsubscribe_requested', this._pre_unsubscribe_requested);
server.on('pre_publish_requested', this._pre_publish_requested);
for (var topic of this._blocked_topics)
{
this._blocked_matcher.add(topic, server.handler);
}
this._blocked_handlers.add(server.handler);
if (server.fsq.filters.indexOf(filter) < 0)
{
server.fsq.filters.push(filter);
}
server.mqlobber_access_control_publish_count = 0;
server.mqlobber_access_control = this;
};
/**
Stop applying access control to a [`MQlobberServer`](https://github.com/davedoesdev/mqlobber#mqlobberserverfsq-stream-options) object.
@param {MQlobberServer} server Object to which to stop applying access control.
*/
AccessControl.prototype.detach = function (server)
{
server.removeListener('pre_subscribe_requested',
this._pre_subscribe_requested);
server.removeListener('pre_publish_requested',
this._pre_publish_requested);
for (var topic of this._blocked_topics)
{
this._blocked_matcher.remove(topic, server.handler);
}
this._blocked_handlers.delete(server.handler);
delete server.mqlobber_access_control;
};
exports.AccessControl = AccessControl;
|