11 Commits

20 changed files with 3939 additions and 6219 deletions

View File

@ -1,6 +1,7 @@
{
"extends": ["conventions", "prettier"],
"plugins": ["prettier", "import", "unicorn"],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"project": "./tsconfig.json"
},

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. -->
## What changes this PR introduce?
# What changes this PR introduce?
## List any relevant issue numbers

View File

@ -10,16 +10,16 @@ jobs:
build:
runs-on: 'ubuntu-latest'
steps:
- uses: 'actions/checkout@v3.5.0'
- uses: 'actions/checkout@v4.0.0'
- name: 'Use Node.js'
uses: 'actions/setup-node@v3.6.0'
- name: 'Setup Node.js'
uses: 'actions/setup-node@v3.8.1'
with:
node-version: 'lts/*'
node-version: '20.x'
cache: 'npm'
- name: 'Install'
run: 'npm install'
- name: 'Install dependencies'
run: 'npm clean-install'
- name: 'Build'
run: 'npm run build'

View File

@ -10,16 +10,16 @@ jobs:
lint:
runs-on: 'ubuntu-latest'
steps:
- uses: 'actions/checkout@v3.5.0'
- uses: 'actions/checkout@v4.0.0'
- name: 'Use Node.js'
uses: 'actions/setup-node@v3.6.0'
- name: 'Setup Node.js'
uses: 'actions/setup-node@v3.8.1'
with:
node-version: 'lts/*'
node-version: '20.x'
cache: 'npm'
- name: 'Install'
run: 'npm install'
- name: 'Install dependencies'
run: 'npm clean-install'
- run: 'npm run lint:commit -- --to "${{ github.sha }}"'
- run: 'npm run lint:editorconfig'

View File

@ -7,23 +7,31 @@ on:
jobs:
release:
runs-on: 'ubuntu-latest'
permissions:
contents: 'write'
issues: 'write'
pull-requests: 'write'
id-token: 'write'
steps:
- uses: 'actions/checkout@v3.5.0'
- uses: 'actions/checkout@v4.0.0'
- name: 'Use Node.js'
uses: 'actions/setup-node@v3.6.0'
- name: 'Setup Node.js'
uses: 'actions/setup-node@v3.8.1'
with:
node-version: 'lts/*'
node-version: '20.x'
cache: 'npm'
- name: 'Install'
run: 'npm install'
- name: 'Install dependencies'
run: 'npm clean-install'
- name: 'Build Package'
run: 'npm run build'
- run: 'npm run build:typescript'
- name: 'Verify the integrity of provenance attestations and registry signatures for installed dependencies'
run: 'npm audit signatures'
- name: 'Release'
run: 'npm run release'
env:

View File

@ -10,16 +10,16 @@ jobs:
test:
runs-on: 'ubuntu-latest'
steps:
- uses: 'actions/checkout@v3.5.0'
- uses: 'actions/checkout@v4.0.0'
- name: 'Use Node.js'
uses: 'actions/setup-node@v3.6.0'
- name: 'Setup Node.js'
uses: 'actions/setup-node@v3.8.1'
with:
node-version: 'lts/*'
node-version: '20.x'
cache: 'npm'
- name: 'Install'
run: 'npm install'
- name: 'Install dependencies'
run: 'npm clean-install'
- name: 'Build'
run: 'npm run build'

View File

@ -1,4 +1,10 @@
{
"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,
"relative-links": true,
"extends": "markdownlint/style/prettier",
"MD033": false,
"MD041": false
}

1
.npmrc
View File

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

View File

@ -1,5 +0,0 @@
{
"reporter": ["text", "cobertura"],
"src": "./build",
"all": true
}

3
.swcrc
View File

@ -1,10 +1,11 @@
{
"sourceMaps": true,
"jsc": {
"parser": {
"syntax": "typescript",
"dynamicImport": true
},
"target": "es2022"
"target": "esnext"
},
"module": {
"type": "es6"

9
.taprc
View File

@ -1,9 +0,0 @@
ts: false
jsx: false
flow: false
check-coverage: false
coverage: false
timeout: 10000
files:
- 'build/**/*.test.js'

View File

@ -60,7 +60,7 @@ representative at an online or offline event.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
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 community leaders are obligated to respect the privacy and security of the

View File

@ -29,26 +29,4 @@ If you're adding new features to **Thream/socketio-jwt**, please include tests.
## 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.
### 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.
The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.

View File

@ -1,6 +1,6 @@
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
of this software and associated documentation files (the "Software"), to deal

View File

@ -22,13 +22,12 @@
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) & 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) and 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

