chore(release): v2.1.0

BREAKING CHANGE: extraHeaders with Authorization doesn't work anymore

See: https://socket.io/docs/v3/middlewares/#Sending-credentials

.commitlintrc.json

@@ -0,0 +1 @@
+{ "extends": ["@commitlint/config-conventional"] }

.github/CODE_OF_CONDUCT.md

@@ -1,132 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-- Demonstrating empathy and kindness toward other people
-- Being respectful of differing opinions, viewpoints, and experiences
-- Giving and gracefully accepting constructive feedback
-- Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-- Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-- The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-- Trolling, insulting or derogatory comments, and personal or political attacks
-- Public or private harassment
-- Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-- Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-contact@divlo.fr.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
-
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][mozilla coc].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][faq]. Translations are available
-at [https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
-[mozilla coc]: https://github.com/mozilla/diversity
-[faq]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations

.github/ISSUE_TEMPLATE/BUG.md

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

.github/ISSUE_TEMPLATE/DOCUMENTATION.md

@@ -1,20 +1,18 @@
 ---
 name: '📜 Documentation'
 about: 'Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).'
+title: '[Documentation]'
 labels: 'documentation'
 ---
 
-<!--
+<!-- Please make sure your issue has not already been fixed. -->
-Please make sure your issue has not already been fixed.
 
-Please place an x (no spaces - [x]) in all [ ] that apply.
+## Documentation
--->
 
-### Documentation :
+<!-- Please uncomment the type of documentation problem this issue address -->
 
-- [ ] Is Missing
+<!-- Documentation is Missing -->
-- [ ] Is Confusing
+<!-- Documentation is Confusing -->
-- [ ] Has Typo errors
+<!-- Documentation has Typo errors -->
-- [ ] Not Sure?
 
-### Proposal
+## Proposal

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -1,19 +1,20 @@
 ---
 name: '✨ Feature Request'
 about: 'Suggest a new feature idea.'
+title: '[Feature]'
 labels: 'feature request'
 ---
 
 <!-- Please make sure your issue has not already been fixed. -->
 
-### Description
+## Description
 
 <!-- A clear and concise description of the problem or missing capability... -->
 
-### Describe the solution you'd like
+## Describe the solution you'd like
 
 <!-- If you have a solution in mind, please describe it. -->
 
-### Describe alternatives you've considered
+## Describe alternatives you've considered
 
 <!-- Have you considered any alternative solutions or workarounds? -->

.github/ISSUE_TEMPLATE/IMPROVEMENT.md

@@ -1,21 +1,20 @@
 ---
 name: '🔧 Improvement'
 about: 'Improve structure/format/performance/refactor/tests of the code.'
+title: '[Improvement]'
 labels: 'improvement'
 ---
 
-<!--
+<!-- Please make sure your issue has not already been fixed. -->
-Please make sure your issue has not already been fixed.
 
-Please place an x (no spaces - [x]) in all [ ] that apply.
+## Type of Improvement
--->
 
-### Type of Improvement :
+<!-- Please uncomment the type of improvements this issue address -->
 
-- [ ] Files and Folders Structure
+<!-- Files and Folders Structure -->
-- [ ] Performance
+<!-- Performance -->
-- [ ] Refactoring code
+<!-- Refactoring code -->
-- [ ] Tests
+<!-- Tests -->
-- [ ] Not Sure?
+<!-- Not Sure? -->
 
-### Proposal
+## Proposal

.github/ISSUE_TEMPLATE/QUESTION.md

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

.github/PULL_REQUEST_TEMPLATE.md

@@ -3,25 +3,12 @@
 Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time.
 
 Before submitting your contribution, please take a moment to review this document:
-https://github.com/Thream/socketio-jwt/blob/master/.github/CONTRIBUTING.md
+https://github.com/Thream/socketio-jwt/blob/master/CONTRIBUTING.md
-
-Please place an x (no spaces - [x]) in all [ ] that apply.
 
 -->
 
-### What type of change does this PR introduce?
+## What changes this PR introduce?
 
-- [ ] Bugfix
+## List any relevant issue numbers
-- [ ] Feature
-- [ ] Refactor
-- [ ] Documentation
-- [ ] Not Sure?
 
-### Does this PR introduce breaking changes?
+## Is there anything you'd like reviewers to focus on?
-
-- [ ] Yes
-- [ ] No
-
-### List any relevant issue numbers:
-
-### Description:

.github/workflows/codeql-analysis.yml

@@ -1,41 +0,0 @@
-# For more information see: https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code
-
-name: 'CodeQL'
-
-on:
-  push:
-    branches: [master, develop]
-  pull_request_review:
-    branches: [master, develop]
-    types: [submitted]
-
-jobs:
-  analyze:
-    if: ${{ (github.event_name == 'push') || (github.event_name == 'pull_request_review' && github.event.review.state == 'approved' && (github.event.review.author_association == 'COLLABORATOR' || github.event.review.author_association == 'MEMBER' || github.event.review.author_association == 'OWNER') && !github.event.pull_request.draft && github.event.pull_request.state == 'open') }}
-    name: 'Analyze'
-    runs-on: ubuntu-latest
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: ['javascript']
-
-    steps:
-      - name: 'Checkout repository'
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 2
-
-      - run: git checkout HEAD^2
-        if: ${{ github.event_name == 'pull_request' }}
-
-      - name: 'Initialize CodeQL'
-        uses: github/codeql-action/init@v1
-        with:
-          languages: ${{ matrix.language }}
-
-      - name: 'Autobuild'
-        uses: github/codeql-action/autobuild@v1
-
-      - name: 'Perform CodeQL Analysis'
-        uses: github/codeql-action/analyze@v1

.github/workflows/commitlint.yml

@@ -12,9 +12,11 @@ on:
 jobs:
   commitlint:
     if: ${{ (github.event_name == 'push') || (github.event_name == 'pull_request_review' && github.event.review.state == 'approved' && (github.event.review.author_association == 'COLLABORATOR' || github.event.review.author_association == 'MEMBER' || github.event.review.author_association == 'OWNER') && !github.event.pull_request.draft && github.event.pull_request.state == 'open') }}
-    runs-on: ubuntu-latest
+    runs-on: 'ubuntu-latest'
     steps:
       - uses: 'actions/checkout@v2'
         with:
           fetch-depth: 0
-      - uses: 'wagoid/commitlint-github-action@v2'
+      - uses: 'wagoid/commitlint-github-action@v3.0.6'
+        with:
+          configFile: '.commitlintrc.json'

.github/workflows/nodejs.yml

@@ -12,7 +12,7 @@ on:
 jobs:
   ci_app:
     if: ${{ (github.event_name == 'push') || (github.event_name == 'pull_request_review' && github.event.review.state == 'approved' && (github.event.review.author_association == 'COLLABORATOR' || github.event.review.author_association == 'MEMBER' || github.event.review.author_association == 'OWNER') && !github.event.pull_request.draft && github.event.pull_request.state == 'open') }}
-    runs-on: ubuntu-latest
+    runs-on: 'ubuntu-latest'
     strategy:
       matrix:
         node-version: [14.x]
@@ -20,23 +20,25 @@ jobs:
       - uses: 'actions/checkout@v2'
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: 'actions/setup-node@v2.1.4'
+        uses: 'actions/setup-node@v2.1.5'
         with:
           node-version: ${{ matrix.node-version }}
 
       - name: 'Cache dependencies'
-        uses: 'actions/cache@v2'
+        uses: 'actions/cache@v2.1.4'
         with:
-          path: |
+          path: '.npm'
-            **/node_modules
+          key: ${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
-          key: ${{ runner.os }}-${{ hashFiles('**/package.json') }}
 
       - name: 'Install dependencies'
-        run: 'npm install'
+        run: 'npm ci --cache .npm --prefer-offline'
 
       - name: 'Lint'
         run: 'npm run lint'
 
+      - name: 'MarkdownLint'
+        run: 'npm run markdownlint'
+
       - name: 'Build'
         run: 'npm run build'
 

.github/workflows/npm-publish.yml

@@ -12,19 +12,25 @@ jobs:
     steps:
       - uses: 'actions/checkout@v2'
 
-      - name: 'Cache dependencies'
+      - name: Use Node.js ${{ matrix.node-version }}
-        uses: 'actions/cache@v2'
+        uses: 'actions/setup-node@v2.1.5'
-        with:
-          path: '**/node_modules'
-          key: ${{ runner.os }}-${{ hashFiles('**/package.json') }}
-
-      - uses: 'actions/setup-node@v2.1.2'
         with:
           node-version: 14
           registry-url: 'https://registry.npmjs.org/'
 
-      - run: 'npm install'
+      - name: 'Cache dependencies'
-      - run: 'npm run build'
+        uses: 'actions/cache@v2.1.4'
-      - run: 'npm publish --access public'
+        with:
+          path: '.npm'
+          key: ${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
+
+      - name: 'Install dependencies'
+        run: 'npm ci --cache .npm --prefer-offline'
+
+      - name: 'Build'
+        run: 'npm run build'
+
+      - name: 'Publish package on npm'
+        run: 'npm publish --access public'
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.gitignore

@@ -2,9 +2,7 @@
 
 # dependencies
 node_modules
-.pnp
+.npm
-.pnp.js
-.yarn
 
 # production
 build
@@ -12,19 +10,8 @@ build
 # testing
 coverage
 
-# envs
-.env
-.env.production
-
 # debug
 npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# lockfiles
-package-lock.json
-yarn.lock
-pnpm-lock.yaml
 
 # editors
 .vscode

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run lint
+npm run markdownlint

.markdownlint.json

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

.npmrc

@@ -1,2 +1 @@
-package-lock=false
 save-exact=true

.yarnrc

@@ -1,2 +0,0 @@
-install.no-lockfile true
-save-exact true

CHANGELOG.md

@@ -1,3 +1,71 @@
-# [1.0.0](https://github.com/Thream/socketio-jwt/compare/v4.6.2...v1.0.0) (2020-12-29)
+# Changelog
+
+## [2.1.0](https://github.com/Thream/socketio-jwt/compare/v2.0.0...v2.1.0) (2021-03-08)
+
+### Features
+
+- add optional `onAuthentication` option to add `user` property in `socket` object ([#62](https://github.com/Thream/socketio-jwt/issues/62)) ([c7f64a6](https://github.com/Thream/socketio-jwt/commit/c7f64a6312a3e1f6f04918cb7cd415ddef7a11e5))
+
+## [2.0.0](https://github.com/Thream/socketio-jwt/compare/v1.1.1...v2.0.0) (2021-02-22)
+
+### Features
+
+- usage of auth option to send credentials ([a14d4e9](https://github.com/Thream/socketio-jwt/commit/a14d4e937b764fdf4fb6b173c55b6f49688766dd))
+
+  See: <https://socket.io/docs/v3/middlewares/#Sending-credentials>
+
+### BREAKING CHANGES
+
+- `extraHeaders` with `Authorization` doesn't work anymore
+
+### Migration
+
+You need to change the way to connect client side.
+
+Before :
+
+```ts
+import { io } from 'socket.io-client'
+
+const socket = io('http://localhost:9000', {
+  extraHeaders: { Authorization: `Bearer ${yourJWT}` }
+})
+```
+
+After :
+
+```ts
+import { io } from 'socket.io-client'
+
+const socket = io('http://localhost:9000', {
+  auth: { token: `Bearer ${yourJWT}` }
+})
+```
+
+## [1.1.1](https://github.com/Thream/socketio-jwt/compare/v1.1.0...v1.1.1) (2021-01-28)
+
+### Bug Fixes
+
+- **types:** decodedToken in secret callback ([c1a9213](https://github.com/Thream/socketio-jwt/commit/c1a9213a527e4c6188328221372e1f40191a790e)), closes [#21](https://github.com/Thream/socketio-jwt/issues/21)
+
+### Documentation
+
+- update server side usage with `jwks-rsa` : get the secret with `key.getPublicKey()` instead of `key.rsaPublicKey`
+
+## [1.1.0](https://github.com/Thream/socketio-jwt/compare/v1.0.1...v1.1.0) (2021-01-07)
+
+### Features
+
+- add algorithms option ([abbabc5](https://github.com/Thream/socketio-jwt/commit/abbabc588e3ea8b906fa0a0dcc83c91a3b5b5ea8))
+- add support for jwks-rsa ([#1](https://github.com/Thream/socketio-jwt/issues/1)) ([261e8d6](https://github.com/Thream/socketio-jwt/commit/261e8d66e2ec6fefb77429abcef8f846d996ecac))
+- improve types by extending socket.io module ([#6](https://github.com/Thream/socketio-jwt/issues/6)) ([84b523f](https://github.com/Thream/socketio-jwt/commit/84b523f4348c81933887f0dc700f438c84bd779a))
+
+## [1.0.1](https://github.com/Thream/socketio-jwt/compare/v1.0.0...v1.0.1) (2020-12-29)
+
+### Documentation
+
+- fix usage section by correctly importing `authorize`
+
+## [1.0.0](https://github.com/Thream/socketio-jwt/compare/v4.6.2...v1.0.0) (2020-12-29)
 
 Initial release.

CONTRIBUTING.md

@@ -4,7 +4,7 @@ Thanks a lot for your interest in contributing to **Thream/socketio-jwt**! 🎉
 
 ## Code of Conduct
 
-**Thream** has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect project participants to adhere to it. Please read [the full text](./CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
+**Thream** has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect project participants to adhere to it. Please read [the full text](https://github.com/Thream/Thream/blob/master/.github/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
 
 ## Open Development
 

README.md

@@ -8,17 +8,18 @@
   <a href="https://github.com/Thream/socketio-jwt/actions?query=workflow%3A%22Node.js+CI%22"><img src="https://github.com/Thream/socketio-jwt/workflows/Node.js%20CI/badge.svg" alt="Node.js CI" /></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>
   <a href="https://dependabot.com/"><img src="https://badgen.net/github/dependabot/Thream/socketio-jwt?icon=dependabot" alt="Dependabot badge" /></a>
+  <a href="https://www.npmjs.com/package/@thream/socketio-jwt"><img src="https://img.shields.io/npm/v/@thream/socketio-jwt.svg" alt="npm version"></a>
   <a href="https://www.npmjs.com/package/ts-standard"><img alt="TypeScript Standard Style" src="https://camo.githubusercontent.com/f87caadb70f384c0361ec72ccf07714ef69a5c0a/68747470733a2f2f62616467656e2e6e65742f62616467652f636f64652532307374796c652f74732d7374616e646172642f626c75653f69636f6e3d74797065736372697074"/></a>
   <a href="./LICENSE"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="Licence MIT"/></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="./.github/CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant" /></a>
+  <a href="https://github.com/Thream/Thream/blob/master/.github/CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant" /></a>
 </p>
 
 ## 📜 About
 
 Authenticate socket.io incoming connections with JWTs.
 
-Compatible with `socket.io >= 3.0`.
+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.
 
@@ -34,7 +35,7 @@ npm install --save @thream/socketio-jwt
 
 ```ts
 import { Server } from 'socket.io'
-import socketioJWT from '@thream/socketio-jwt'
+import { authorize } from '@thream/socketio-jwt'
 
 const io = new Server(9000)
 io.use(
@@ -43,23 +44,89 @@ io.use(
   })
 )
 
-io.on('connection', async () => {
+io.on('connection', async (socket) => {
+  // jwt payload of the connected client
+  console.log(socket.decodedToken)
   const clients = await io.sockets.allSockets()
-  for (const clientId of clients) {
+  if (clients != null) {
-    const client = io.sockets.sockets.get(clientId)
+    for (const clientId of clients) {
-    console.log(client.decodedToken) // we can access the jwt payload of each connected client
+      const client = io.sockets.sockets.get(clientId)
+      client?.emit('messages', { message: 'Success!' })
+      // we can access the jwt payload of each connected client
+      console.log(client?.decodedToken)
+    }
   }
 })
 ```
 
+### Server side with `jwks-rsa` (example)
+
+```ts
+import jwksClient from 'jwks-rsa'
+import { Server } from 'socket.io'
+import { authorize } from '@thream/socketio-jwt'
+
+const client = jwksClient({
+  jwksUri: 'https://sandrino.auth0.com/.well-known/jwks.json'
+})
+
+const io = new Server(9000)
+io.use(
+  authorize({
+    secret: async (decodedToken) => {
+      const key = await client.getSigningKeyAsync(decodedToken.header.kid)
+      return key.getPublicKey()
+    }
+  })
+)
+
+io.on('connection', async (socket) => {
+  // jwt payload of the connected client
+  console.log(socket.decodedToken)
+  // You can do the same things of the previous example there...
+})
+```
+
+### Server side with `onAuthentication` (example)
+
+```ts
+import { Server } from 'socket.io'
+import { authorize } from '@thream/socketio-jwt'
+
+const io = new Server(9000)
+io.use(
+  authorize({
+    secret: 'your secret or public key',
+    onAuthentication: async decodedToken => {
+      // return the object that you want to add to the user property
+      // or throw an error if the token is unauthorized
+    }
+  })
+)
+
+io.on('connection', async (socket) => {
+  // jwt payload of the connected client
+  console.log(socket.decodedToken)
+  // You can do the same things of the previous example there...
+  // user object returned in onAuthentication
+  console.log(socket.user)
+})
+```
+
+### `authorize` options
+
+- `secret` is a string containing the secret for HMAC algorithms, or a function that should fetch the secret or public key as shown in the example with `jwks-rsa`.
+- `algorithms` (default: `HS256`)
+- `onAuthentication` is a function that will be called with the `decodedToken` as a parameter after the token is authenticated. Return a value to add to the `user` property in the socket object.
+
 ### Client side
 
 ```ts
 import { io } from 'socket.io-client'
 
-// Require Bearer Tokens to be passed in as an Authorization Header
+// Require Bearer Token
 const socket = io('http://localhost:9000', {
-  extraHeaders: { Authorization: `Bearer ${yourJWT}` }
+  auth: { token: `Bearer ${yourJWT}` }
 })
 
 // Handling token expiration
@@ -79,7 +146,7 @@ socket.on('messages', (data) => {
 
 Anyone can help to improve the project, submit a Feature Request, a bug report or even correct a simple spelling mistake.
 
-The steps to contribute can be found in the [CONTRIBUTING.md](./.github/CONTRIBUTING.md) file.
+The steps to contribute can be found in the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
 
 ## 📄 License
 

commitlint.config.js

@@ -1 +0,0 @@
-module.exports = { extends: ['@commitlint/config-conventional'] }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thream/socketio-jwt",
-  "version": "1.0.0",
+  "version": "2.1.0",
   "description": "Authenticate socket.io incoming connections with JWTs.",
   "license": "MIT",
   "main": "build/index.js",
@@ -25,15 +25,11 @@
     "url": "https://github.com/Thream/socketio-jwt/issues"
   },
   "homepage": "https://github.com/Thream/socketio-jwt#readme",
-  "husky": {
-    "hooks": {
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
-      "pre-commit": "npm run lint"
-    }
-  },
   "release-it": {
     "git": {
-      "commitMessage": "chore(release): v${version}"
+      "commit": false,
+      "push": false,
+      "tag": false
     },
     "github": {
       "release": false
@@ -44,6 +40,8 @@
     "hooks": {
       "before:init": [
         "npm run lint",
+        "npm run markdownlint",
+        "npm run build",
         "npm run test"
       ]
     },
@@ -62,50 +60,55 @@
     "coverageDirectory": "../coverage/"
   },
   "ts-standard": {
-    "files": [
+    "ignore": [
-      "./src/**/*.ts"
+      "build",
+      "coverage",
+      "node_modules"
     ],
     "envs": [
       "node",
       "jest"
-    ]
+    ],
+    "report": "stylish"
   },
   "scripts": {
     "build": "rimraf ./build && tsc",
-    "lint": "exit 0",
+    "markdownlint": "markdownlint '**/*.md' --dot --ignore node_modules",
-    "format": "ts-standard --fix | snazzy",
+    "lint": "ts-standard",
     "release": "release-it",
     "test": "jest",
-    "test:watchAll": "jest --watchAll",
+    "postinstall": "husky install",
-    "test:clearCache": "jest --clearCache"
+    "prepublishOnly": "pinst --disable",
+    "postpublish": "pinst --enable"
   },
   "peerDependencies": {
-    "socket.io": "*"
+    "socket.io": ">=3.0.0"
   },
   "dependencies": {
     "jsonwebtoken": "8.5.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "11.0.0",
+    "@commitlint/cli": "12.0.1",
-    "@commitlint/config-conventional": "11.0.0",
+    "@commitlint/config-conventional": "12.0.1",
-    "@release-it/conventional-changelog": "2.0.0",
+    "@release-it/conventional-changelog": "2.0.1",
-    "@types/express": "4.17.9",
+    "@types/express": "4.17.11",
-    "@types/jest": "26.0.19",
+    "@types/jest": "26.0.20",
     "@types/jsonwebtoken": "8.5.0",
-    "@types/node": "14.14.16",
+    "@types/node": "14.14.32",
     "@types/server-destroy": "1.0.1",
     "axios": "0.21.1",
     "express": "4.17.1",
-    "husky": "4.3.6",
+    "husky": "5.1.3",
     "jest": "26.6.3",
-    "release-it": "14.2.2",
+    "markdownlint-cli": "0.27.1",
+    "pinst": "2.1.6",
+    "release-it": "14.4.1",
     "rimraf": "3.0.2",
     "server-destroy": "1.0.1",
-    "snazzy": "9.0.0",
+    "socket.io": "3.1.2",
-    "socket.io": "3.0.4",
+    "socket.io-client": "3.1.2",
-    "socket.io-client": "3.0.4",
+    "ts-jest": "26.5.3",
-    "ts-jest": "26.4.4",
     "ts-standard": "10.0.0",
-    "typescript": "4.1.3"
+    "typescript": "4.2.3"
   }
 }

src/__test__/authorize.test.ts

@@ -1,14 +1,14 @@
 import axios from 'axios'
 import { io } from 'socket.io-client'
 
-import { fixtureStart, fixtureStop } from './fixture'
+import { fixtureStart, fixtureStop, getSocket, Profile } from './fixture'
 
-describe('authorize', () => {
+describe('authorize - with secret as string in options', () => {
   let token: string = ''
 
-  beforeEach((done) => {
+  beforeEach(async (done) => {
     jest.setTimeout(15_000)
-    fixtureStart(async () => {
+    await fixtureStart(async () => {
       const response = await axios.post('http://localhost:9000/login')
       token = response.data.token
       done()
@@ -31,7 +31,7 @@ describe('authorize', () => {
 
   it('should emit error with bad token format', (done) => {
     const socket = io('http://localhost:9000', {
-      extraHeaders: { Authorization: 'testing' }
+      auth: { token: 'testing' }
     })
     socket.on('connect_error', (err: any) => {
       expect(err.data.message).toEqual(
@@ -45,7 +45,7 @@ describe('authorize', () => {
 
   it('should emit error with unauthorized handshake', (done) => {
     const socket = io('http://localhost:9000', {
-      extraHeaders: { Authorization: 'Bearer testing' }
+      auth: { token: 'Bearer testing' }
     })
     socket.on('connect_error', (err: any) => {
       expect(err.data.message).toEqual(
@@ -59,7 +59,7 @@ describe('authorize', () => {
 
   it('should connect the user', (done) => {
     const socket = io('http://localhost:9000', {
-      extraHeaders: { Authorization: `Bearer ${token}` }
+      auth: { token: `Bearer ${token}` }
     })
     socket.on('connect', () => {
       socket.close()
@@ -67,3 +67,110 @@ describe('authorize', () => {
     })
   })
 })
+
+const secretCallback = async (): Promise<string> => {
+  return 'somesecret'
+}
+
+describe('authorize - with secret as callback in options', () => {
+  let token: string = ''
+
+  beforeEach(async (done) => {
+    jest.setTimeout(15_000)
+    await fixtureStart(
+      async () => {
+        const response = await axios.post('http://localhost:9000/login')
+        token = response.data.token
+        done()
+      },
+      { secret: secretCallback }
+    )
+  })
+
+  afterEach((done) => {
+    fixtureStop(done)
+  })
+
+  it('should connect the user', (done) => {
+    const socket = io('http://localhost:9000', {
+      auth: { token: `Bearer ${token}` }
+    })
+    socket.on('connect', () => {
+      socket.close()
+      done()
+    })
+  })
+})
+
+describe('authorize - with onAuthentication callback in options', () => {
+  let token: string = ''
+  let wrongToken: string = ''
+
+  beforeEach(async (done) => {
+    jest.setTimeout(15_000)
+    await 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
+        done()
+      },
+      {
+        secret: secretCallback,
+        onAuthentication: (decodedToken: Profile) => {
+          if (!decodedToken.checkField) {
+            throw new Error('Check Field validation failed')
+          }
+          return {
+            email: decodedToken.email
+          }
+        }
+      }
+    )
+  })
+
+  afterEach((done) => {
+    fixtureStop(done)
+  })
+
+  it('should connect the user', (done) => {
+    const socket = io('http://localhost:9000', {
+      auth: { token: `Bearer ${token}` }
+    })
+    socket.on('connect', () => {
+      socket.close()
+      done()
+    })
+  })
+
+  it('should contain user property', (done) => {
+    const socketServer = getSocket()
+    socketServer?.on('connection', (client: any) => {
+      expect(client.user.email).toEqual('john@doe.com')
+    })
+    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) => {
+    const socket = io('http://localhost:9000', {
+      auth: { token: `Bearer ${wrongToken}` }
+    })
+    socket.on('connect_error', (err: any) => {
+      try {
+        expect(err.message).toEqual('Check Field validation failed')
+      } catch (err) {
+        socket.close()
+        done(err)
+      }
+      socket.close()
+      done()
+    })
+  })
+})

src/__test__/fixture/index.ts

@@ -5,7 +5,13 @@ import { Server as HttpsServer } from 'https'
 import { Server as SocketIoServer } from 'socket.io'
 import enableDestroy from 'server-destroy'
 
-import { authorize } from '../../index'
+import { authorize, AuthorizeOptions } from '../../index'
+
+export interface Profile {
+  email: string
+  id: number
+  checkField: boolean
+}
 
 interface Socket {
   io: null | SocketIoServer
@@ -21,16 +27,38 @@ const socket: Socket = {
 
 let server: HttpServer | null = null
 
-export const fixtureStart = (done: any): void => {
+export const fixtureStart = async (
-  const options = { secret: 'aaafoo super sercret' }
+  done: any,
+  options: AuthorizeOptions = { secret: 'aaafoo super sercret' }
+): Promise<void> => {
   const app = express()
   app.use(express.json())
+  let keySecret = 'secret'
+  if (typeof options.secret === 'string') {
+    keySecret = options.secret
+  } else {
+    keySecret = await options.secret({ header: { alg: 'RS256' }, payload: '' })
+  }
   app.post('/login', (_req, res) => {
-    const profile = {
+    const profile: Profile = {
       email: 'john@doe.com',
-      id: 123
+      id: 123,
+      checkField: true
     }
-    const token = jwt.sign(profile, options.secret, { expiresIn: 60 * 60 * 5 })
+    const token = jwt.sign(profile, keySecret, {
+      expiresIn: 60 * 60 * 5
+    })
+    return res.json({ token })
+  })
+  app.post('/login-wrong', (_req, res) => {
+    const profile: Profile = {
+      email: 'john@doe.com',
+      id: 123,
+      checkField: false
+    }
+    const token = jwt.sign(profile, keySecret, {
+      expiresIn: 60 * 60 * 5
+    })
     return res.json({ token })
   })
   server = app.listen(9000, done)
@@ -46,3 +74,7 @@ export const fixtureStop = (callback: Function): void => {
   } catch (err) {}
   callback()
 }
+
+export const getSocket = (): SocketIoServer | null => {
+  return socket.io
+}

src/authorize.ts

@@ -1,28 +1,50 @@
-import jwt from 'jsonwebtoken'
+import jwt, { Algorithm } from 'jsonwebtoken'
 import { Socket } from 'socket.io'
 
 import { UnauthorizedError } from './UnauthorizedError'
 
+declare module 'socket.io' {
+  interface Socket extends ExtendedSocket {}
+}
+
 interface ExtendedError extends Error {
   data?: any
 }
 
+interface ExtendedSocket {
+  encodedToken?: string
+  decodedToken?: any
+  user?: any
+}
+
 type SocketIOMiddleware = (
   socket: Socket,
   next: (err?: ExtendedError) => void
 ) => void
 
-interface AuthorizeOptions {
+interface CompleteDecodedToken {
-  secret: string
+  header: {
+    alg: Algorithm
+    [key: string]: any
+  }
+  payload: any
+}
+
+type SecretCallback = (decodedToken: CompleteDecodedToken) => Promise<string>
+
+export interface AuthorizeOptions {
+  secret: string | SecretCallback
+  algorithms?: Algorithm[]
+  onAuthentication?: (decodedToken: any) => Promise<any> | any
 }
 
 export const authorize = (options: AuthorizeOptions): SocketIOMiddleware => {
-  const { secret } = options
+  const { secret, algorithms = ['HS256'], onAuthentication } = options
-  return (socket, next) => {
+  return async (socket, next) => {
-    let token: string | null = null
+    let encodedToken: string | null = null
-    const authorizationHeader = socket.request.headers.authorization
+    const { token } = socket.handshake.auth
-    if (authorizationHeader != null) {
+    if (token != null) {
-      const tokenSplitted = authorizationHeader.split(' ')
+      const tokenSplitted = token.split(' ')
       if (tokenSplitted.length !== 2 || tokenSplitted[0] !== 'Bearer') {
         return next(
           new UnauthorizedError('credentials_bad_format', {
@@ -30,20 +52,26 @@ export const authorize = (options: AuthorizeOptions): SocketIOMiddleware => {
           })
         )
       }
-      token = tokenSplitted[1]
+      encodedToken = tokenSplitted[1]
     }
-    if (token == null) {
+    if (encodedToken == null) {
       return next(
         new UnauthorizedError('credentials_required', {
           message: 'no token provided'
         })
       )
     }
-    // Store encoded JWT
+    socket.encodedToken = encodedToken
-    socket = Object.assign(socket, { encodedToken: token })
+    let keySecret: string | null = null
-    let payload: any
+    let decodedToken: any
+    if (typeof secret === 'string') {
+      keySecret = secret
+    } else {
+      const completeDecodedToken = jwt.decode(encodedToken, { complete: true })
+      keySecret = await secret(completeDecodedToken as CompleteDecodedToken)
+    }
     try {
-      payload = jwt.verify(token, secret)
+      decodedToken = jwt.verify(encodedToken, keySecret, { algorithms })
     } catch {
       return next(
         new UnauthorizedError('invalid_token', {
@@ -51,8 +79,14 @@ export const authorize = (options: AuthorizeOptions): SocketIOMiddleware => {
         })
       )
     }
-    // Store decoded JWT
+    socket.decodedToken = decodedToken
-    socket = Object.assign(socket, { decodedToken: payload })
+    if (onAuthentication != null) {
+      try {
+        socket.user = await onAuthentication(decodedToken)
+      } catch (err) {
+        return next(err)
+      }
+    }
     return next()
   }
 }