Compare commits

...

27 Commits

Author SHA1 Message Date
cfcb8a4be2
fix: archive repository
This project is not anymore maintained.
2024-11-11 14:55:04 +01:00
5f2742be0b
chore: better Prettier config for easier reviews 2023-10-23 23:44:50 +02:00
2d84d11034
fix: update jsonwebtoken from v9.0.1 to v9.0.2 2023-09-18 21:45:05 +02:00
4ba9a452ea
docs: improve Prerequisites section 2023-08-06 11:45:16 +02:00
6a28554b00
fix: update jsonwebtoken from v9.0.0 to v9.0.1 2023-07-22 12:20:18 +02:00
50c236ca4d
refactor: usage of node:test instead of tap 2023-07-22 12:18:28 +02:00
b708d66586
chore: sync package-lock.json 2023-07-02 18:14:09 +02:00
d1145e5f63
perf: ignore test files in published package (reduce package size) 2023-07-02 18:12:07 +02:00
487965b9aa
chore: clean up 2023-07-02 18:10:38 +02:00
108ae8f6fc
fix: update author - Théo LUDWIG 2023-07-02 18:08:35 +02:00
7d0df02299
build(deps): update latest 2023-07-02 18:05:47 +02:00
Divlo
26bbc075cf
feat: add npm package provenance
Ref: https://github.blog/2023-04-19-introducing-npm-package-provenance/
2023-05-13 19:34:01 +02:00
Divlo
41d9424940
build(deps): update latest 2023-05-13 19:25:45 +02:00
Divlo
41a0f1839f
fix: safer (and correct) isUnauthorizedError 2023-04-02 23:32:28 +02:00
Divlo
71e0d82655
fix: safer isUnauthorizedError type guard 2023-04-02 23:04:41 +02:00
Divlo
03e8d51f9a
fix: bump jsonwebtoken to v9.0.0
fixes #342