9763
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -8,20 +8,25 @@
"main": "build/index.js",
"types": "build/index.d.ts",
"files": [
"build"
"build",
"!**/*.test.js",
"!**/*.test.d.ts",
"!**/*.map"
],
"engines": {
"node": ">=16.0.0"
"node": ">=16.0.0",
"npm": ">=9.0.0"
},
"publishConfig": {
"access": "public"
"access": "public",
"provenance": true
},
"keywords": [
"socket",
"socket.io",
"jwt"
],
"author": "Divlo <contact@divlo.fr>",
"author": "Théo LUDWIG <contact@theoludwig.fr>",
"repository": {
"type": "git",
"url": "https://github.com/Thream/socketio-jwt"
@ -37,10 +42,10 @@
"lint:commit": "commitlint",
"lint:editorconfig": "editorconfig-checker",
"lint:markdown": "markdownlint-cli2",
"lint:eslint": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"",
"lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"",
"lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
"lint:prettier": "prettier . --check",
"lint:staged": "lint-staged",
"test": "c8 tap",
"test": "cross-env NODE_ENV=test node --enable-source-maps --test build/",
"release": "semantic-release",
"postinstall": "husky install",
"prepublishOnly": "pinst --disable",
@ -50,41 +55,39 @@
"socket.io": ">=3.0.0"
},
"dependencies": {
"jsonwebtoken": "9.0.0"
"jsonwebtoken": "9.0.2"
},
"devDependencies": {
"@commitlint/cli": "17.5.1",
"@commitlint/config-conventional": "17.4.4",
"@commitlint/cli": "17.7.1",
"@commitlint/config-conventional": "17.7.0",
"@swc/cli": "0.1.62",
"@swc/core": "1.3.44",
"@tsconfig/strictest": "2.0.0",
"@types/jsonwebtoken": "9.0.1",
"@types/node": "18.15.11",
"@types/tap": "15.0.8",
"@typescript-eslint/eslint-plugin": "5.57.0",
"@typescript-eslint/parser": "5.57.0",
"axios": "1.3.4",
"c8": "7.13.0",
"editorconfig-checker": "5.0.1",
"eslint": "8.37.0",
"eslint-config-conventions": "8.0.0",
"eslint-config-prettier": "8.8.0",
"eslint-plugin-import": "2.27.5",
"eslint-plugin-prettier": "4.2.1",
"@swc/core": "1.3.85",
"@tsconfig/strictest": "2.0.2",
"@types/jsonwebtoken": "9.0.3",
"@types/node": "20.6.2",
"@typescript-eslint/eslint-plugin": "6.7.2",
"@typescript-eslint/parser": "6.7.2",
"axios": "1.5.0",
"cross-env": "7.0.3",
"editorconfig-checker": "5.1.1",
"eslint": "8.49.0",
"eslint-config-conventions": "11.0.1",
"eslint-config-prettier": "9.0.0",
"eslint-plugin-import": "2.28.1",
"eslint-plugin-prettier": "5.0.0",
"eslint-plugin-promise": "6.1.1",
"eslint-plugin-unicorn": "46.0.0",
"fastify": "4.15.0",
"eslint-plugin-unicorn": "48.0.1",
"fastify": "4.23.2",
"husky": "8.0.3",
"lint-staged": "13.2.0",
"markdownlint-cli2": "0.6.0",
"markdownlint-rule-relative-links": "1.1.2",
"lint-staged": "14.0.1",
"markdownlint-cli2": "0.10.0",
"markdownlint-rule-relative-links": "2.1.0",
"pinst": "3.0.0",
"prettier": "2.8.7",
"rimraf": "4.4.1",
"semantic-release": "21.0.1",
"socket.io": "4.6.1",
"socket.io-client": "4.6.1",
"tap": "16.3.4",
"typescript": "5.0.3"
"prettier": "3.0.3",
"rimraf": "5.0.1",
"semantic-release": "22.0.0",
"socket.io": "4.7.2",
"socket.io-client": "4.7.2",
"typescript": "5.2.2"
}
}

View File

