Compare commits
242 Commits
Author | SHA1 | Date | |
---|---|---|---|
098475d64c | |||
056c7b4807 | |||
25c74045a9 | |||
f68daca38b | |||
f78f58cd4b | |||
7eb3634286 | |||
853aa301de | |||
1d853e2457 | |||
585e488471 | |||
1088803ee2 | |||
280d9eb485 | |||
033a8be43e | |||
8d2ff1b7c3 | |||
91c9820846 | |||
8b94866469 | |||
911a5f20db | |||
56d3420c71 | |||
025f8d9c3d | |||
844cd7d138 | |||
6d9d36dea5 | |||
54bcaab4ea | |||
87a2542abc | |||
c944d36e06 | |||
c6d6ef997e | |||
5f85941f43 | |||
d5447a5f29 | |||
1f50d858e5 | |||
5949d0e4e0 | |||
4ac3dfd37f | |||
8c6bd1fe7d | |||
8165c13a64 | |||
54f11e3736 | |||
f715eb2356 | |||
ee97a6decb | |||
c92e84b81e | |||
a470151958 | |||
7b8dc0c03f | |||
112be97015 | |||
6f2f301562 | |||
a78c770a52 | |||
24489d5e55 | |||
64ef87b2a2 | |||
1b9c39bd82 | |||
df4522c0c7 | |||
1b079565bc | |||
bcced4001a | |||
b0ab7a1ef3 | |||
b24597ddc7 | |||
4035af075f | |||
0cee31c8aa | |||
3d52581092 | |||
74de828af7 | |||
9a525578e1 | |||
b537a4c594 | |||
c2229809f4 | |||
8042db1eb3 | |||
af3ae33e24 | |||
21dd8971ad | |||
020220210b | |||
8295acaba3 | |||
cfc166cd48 | |||
c0b7d2128f | |||
f594c17097 | |||
577aadb022 | |||
6b79e86277 | |||
257f967ba6 | |||
5c3d12a201 | |||
bea0548d7d | |||
30bbbd8f59 | |||
ece3c53fbf | |||
094b1cd257 | |||
520df540b5 | |||
162ca4401d | |||
f88772710d | |||
2f696bca36 | |||
336cc8d6a6 | |||
b48136818e | |||
4de72a1b3d | |||
d6785b99d2 | |||
8b1fcf51fc | |||
e9e69ea210 | |||
6996f3aef1 | |||
2769000be6 | |||
b87cab898f | |||
3b644a4682 | |||
33c6027c01 | |||
a747280e1d | |||
44e60d10b0 | |||
927d5dc5c1 | |||
22a35720ff | |||
c461a15566 | |||
74cddbce37 | |||
075d67b7aa | |||
2e2ad556d8 | |||
596d6a82c9 | |||
5a7d281798 | |||
6fb3dfef40 | |||
37824f15e0 | |||
f2f064e03a | |||
1ea767e551 | |||
09c4fe89be | |||
986f7b8cdb | |||
6fd7dc60d7 | |||
4408e6e18c | |||
fdc7ee7f06 | |||
9d5981f403 | |||
1409c25824 | |||
c82aa67e4e | |||
2dddbe3d94 | |||
6d02644d60 | |||
3908f1e6c4 | |||
5cee6e17cd | |||
9eedd5afbd | |||
dff86f7bda | |||
a41881744a | |||
15f5c60b27 | |||
56fb31edf6 | |||
c08c431e6a | |||
4ae9f519c5 | |||
e4dcdf9928 | |||
f08a6e4f62 | |||
18df1dd19f | |||
86cac11108 | |||
170ad34da3 | |||
b5460b95ee | |||
b1ab84e610 | |||
b56248919e | |||
464381813f | |||
6dc3696910 | |||
e500fd3862 | |||
30aea8120a | |||
87d3af481e | |||
8867b9914e | |||
8ae78c6732 | |||
def5b56184 | |||
983d18ee09 | |||
16f632d1b4 | |||
65bc3314cc | |||
d6bd5e5cd7 | |||
96a41659bd | |||
e5fca7e5ee | |||
da40d6b1fd | |||
219094da40 | |||
6361bd8782 | |||
59efee7c37 | |||
07c96e876b | |||
ae08cc6e65 | |||
3bae2e2bbf | |||
47e69050e5 | |||
9851fb319d | |||
73fc64b9e5 | |||
e300799e99 | |||
f6755c7d12 | |||
5e16b06575 | |||
a5468fdfae | |||
4b86c778bf | |||
a14e6e5ab1 | |||
927f021941 | |||
344f71ced1 | |||
3ce4b14d03 | |||
d11cbc3ffb | |||
31ba9b48b5 | |||
88eba43f83 | |||
9330edd3bc | |||
2412e2e5fc | |||
7cfab50330 | |||
644e3a52b7 | |||
1f912feda1 | |||
6dcb8cbd49 | |||
a93271bcec | |||
68e02a6ad5 | |||
efb2b72572 | |||
4c869ba0ea | |||
79c88b928b | |||
f0f58630d9 | |||
cf81ca58fc | |||
1255f7545e | |||
8570861d16 | |||
f90cddc4a4 | |||
f260bc793b | |||
089ca1b67e | |||
6696d1fa0a | |||
d4d4adac31 | |||
c8723a736e | |||
38a5036623 | |||
f1866e290d | |||
47d74534ea | |||
0d0109be52 | |||
85953cdcce | |||
da2be10ed4 | |||
1bb3e0174f | |||
a20ead358c | |||
215593c6d6 | |||
7380635760 | |||
7f7dda651b | |||
2512c046d2 | |||
88bfd46c33 | |||
4b95cd4293 | |||
c7f64a6312 | |||
89518a45d5 | |||
a5da945bb5 | |||
ce798241e5 | |||
8dfddbd5b4 | |||
e353d2a1fe | |||
5a02e25f86 | |||
f9678604cc | |||
c5121fb008 | |||
95e461540a | |||
7687ddfe83 | |||
565f83db9d | |||
6953d6952b | |||
3d109f362f | |||
ced2f5db1e | |||
0971dcc1bb | |||
a710630ccf | |||
e50e7ea00e | |||
cff7892c3d | |||
17232c18e1 | |||
8f896eb93b | |||
814fc781e3 | |||
4291da1417 | |||
ad86800d8c | |||
a14d4e937b | |||
4ba3e3bccb | |||
907b82fca9 | |||
4c469169f4 | |||
d5f402df86 | |||
d01bcc29fa | |||
55a5f71b6e | |||
7ccdb8f9a0 | |||
b61ddd1872 | |||
ac3b5177e5 | |||
0e8630d145 | |||
bb1daa2e28 | |||
17d7f264a4 | |||
7f1c25ed98 | |||
d9fa92cb1c | |||
b08354f2b2 | |||
06141ec89d | |||
113df6f8f7 | |||
a761725e6b | |||
f5a13c01b0 |
1
.commitlintrc.json
Normal file
1
.commitlintrc.json
Normal file
@ -0,0 +1 @@
|
|||||||
|
{ "extends": ["@commitlint/config-conventional"] }
|
23
.eslintrc.json
Normal file
23
.eslintrc.json
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
{
|
||||||
|
"extends": ["standard-with-typescript", "prettier"],
|
||||||
|
"plugins": ["unicorn", "import", "prettier"],
|
||||||
|
"parserOptions": {
|
||||||
|
"project": "./tsconfig.json"
|
||||||
|
},
|
||||||
|
"env": {
|
||||||
|
"node": true,
|
||||||
|
"jest": true
|
||||||
|
},
|
||||||
|
"rules": {
|
||||||
|
"prettier/prettier": "error",
|
||||||
|
"import/order": [
|
||||||
|
"error",
|
||||||
|
{
|
||||||
|
"groups": ["builtin", "external", "internal"],
|
||||||
|
"newlines-between": "always"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"import/extensions": ["error", "always"],
|
||||||
|
"unicorn/prefer-node-protocol": "error"
|
||||||
|
}
|
||||||
|
}
|
1
.gitattributes
vendored
Normal file
1
.gitattributes
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
* text=auto eol=lf
|
1
.github/ISSUE_TEMPLATE/BUG.md
vendored
1
.github/ISSUE_TEMPLATE/BUG.md
vendored
@ -1,6 +1,7 @@
|
|||||||
---
|
---
|
||||||
name: '🐛 Bug Report'
|
name: '🐛 Bug Report'
|
||||||
about: 'Report an unexpected problem or unintended behavior.'
|
about: 'Report an unexpected problem or unintended behavior.'
|
||||||
|
title: '[Bug]'
|
||||||
labels: 'bug'
|
labels: 'bug'
|
||||||
---
|
---
|
||||||
|
|
||||||
|
18
.github/ISSUE_TEMPLATE/DOCUMENTATION.md
vendored
18
.github/ISSUE_TEMPLATE/DOCUMENTATION.md
vendored
@ -1,20 +1,18 @@
|
|||||||
---
|
---
|
||||||
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]'
|
||||||
labels: '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
|
||||||
|
7
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
vendored
7
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
vendored
@ -1,19 +1,20 @@
|
|||||||
---
|
---
|
||||||
name: '✨ Feature Request'
|
name: '✨ Feature Request'
|
||||||
about: 'Suggest a new feature idea.'
|
about: 'Suggest a new feature idea.'
|
||||||
|
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. -->
|
||||||
|
|
||||||
### Description
|
## Description
|
||||||
|
|
||||||
<!-- A clear and concise description of the problem or missing capability... -->
|
<!-- 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. -->
|
<!-- 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? -->
|
<!-- Have you considered any alternative solutions or workarounds? -->
|
||||||
|
21
.github/ISSUE_TEMPLATE/IMPROVEMENT.md
vendored
21
.github/ISSUE_TEMPLATE/IMPROVEMENT.md
vendored
@ -1,21 +1,20 @@
|
|||||||
---
|
---
|
||||||
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]'
|
||||||
labels: '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
|
||||||
|
1
.github/ISSUE_TEMPLATE/QUESTION.md
vendored
1
.github/ISSUE_TEMPLATE/QUESTION.md
vendored
@ -1,6 +1,7 @@
|
|||||||
---
|
---
|
||||||
name: '🙋 Question'
|
name: '🙋 Question'
|
||||||
about: 'Further information is requested.'
|
about: 'Further information is requested.'
|
||||||
|
title: '[Question]'
|
||||||
labels: 'question'
|
labels: 'question'
|
||||||
---
|
---
|
||||||
|
|
||||||
|
28
.github/PULL_REQUEST_TEMPLATE.md
vendored
28
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,27 +1,7 @@
|
|||||||
<!--
|
<!-- 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?
|
||||||
|
|
||||||
Before submitting your contribution, please take a moment to review this document:
|
## List any relevant issue numbers
|
||||||
https://github.com/Thream/socketio-jwt/blob/master/.github/CONTRIBUTING.md
|
|
||||||
|
|
||||||
Please place an x (no spaces - [x]) in all [ ] that apply.
|
## Is there anything you'd like reviewers to focus on?
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
### What type of change does this PR introduce?
|
|
||||||
|
|
||||||
- [ ] Bugfix
|
|
||||||
- [ ] Feature
|
|
||||||
- [ ] Refactor
|
|
||||||
- [ ] Documentation
|
|
||||||
- [ ] Not Sure?
|
|
||||||
|
|
||||||
### Does this PR introduce breaking changes?
|
|
||||||
|
|
||||||
- [ ] Yes
|
|
||||||
- [ ] No
|
|
||||||
|
|
||||||
### List any relevant issue numbers:
|
|
||||||
|
|
||||||
### Description:
|
|
||||||
|
13
.github/dependabot.yml
vendored
13
.github/dependabot.yml
vendored
@ -1,13 +0,0 @@
|
|||||||
# For more information see: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates
|
|
||||||
|
|
||||||
version: 2
|
|
||||||
updates:
|
|
||||||
- package-ecosystem: 'github-actions'
|
|
||||||
directory: '/'
|
|
||||||
schedule:
|
|
||||||
interval: 'daily'
|
|
||||||
|
|
||||||
- package-ecosystem: 'npm'
|
|
||||||
directory: '/'
|
|
||||||
schedule:
|
|
||||||
interval: 'daily'
|
|
25
.github/workflows/build.yml
vendored
Normal file
25
.github/workflows/build.yml
vendored
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
name: 'Build'
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [master, develop]
|
||||||
|
pull_request:
|
||||||
|
branches: [master, develop]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: 'ubuntu-latest'
|
||||||
|
steps:
|
||||||
|
- uses: 'actions/checkout@v2'
|
||||||
|
|
||||||
|
- name: 'Use Node.js'
|
||||||
|
uses: 'actions/setup-node@v2.5.1'
|
||||||
|
with:
|
||||||
|
node-version: 'lts/*'
|
||||||
|
cache: 'npm'
|
||||||
|
|
||||||
|
- name: 'Install'
|
||||||
|
run: 'npm install'
|
||||||
|
|
||||||
|
- name: 'Build Package'
|
||||||
|
run: 'npm run build'
|
20
.github/workflows/commitlint.yml
vendored
20
.github/workflows/commitlint.yml
vendored
@ -1,20 +0,0 @@
|
|||||||
# For more information see: https://github.com/marketplace/actions/commit-linter
|
|
||||||
|
|
||||||
name: 'Lint Commit Messages'
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [master, develop]
|
|
||||||
pull_request_review:
|
|
||||||
branches: [master, develop]
|
|
||||||
types: [submitted]
|
|
||||||
|
|
||||||
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
|
|
||||||
steps:
|
|
||||||
- uses: 'actions/checkout@v2'
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
- uses: 'wagoid/commitlint-github-action@v2'
|
|
28
.github/workflows/lint.yml
vendored
Normal file
28
.github/workflows/lint.yml
vendored
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
name: 'Lint'
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [master, develop]
|
||||||
|
pull_request:
|
||||||
|
branches: [master, develop]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
lint:
|
||||||
|
runs-on: 'ubuntu-latest'
|
||||||
|
steps:
|
||||||
|
- uses: 'actions/checkout@v2'
|
||||||
|
|
||||||
|
- name: 'Use Node.js'
|
||||||
|
uses: 'actions/setup-node@v2.5.1'
|
||||||
|
with:
|
||||||
|
node-version: 'lts/*'
|
||||||
|
cache: 'npm'
|
||||||
|
|
||||||
|
- name: 'Install'
|
||||||
|
run: 'npm install'
|
||||||
|
|
||||||
|
- run: 'npm run lint:commit -- --to "${{ github.sha }}"'
|
||||||
|
- run: 'npm run lint:editorconfig'
|
||||||
|
- run: 'npm run lint:markdown'
|
||||||
|
- run: 'npm run lint:typescript'
|
||||||
|
- run: 'npm run lint:prettier'
|
47
.github/workflows/nodejs.yml
vendored
47
.github/workflows/nodejs.yml
vendored
@ -1,47 +0,0 @@
|
|||||||
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
|
|
||||||
|
|
||||||
name: 'Node.js CI'
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [master, develop]
|
|
||||||
pull_request_review:
|
|
||||||
branches: [master, develop]
|
|
||||||
types: [submitted]
|
|
||||||
|
|
||||||
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
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
node-version: [14.x]
|
|
||||||
steps:
|
|
||||||
- uses: 'actions/checkout@v2'
|
|
||||||
|
|
||||||
- name: Use Node.js ${{ matrix.node-version }}
|
|
||||||
uses: 'actions/setup-node@v2.1.4'
|
|
||||||
with:
|
|
||||||
node-version: ${{ matrix.node-version }}
|
|
||||||
|
|
||||||
- name: 'Cache dependencies'
|
|
||||||
uses: 'actions/cache@v2'
|
|
||||||
with:
|
|
||||||
path: |
|
|
||||||
**/node_modules
|
|
||||||
key: ${{ runner.os }}-${{ hashFiles('**/package.json') }}
|
|
||||||
|
|
||||||
- name: 'Install dependencies'
|
|
||||||
run: 'npm install'
|
|
||||||
|
|
||||||
- name: 'Lint'
|
|
||||||
run: 'npm run lint'
|
|
||||||
|
|
||||||
- name: 'Build'
|
|
||||||
run: 'npm run build'
|
|
||||||
|
|
||||||
- name: 'Run the tests and generate coverage report'
|
|
||||||
run: 'npm test'
|
|
||||||
|
|
||||||
- name: 'Upload coverage to Codecov'
|
|
||||||
uses: 'codecov/codecov-action@v1'
|
|
30
.github/workflows/npm-publish.yml
vendored
30
.github/workflows/npm-publish.yml
vendored
@ -1,30 +0,0 @@
|
|||||||
# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
|
|
||||||
|
|
||||||
name: 'Node.js Package'
|
|
||||||
|
|
||||||
on:
|
|
||||||
release:
|
|
||||||
types: [created]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
publish-npm:
|
|
||||||
runs-on: 'ubuntu-latest'
|
|
||||||
steps:
|
|
||||||
- uses: 'actions/checkout@v2'
|
|
||||||
|
|
||||||
- name: 'Cache dependencies'
|
|
||||||
uses: 'actions/cache@v2'
|
|
||||||
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'
|
|
||||||
- run: 'npm run build'
|
|
||||||
- run: 'npm publish --access public'
|
|
||||||
env:
|
|
||||||
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
|
|
29
.github/workflows/release.yml
vendored
Normal file
29
.github/workflows/release.yml
vendored
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
name: 'Release'
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [master]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
runs-on: 'ubuntu-latest'
|
||||||
|
steps:
|
||||||
|
- uses: 'actions/checkout@v2'
|
||||||
|
|
||||||
|
- name: 'Use Node.js'
|
||||||
|
uses: 'actions/setup-node@v2.5.1'
|
||||||
|
with:
|
||||||
|
node-version: 'lts/*'
|
||||||
|
cache: 'npm'
|
||||||
|
|
||||||
|
- name: 'Install'
|
||||||
|
run: 'npm install'
|
||||||
|
|
||||||
|
- name: 'Build Package'
|
||||||
|
run: 'npm run build'
|
||||||
|
|
||||||
|
- name: 'Release'
|
||||||
|
run: 'npm run release'
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
28
.github/workflows/test.yml
vendored
Normal file
28
.github/workflows/test.yml
vendored
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
name: 'Test'
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [master, develop]
|
||||||
|
pull_request:
|
||||||
|
branches: [master, develop]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: 'ubuntu-latest'
|
||||||
|
steps:
|
||||||
|
- uses: 'actions/checkout@v2'
|
||||||
|
|
||||||
|
- name: 'Use Node.js'
|
||||||
|
uses: 'actions/setup-node@v2.5.1'
|
||||||
|
with:
|
||||||
|
node-version: 'lts/*'
|
||||||
|
cache: 'npm'
|
||||||
|
|
||||||
|
- name: 'Install'
|
||||||
|
run: 'npm install'
|
||||||
|
|
||||||
|
- name: 'Test'
|
||||||
|
run: 'npm run test'
|
||||||
|
|
||||||
|
- name: 'Upload Coverage'
|
||||||
|
uses: 'codecov/codecov-action@v2.1.0'
|
33
.gitignore
vendored
33
.gitignore
vendored
@ -2,34 +2,33 @@
|
|||||||
|
|
||||||
# dependencies
|
# dependencies
|
||||||
node_modules
|
node_modules
|
||||||
.pnp
|
.npm
|
||||||
.pnp.js
|
|
||||||
.yarn
|
|
||||||
|
|
||||||
# production
|
# production
|
||||||
build
|
build
|
||||||
|
.swc
|
||||||
|
|
||||||
# testing
|
# testing
|
||||||
coverage
|
coverage
|
||||||
|
|
||||||
# envs
|
|
||||||
.env
|
|
||||||
.env.production
|
|
||||||
|
|
||||||
# debug
|
# debug
|
||||||
npm-debug.log*
|
npm-debug.log*
|
||||||
yarn-debug.log*
|
|
||||||
yarn-error.log*
|
|
||||||
|
|
||||||
# lockfiles
|
# IDEs and editors
|
||||||
package-lock.json
|
/.idea
|
||||||
yarn.lock
|
.project
|
||||||
pnpm-lock.yaml
|
.classpath
|
||||||
|
.c9/
|
||||||
|
*.launch
|
||||||
|
.settings/
|
||||||
|
*.sublime-workspace
|
||||||
|
|
||||||
# editors
|
# IDE - VSCode
|
||||||
.vscode
|
.vscode/*
|
||||||
.theia
|
!.vscode/settings.json
|
||||||
.idea
|
!.vscode/tasks.json
|
||||||
|
!.vscode/launch.json
|
||||||
|
!.vscode/extensions.json
|
||||||
|
|
||||||
# misc
|
# misc
|
||||||
.DS_Store
|
.DS_Store
|
||||||
|
4
.husky/commit-msg
Executable file
4
.husky/commit-msg
Executable file
@ -0,0 +1,4 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
. "$(dirname "$0")/_/husky.sh"
|
||||||
|
|
||||||
|
npm run lint:commit -- --edit
|
5
.husky/pre-commit
Executable file
5
.husky/pre-commit
Executable file
@ -0,0 +1,5 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
. "$(dirname "$0")/_/husky.sh"
|
||||||
|
|
||||||
|
npm run lint:staged
|
||||||
|
npm run build
|
10
.lintstagedrc.json
Normal file
10
.lintstagedrc.json
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"*": ["editorconfig-checker"],
|
||||||
|
"*.{js,jsx,ts,tsx}": [
|
||||||
|
"prettier --write",
|
||||||
|
"eslint --fix",
|
||||||
|
"jest --findRelatedTests"
|
||||||
|
],
|
||||||
|
"*.{json,jsonc,yml,yaml}": ["prettier --write"],
|
||||||
|
"*.{md}": ["prettier --write", "markdownlint --dot --fix"]
|
||||||
|
}
|
7
.markdownlint.json
Normal file
7
.markdownlint.json
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
{
|
||||||
|
"default": true,
|
||||||
|
"MD013": false,
|
||||||
|
"MD024": false,
|
||||||
|
"MD033": false,
|
||||||
|
"MD041": false
|
||||||
|
}
|
6
.prettierrc.json
Normal file
6
.prettierrc.json
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
{
|
||||||
|
"singleQuote": true,
|
||||||
|
"jsxSingleQuote": true,
|
||||||
|
"semi": false,
|
||||||
|
"trailingComma": "none"
|
||||||
|
}
|
19
.releaserc.json
Normal file
19
.releaserc.json
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
{
|
||||||
|
"branches": ["master"],
|
||||||
|
"plugins": [
|
||||||
|
[
|
||||||
|
"@semantic-release/commit-analyzer",
|
||||||
|
{
|
||||||
|
"preset": "conventionalcommits"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
[
|
||||||
|
"@semantic-release/release-notes-generator",
|
||||||
|
{
|
||||||
|
"preset": "conventionalcommits"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"@semantic-release/npm",
|
||||||
|
"@semantic-release/github"
|
||||||
|
]
|
||||||
|
}
|
22
.swcrc
Normal file
22
.swcrc
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
{
|
||||||
|
"jsc": {
|
||||||
|
"parser": {
|
||||||
|
"syntax": "typescript",
|
||||||
|
"decorators": true,
|
||||||
|
"dynamicImport": true
|
||||||
|
},
|
||||||
|
"transform": {
|
||||||
|
"legacyDecorator": true,
|
||||||
|
"decoratorMetadata": true
|
||||||
|
},
|
||||||
|
"target": "es2022",
|
||||||
|
"loose": true
|
||||||
|
},
|
||||||
|
"module": {
|
||||||
|
"type": "commonjs",
|
||||||
|
"strict": false,
|
||||||
|
"strictMode": true,
|
||||||
|
"lazy": false,
|
||||||
|
"noInterop": false
|
||||||
|
}
|
||||||
|
}
|
8
.vscode/extensions.json
vendored
Normal file
8
.vscode/extensions.json
vendored
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"recommendations": [
|
||||||
|
"editorconfig.editorconfig",
|
||||||
|
"esbenp.prettier-vscode",
|
||||||
|
"dbaeumer.vscode-eslint",
|
||||||
|
"davidanson.vscode-markdownlint"
|
||||||
|
]
|
||||||
|
}
|
10
.vscode/settings.json
vendored
Normal file
10
.vscode/settings.json
vendored
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"typescript.tsdk": "node_modules/typescript/lib",
|
||||||
|
"typescript.preferences.importModuleSpecifierEnding": "js",
|
||||||
|
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
||||||
|
"prettier.configPath": ".prettierrc.json",
|
||||||
|
"editor.formatOnSave": true,
|
||||||
|
"editor.codeActionsOnSave": {
|
||||||
|
"source.fixAll": true
|
||||||
|
}
|
||||||
|
}
|
29
CHANGELOG.md
29
CHANGELOG.md
@ -1,29 +0,0 @@
|
|||||||
# Changelog
|
|
||||||
|
|
||||||
## [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.
|
|
132
CODE_OF_CONDUCT.md
Normal file
132
CODE_OF_CONDUCT.md
Normal file
@ -0,0 +1,132 @@
|
|||||||
|
# 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
|
@ -4,7 +4,7 @@ Thanks a lot for your interest in contributing to **Thream/socketio-jwt**! 🎉
|
|||||||
|
|
||||||
## Code of Conduct
|
## 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](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.
|
**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.
|
||||||
|
|
||||||
## Open Development
|
## Open Development
|
||||||
|
|
||||||
@ -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 [Typescript Standard Style](https://www.npmjs.com/package/ts-standard).
|
- Ensure your code respect `eslint` and `prettier`.
|
||||||
|
|
||||||
- Make sure your **code passes the tests**.
|
- Make sure your **code passes the tests**.
|
||||||
|
|
59
README.md
59
README.md
@ -5,14 +5,18 @@
|
|||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<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>
|
<a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" /></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="./LICENSE"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="Licence MIT"/></a>
|
||||||
|
<a href="./CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant" /></a>
|
||||||
|
<br/>
|
||||||
|
<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/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 />
|
||||||
<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/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>
|
<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://www.npmjs.com/package/@thream/socketio-jwt"><img src="https://img.shields.io/npm/v/@thream/socketio-jwt.svg" alt="npm version"></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## 📜 About
|
## 📜 About
|
||||||
@ -25,6 +29,8 @@ This repository was originally forked from [auth0-socketio-jwt](https://github.c
|
|||||||
|
|
||||||
## 💾 Install
|
## 💾 Install
|
||||||
|
|
||||||
|
**Note:** It is a package that is recommended to use/install on both the client and server sides.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
npm install --save @thream/socketio-jwt
|
npm install --save @thream/socketio-jwt
|
||||||
```
|
```
|
||||||
@ -87,19 +93,52 @@ io.on('connection', async (socket) => {
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### 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
|
### Client side
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
import { io } from 'socket.io-client'
|
import { io } from 'socket.io-client'
|
||||||
|
import { isUnauthorizedError } from '@thream/socketio-jwt'
|
||||||
|
|
||||||
// Require Bearer Tokens to be passed in as an Authorization Header
|
// Require Bearer Token
|
||||||
const socket = io('http://localhost:9000', {
|
const socket = io('http://localhost:9000', {
|
||||||
extraHeaders: { Authorization: `Bearer ${yourJWT}` }
|
auth: { token: `Bearer ${yourJWT}` }
|
||||||
})
|
})
|
||||||
|
|
||||||
// Handling token expiration
|
// Handling token expiration
|
||||||
socket.on('connect_error', (error) => {
|
socket.on('connect_error', (error) => {
|
||||||
if (error.data.type === 'UnauthorizedError') {
|
if (isUnauthorizedError(error)) {
|
||||||
console.log('User token has expired')
|
console.log('User token has expired')
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@ -114,7 +153,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.
|
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
|
## 📄 License
|
||||||
|
|
||||||
|
@ -1 +0,0 @@
|
|||||||
module.exports = { extends: ['@commitlint/config-conventional'] }
|
|
10
jest.config.json
Normal file
10
jest.config.json
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"testEnvironment": "node",
|
||||||
|
"resolver": "jest-ts-webcompat-resolver",
|
||||||
|
"transform": {
|
||||||
|
"^.+\\.(t|j)sx?$": ["@swc/jest"]
|
||||||
|
},
|
||||||
|
"rootDir": "./src",
|
||||||
|
"collectCoverage": true,
|
||||||
|
"coverageDirectory": "../coverage/"
|
||||||
|
}
|
24171
package-lock.json
generated
Normal file
24171
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
122
package.json
122
package.json
@ -1,6 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "@thream/socketio-jwt",
|
"name": "@thream/socketio-jwt",
|
||||||
"version": "1.1.1",
|
"version": "0.0.0-development",
|
||||||
|
"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",
|
||||||
@ -9,7 +10,10 @@
|
|||||||
"build"
|
"build"
|
||||||
],
|
],
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=12"
|
"node": ">=12.0.0"
|
||||||
|
},
|
||||||
|
"publishConfig": {
|
||||||
|
"access": "public"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"socket",
|
"socket",
|
||||||
@ -19,65 +23,25 @@
|
|||||||
"author": "Divlo <contact@divlo.fr>",
|
"author": "Divlo <contact@divlo.fr>",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://github.com/Thream/socketio-jwt"
|
"url": "https://github.com/Thream/socketio-jwt"
|
||||||
},
|
},
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/Thream/socketio-jwt/issues"
|
"url": "https://github.com/Thream/socketio-jwt/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://github.com/Thream/socketio-jwt#readme",
|
"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}"
|
|
||||||
},
|
|
||||||
"github": {
|
|
||||||
"release": false
|
|
||||||
},
|
|
||||||
"npm": {
|
|
||||||
"publish": false
|
|
||||||
},
|
|
||||||
"hooks": {
|
|
||||||
"before:init": [
|
|
||||||
"npm run lint",
|
|
||||||
"npm run test"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"plugins": {
|
|
||||||
"@release-it/conventional-changelog": {
|
|
||||||
"preset": "angular",
|
|
||||||
"infile": "CHANGELOG.md"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"jest": {
|
|
||||||
"preset": "ts-jest",
|
|
||||||
"testEnvironment": "node",
|
|
||||||
"rootDir": "./src",
|
|
||||||
"collectCoverage": true,
|
|
||||||
"coverageDirectory": "../coverage/"
|
|
||||||
},
|
|
||||||
"ts-standard": {
|
|
||||||
"files": [
|
|
||||||
"./src/**/*.ts"
|
|
||||||
],
|
|
||||||
"envs": [
|
|
||||||
"node",
|
|
||||||
"jest"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "rimraf ./build && tsc",
|
"build": "rimraf ./build && swc ./src --out-dir ./build && tsc",
|
||||||
"lint": "ts-standard | snazzy",
|
"lint:commit": "commitlint",
|
||||||
"format": "ts-standard --fix | snazzy",
|
"lint:editorconfig": "editorconfig-checker",
|
||||||
"release": "release-it",
|
"lint:markdown": "markdownlint \"**/*.md\" --dot --ignore-path \".gitignore\"",
|
||||||
|
"lint:typescript": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"",
|
||||||
|
"lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"",
|
||||||
|
"lint:staged": "lint-staged",
|
||||||
"test": "jest",
|
"test": "jest",
|
||||||
"test:watchAll": "jest --watchAll",
|
"release": "semantic-release",
|
||||||
"test:clearCache": "jest --clearCache"
|
"postinstall": "husky install",
|
||||||
|
"prepublishOnly": "pinst --disable",
|
||||||
|
"postpublish": "pinst --enable"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"socket.io": ">=3.0.0"
|
"socket.io": ">=3.0.0"
|
||||||
@ -86,26 +50,40 @@
|
|||||||
"jsonwebtoken": "8.5.1"
|
"jsonwebtoken": "8.5.1"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@commitlint/cli": "11.0.0",
|
"@commitlint/cli": "16.2.1",
|
||||||
"@commitlint/config-conventional": "11.0.0",
|
"@commitlint/config-conventional": "16.2.1",
|
||||||
"@release-it/conventional-changelog": "2.0.0",
|
"@swc/cli": "0.1.55",
|
||||||
"@types/express": "4.17.11",
|
"@swc/core": "1.2.141",
|
||||||
"@types/jest": "26.0.20",
|
"@swc/jest": "0.2.17",
|
||||||
"@types/jsonwebtoken": "8.5.0",
|
"@types/express": "4.17.13",
|
||||||
"@types/node": "14.14.22",
|
"@types/jest": "27.4.0",
|
||||||
|
"@types/jsonwebtoken": "8.5.8",
|
||||||
|
"@types/node": "17.0.18",
|
||||||
"@types/server-destroy": "1.0.1",
|
"@types/server-destroy": "1.0.1",
|
||||||
"axios": "0.21.1",
|
"@typescript-eslint/eslint-plugin": "4.32.0",
|
||||||
"express": "4.17.1",
|
"axios": "0.26.0",
|
||||||
"husky": "4.3.8",
|
"editorconfig-checker": "4.0.2",
|
||||||
"jest": "26.6.3",
|
"eslint": "7.32.0",
|
||||||
"release-it": "14.2.2",
|
"eslint-config-prettier": "8.3.0",
|
||||||
|
"eslint-config-standard-with-typescript": "21.0.1",
|
||||||
|
"eslint-plugin-import": "2.25.4",
|
||||||
|
"eslint-plugin-node": "11.1.0",
|
||||||
|
"eslint-plugin-prettier": "4.0.0",
|
||||||
|
"eslint-plugin-promise": "5.2.0",
|
||||||
|
"eslint-plugin-unicorn": "40.1.0",
|
||||||
|
"express": "4.17.3",
|
||||||
|
"husky": "7.0.4",
|
||||||
|
"jest": "27.5.1",
|
||||||
|
"jest-ts-webcompat-resolver": "1.0.0",
|
||||||
|
"lint-staged": "12.3.4",
|
||||||
|
"markdownlint-cli": "0.31.1",
|
||||||
|
"pinst": "2.1.6",
|
||||||
"rimraf": "3.0.2",
|
"rimraf": "3.0.2",
|
||||||
|
"semantic-release": "19.0.2",
|
||||||
"server-destroy": "1.0.1",
|
"server-destroy": "1.0.1",
|
||||||
"snazzy": "9.0.0",
|
"prettier": "2.5.1",
|
||||||
"socket.io": "3.1.0",
|
"socket.io": "4.4.1",
|
||||||
"socket.io-client": "3.1.0",
|
"socket.io-client": "4.4.1",
|
||||||
"ts-jest": "26.4.4",
|
"typescript": "4.5.5"
|
||||||
"ts-standard": "10.0.0",
|
|
||||||
"typescript": "4.1.3"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
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.message = error.message
|
||||||
this.inner = error
|
this.inner = error
|
||||||
@ -14,3 +14,7 @@ export class UnauthorizedError extends Error {
|
|||||||
Object.setPrototypeOf(this, UnauthorizedError.prototype)
|
Object.setPrototypeOf(this, UnauthorizedError.prototype)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export const isUnauthorizedError = (error: any): error is UnauthorizedError => {
|
||||||
|
return error.data.type === 'UnauthorizedError'
|
||||||
|
}
|
||||||
|
@ -1,17 +1,25 @@
|
|||||||
import axios from 'axios'
|
import axios from 'axios'
|
||||||
import { io } from 'socket.io-client'
|
import { io } from 'socket.io-client'
|
||||||
|
|
||||||
import { fixtureStart, fixtureStop } from './fixture'
|
import { isUnauthorizedError } from '../UnauthorizedError.js'
|
||||||
|
import {
|
||||||
|
fixtureStart,
|
||||||
|
fixtureStop,
|
||||||
|
getSocket,
|
||||||
|
Profile
|
||||||
|
} from './fixture/index.js'
|
||||||
|
|
||||||
describe('authorize - with secret as string in options', () => {
|
describe('authorize - with secret as string in options', () => {
|
||||||
let token: string = ''
|
let token: string = ''
|
||||||
|
|
||||||
beforeEach(async (done) => {
|
beforeEach((done) => {
|
||||||
jest.setTimeout(15_000)
|
fixtureStart(async () => {
|
||||||
await fixtureStart(async () => {
|
|
||||||
const response = await axios.post('http://localhost:9000/login')
|
const response = await axios.post('http://localhost:9000/login')
|
||||||
token = response.data.token
|
token = response.data.token
|
||||||
done()
|
})
|
||||||
|
.then(done)
|
||||||
|
.catch((error) => {
|
||||||
|
done(error)
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
@ -21,9 +29,12 @@ describe('authorize - with secret as string in options', () => {
|
|||||||
|
|
||||||
it('should emit error with no token provided', (done) => {
|
it('should emit error with no token provided', (done) => {
|
||||||
const socket = io('http://localhost:9000')
|
const socket = io('http://localhost:9000')
|
||||||
socket.on('connect_error', (err: any) => {
|
socket.on('connect_error', (error) => {
|
||||||
expect(err.data.message).toEqual('no token provided')
|
expect(isUnauthorizedError(error)).toBeTruthy()
|
||||||
expect(err.data.code).toEqual('credentials_required')
|
if (isUnauthorizedError(error)) {
|
||||||
|
expect(error.data.message).toEqual('no token provided')
|
||||||
|
expect(error.data.code).toEqual('credentials_required')
|
||||||
|
}
|
||||||
socket.close()
|
socket.close()
|
||||||
done()
|
done()
|
||||||
})
|
})
|
||||||
@ -31,13 +42,16 @@ describe('authorize - with secret as string in options', () => {
|
|||||||
|
|
||||||
it('should emit error with bad token format', (done) => {
|
it('should emit error with bad token format', (done) => {
|
||||||
const socket = io('http://localhost:9000', {
|
const socket = io('http://localhost:9000', {
|
||||||
extraHeaders: { Authorization: 'testing' }
|
auth: { token: 'testing' }
|
||||||
})
|
})
|
||||||
socket.on('connect_error', (err: any) => {
|
socket.on('connect_error', (error) => {
|
||||||
expect(err.data.message).toEqual(
|
expect(isUnauthorizedError(error)).toBeTruthy()
|
||||||
|
if (isUnauthorizedError(error)) {
|
||||||
|
expect(error.data.message).toEqual(
|
||||||
'Format is Authorization: Bearer [token]'
|
'Format is Authorization: Bearer [token]'
|
||||||
)
|
)
|
||||||
expect(err.data.code).toEqual('credentials_bad_format')
|
expect(error.data.code).toEqual('credentials_bad_format')
|
||||||
|
}
|
||||||
socket.close()
|
socket.close()
|
||||||
done()
|
done()
|
||||||
})
|
})
|
||||||
@ -45,13 +59,16 @@ describe('authorize - with secret as string in options', () => {
|
|||||||
|
|
||||||
it('should emit error with unauthorized handshake', (done) => {
|
it('should emit error with unauthorized handshake', (done) => {
|
||||||
const socket = io('http://localhost:9000', {
|
const socket = io('http://localhost:9000', {
|
||||||
extraHeaders: { Authorization: 'Bearer testing' }
|
auth: { token: 'Bearer testing' }
|
||||||
})
|
})
|
||||||
socket.on('connect_error', (err: any) => {
|
socket.on('connect_error', (error) => {
|
||||||
expect(err.data.message).toEqual(
|
expect(isUnauthorizedError(error)).toBeTruthy()
|
||||||
|
if (isUnauthorizedError(error)) {
|
||||||
|
expect(error.data.message).toEqual(
|
||||||
'Unauthorized: Token is missing or invalid Bearer'
|
'Unauthorized: Token is missing or invalid Bearer'
|
||||||
)
|
)
|
||||||
expect(err.data.code).toEqual('invalid_token')
|
expect(error.data.code).toEqual('invalid_token')
|
||||||
|
}
|
||||||
socket.close()
|
socket.close()
|
||||||
done()
|
done()
|
||||||
})
|
})
|
||||||
@ -59,12 +76,15 @@ describe('authorize - with secret as string in options', () => {
|
|||||||
|
|
||||||
it('should connect the user', (done) => {
|
it('should connect the user', (done) => {
|
||||||
const socket = io('http://localhost:9000', {
|
const socket = io('http://localhost:9000', {
|
||||||
extraHeaders: { Authorization: `Bearer ${token}` }
|
auth: { token: `Bearer ${token}` }
|
||||||
})
|
})
|
||||||
socket.on('connect', () => {
|
socket.on('connect', () => {
|
||||||
socket.close()
|
socket.close()
|
||||||
done()
|
done()
|
||||||
})
|
})
|
||||||
|
socket.on('connect_error', (error) => {
|
||||||
|
done(error)
|
||||||
|
})
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
@ -75,29 +95,205 @@ const secretCallback = async (): Promise<string> => {
|
|||||||
describe('authorize - with secret as callback in options', () => {
|
describe('authorize - with secret as callback in options', () => {
|
||||||
let token: string = ''
|
let token: string = ''
|
||||||
|
|
||||||
beforeEach(async (done) => {
|
beforeEach((done) => {
|
||||||
jest.setTimeout(15_000)
|
fixtureStart(
|
||||||
await fixtureStart(
|
|
||||||
async () => {
|
async () => {
|
||||||
const response = await axios.post('http://localhost:9000/login')
|
const response = await axios.post('http://localhost:9000/login')
|
||||||
token = response.data.token
|
token = response.data.token
|
||||||
done()
|
|
||||||
},
|
},
|
||||||
{ secret: secretCallback }
|
{ secret: secretCallback }
|
||||||
)
|
)
|
||||||
|
.then(done)
|
||||||
|
.catch((error) => {
|
||||||
|
done(error)
|
||||||
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
afterEach((done) => {
|
afterEach((done) => {
|
||||||
fixtureStop(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) => {
|
it('should connect the user', (done) => {
|
||||||
const socket = io('http://localhost:9000', {
|
const socket = io('http://localhost:9000', {
|
||||||
extraHeaders: { Authorization: `Bearer ${token}` }
|
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,
|
||||||
|
onAuthentication: (decodedToken: Profile) => {
|
||||||
|
if (!decodedToken.checkField) {
|
||||||
|
throw new Error('Check Field validation failed')
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
email: decodedToken.email
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
.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.on('connect', () => {
|
||||||
socket.close()
|
socket.close()
|
||||||
done()
|
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()
|
||||||
|
})
|
||||||
|
})
|
||||||
})
|
})
|
||||||
|
@ -1,11 +1,18 @@
|
|||||||
|
import type { Server as HttpServer } from 'node:http'
|
||||||
|
import type { Server as HttpsServer } from 'node:https'
|
||||||
|
|
||||||
import express from 'express'
|
import express from 'express'
|
||||||
import jwt from 'jsonwebtoken'
|
import jwt from 'jsonwebtoken'
|
||||||
import { Server as HttpServer } from 'http'
|
|
||||||
import { Server as HttpsServer } from 'https'
|
|
||||||
import { Server as SocketIoServer } from 'socket.io'
|
import { Server as SocketIoServer } from 'socket.io'
|
||||||
import enableDestroy from 'server-destroy'
|
import enableDestroy from 'server-destroy'
|
||||||
|
|
||||||
import { authorize, AuthorizeOptions } from '../../index'
|
import { authorize, AuthorizeOptions } from '../../index.js'
|
||||||
|
|
||||||
|
export interface Profile {
|
||||||
|
email: string
|
||||||
|
id: number
|
||||||
|
checkField: boolean
|
||||||
|
}
|
||||||
|
|
||||||
interface Socket {
|
interface Socket {
|
||||||
io: null | SocketIoServer
|
io: null | SocketIoServer
|
||||||
@ -14,7 +21,7 @@ interface Socket {
|
|||||||
|
|
||||||
const socket: Socket = {
|
const socket: Socket = {
|
||||||
io: null,
|
io: null,
|
||||||
init (httpServer) {
|
init(httpServer) {
|
||||||
socket.io = new SocketIoServer(httpServer)
|
socket.io = new SocketIoServer(httpServer)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -23,21 +30,32 @@ let server: HttpServer | null = null
|
|||||||
|
|
||||||
export const fixtureStart = async (
|
export const fixtureStart = async (
|
||||||
done: any,
|
done: any,
|
||||||
options: AuthorizeOptions = { secret: 'aaafoo super sercret' }
|
options: AuthorizeOptions = { secret: 'super secret' }
|
||||||
): Promise<void> => {
|
): Promise<void> => {
|
||||||
const app = express()
|
const profile: Profile = {
|
||||||
app.use(express.json())
|
email: 'john@doe.com',
|
||||||
let keySecret = 'secret'
|
id: 123,
|
||||||
|
checkField: true
|
||||||
|
}
|
||||||
|
let keySecret = ''
|
||||||
if (typeof options.secret === 'string') {
|
if (typeof options.secret === 'string') {
|
||||||
keySecret = options.secret
|
keySecret = options.secret
|
||||||
} else {
|
} else {
|
||||||
keySecret = await options.secret({ header: { alg: 'RS256' }, payload: '' })
|
keySecret = await options.secret({
|
||||||
|
header: { alg: 'HS256' },
|
||||||
|
payload: profile
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
const app = express()
|
||||||
|
app.use(express.json())
|
||||||
app.post('/login', (_req, res) => {
|
app.post('/login', (_req, res) => {
|
||||||
const profile = {
|
const token = jwt.sign(profile, keySecret, {
|
||||||
email: 'john@doe.com',
|
expiresIn: 60 * 60 * 5
|
||||||
id: 123
|
})
|
||||||
}
|
return res.json({ token })
|
||||||
|
})
|
||||||
|
app.post('/login-wrong', (_req, res) => {
|
||||||
|
profile.checkField = false
|
||||||
const token = jwt.sign(profile, keySecret, {
|
const token = jwt.sign(profile, keySecret, {
|
||||||
expiresIn: 60 * 60 * 5
|
expiresIn: 60 * 60 * 5
|
||||||
})
|
})
|
||||||
@ -53,6 +71,10 @@ export const fixtureStop = (callback: Function): void => {
|
|||||||
socket.io?.close()
|
socket.io?.close()
|
||||||
try {
|
try {
|
||||||
server?.destroy()
|
server?.destroy()
|
||||||
} catch (err) {}
|
} catch {}
|
||||||
callback()
|
callback()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export const getSocket = (): SocketIoServer | null => {
|
||||||
|
return socket.io
|
||||||
|
}
|
||||||
|
@ -1,24 +1,21 @@
|
|||||||
import jwt, { Algorithm } from 'jsonwebtoken'
|
import jwt, { Algorithm } from 'jsonwebtoken'
|
||||||
import { Socket } from 'socket.io'
|
import { Socket } from 'socket.io'
|
||||||
|
|
||||||
import { UnauthorizedError } from './UnauthorizedError'
|
import { UnauthorizedError } from './UnauthorizedError.js'
|
||||||
|
|
||||||
declare module 'socket.io' {
|
declare module 'socket.io' {
|
||||||
interface Socket extends ExtendedSocket {}
|
interface Socket extends ExtendedSocket {}
|
||||||
}
|
}
|
||||||
|
|
||||||
interface ExtendedError extends Error {
|
|
||||||
data?: any
|
|
||||||
}
|
|
||||||
|
|
||||||
interface ExtendedSocket {
|
interface ExtendedSocket {
|
||||||
encodedToken?: string
|
encodedToken?: string
|
||||||
decodedToken?: any
|
decodedToken?: any
|
||||||
|
user?: any
|
||||||
}
|
}
|
||||||
|
|
||||||
type SocketIOMiddleware = (
|
type SocketIOMiddleware = (
|
||||||
socket: Socket,
|
socket: Socket,
|
||||||
next: (err?: ExtendedError) => void
|
next: (error?: UnauthorizedError) => void
|
||||||
) => void
|
) => void
|
||||||
|
|
||||||
interface CompleteDecodedToken {
|
interface CompleteDecodedToken {
|
||||||
@ -29,20 +26,23 @@ interface CompleteDecodedToken {
|
|||||||
payload: any
|
payload: any
|
||||||
}
|
}
|
||||||
|
|
||||||
type SecretCallback = (decodedToken: CompleteDecodedToken) => Promise<string>
|
type SecretCallback = (
|
||||||
|
decodedToken: CompleteDecodedToken
|
||||||
|
) => Promise<string> | string
|
||||||
|
|
||||||
export interface AuthorizeOptions {
|
export interface AuthorizeOptions {
|
||||||
secret: string | SecretCallback
|
secret: string | SecretCallback
|
||||||
algorithms?: Algorithm[]
|
algorithms?: Algorithm[]
|
||||||
|
onAuthentication?: (decodedToken: any) => Promise<any> | any
|
||||||
}
|
}
|
||||||
|
|
||||||
export const authorize = (options: AuthorizeOptions): SocketIOMiddleware => {
|
export const authorize = (options: AuthorizeOptions): SocketIOMiddleware => {
|
||||||
const { secret, algorithms = ['HS256'] } = 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 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') {
|
if (tokenSplitted.length !== 2 || tokenSplitted[0] !== 'Bearer') {
|
||||||
return next(
|
return next(
|
||||||
new UnauthorizedError('credentials_bad_format', {
|
new UnauthorizedError('credentials_bad_format', {
|
||||||
@ -59,7 +59,6 @@ export const authorize = (options: AuthorizeOptions): SocketIOMiddleware => {
|
|||||||
})
|
})
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
// Store encoded JWT
|
|
||||||
socket.encodedToken = encodedToken
|
socket.encodedToken = encodedToken
|
||||||
let keySecret: string | null = null
|
let keySecret: string | null = null
|
||||||
let decodedToken: any
|
let decodedToken: any
|
||||||
@ -78,8 +77,14 @@ export const authorize = (options: AuthorizeOptions): SocketIOMiddleware => {
|
|||||||
})
|
})
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
// Store decoded JWT
|
|
||||||
socket.decodedToken = decodedToken
|
socket.decodedToken = decodedToken
|
||||||
|
if (onAuthentication != null) {
|
||||||
|
try {
|
||||||
|
socket.user = await onAuthentication(decodedToken)
|
||||||
|
} catch (error: any) {
|
||||||
|
return next(error)
|
||||||
|
}
|
||||||
|
}
|
||||||
return next()
|
return next()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1 +1,2 @@
|
|||||||
export * from './authorize'
|
export * from './authorize.js'
|
||||||
|
export * from './UnauthorizedError.js'
|
||||||
|
@ -1,23 +1,14 @@
|
|||||||
{
|
{
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
"target": "ES2019",
|
"target": "ESNext",
|
||||||
"module": "commonjs",
|
"module": "commonjs",
|
||||||
"lib": ["ES2019"],
|
"lib": ["ESNext"],
|
||||||
"moduleResolution": "node",
|
"moduleResolution": "node",
|
||||||
"allowJs": false,
|
|
||||||
"checkJs": false,
|
|
||||||
"declaration": true,
|
|
||||||
"sourceMap": false,
|
|
||||||
"outDir": "./build",
|
"outDir": "./build",
|
||||||
"rootDir": "./src",
|
"rootDir": "./src",
|
||||||
"removeComments": false,
|
"noEmit": true,
|
||||||
"noEmitOnError": true,
|
|
||||||
"importHelpers": false,
|
|
||||||
"strict": true,
|
"strict": true,
|
||||||
"esModuleInterop": true,
|
"skipLibCheck": true,
|
||||||
"experimentalDecorators": true,
|
"esModuleInterop": true
|
||||||
"emitDecoratorMetadata": true,
|
|
||||||
"forceConsistentCasingInFileNames": true,
|
|
||||||
"incremental": false
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user