It introduces several security fixes to follow best practices.
2023-01-10 20:57:23 +01:00
Divlo
bf234bd7b8
docs: client side usage, specify build in import 2022-09-09 12:10:12 +02:00
Divlo
ff6a84a8e1
fix: publish updated README 2022-09-09 11:41:42 +02:00
Divlo
c7c152a554
build(deps): update latest 2022-09-09 11:39:27 +02:00
dependabot[bot]
7977c42c20
build(deps): bump npm from 8.10.0 to 8.12.0 (#338) 2022-07-25 12:52:11 +02:00
dependabot[bot]
05b9eea638
build(deps): bump semver-regex from 3.1.3 to 3.1.4 (#339) 2022-07-25 12:51:59 +02:00
dependabot[bot]
e14b456d9a
build(deps-dev): bump semantic-release from 19.0.2 to 19.0.3 (#340) 2022-07-25 12:51:41 +02:00
Divlo
f85595224f
build(deps): update latest 2022-05-12 21:26:33 +02:00
Divlo
1247a9b5f0
chore: remove codecov 2022-05-12 21:24:15 +02:00
Divlo
9a942c52c5
style: fix linting issue 2022-04-07 10:14:52 +02:00
Divlo
dbb363747d
feat: usage of ESM modules imports (instead of CommonJS)
BREAKING CHANGE: This package is now pure ESM

BREAKING CHANGE: minimum supported Node.js >= 16.0.0
2022-04-07 10:11:48 +02:00
Divlo
559ad8bd6d
ci: avoid duplicate runs 2022-03-01 09:02:21 +01:00
33 changed files with 8055 additions and 17898 deletions

View File

@ -1,22 +1,15 @@
{ {
"extends": ["standard-with-typescript", "prettier"], "extends": ["conventions", "prettier"],
"plugins": ["unicorn", "import", "prettier"], "plugins": ["prettier", "import", "unicorn"],
"parser": "@typescript-eslint/parser",
"parserOptions": { "parserOptions": {
"project": "./tsconfig.json" "project": "./tsconfig.json"
}, },
"env": { "env": {
"node": true, "node": true
"jest": true
}, },
"rules": { "rules": {
"prettier/prettier": "error", "prettier/prettier": "error",
"import/order": [
"error",
{
"groups": ["builtin", "external", "internal"],
"newlines-between": "always"
}
],
"import/extensions": ["error", "always"], "import/extensions": ["error", "always"],
"unicorn/prefer-node-protocol": "error" "unicorn/prefer-node-protocol": "error"
} }

View File

@ -1,8 +1,8 @@
--- ---
name: '🐛 Bug Report' name: "🐛 Bug Report"
about: 'Report an unexpected problem or unintended behavior.' about: "Report an unexpected problem or unintended behavior."
title: '[Bug]' title: "[Bug]"
labels: 'bug' labels: "bug"
--- ---
<!-- <!--

View File

@ -1,8 +1,8 @@
--- ---
name: '📜 Documentation' name: "📜 Documentation"
about: 'Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).' about: "Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...)."
title: '[Documentation]' title: "[Documentation]"
labels: 'documentation' labels: "documentation"
--- ---
<!-- Please make sure your issue has not already been fixed. --> <!-- Please make sure your issue has not already been fixed. -->

View File

@ -1,8 +1,8 @@
--- ---
name: '✨ Feature Request' name: "✨ Feature Request"
about: 'Suggest a new feature idea.' about: "Suggest a new feature idea."
title: '[Feature]' title: "[Feature]"
labels: 'feature request' labels: "feature request"
--- ---
<!-- Please make sure your issue has not already been fixed. --> <!-- Please make sure your issue has not already been fixed. -->

View File

@ -1,8 +1,8 @@
--- ---
name: '🔧 Improvement' name: "🔧 Improvement"
about: 'Improve structure/format/performance/refactor/tests of the code.' about: "Improve structure/format/performance/refactor/tests of the code."
title: '[Improvement]' title: "[Improvement]"
labels: 'improvement' labels: "improvement"
--- ---
<!-- Please make sure your issue has not already been fixed. --> <!-- Please make sure your issue has not already been fixed. -->

View File

@ -1,8 +1,8 @@
--- ---
name: '🙋 Question' name: "🙋 Question"
about: 'Further information is requested.' about: "Further information is requested."
title: '[Question]' title: "[Question]"
labels: 'question' labels: "question"
--- ---
### Question ### Question

View File

@ -1,6 +1,6 @@
<!-- Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time. --> <!-- Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time. -->
## What changes this PR introduce? # What changes this PR introduce?
## List any relevant issue numbers ## List any relevant issue numbers

View File

@ -1,25 +1,27 @@
name: 'Build' name: "Build"
on: on:
push: push:
branches: [master, develop] branches: [develop]
pull_request: pull_request:
branches: [master, develop] branches: [master, develop]
jobs: jobs:
build: build:
runs-on: 'ubuntu-latest' runs-on: "ubuntu-latest"
steps: steps:
- uses: 'actions/checkout@v2' - uses: "actions/checkout@v4.0.0"
- name: 'Use Node.js' - name: "Setup Node.js"
uses: 'actions/setup-node@v2.5.1' uses: "actions/setup-node@v3.8.1"
with: with:
node-version: 'lts/*' node-version: "20.x"
cache: 'npm' cache: "npm"
- name: 'Install' - name: "Install dependencies"
run: 'npm install' run: "npm clean-install"
- name: 'Build Package' - name: "Build"
run: 'npm run build' run: "npm run build"
- run: "npm run build:typescript"

View File

@ -1,28 +1,28 @@
name: 'Lint' name: "Lint"
on: on:
push: push:
branches: [master, develop] branches: [develop]
pull_request: pull_request:
branches: [master, develop] branches: [master, develop]
jobs: jobs:
lint: lint:
runs-on: 'ubuntu-latest' runs-on: "ubuntu-latest"
steps: steps:
- uses: 'actions/checkout@v2' - uses: "actions/checkout@v4.0.0"
- name: 'Use Node.js' - name: "Setup Node.js"
uses: 'actions/setup-node@v2.5.1' uses: "actions/setup-node@v3.8.1"
with: with:
node-version: 'lts/*' node-version: "20.x"
cache: 'npm' cache: "npm"
- name: 'Install' - name: "Install dependencies"
run: 'npm install' run: "npm clean-install"
- run: 'npm run lint:commit -- --to "${{ github.sha }}"' - run: 'npm run lint:commit -- --to "${{ github.sha }}"'
- run: 'npm run lint:editorconfig' - run: "npm run lint:editorconfig"
- run: 'npm run lint:markdown' - run: "npm run lint:markdown"
- run: 'npm run lint:typescript' - run: "npm run lint:eslint"
- run: 'npm run lint:prettier' - run: "npm run lint:prettier"

View File

@ -1,4 +1,4 @@
name: 'Release' name: "Release"
on: on:
push: push:
@ -6,24 +6,34 @@ on:
jobs: jobs:
release: release:
runs-on: 'ubuntu-latest' runs-on: "ubuntu-latest"
permissions:
contents: "write"
issues: "write"
pull-requests: "write"
id-token: "write"
steps: steps:
- uses: 'actions/checkout@v2' - uses: "actions/checkout@v4.0.0"
- name: 'Use Node.js' - name: "Setup Node.js"
uses: 'actions/setup-node@v2.5.1' uses: "actions/setup-node@v3.8.1"
with: with:
node-version: 'lts/*' node-version: "20.x"
cache: 'npm' cache: "npm"
- name: 'Install' - name: "Install dependencies"
run: 'npm install' run: "npm clean-install"
- name: 'Build Package' - name: "Build Package"
run: 'npm run build' run: "npm run build"
- name: 'Release' - run: "npm run build:typescript"
run: 'npm run release'
- name: "Verify the integrity of provenance attestations and registry signatures for installed dependencies"
run: "npm audit signatures"
- name: "Release"
run: "npm run release"
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }} NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

View File

@ -1,28 +1,28 @@
name: 'Test' name: "Test"
on: on:
push: push:
branches: [master, develop] branches: [develop]
pull_request: pull_request:
branches: [master, develop] branches: [master, develop]
jobs: jobs:
test: test:
runs-on: 'ubuntu-latest' runs-on: "ubuntu-latest"
steps: steps:
- uses: 'actions/checkout@v2' - uses: "actions/checkout@v4.0.0"
- name: 'Use Node.js' - name: "Setup Node.js"
uses: 'actions/setup-node@v2.5.1' uses: "actions/setup-node@v3.8.1"
with: with:
node-version: 'lts/*' node-version: "20.x"
cache: 'npm' cache: "npm"
- name: 'Install' - name: "Install dependencies"
run: 'npm install' run: "npm clean-install"
- name: 'Test' - name: "Build"
run: 'npm run test' run: "npm run build"
- name: 'Upload Coverage' - name: "Test"
uses: 'codecov/codecov-action@v2.1.0' run: "npm run test"

1
.gitignore vendored
View File

@ -10,6 +10,7 @@ build
# testing # testing
coverage coverage
.nyc_output
# debug # debug
npm-debug.log* npm-debug.log*

View File

@ -3,3 +3,4 @@
npm run lint:staged npm run lint:staged
npm run build npm run build
npm run build:typescript

View File

@ -1,10 +1,6 @@
{ {
"*": ["editorconfig-checker"], "*": ["editorconfig-checker"],
"*.{js,jsx,ts,tsx}": [ "*.{js,jsx,ts,tsx}": ["prettier --write", "eslint --fix"],
"prettier --write",
"eslint --fix",
"jest --findRelatedTests"
],
"*.{json,jsonc,yml,yaml}": ["prettier --write"], "*.{json,jsonc,yml,yaml}": ["prettier --write"],
"*.{md}": ["prettier --write", "markdownlint --dot --fix"] "*.{md,mdx}": ["prettier --write", "markdownlint-cli2 --fix"]
} }

11
.markdownlint-cli2.jsonc Normal file
View File

@ -0,0 +1,11 @@
{
"config": {
"extends": "markdownlint/style/prettier",
"relative-links": true,
"default": true,
"MD033": false
},
"globs": ["**/*.{md,mdx}"],
"ignores": ["**/node_modules"],
"customRules": ["markdownlint-rule-relative-links"]
}

View File

@ -1,7 +0,0 @@
{
"default": true,
"MD013": false,
"MD024": false,
"MD033": false,
"MD041": false
}

1
.npmrc
View File

@ -1 +1,2 @@
save-exact=true save-exact=true
provenance=true

View File

@ -1,6 +1,3 @@
{ {
"singleQuote": true, "semi": false
"jsxSingleQuote": true,
"semi": false,
"trailingComma": "none"
} }

15
.swcrc
View File

@ -1,22 +1,13 @@
{ {
"sourceMaps": true,
"jsc": { "jsc": {
"parser": { "parser": {
"syntax": "typescript", "syntax": "typescript",
"decorators": true,
"dynamicImport": true "dynamicImport": true
}, },
"transform": { "target": "esnext"
"legacyDecorator": true,
"decoratorMetadata": true
},
"target": "es2022",
"loose": true
}, },
"module": { "module": {
"type": "commonjs", "type": "es6"
"strict": false,
"strictMode": true,
"lazy": false,
"noInterop": false
} }
} }

View File

@ -6,5 +6,6 @@
"editor.formatOnSave": true, "editor.formatOnSave": true,
"editor.codeActionsOnSave": { "editor.codeActionsOnSave": {
"source.fixAll": true "source.fixAll": true
} },
"eslint.options": { "ignorePath": ".gitignore" }
} }

View File

@ -60,7 +60,7 @@ representative at an online or offline event.
Instances of abusive, harassing, or otherwise unacceptable behavior may be Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at reported to the community leaders responsible for enforcement at
contact@divlo.fr. <contact@theoludwig.fr>.
All complaints will be reviewed and investigated promptly and fairly. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the All community leaders are obligated to respect the privacy and security of the

View File

@ -21,7 +21,7 @@ All work on **Thream** happens directly on [GitHub](https://github.com/Thream).
- **Please first discuss** the change you wish to make via [issue](https://github.com/Thream/socketio-jwt/issues) before making a change. It might avoid a waste of your time. - **Please first discuss** the change you wish to make via [issue](https://github.com/Thream/socketio-jwt/issues) before making a change. It might avoid a waste of your time.
- Ensure your code respect `eslint` and `prettier`. - Ensure your code respect linting.
- Make sure your **code passes the tests**. - Make sure your **code passes the tests**.
@ -29,26 +29,4 @@ If you're adding new features to **Thream/socketio-jwt**, please include tests.
## Commits ## Commits
The commit message guidelines respect [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) and [Semantic Versioning](https://semver.org/) for releases. The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.
### Types
Types define which kind of changes you made to the project.
| Types | Description |
| -------- | ------------------------------------------------------------------------------------------------------------ |
| feat | A new feature. |
| fix | A bug fix. |
| docs | Documentation only changes. |
| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc). |
| refactor | A code change that neither fixes a bug nor adds a feature. |
| perf | A code change that improves performance. |
| test | Adding missing tests or correcting existing tests. |
| build | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm). |
| ci | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs). |
| chore | Other changes that don't modify src or test files. |
| revert | Reverts a previous commit. |
### Scopes
Scopes define what part of the code changed.

View File

@ -1,6 +1,6 @@
MIT License MIT License
Copyright (c) Auth0, Inc. <support@auth0.com> (http://auth0.com) and Thream contributors Copyright (c) Auth0, Inc. <support@auth0.com> (<https://auth0.com/>) and Thream contributors
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

View File

@ -4,6 +4,10 @@
<strong>Authenticate socket.io incoming connections with JWTs.</strong> <strong>Authenticate socket.io incoming connections with JWTs.</strong>
</p> </p>
<p align="center">
<strong>⚠️ This project is not maintained anymore, you can still use the code as you wish and fork it to maintain it yourself.</strong>
</p>
<p align="center"> <p align="center">
<a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" /></a> <a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" /></a>
<a href="./LICENSE"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="Licence MIT"/></a> <a href="./LICENSE"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="Licence MIT"/></a>
@ -12,7 +16,6 @@
<a href="https://github.com/Thream/socketio-jwt/actions/workflows/build.yml"><img src="https://github.com/Thream/socketio-jwt/actions/workflows/build.yml/badge.svg?branch=develop" /></a> <a href="https://github.com/Thream/socketio-jwt/actions/workflows/build.yml"><img src="https://github.com/Thream/socketio-jwt/actions/workflows/build.yml/badge.svg?branch=develop" /></a>
<a href="https://github.com/Thream/socketio-jwt/actions/workflows/lint.yml"><img src="https://github.com/Thream/socketio-jwt/actions/workflows/lint.yml/badge.svg?branch=develop" /></a> <a href="https://github.com/Thream/socketio-jwt/actions/workflows/lint.yml"><img src="https://github.com/Thream/socketio-jwt/actions/workflows/lint.yml/badge.svg?branch=develop" /></a>
<a href="https://github.com/Thream/socketio-jwt/actions/workflows/test.yml"><img src="https://github.com/Thream/socketio-jwt/actions/workflows/test.yml/badge.svg?branch=develop" /></a> <a href="https://github.com/Thream/socketio-jwt/actions/workflows/test.yml"><img src="https://github.com/Thream/socketio-jwt/actions/workflows/test.yml/badge.svg?branch=develop" /></a>
<a href="https://codecov.io/gh/Thream/socketio-jwt"><img src="https://codecov.io/gh/Thream/socketio-jwt/branch/develop/graph/badge.svg" alt="codecov" /></a>
<br /> <br />
<a href="https://conventionalcommits.org"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt="Conventional Commits" /></a> <a href="https://conventionalcommits.org"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt="Conventional Commits" /></a>
<a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release" /></a> <a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release" /></a>
@ -23,9 +26,12 @@
Authenticate socket.io incoming connections with JWTs. Authenticate socket.io incoming connections with JWTs.
Compatible with `socket.io >= 3.0.0`. This repository was originally forked from [auth0-socketio-jwt](https://github.com/auth0-community/auth0-socketio-jwt) and it is not intended to take any credit but to improve the code from now on.
This repository was originally forked from [auth0-socketio-jwt](https://github.com/auth0-community/auth0-socketio-jwt) & it is not intended to take any credit but to improve the code from now on. ## Prerequisites
- [Node.js](https://nodejs.org/) >= 16.0.0
- [Socket.IO](https://socket.io/) >= 3.0.0
## 💾 Install ## 💾 Install
@ -40,24 +46,24 @@ npm install --save @thream/socketio-jwt
### Server side ### Server side
```ts ```ts
import { Server } from 'socket.io' import { Server } from "socket.io"
import { authorize } from '@thream/socketio-jwt' import { authorize } from "@thream/socketio-jwt"
const io = new Server(9000) const io = new Server(9000)
io.use( io.use(
authorize({ authorize({
secret: 'your secret or public key' secret: "your secret or public key",
}) }),
) )
io.on('connection', async (socket) => { io.on("connection", async (socket) => {
// jwt payload of the connected client // jwt payload of the connected client
console.log(socket.decodedToken) console.log(socket.decodedToken)
const clients = await io.sockets.allSockets() const clients = await io.sockets.allSockets()
if (clients != null) { if (clients != null) {
for (const clientId of clients) { for (const clientId of clients) {
const client = io.sockets.sockets.get(clientId) const client = io.sockets.sockets.get(clientId)
client?.emit('messages', { message: 'Success!' }) client?.emit("messages", { message: "Success!" })
// we can access the jwt payload of each connected client // we can access the jwt payload of each connected client
console.log(client?.decodedToken) console.log(client?.decodedToken)
} }
@ -68,12 +74,12 @@ io.on('connection', async (socket) => {
### Server side with `jwks-rsa` (example) ### Server side with `jwks-rsa` (example)
```ts ```ts
import jwksClient from 'jwks-rsa' import jwksClient from "jwks-rsa"
import { Server } from 'socket.io' import { Server } from "socket.io"
import { authorize } from '@thream/socketio-jwt' import { authorize } from "@thream/socketio-jwt"
const client = jwksClient({ const client = jwksClient({
jwksUri: 'https://sandrino.auth0.com/.well-known/jwks.json' jwksUri: "https://sandrino.auth0.com/.well-known/jwks.json",
}) })
const io = new Server(9000) const io = new Server(9000)
@ -82,11 +88,11 @@ io.use(
secret: async (decodedToken) => { secret: async (decodedToken) => {
const key = await client.getSigningKeyAsync(decodedToken.header.kid) const key = await client.getSigningKeyAsync(decodedToken.header.kid)
return key.getPublicKey() return key.getPublicKey()
} },
}) }),
) )
io.on('connection', async (socket) => { io.on("connection", async (socket) => {
// jwt payload of the connected client // jwt payload of the connected client
console.log(socket.decodedToken) console.log(socket.decodedToken)
// You can do the same things of the previous example there... // You can do the same things of the previous example there...
@ -96,21 +102,21 @@ io.on('connection', async (socket) => {
### Server side with `onAuthentication` (example) ### Server side with `onAuthentication` (example)
```ts ```ts
import { Server } from 'socket.io' import { Server } from "socket.io"
import { authorize } from '@thream/socketio-jwt' import { authorize } from "@thream/socketio-jwt"
const io = new Server(9000) const io = new Server(9000)
io.use( io.use(
authorize({ authorize({
secret: 'your secret or public key', secret: "your secret or public key",
onAuthentication: async (decodedToken) => { onAuthentication: async (decodedToken) => {
// return the object that you want to add to the user property // return the object that you want to add to the user property
// or throw an error if the token is unauthorized // or throw an error if the token is unauthorized
} },
}) }),
) )
io.on('connection', async (socket) => { io.on("connection", async (socket) => {
// jwt payload of the connected client // jwt payload of the connected client
console.log(socket.decodedToken) console.log(socket.decodedToken)
// You can do the same things of the previous example there... // You can do the same things of the previous example there...
@ -128,23 +134,23 @@ io.on('connection', async (socket) => {
### Client side ### Client side
```ts ```ts
import { io } from 'socket.io-client' import { io } from "socket.io-client"
import { isUnauthorizedError } from '@thream/socketio-jwt' import { isUnauthorizedError } from "@thream/socketio-jwt/build/UnauthorizedError.js"
// Require Bearer Token // Require Bearer Token
const socket = io('http://localhost:9000', { const socket = io("http://localhost:9000", {
auth: { token: `Bearer ${yourJWT}` } auth: { token: `Bearer ${yourJWT}` },
}) })
// Handling token expiration // Handling token expiration
socket.on('connect_error', (error) => { socket.on("connect_error", (error) => {
if (isUnauthorizedError(error)) { if (isUnauthorizedError(error)) {
console.log('User token has expired') console.log("User token has expired")
} }
}) })
// Listening to events // Listening to events
socket.on('messages', (data) => { socket.on("messages", (data) => {
console.log(data) console.log(data)
}) })
``` ```

View File

@ -1,10 +0,0 @@
{
"testEnvironment": "node",
"resolver": "jest-ts-webcompat-resolver",
"transform": {
"^.+\\.(t|j)sx?$": ["@swc/jest"]
},
"rootDir": "./src",
"collectCoverage": true,
"coverageDirectory": "../coverage/"
}

24801
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,26 +1,32 @@
{ {
"name": "@thream/socketio-jwt", "name": "@thream/socketio-jwt",
"version": "0.0.0-development", "version": "0.0.0-development",
"type": "module",
"public": true, "public": true,
"description": "Authenticate socket.io incoming connections with JWTs.", "description": "Authenticate socket.io incoming connections with JWTs.",
"license": "MIT", "license": "MIT",
"main": "build/index.js", "main": "build/index.js",
"types": "build/index.d.ts", "types": "build/index.d.ts",
"files": [ "files": [
"build" "build",
"!**/*.test.js",
"!**/*.test.d.ts",
"!**/*.map"
], ],
"engines": { "engines": {
"node": ">=12.0.0" "node": ">=16.0.0",
"npm": ">=9.0.0"
}, },
"publishConfig": { "publishConfig": {
"access": "public" "access": "public",
"provenance": true
}, },
"keywords": [ "keywords": [
"socket", "socket",
"socket.io", "socket.io",
"jwt" "jwt"
], ],
"author": "Divlo <contact@divlo.fr>", "author": "Théo LUDWIG <contact@theoludwig.fr>",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/Thream/socketio-jwt" "url": "https://github.com/Thream/socketio-jwt"
@ -30,14 +36,16 @@
}, },
"homepage": "https://github.com/Thream/socketio-jwt#readme", "homepage": "https://github.com/Thream/socketio-jwt#readme",
"scripts": { "scripts": {
"build": "rimraf ./build && swc ./src --out-dir ./build && tsc", "build": "rimraf ./build && swc ./src --out-dir ./build",
"build:dev": "swc ./src --out-dir ./build --watch",
"build:typescript": "tsc",
"lint:commit": "commitlint", "lint:commit": "commitlint",
"lint:editorconfig": "editorconfig-checker", "lint:editorconfig": "editorconfig-checker",
"lint:markdown": "markdownlint \"**/*.md\" --dot --ignore-path \".gitignore\"", "lint:markdown": "markdownlint-cli2",
"lint:typescript": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"", "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
"lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"", "lint:prettier": "prettier . --check",
"lint:staged": "lint-staged", "lint:staged": "lint-staged",
"test": "jest", "test": "cross-env NODE_ENV=test node --enable-source-maps --test build/",
"release": "semantic-release", "release": "semantic-release",
"postinstall": "husky install", "postinstall": "husky install",
"prepublishOnly": "pinst --disable", "prepublishOnly": "pinst --disable",
@ -47,43 +55,39 @@
"socket.io": ">=3.0.0" "socket.io": ">=3.0.0"
}, },
"dependencies": { "dependencies": {
"jsonwebtoken": "8.5.1" "jsonwebtoken": "9.0.2"
}, },
"devDependencies": { "devDependencies": {
"@commitlint/cli": "16.2.1", "@commitlint/cli": "18.0.0",
"@commitlint/config-conventional": "16.2.1", "@commitlint/config-conventional": "18.0.0",
"@swc/cli": "0.1.55", "@swc/cli": "0.1.62",
"@swc/core": "1.2.141", "@swc/core": "1.3.94",
"@swc/jest": "0.2.17", "@tsconfig/strictest": "2.0.2",
"@types/express": "4.17.13", "@types/jsonwebtoken": "9.0.4",
"@types/jest": "27.4.0", "@types/node": "20.8.7",
"@types/jsonwebtoken": "8.5.8", "@typescript-eslint/eslint-plugin": "6.9.0",
"@types/node": "17.0.18", "@typescript-eslint/parser": "6.9.0",
"@types/server-destroy": "1.0.1", "axios": "1.5.1",
"@typescript-eslint/eslint-plugin": "4.32.0", "cross-env": "7.0.3",
"axios": "0.26.0", "editorconfig-checker": "5.1.1",
"editorconfig-checker": "4.0.2", "eslint": "8.52.0",
"eslint": "7.32.0", "eslint-config-conventions": "12.0.0",
"eslint-config-prettier": "8.3.0", "eslint-config-prettier": "9.0.0",
"eslint-config-standard-with-typescript": "21.0.1", "eslint-plugin-import": "2.29.0",
"eslint-plugin-import": "2.25.4", "eslint-plugin-prettier": "5.0.1",
"eslint-plugin-node": "11.1.0", "eslint-plugin-promise": "6.1.1",
"eslint-plugin-prettier": "4.0.0", "eslint-plugin-unicorn": "48.0.1",
"eslint-plugin-promise": "5.2.0", "fastify": "4.24.3",
"eslint-plugin-unicorn": "40.1.0", "husky": "8.0.3",
"express": "4.17.3", "lint-staged": "15.0.2",
"husky": "7.0.4", "markdownlint-cli2": "0.10.0",
"jest": "27.5.1", "markdownlint-rule-relative-links": "2.1.0",
"jest-ts-webcompat-resolver": "1.0.0", "pinst": "3.0.0",
"lint-staged": "12.3.4", "prettier": "3.0.3",
"markdownlint-cli": "0.31.1", "rimraf": "5.0.5",
"pinst": "2.1.6", "semantic-release": "22.0.5",
"rimraf": "3.0.2", "socket.io": "4.7.2",
"semantic-release": "19.0.2", "socket.io-client": "4.7.2",
"server-destroy": "1.0.1", "typescript": "5.2.2"
"prettier": "2.5.1",
"socket.io": "4.4.1",
"socket.io-client": "4.4.1",
"typescript": "4.5.5"
} }
} }

View File

@ -1,20 +1,30 @@
export class UnauthorizedError extends Error { export class UnauthorizedError extends Error {
public inner: { message: string } public inner: { message: string }
public data: { message: string; code: string; type: 'UnauthorizedError' } public data: { message: string; code: string; type: "UnauthorizedError" }
constructor(code: string, error: { message: string }) { constructor(code: string, error: { message: string }) {
super(error.message) super(error.message)
this.message = error.message this.name = "UnauthorizedError"
this.inner = error this.inner = error
this.data = { this.data = {
message: this.message, message: this.message,
code, code,
type: 'UnauthorizedError' type: "UnauthorizedError",
} }
Object.setPrototypeOf(this, UnauthorizedError.prototype) Object.setPrototypeOf(this, UnauthorizedError.prototype)
} }
} }
export const isUnauthorizedError = (error: any): error is UnauthorizedError => { export const isUnauthorizedError = (
return error.data.type === 'UnauthorizedError' error: unknown,
): error is UnauthorizedError => {
return (
typeof error === "object" &&
error != null &&
"data" in error &&
typeof error.data === "object" &&
error.data != null &&
"type" in error.data &&
error.data.type === "UnauthorizedError"
)
} }

View File

@ -1,299 +1,340 @@
import axios from 'axios' import test from "node:test"
import { io } from 'socket.io-client' import assert from "node:assert/strict"
import { isUnauthorizedError } from '../UnauthorizedError.js' import axios from "axios"
import type { Socket } from "socket.io-client"
import { io } from "socket.io-client"
import { isUnauthorizedError } from "../UnauthorizedError.js"
import type { Profile } from "./fixture/index.js"
import { import {
API_URL,
fixtureStart, fixtureStart,
fixtureStop, fixtureStop,
getSocket, getSocket,
Profile basicProfile,
} from './fixture/index.js' } from "./fixture/index.js"
describe('authorize - with secret as string in options', () => { export const api = axios.create({
let token: string = '' baseURL: API_URL,
headers: {
beforeEach((done) => { "Content-Type": "application/json",
fixtureStart(async () => { },
const response = await axios.post('http://localhost:9000/login')
token = response.data.token
})
.then(done)
.catch((error) => {
done(error)
})
})
afterEach((done) => {
fixtureStop(done)
})
it('should emit error with no token provided', (done) => {
const socket = io('http://localhost:9000')
socket.on('connect_error', (error) => {
expect(isUnauthorizedError(error)).toBeTruthy()
if (isUnauthorizedError(error)) {
expect(error.data.message).toEqual('no token provided')
expect(error.data.code).toEqual('credentials_required')
}
socket.close()
done()
})
})
it('should emit error with bad token format', (done) => {
const socket = io('http://localhost:9000', {
auth: { token: 'testing' }
})
socket.on('connect_error', (error) => {
expect(isUnauthorizedError(error)).toBeTruthy()
if (isUnauthorizedError(error)) {
expect(error.data.message).toEqual(
'Format is Authorization: Bearer [token]'
)
expect(error.data.code).toEqual('credentials_bad_format')
}
socket.close()
done()
})
})
it('should emit error with unauthorized handshake', (done) => {
const socket = io('http://localhost:9000', {
auth: { token: 'Bearer testing' }
})
socket.on('connect_error', (error) => {
expect(isUnauthorizedError(error)).toBeTruthy()
if (isUnauthorizedError(error)) {
expect(error.data.message).toEqual(
'Unauthorized: Token is missing or invalid Bearer'
)
expect(error.data.code).toEqual('invalid_token')
}
socket.close()
done()
})
})
it('should connect the user', (done) => {
const socket = io('http://localhost:9000', {
auth: { token: `Bearer ${token}` }
})
socket.on('connect', () => {
socket.close()
done()
})
socket.on('connect_error', (error) => {
done(error)
})
})
}) })
const secretCallback = async (): Promise<string> => { const secretCallback = async (): Promise<string> => {
return 'somesecret' return "somesecret"
} }
describe('authorize - with secret as callback in options', () => { await test("authorize", async (t) => {
let token: string = '' await t.test("with secret as string in options", async (t) => {
let token = ""
let socket: Socket | null = null
beforeEach((done) => { t.beforeEach(async () => {
fixtureStart( await fixtureStart()
async () => { const response = await api.post("/login", {})
const response = await axios.post('http://localhost:9000/login') token = response.data.token
token = response.data.token })
},
{ secret: secretCallback } t.afterEach(async () => {
) socket?.disconnect()
.then(done) await fixtureStop()
.catch((error) => { })
done(error)
await t.test("should emit error with no token provided", () => {
socket = io(API_URL)
socket.on("connect_error", async (error) => {
assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
assert.strictEqual(error.data.message, "no token provided")
assert.strictEqual(error.data.code, "credentials_required")
assert.ok(true)
} else {
assert.fail("should be unauthorized error")
}
}) })
}) socket.on("connect", async () => {
assert.fail("should not connect")
})
})
afterEach((done) => { await t.test("should emit error with bad token format", () => {
fixtureStop(done) socket = io(API_URL, {
}) auth: { token: "testing" },
})
socket.on("connect_error", async (error) => {
assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
assert.strictEqual(
error.data.message,
"Format is Authorization: Bearer [token]",
)
assert.strictEqual(error.data.code, "credentials_bad_format")
assert.ok(true)
} else {
assert.fail("should be unauthorized error")
}
})
socket.on("connect", async () => {
assert.fail("should not connect")
})
})
it('should emit error with no token provided', (done) => { await t.test("should emit error with unauthorized handshake", () => {
const socket = io('http://localhost:9000') socket = io(API_URL, {
socket.on('connect_error', (error) => { auth: { token: "Bearer testing" },
expect(isUnauthorizedError(error)).toBeTruthy() })
if (isUnauthorizedError(error)) { socket.on("connect_error", async (error) => {
expect(error.data.message).toEqual('no token provided') assert.strictEqual(isUnauthorizedError(error), true)
expect(error.data.code).toEqual('credentials_required') if (isUnauthorizedError(error)) {
} assert.strictEqual(
socket.close() error.data.message,
done() "Unauthorized: Token is missing or invalid Bearer",
)
assert.strictEqual(error.data.code, "invalid_token")
assert.ok(true)
} else {
assert.fail("should be unauthorized error")
}
})
socket.on("connect", async () => {
assert.fail("should not connect")
})
})
await t.test("should connect the user", () => {
socket = io(API_URL, {
auth: { token: `Bearer ${token}` },
})
socket.on("connect", async () => {
assert.ok(true)
})
socket.on("connect_error", async (error) => {
assert.fail(error.message)
})
}) })
}) })
it('should emit error with bad token format', (done) => { await t.test("with secret as callback in options", async (t) => {
const socket = io('http://localhost:9000', { let token = ""
auth: { token: 'testing' } let socket: Socket | null = null
t.beforeEach(async () => {
await fixtureStart({ secret: secretCallback })
const response = await api.post("/login", {})
token = response.data.token
}) })
socket.on('connect_error', (error) => {
expect(isUnauthorizedError(error)).toBeTruthy() t.afterEach(async () => {
if (isUnauthorizedError(error)) { socket?.disconnect()
expect(error.data.message).toEqual( await fixtureStop()
'Format is Authorization: Bearer [token]' })
)
expect(error.data.code).toEqual('credentials_bad_format') await t.test("should emit error with no token provided", () => {
} socket = io(API_URL)
socket.close() socket.on("connect_error", async (error) => {
done() assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
assert.strictEqual(error.data.message, "no token provided")
assert.strictEqual(error.data.code, "credentials_required")
assert.ok(true)
} else {
assert.fail("should be unauthorized error")
}
})
socket.on("connect", async () => {
assert.fail("should not connect")
})
})
await t.test("should emit error with bad token format", () => {
socket = io(API_URL, {
auth: { token: "testing" },
})
socket.on("connect_error", async (error) => {
assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
assert.strictEqual(
error.data.message,
"Format is Authorization: Bearer [token]",
)
assert.strictEqual(error.data.code, "credentials_bad_format")
assert.ok(true)
} else {
assert.fail("should be unauthorized error")
}
})
socket.on("connect", async () => {
assert.fail("should not connect")
})
})
await t.test("should emit error with unauthorized handshake", () => {
socket = io(API_URL, {
auth: { token: "Bearer testing" },
})
socket.on("connect_error", async (error) => {
assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
assert.strictEqual(
error.data.message,
"Unauthorized: Token is missing or invalid Bearer",
)
assert.strictEqual(error.data.code, "invalid_token")
assert.ok(true)
} else {
assert.fail("should be unauthorized error")
}
})
socket.on("connect", async () => {
assert.fail("should not connect")
})
})
await t.test("should connect the user", () => {
socket = io(API_URL, {
auth: { token: `Bearer ${token}` },
})
socket.on("connect", async () => {
assert.ok(true)
})
socket.on("connect_error", async (error) => {
assert.fail(error.message)
})
}) })
}) })
it('should emit error with unauthorized handshake', (done) => { await t.test("with onAuthentication callback in options", async (t) => {
const socket = io('http://localhost:9000', { let token = ""
auth: { token: 'Bearer testing' } let wrongToken = ""
}) let socket: Socket | null = null
socket.on('connect_error', (error) => {
expect(isUnauthorizedError(error)).toBeTruthy()
if (isUnauthorizedError(error)) {
expect(error.data.message).toEqual(
'Unauthorized: Token is missing or invalid Bearer'
)
expect(error.data.code).toEqual('invalid_token')
}
socket.close()
done()
})
})
it('should connect the user', (done) => { t.beforeEach(async () => {
const socket = io('http://localhost:9000', { await fixtureStart({
auth: { token: `Bearer ${token}` }
})
socket.on('connect', () => {
socket.close()
done()
})
socket.on('connect_error', (error) => {
done(error)
})
})
})
describe('authorize - with onAuthentication callback in options', () => {
let token: string = ''
let wrongToken: string = ''
beforeEach((done) => {
fixtureStart(
async () => {
const response = await axios.post('http://localhost:9000/login')
token = response.data.token
const responseWrong = await axios.post(
'http://localhost:9000/login-wrong'
)
wrongToken = responseWrong.data.token
},
{
secret: secretCallback, secret: secretCallback,
onAuthentication: (decodedToken: Profile) => { onAuthentication: (decodedToken: Profile) => {
if (!decodedToken.checkField) { if (!decodedToken.checkField) {
throw new Error('Check Field validation failed') throw new Error("Check Field validation failed")
} }
return { return {
email: decodedToken.email email: decodedToken.email,
} }
} },
}
)
.then(done)
.catch((error) => {
done(error)
}) })
}) const response = await api.post("/login", {})
token = response.data.token
const responseWrong = await api.post("/login-wrong", {})
wrongToken = responseWrong.data.token
})
afterEach((done) => { t.afterEach(async () => {
fixtureStop(done) socket?.disconnect()
}) await fixtureStop()
})
it('should emit error with no token provided', (done) => { await t.test("should emit error with no token provided", () => {
const socket = io('http://localhost:9000') socket = io(API_URL)
socket.on('connect_error', (error) => { socket.on("connect_error", async (error) => {
expect(isUnauthorizedError(error)).toBeTruthy() assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) { if (isUnauthorizedError(error)) {
expect(error.data.message).toEqual('no token provided') assert.strictEqual(error.data.message, "no token provided")
expect(error.data.code).toEqual('credentials_required') assert.strictEqual(error.data.code, "credentials_required")
} assert.ok(true)
socket.close() } else {
done() assert.fail("should be unauthorized error")
}
})
socket.on("connect", async () => {
assert.fail("should not connect")
})
}) })
})
it('should emit error with bad token format', (done) => { await t.test("should emit error with bad token format", () => {
const socket = io('http://localhost:9000', { socket = io(API_URL, {
auth: { token: 'testing' } auth: { token: "testing" },
})
socket.on("connect_error", async (error) => {
assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
assert.strictEqual(
error.data.message,
"Format is Authorization: Bearer [token]",
)
assert.strictEqual(error.data.code, "credentials_bad_format")
assert.ok(true)
} else {
assert.fail("should be unauthorized error")
}
})
socket.on("connect", async () => {
assert.fail("should not connect")
})
}) })
socket.on('connect_error', (error) => {
expect(isUnauthorizedError(error)).toBeTruthy()
if (isUnauthorizedError(error)) {
expect(error.data.message).toEqual(
'Format is Authorization: Bearer [token]'
)
expect(error.data.code).toEqual('credentials_bad_format')
}
socket.close()
done()
})
})
it('should emit error with unauthorized handshake', (done) => { await t.test("should emit error with unauthorized handshake", () => {
const socket = io('http://localhost:9000', { socket = io(API_URL, {
auth: { token: 'Bearer testing' } auth: { token: "Bearer testing" },
})
socket.on("connect_error", async (error) => {
assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
assert.strictEqual(
error.data.message,
"Unauthorized: Token is missing or invalid Bearer",
)
assert.strictEqual(error.data.code, "invalid_token")
assert.ok(true)
} else {
assert.fail("should be unauthorized error")
}
})
socket.on("connect", async () => {
assert.fail("should not connect")
})
}) })
socket.on('connect_error', (error) => {
expect(isUnauthorizedError(error)).toBeTruthy()
if (isUnauthorizedError(error)) {
expect(error.data.message).toEqual(
'Unauthorized: Token is missing or invalid Bearer'
)
expect(error.data.code).toEqual('invalid_token')
}
socket.close()
done()
})
})
it('should connect the user', (done) => { await t.test("should connect the user", () => {
const socket = io('http://localhost:9000', { socket = io(API_URL, {
auth: { token: `Bearer ${token}` } auth: { token: `Bearer ${token}` },
})
socket.on("connect", async () => {
assert.ok(true)
})
socket.on("connect_error", async (error) => {
assert.fail(error.message)
})
}) })
socket.on('connect', () => {
socket.close()
done()
})
})
it('should contain user property', (done) => { await t.test("should contains user properties", () => {
const socketServer = getSocket() const socketServer = getSocket()
socketServer?.on('connection', (client: any) => { socketServer?.on("connection", (client: any) => {
expect(client.user.email).toEqual('john@doe.com') assert.strictEqual(client.user.email, basicProfile.email)
assert.ok(true)
})
socket = io(API_URL, {
auth: { token: `Bearer ${token}` },
})
socket.on("connect_error", async (error) => {
assert.fail(error.message)
})
}) })
const socket = io('http://localhost:9000', {
auth: { token: `Bearer ${token}` }
})
socket.on('connect', () => {
socket.close()
done()
})
})
it('should emit error when user validation fails', (done) => { await t.test("should emit error when user validation fails", () => {
const socket = io('http://localhost:9000', { socket = io(API_URL, {
auth: { token: `Bearer ${wrongToken}` } auth: { token: `Bearer ${wrongToken}` },
}) })
socket.on('connect_error', (err: any) => { socket.on("connect_error", async (error) => {
try { try {
expect(err.message).toEqual('Check Field validation failed') assert.strictEqual(error.message, "Check Field validation failed")
} catch (err) { assert.ok(true)
socket.close() } catch {
done(err) assert.fail(error.message)
} }
socket.close() })
done() socket.on("connect", async () => {
assert.fail("should not connect")
})
}) })
}) })
}) })

View File

@ -1,80 +1,83 @@
import type { Server as HttpServer } from 'node:http' import jwt from "jsonwebtoken"
import type { Server as HttpsServer } from 'node:https' import { Server as SocketIoServer } from "socket.io"
import type { FastifyInstance } from "fastify"
import fastify from "fastify"
import express from 'express' import type { AuthorizeOptions } from "../../index.js"
import jwt from 'jsonwebtoken' import { authorize } from "../../index.js"
import { Server as SocketIoServer } from 'socket.io'
import enableDestroy from 'server-destroy'
import { authorize, AuthorizeOptions } from '../../index.js' interface FastifyIo {
instance: SocketIoServer
}
export interface Profile { declare module "fastify" {
export interface FastifyInstance {
io: FastifyIo
}
}
export interface BasicProfile {
email: string email: string
id: number id: number
}
export interface Profile extends BasicProfile {
checkField: boolean checkField: boolean
} }
interface Socket { export const PORT = 9000
io: null | SocketIoServer export const API_URL = `http://localhost:${PORT}`
init: (httpServer: HttpServer | HttpsServer) => void export const basicProfile: BasicProfile = {
email: "john@doe.com",
id: 123,
} }
const socket: Socket = { let application: FastifyInstance | null = null
io: null,
init(httpServer) {
socket.io = new SocketIoServer(httpServer)
}
}
let server: HttpServer | null = null
export const fixtureStart = async ( export const fixtureStart = async (
done: any, options: AuthorizeOptions = { secret: "super secret" },
options: AuthorizeOptions = { secret: 'super secret' }
): Promise<void> => { ): Promise<void> => {
const profile: Profile = { const profile: Profile = { ...basicProfile, checkField: true }
email: 'john@doe.com', let keySecret = ""
id: 123, if (typeof options.secret === "string") {
checkField: true
}
let keySecret = ''
if (typeof options.secret === 'string') {
keySecret = options.secret keySecret = options.secret
} else { } else {
keySecret = await options.secret({ keySecret = await options.secret({
header: { alg: 'HS256' }, header: { alg: "HS256" },
payload: profile payload: profile,
}) })
} }
const app = express() application = fastify()
app.use(express.json()) application.post("/login", async (_request, reply) => {
app.post('/login', (_req, res) => {
const token = jwt.sign(profile, keySecret, { const token = jwt.sign(profile, keySecret, {
expiresIn: 60 * 60 * 5 expiresIn: 60 * 60 * 5,
}) })
return res.json({ token }) reply.statusCode = 201
return { token }
}) })
app.post('/login-wrong', (_req, res) => { application.post("/login-wrong", async (_request, reply) => {
profile.checkField = false profile.checkField = false
const token = jwt.sign(profile, keySecret, { const token = jwt.sign(profile, keySecret, {
expiresIn: 60 * 60 * 5 expiresIn: 60 * 60 * 5,
}) })
return res.json({ token }) reply.statusCode = 201
return { token }
})
const instance = new SocketIoServer(application.server)
instance.use(authorize(options))
application.decorate("io", { instance })
application.addHook("onClose", (fastify) => {
fastify.io.instance.close()
})
await application.listen({
port: PORT,
}) })
server = app.listen(9000, done)
socket.init(server)
socket.io?.use(authorize(options))
enableDestroy(server)
} }
export const fixtureStop = (callback: Function): void => { export const fixtureStop = async (): Promise<void> => {
socket.io?.close() await application?.close()
try {
server?.destroy()
} catch {}
callback()
} }
export const getSocket = (): SocketIoServer | null => { export const getSocket = (): SocketIoServer | undefined => {
return socket.io return application?.io.instance
} }

View File

@ -1,9 +1,10 @@
import jwt, { Algorithm } from 'jsonwebtoken' import type { Algorithm } from "jsonwebtoken"
import { Socket } from 'socket.io' import jwt from "jsonwebtoken"
import type { Socket } from "socket.io"
import { UnauthorizedError } from './UnauthorizedError.js' import { UnauthorizedError } from "./UnauthorizedError.js"
declare module 'socket.io' { declare module "socket.io" {
interface Socket extends ExtendedSocket {} interface Socket extends ExtendedSocket {}
} }
@ -15,7 +16,7 @@ interface ExtendedSocket {
type SocketIOMiddleware = ( type SocketIOMiddleware = (
socket: Socket, socket: Socket,
next: (error?: UnauthorizedError) => void next: (error?: UnauthorizedError) => void,
) => void ) => void
interface CompleteDecodedToken { interface CompleteDecodedToken {
@ -27,7 +28,7 @@ interface CompleteDecodedToken {
} }
type SecretCallback = ( type SecretCallback = (
decodedToken: CompleteDecodedToken decodedToken: CompleteDecodedToken,
) => Promise<string> | string ) => Promise<string> | string
export interface AuthorizeOptions { export interface AuthorizeOptions {
@ -37,32 +38,32 @@ export interface AuthorizeOptions {
} }
export const authorize = (options: AuthorizeOptions): SocketIOMiddleware => { export const authorize = (options: AuthorizeOptions): SocketIOMiddleware => {
const { secret, algorithms = ['HS256'], onAuthentication } = options const { secret, algorithms = ["HS256"], onAuthentication } = options
return async (socket, next) => { return async (socket, next) => {
let encodedToken: string | null = null let encodedToken: string | null = null
const { token } = socket.handshake.auth const { token } = socket.handshake.auth
if (token != null) { if (token != null) {
const tokenSplitted = token.split(' ') const tokenSplitted = token.split(" ")
if (tokenSplitted.length !== 2 || tokenSplitted[0] !== 'Bearer') { if (tokenSplitted.length !== 2 || tokenSplitted[0] !== "Bearer") {
return next( return next(
new UnauthorizedError('credentials_bad_format', { new UnauthorizedError("credentials_bad_format", {
message: 'Format is Authorization: Bearer [token]' message: "Format is Authorization: Bearer [token]",
}) }),
) )
} }
encodedToken = tokenSplitted[1] encodedToken = tokenSplitted[1]
} }
if (encodedToken == null) { if (encodedToken == null) {
return next( return next(
new UnauthorizedError('credentials_required', { new UnauthorizedError("credentials_required", {
message: 'no token provided' message: "no token provided",
}) }),
) )
} }
socket.encodedToken = encodedToken socket.encodedToken = encodedToken
let keySecret: string | null = null let keySecret: string | null = null
let decodedToken: any let decodedToken: any = null
if (typeof secret === 'string') { if (typeof secret === "string") {
keySecret = secret keySecret = secret
} else { } else {
const completeDecodedToken = jwt.decode(encodedToken, { complete: true }) const completeDecodedToken = jwt.decode(encodedToken, { complete: true })
@ -72,9 +73,9 @@ export const authorize = (options: AuthorizeOptions): SocketIOMiddleware => {
decodedToken = jwt.verify(encodedToken, keySecret, { algorithms }) decodedToken = jwt.verify(encodedToken, keySecret, { algorithms })
} catch { } catch {
return next( return next(
new UnauthorizedError('invalid_token', { new UnauthorizedError("invalid_token", {
message: 'Unauthorized: Token is missing or invalid Bearer' message: "Unauthorized: Token is missing or invalid Bearer",
}) }),
) )
} }
socket.decodedToken = decodedToken socket.decodedToken = decodedToken

View File

@ -1,2 +1,2 @@
export * from './authorize.js' export * from "./authorize.js"
export * from './UnauthorizedError.js' export * from "./UnauthorizedError.js"

View File

@ -1,15 +1,13 @@
{ {
"extends": "@tsconfig/strictest/tsconfig.json",
"compilerOptions": { "compilerOptions": {
"target": "ESNext", "target": "ESNext",
"module": "commonjs",
"lib": ["ESNext"], "lib": ["ESNext"],
"moduleResolution": "node", "module": "NodeNext",
"moduleResolution": "NodeNext",
"outDir": "./build", "outDir": "./build",
"rootDir": "./src", "rootDir": "./src",
"emitDeclarationOnly": true, "emitDeclarationOnly": true,
"declaration": true, "declaration": true
"strict": true,
"skipLibCheck": true,
"esModuleInterop": true
} }
} }