@ -1,4 +1,6 @@
import tap from 'tap'
import test from 'node:test'
import assert from 'node:assert/strict'
import axios from 'axios'
import type { Socket } from 'socket.io-client'
import { io } from 'socket.io-client'
@ -24,7 +26,7 @@ const secretCallback = async (): Promise<string> => {
return 'somesecret'
}
await tap.test('authorize', async (t) => {
await test('authorize', async (t) => {
await t.test('with secret as string in options', async (t) => {
let token = ''
let socket: Socket | null = null
@ -40,71 +42,76 @@ await tap.test('authorize', async (t) => {
await fixtureStop()
})
await t.test('should emit error with no token provided', (t) => {
t.plan(4)
await t.test('should emit error with no token provided', () => {
socket = io(API_URL)
socket.on('connect_error', async (error) => {
t.equal(isUnauthorizedError(error), true)
assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
t.equal(error.data.message, 'no token provided')
t.equal(error.data.code, 'credentials_required')
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')
}
t.pass()
})
socket.on('connect', async () => {
t.fail()
assert.fail('should not connect')
})
})
await t.test('should emit error with bad token format', (t) => {
t.plan(4)
await t.test('should emit error with bad token format', () => {
socket = io(API_URL, {
auth: { token: 'testing' }
})
socket.on('connect_error', async (error) => {
t.equal(isUnauthorizedError(error), true)
assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
t.equal(error.data.message, 'Format is Authorization: Bearer [token]')
t.equal(error.data.code, 'credentials_bad_format')
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')
}
t.pass()
})
socket.on('connect', async () => {
t.fail()
assert.fail('should not connect')
})
})
await t.test('should emit error with unauthorized handshake', (t) => {
t.plan(4)
await t.test('should emit error with unauthorized handshake', () => {
socket = io(API_URL, {
auth: { token: 'Bearer testing' }
})
socket.on('connect_error', async (error) => {
t.equal(isUnauthorizedError(error), true)
assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
t.equal(
assert.strictEqual(
error.data.message,
'Unauthorized: Token is missing or invalid Bearer'
)
t.equal(error.data.code, 'invalid_token')
assert.strictEqual(error.data.code, 'invalid_token')
assert.ok(true)
} else {
assert.fail('should be unauthorized error')
}
t.pass()
})
socket.on('connect', async () => {
t.fail()
assert.fail('should not connect')
})
})
await t.test('should connect the user', (t) => {
t.plan(1)
await t.test('should connect the user', () => {
socket = io(API_URL, {
auth: { token: `Bearer ${token}` }
})
socket.on('connect', async () => {
t.pass()
assert.ok(true)
})
socket.on('connect_error', async (error) => {
t.fail(error.message)
assert.fail(error.message)
})
})
})
@ -124,71 +131,76 @@ await tap.test('authorize', async (t) => {
await fixtureStop()
})
await t.test('should emit error with no token provided', (t) => {
t.plan(4)
await t.test('should emit error with no token provided', () => {
socket = io(API_URL)
socket.on('connect_error', async (error) => {
t.equal(isUnauthorizedError(error), true)
assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
t.equal(error.data.message, 'no token provided')
t.equal(error.data.code, 'credentials_required')
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')
}
t.pass()
})
socket.on('connect', async () => {
t.fail()
assert.fail('should not connect')
})
})
await t.test('should emit error with bad token format', (t) => {
t.plan(4)
await t.test('should emit error with bad token format', () => {
socket = io(API_URL, {
auth: { token: 'testing' }
})
socket.on('connect_error', async (error) => {
t.equal(isUnauthorizedError(error), true)
assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
t.equal(error.data.message, 'Format is Authorization: Bearer [token]')
t.equal(error.data.code, 'credentials_bad_format')
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')
}
t.pass()
})
socket.on('connect', async () => {
t.fail()
assert.fail('should not connect')
})
})
await t.test('should emit error with unauthorized handshake', (t) => {
t.plan(4)
await t.test('should emit error with unauthorized handshake', () => {
socket = io(API_URL, {
auth: { token: 'Bearer testing' }
})
socket.on('connect_error', async (error) => {
t.equal(isUnauthorizedError(error), true)
assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
t.equal(
assert.strictEqual(
error.data.message,
'Unauthorized: Token is missing or invalid Bearer'
)
t.equal(error.data.code, 'invalid_token')
assert.strictEqual(error.data.code, 'invalid_token')
assert.ok(true)
} else {
assert.fail('should be unauthorized error')
}
t.pass()
})
socket.on('connect', async () => {
t.fail()
assert.fail('should not connect')
})
})
await t.test('should connect the user', (t) => {
t.plan(1)
await t.test('should connect the user', () => {
socket = io(API_URL, {
auth: { token: `Bearer ${token}` }
})
socket.on('connect', async () => {
t.pass()
assert.ok(true)
})
socket.on('connect_error', async (error) => {
t.fail(error.message)
assert.fail(error.message)
})
})
})
@ -221,104 +233,107 @@ await tap.test('authorize', async (t) => {
await fixtureStop()
})
await t.test('should emit error with no token provided', (t) => {
t.plan(4)
await t.test('should emit error with no token provided', () => {
socket = io(API_URL)
socket.on('connect_error', async (error) => {
t.equal(isUnauthorizedError(error), true)
assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
t.equal(error.data.message, 'no token provided')
t.equal(error.data.code, 'credentials_required')
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')
}
t.pass()
})
socket.on('connect', async () => {
t.fail()
assert.fail('should not connect')
})
})
await t.test('should emit error with bad token format', (t) => {
t.plan(4)
await t.test('should emit error with bad token format', () => {
socket = io(API_URL, {
auth: { token: 'testing' }
})
socket.on('connect_error', async (error) => {
t.equal(isUnauthorizedError(error), true)
assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
t.equal(error.data.message, 'Format is Authorization: Bearer [token]')
t.equal(error.data.code, 'credentials_bad_format')
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')
}
t.pass()
})
socket.on('connect', async () => {
t.fail()
assert.fail('should not connect')
})
})
await t.test('should emit error with unauthorized handshake', (t) => {
t.plan(4)
await t.test('should emit error with unauthorized handshake', () => {
socket = io(API_URL, {
auth: { token: 'Bearer testing' }
})
socket.on('connect_error', async (error) => {
t.equal(isUnauthorizedError(error), true)
assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
t.equal(
assert.strictEqual(
error.data.message,
'Unauthorized: Token is missing or invalid Bearer'
)
t.equal(error.data.code, 'invalid_token')
assert.strictEqual(error.data.code, 'invalid_token')
assert.ok(true)
} else {
assert.fail('should be unauthorized error')
}
t.pass()
})
socket.on('connect', async () => {
t.fail()
assert.fail('should not connect')
})
})
await t.test('should connect the user', (t) => {
t.plan(1)
await t.test('should connect the user', () => {
socket = io(API_URL, {
auth: { token: `Bearer ${token}` }
})
socket.on('connect', async () => {
t.pass()
assert.ok(true)
})
socket.on('connect_error', async (error) => {
t.fail(error.message)
assert.fail(error.message)
})
})
await t.test('should contains user properties', (t) => {
t.plan(2)
await t.test('should contains user properties', () => {
const socketServer = getSocket()
socketServer?.on('connection', (client: any) => {
t.equal(client.user.email, basicProfile.email)
t.pass()
assert.strictEqual(client.user.email, basicProfile.email)
assert.ok(true)
})
socket = io(API_URL, {
auth: { token: `Bearer ${token}` }
})
socket.on('connect_error', async (error) => {
t.fail(error.message)
assert.fail(error.message)
})
})
await t.test('should emit error when user validation fails', (t) => {
t.plan(2)
await t.test('should emit error when user validation fails', () => {
socket = io(API_URL, {
auth: { token: `Bearer ${wrongToken}` }
})
socket.on('connect_error', async (error) => {
try {
t.equal(error.message, 'Check Field validation failed')
t.pass()
assert.strictEqual(error.message, 'Check Field validation failed')
assert.ok(true)
} catch {
t.fail()
assert.fail(error.message)
}
})
socket.on('connect', async () => {
t.fail()
assert.fail('should not connect')
})
})
})

View File

@ -2,9 +2,9 @@
"extends": "@tsconfig/strictest/tsconfig.json",
"compilerOptions": {
"target": "ESNext",
"module": "ESNext",
"lib": ["ESNext"],
"moduleResolution": "node",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"outDir": "./build",
"rootDir": "./src",
"emitDeclarationOnly": true,