Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robotsandpencils/express-oauth
OAuth 2.0 Middleware with CSRF mitigation for Express
https://github.com/robotsandpencils/express-oauth
express express-middleware expressjs expressjs-middleware oauth oauth2
Last synced: 6 days ago
JSON representation
OAuth 2.0 Middleware with CSRF mitigation for Express
- Host: GitHub
- URL: https://github.com/robotsandpencils/express-oauth
- Owner: RobotsAndPencils
- License: mit
- Created: 2021-11-05T15:08:01.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2021-11-13T19:32:44.000Z (about 3 years ago)
- Last Synced: 2024-12-25T16:09:15.118Z (6 days ago)
- Topics: express, express-middleware, expressjs, expressjs-middleware, oauth, oauth2
- Language: JavaScript
- Homepage:
- Size: 46.9 KB
- Stars: 0
- Watchers: 10
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# express-oauth
[](https://github.com/RobotsAndPencils/express-oauth/actions/workflows/pr-check.yml)
[](https://coveralls.io/github/RobotsAndPencils/express-oauth?branch=main)
`@robotsandpencils/express-oauth` is an express middleware for mitigating CSRF attacks in OAuth 2.0 flows. It is not intended to be used on it's own. Examples follow for leveraging this package to produce more specific OAuth middleware.
## Usage
```Shell
npm install --save @robotsandpencils/express-oauth
```
```javascript
const { ExpressOAuth } = require('@robotsandpencils/express-oauth')
const { App, ExpressReceiver } = require('@slack/bolt')
const { WebClient } = require('@slack/web-api')
const qs = require('qs')
const { makeState, verifyState } = new ExpressOAuth({
secret: process.env.OAUTH_SECRET, // minimum 256 bit string (i.e. 32 char utf8 string)
})
const receiver = new ExpressReceiver({
signingSecret: process.env.SLACK_SIGNING_SECRET,
})
const app = receiver.app
const bolt = new App({
receiver,
authorize: async (ctx) => { /* ... */ },
convoStore: false,
})
const authorizePath = '/slack/install/authorize'
const verifyPath = '/slack/install/verify'
app.get(authorizePath, async (req, res, next) => {
const data = { foo: 'bar' } // state data we want to use when oauth is complete
const { synchronizer } = await makeState(data)(req, res)
const queryObject = {
client_id: process.env.SLACK_CLIENT_ID,
response_type: 'code',
response_mode: 'query',
redirect_uri: `https://${req.get('host')}${verifyPath}`,
scope: ['app_mentions:read', 'chat:write', 'commands', 'users:read'],
state: synchronizer,
}
const query = qs.stringify(queryObject)
const redirectURL = `https://slack.com/oauth/v2/authorize?${query}`
/*
* NOTE that this redirects the client to Slack immediately because
* the OAuth flow is time sensitive (only valid for 3 minutes in this example)
*/
const htmlResponse = '' +
`\n` +
'\n' +
'\n
Success! Redirecting to the Slack App...
' +
`\n Click here to redirect` +
'\n'
res.writeHead(200, { 'Content-Type': 'text/html' })
res.end(htmlResponse)
})
app.get(verifyPath, async (req, res, next) => {
const { data } = await verifyState(req, res)
const tokenRes = await new WebClient()
.oauth.v2.access({
code: req.query.code,
client_id: slackClientId,
client_secret: slackClientSecret,
redirect_uri: `https://${req.get('host')}${verifyPath}`,
})
const testRes = await new WebClient(tokenRes.access_token)
.auth.test()
// save user and team data to a database
// maybe do something with the state `data`?
const redirectURL = `slack://app?team=${team.id}&id=${team.appId}`
const htmlResponse = '' +
`\n` +
'\n' +
'\n
Success! Redirecting to the Slack App...
' +
`\n Click here to redirect` +
`\n Install again`
'\n'
res.writeHead(200, { 'Content-Type': 'text/html' })
res.end(htmlResponse)
})
app.listen('3000')
```