Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leon3s/socknet
PropTypes style for secure your socket.io application
https://github.com/leon3s/socknet
argument-parser framework nodejs security socket-io websockets
Last synced: 18 days ago
JSON representation
PropTypes style for secure your socket.io application
- Host: GitHub
- URL: https://github.com/leon3s/socknet
- Owner: leon3s
- Created: 2016-11-27T01:50:53.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-11T03:54:02.000Z (4 months ago)
- Last Synced: 2025-01-07T11:20:23.077Z (23 days ago)
- Topics: argument-parser, framework, nodejs, security, socket-io, websockets
- Language: TypeScript
- Homepage: https://leon3s.github.io/socknet/
- Size: 1.46 MB
- Stars: 12
- Watchers: 2
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Socknet
[](https://travis-ci.org/leon3s/socknet)
[](https://david-dm.org/leon3s/socknet.svg)
[](https://www.npmjs.com/package/socknet)
[]()
[](https://nodei.co/npm/socknet/)
## Overview
Socknet hook any socket.io like library that allow you to use your favourite validation lib before calling your all your events.
It's inspired by react component declaration style for event creation focusing on lisibility, modularity and security.
Fully compatible with socket.io client it works on every platform,
browser or device, focusing equally on reliability, and speed.
### How to use
## Installing
```sh
$ npm install --save socknet
```
## Parametes
`Socknet` constructor take an options object before all socket.io [Server](https://socket.io/docs/v4/server-api/) constructor parameters:
{
schemas: schemas indexed by eventName,
validate: a validation function which receive schema and data to validate. Must throw on error, could be async
}
## Examples
### Basic usage
server.js
```js
import { Socknet } from 'socknet';
import * as Joi from 'joi';
// Note that schema is an array of all args
const schema = Joi.array().ordened([
Joi.object({
data: Joi.string(),
}),
Joi.object({
data2: Joi.string(),
}),
])
const socknet = new Socknet({ schemas: { '/test': schema }, validate: (schema: Joi.AnySchema, data: unknown[]) => schema.validateAsync(data) }, httpServer)
const socknet.listen(PORT)
const testEvent = (...args: any[]) => {
console.log('received and validated args', args);
}
socknet.on('connection', (socket) => {
// event /test now have arguments protection
socket.on('/test', testEvent);
});
```
client.js
```js
import { Socket } from 'socket.io-client';
Socket = io('http://localhost:' + PORT) as unknown as Socket;
Socket.emit('/test', { data: 'test' }, { data2: test2});
```
Server should log
```json
[{ "data": "test" }, { "data2": "test2" }]
```
Note that in this case invalid data will cause request is cancelled see below for error handling
### Response callback
server.js
```js
import { Socknet } from 'socknet';
import * as Joi from 'joi';
// Note that schema must contain callback function to allow it
const schema = Joi.array().ordened([
Joi.string(),
Joi.func()
])
const socknet = new Socknet({ schemas: { '/test': schema }, validate: (schema: Joi.AnySchema, data: unknown[]) => schema.validateAsync(data) }, httpServer)
const socknet.listen(PORT)
const testEvent = ((username, eventCallback) => {
const error = doSomething();
// Here whe handle both cases with callback or not but you could validate the function as `Joi.func().required()` and always have it
if (eventCallback) {
if (error) eventCallback(error)
else eventCallback(null, username)
}
})
socknet.on('connection', (socket) => {
// event /test now have arguments protection
socket.on('/test', testEvent);
});
```
client.js
```js
import { Socket } from 'socket.io-client';
Socket = io('http://localhost:' + PORT) as unknown as Socket;
Socket.emit('/test', 'someusername', function (error, response) {
if (error) {
// handle error
} else {
console.log(response);
}
});
```
Client should log
```json
["someusername"]
```
### Ajv
```js
import { Socknet } from 'socknet';
import Ajv, { JSONSchemaType } from 'ajv';
import { Location } from '@/types';
const LocationSchema = {
type: 'array',
items: [
{
type: 'integer',
},
{
type: 'integer',
},
],
minItems: 2,
maxItems: 2,
} as JSONSchemaType;
export const ajv = new Ajv({
schemas: {
location: LocationSchema,
},
});
const socknet = new Socknet(
{
schemas: {
'/test': 'location',
},
validate: (schema, data) => {
try {
console.log(ajv.validate(schema, data));
} catch (error) {
console.log(error);
throw error;
}
},
},
);
const socknet.listen(PORT)
const testEvent = ((longitude, latitude, eventCallback) => {
const error = doSomething(longitude, latitude);
if (eventCallback) {
if (error) eventCallback(error)
else eventCallback(null, username)
}
})
socknet.on('connection', (socket) => {
// event /test now have arguments protection
socket.on('/test', testEvent);
});
```
client.js
```js
import { Socket } from 'socket.io-client';
Socket = io('http://localhost:' + PORT) as unknown as Socket;
Socket.emit('/test', 1.184646, 50.123415);
```