2
1
mirror of https://github.com/Thream/socketio-jwt.git synced 2024-07-21 09:38:31 +02:00
socketio-jwt/README.md

122 lines
4.0 KiB
Markdown
Raw Normal View History

2021-01-07 05:45:46 +01:00
<h1 align="center">Thream/socketio-jwt</h1>
2019-07-23 15:22:23 +02:00
<p align="center">
<strong>Authenticate socket.io incoming connections with JWTs.</strong>
</p>
2015-05-29 14:42:14 +02:00
<p align="center">
<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>
2020-12-29 04:44:15 +01:00
<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>
2020-12-29 12:28:53 +01:00
<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>
2021-01-02 18:35:26 +01:00
<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>
2019-07-16 11:33:44 +02:00
## 📜 About
2019-07-16 11:33:44 +02:00
Authenticate socket.io incoming connections with JWTs.
2012-09-05 20:14:36 +02:00
2021-01-07 14:30:37 +01:00
Compatible with `socket.io >= 3.0.0`.
2020-12-29 04:30:34 +01:00
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.
2019-01-15 17:43:44 +01:00
2020-12-29 04:30:34 +01:00
## 💾 Install
2019-01-15 17:43:44 +01:00
```sh
2020-12-29 04:30:34 +01:00
npm install --save @thream/socketio-jwt
2012-09-05 20:14:36 +02:00
```
## ⚙️ Usage
2012-09-05 20:14:36 +02:00
2020-12-29 04:30:34 +01:00
### Server side
2020-12-29 04:30:34 +01:00
```ts
import { Server } from 'socket.io'
import { authorize } from '@thream/socketio-jwt'
2020-12-29 04:30:34 +01:00
const io = new Server(9000)
2020-12-27 17:25:44 +01:00
io.use(
2020-12-29 04:30:34 +01:00
authorize({
secret: 'your secret or public key'
2020-12-27 17:25:44 +01:00
})
)
io.on('connection', async (socket) => {
// jwt payload of the connected client
console.log(socket.decodedToken)
2020-12-29 04:30:34 +01:00
const clients = await io.sockets.allSockets()
if (clients != null) {
for (const clientId of clients) {
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)
}
}
2020-12-27 17:25:44 +01:00
})
```
2021-01-07 14:30:37 +01:00
### 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.rsaPublicKey
}
})
)
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...
})
```
2020-12-29 04:30:34 +01:00
### Client side
2020-12-29 04:30:34 +01:00
```ts
import { io } from 'socket.io-client'
2020-12-29 04:30:34 +01:00
// Require Bearer Tokens to be passed in as an Authorization Header
const socket = io('http://localhost:9000', {
extraHeaders: { Authorization: `Bearer ${yourJWT}` }
2020-12-27 17:25:44 +01:00
})
2020-12-29 04:30:34 +01:00
// Handling token expiration
socket.on('connect_error', (error) => {
if (error.data.type === 'UnauthorizedError') {
2020-12-27 17:25:44 +01:00
console.log('User token has expired')
}
2020-12-27 17:25:44 +01:00
})
2020-12-29 04:30:34 +01:00
// Listening to events
socket.on('messages', (data) => {
console.log(data)
2020-12-27 17:25:44 +01:00
})
```
## 💡 Contributing
2020-12-27 17:25:44 +01:00
Anyone can help to improve the project, submit a Feature Request, a bug report or even correct a simple spelling mistake.
2020-12-27 17:25:44 +01:00
The steps to contribute can be found in the [CONTRIBUTING.md](./.github/CONTRIBUTING.md) file.
2019-01-15 17:43:44 +01:00
## 📄 License
2019-01-15 17:43:44 +01:00
[MIT](./LICENSE)