Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
aedes-server-factory
Advanced tools
Readme
Aedes server factory. Supports TCP, HTTP, HTTP2, WS, and PROXY decoders.
Work In Progress: TLS, HTTPS, HTTP2, WSS.
To install aedes-server-factory :
npm install aedes-server-factory
1 - Per default, if no options are set, createServer
will return a TCP server instance, from which the stream will be bound to aedes (via aedes.handle
).
2 - To bind a Websocket stream to Aedes, set ws
to true, and eventually configure the HTTP server instance by using one of http
or http2
options.
Additionaly, you can add https
option to create a secure HTTP | HTTP2 server.
createServer
will then return an HTTP | HTTP2 server instance.
Object
used to create and configure a TCP server.
Object
used to create and configure a TCP over TLS server.
Default to null, if defined, will be used to create TCP secure server.
boolean used to wrap a http | http2 | https server in a websocket server.
Object
used to create and configure HTTP server.
createServer
will return the HTTP server if no HTTP options is defined.
function used to handle errors thrown by WS server.
customWSErrorHandler
will be called with Error
.
Object
used to create and configure HTTP2 server.
Default to null, if defined, will be used to create HTTP2 server instance.
https://nodejs.org/api/http2.html#http2_http2_createsecureserver_options_onrequesthandler
Object
used to create and configure HTTPS server, can be used in combination of HTTP | HTTP2 option.
Default to null, if defined, will be used to create HTTP | HTTP2 secure server.
boolean
to indicates that aedes-server-factory
should retrieve information from the Proxy server ( HTTP headers and/or Proxy protocol header ).
Default to false.
<Duplex | Socket>
]Invoked when options.trustProxy
is false
| undefined
.
aedes-protocol-decoder extractSocketDetails
function is used as default value.
const aedes = require('aedes')();
const { createServer } = require('aedes-server-factory');
const yourDecoder = require('./path-to-your-decoder');
const options = { trustProxy: false };
options.extractSocketDetails = function (socket) {
return yourDecoder(socket);
};
const server = createServer(aedes, options);
<Duplex | Socket>
<Buffer>
<IncomingMessage>
Invoked when options.trustProxy
is true
.
aedes-protocol-decoder protocolDecoder
function is used as default value.
const aedes = require('aedes')();
const { createServer } = require('aedes-server-factory');
const yourDecoder = require('./path-to-your-decoder');
const options = { trustProxy: true };
options.protocolDecoder = function (conn, buffer) {
return yourDecoder(conn, buffer);
};
const server = createServer(aedes, options);
<Aedes>
<object>
Use to override createServer
behavior and create your own server instance.
const aedes = require('aedes')();
const { createServer } = require('aedes-server-factory');
const options = { trustProxy: false };
options.serverFactory = function (aedes, options) {
return net.createServer((conn) => {
aedes.handle(conn);
});
};
const server = createServer(aedes, options);
const aedes = require('aedes')();
const server = require('aedes-server-factory').createServer(aedes);
const port = 1883;
server.listen(port, function () {
console.log('server started and listening on port ', port);
});
const aedes = require('aedes')();
const server = require('aedes-server-factory').createServer(aedes, {
trustProxy: true,
});
const port = 1883;
server.listen(port, function () {
console.log('server started and listening on port ', port);
});
const aedes = require('aedes')();
const server = require('aedes-server-factory').createServer(aedes, {
ws: true,
});
const port = 1883;
server.listen(port, function () {
console.log('server started and listening on port ', port);
});
FAQs
Aedes helper to create a server and bind its connection to Aedes
The npm package aedes-server-factory receives a total of 726 weekly downloads. As such, aedes-server-factory popularity was classified as not popular.
We found that aedes-server-factory demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.