npmpackage.info

Gathering detailed insights and metrics for aedes-protocol-decoder

Other packages similar to aedes-protocol-decoder

aedes-protocol-decoder-mtls

2.0.1

Aedes plugin to decode connection frame and validate proxies

Gathering detailed insights and metrics for aedes-protocol-decoder

aedes-protocol-decoder - 2.2.0 | npmpackage.info

aedes-protocol-decoder

Protocol decoder for Aedes MQTT Broker

2.2.0

MIT

JavaScript

36.39 kB

3.9

Installations

npm install aedes-protocol-decoder

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=10

Node Version

18.13.0

NPM Version

8.19.3 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

Updated on Sep 20, 2023

Release 2.1.0

v2.1.0

Updated on Jun 28, 2021

Release 2.0.0

v2.0.0

Updated on Oct 28, 2020

Release 1.0.0

v1.0.0

Updated on Feb 04, 2020

View All 4 releases

Languages

JavaScript

JavaScript (100%)

Developer

moscajs

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

3 Stars

20 Commits

3 Forks

8 Watchers

2 Branches

3 Contributors

Updated on Sep 20, 2023

Maintainers

View All 3 Contributors

Package Meta Information

Latest Version

2.2.0

Package Id

aedes-protocol-decoder@2.2.0

Unpacked Size

36.39 kB

Size

9.30 kB

File Count

NPM Version

8.19.3

Node Version

18.13.0

Published on

Sep 20, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

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

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

Dangerous-Workflow

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

10

Binary-Artifacts

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

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

Pinned-Dependencies

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

0

Token-Permissions

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

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

Branch-Protection

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

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

Score

3.9

/10

Last Scanned on 2025-07-07

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