npmpackage.info

aedes-protocol-decoder

Protocol decoder for Aedes MQTT Broker

2.2.0

MIT

JavaScript

Installations

npm install aedes-protocol-decoder

Pull Requests

Open

0

Total

8

Closed

1

Merged

7

Issues

Open

1

Total

3

Closed

2

Releases

Release 2.2.0

v2.2.0

Published on 20 Sept 2023

Release 2.1.0

v2.1.0

Published on 28 Jun 2021

Release 2.0.0

v2.0.0

Published on 28 Oct 2020

Release 1.0.0

v1.0.0

Published on 04 Feb 2020

View all 4 releases

Developer

moscajs

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=10

Typescript Support

Yes

Node Version

18.13.0

NPM Version

8.19.3 Statistics

3 Stars

20 Commits

3 Forks

8 Watching

2 Branches

3 Contributors

Updated on 20 Sept 2023

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

341,243

Last day

22.8%

528

Compared to previous day

Last week

11.2%

2,657

Compared to previous week

Last month

-13.4%

11,069

Compared to previous month

Last year

9.6%

83,029

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

forwarded proxy-protocol-js

Dev Dependencies

@types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser aedes aedes-server-factory faucet license-checker mqtt mqtt-packet nyc pre-commit release-it snazzy standard tape typescript

Versions

aedes-protocol-decoder

Protocol decoder for Aedes MQTT Broker

The purpose of this module is to be used inside aedes-server-factory bindConnection function, which is called when the server receives a connection from client (before CONNECT packet). The client object state is in default and its connected state is false. The function extract socket details and if aedes-server-factory trustProxy option is set to true, it will first parse http headers (x-real-ip | x-forwarded-for) and/or proxy protocol (v1 and v2), then passing the informations to aedes that will assign them to client.connDetails.

Additionally, if the current socket is a TLS socket, the module will extract the authorization status and the full certificate chain.

The function protocolDecoder and extractSocketDetails returns ConnectionDetails, if the object contains data property, it will be parsed as an mqtt-packet.

Install

1npm install aedes-protocol-decoder --save

Example

1var aedes = require('aedes')
2var { protocolDecoder } = require('aedes-protocol-decoder')
3var { createServer } = require('aedes-server-factory')
4var port = 1883
5
6var broker = aedes({
7	preConnect: function (client, packet, done) {
8	  if (client.connDetails && client.connDetails.ipAddress) {
9	    client.ip = client.connDetails.ipAddress
10	  }
11	  return done(null, true)
12	},
13})
14
15var server = createServer(broker, { trustProxy: true, protocolDecoder })
16server.listen(port, function () {
17  console.log('server listening on port', port)
18})

License

MIT

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

5

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.9

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to aedes-protocol-decoder

socket.io-parser

3.3.4

socket.io protocol parser

aedes-packet

3.0.0

Basic data structure for packets in Aedes

aedes

0.51.3

Stream-based MQTT broker

aedes-persistence

9.1.2

The spec for an Aedes persistence, with abstract tests and a fast in-memory implementation.