https://github.com/bioblaze/passport-discord.js
Passport strategy for authentication with Discord (discordapp.com)
https://github.com/bioblaze/passport-discord.js
Last synced: about 1 month ago
JSON representation
Passport strategy for authentication with Discord (discordapp.com)
- Host: GitHub
- URL: https://github.com/bioblaze/passport-discord.js
- Owner: Bioblaze
- License: gpl-3.0
- Created: 2019-05-24T18:17:53.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T22:39:42.000Z (over 3 years ago)
- Last Synced: 2025-05-30T11:56:52.900Z (about 1 year ago)
- Language: JavaScript
- Size: 1.03 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# passport-discord.js
[](https://github.com/semantic-release/semantic-release)
[](https://codeclimate.com/github/Bioblaze/passport-discord.js)
[](https://discord.gg/T8uVhzU)
[](https://paypal.me/BioblazePayne)
Discord is a trademark or registered trademark of Hammer & Chisel, Inc. in the U.S. and/or other countries. "passport-discord.js" is not operated by, sponsored by, or affiliated with Hammer & Chisel Inc. in any way.
[Passport](http://passportjs.org/) strategies for authenticating with [Discord](https://discordapp.com/)
using OAuth 2.0 API.
This module lets you authenticate using Discord in your Node.js applications.
By plugging into Passport, Discord authentication can be easily and
unobtrusively integrated into any application or framework that supports
[Connect](http://www.senchalabs.org/connect/)-style middleware, including
[Express](http://expressjs.com/).
## Install
```bash
$ npm install passport-discord.js
```
## Usage of OAuth 2.0
#### Configure Strategy
The Discord OAuth 2.0 authentication strategy authenticates users using a Discord
account and OAuth 2.0 tokens. The strategy requires a `verify` callback, which
accepts these credentials and calls `done` providing a user, as well as
`options` specifying a client ID, client secret, and callback URL.
```javascript
var passport = require("passport");
var discordStrategy = require("passport-discord.js").Strategy;
passport.use(new discordStrategy({
clientID: DISCORD_CLIENT_ID,
clientSecret: DISCORD_CLIENT_SECRET,
callbackURL: "http://127.0.0.1:3000/auth/discord/callback",
scope: ["guilds", "connections", "email"]
},
function(accessToken, refreshToken, profile, done) {
//Handle Database Query Addition Here.
}
));
```
#### Authenticate Requests
Use `passport.authenticate()`, specifying the `"discord.js"` strategy, to
authenticate requests.
For example, as route middleware in an [Express](http://expressjs.com/)
application:
```javascript
app.get("/auth/discord", passport.authenticate("discord.js"));
app.get("/auth/discord/callback", passport.authenticate("discord.js", { failureRedirect: "/" }), function(req, res) {
// Successful authentication, redirect home.
res.redirect("/");
});
```
The request to this route should include a GET or POST data with the keys `access_token` from Discord.
```
GET /auth/discord?access_token=
```
## Issues
If you receive a `401 Unauthorized` error, it is most likely because you have wrong access token or not yet specified any application permissions.
Once you refresh access token with new permissions, try to send this access token again.
## Example
```javascript
#!/bin/env node
require('dotenv').config();
var express = require('express');
var session = require('express-session');
var helmet = require('helmet');
var bodyParser = require('body-parser');
var passport = require('passport');
var refresh = require('passport-oauth2-refresh');
var _strategy = require('passport-discord.js').Strategy;
var app = express();
app.use(session({
key: process.env.SESSION_KEY,
secret: process.env.SESSION_SECRET,
resave: true,
saveUninitialized: true,
cookie: {
secure: true
}
}));
app.use(helmet());
app.use(bodyParser.urlencoded({ extended: true }));
app.use(bodyParser.json());
passport.serializeUser(function(u, d) {
d(null, u);
});
passport.deserializeUser(function(u, d) {
d(null, u);
});
var DiscordStrategy = new _strategy({
clientID: process.env.DISCORD_ID,
clientSecret: process.env.DISCORD_SECRET,
callbackURL: "http://127.0.0.1:3000/auth/discord/callback",
scope: ["guilds", "connections", "email"]
}, function(accesstoken, refreshToken, profile, done) {
console.log(profile);
return done(null, profile);
});
passport.use(DiscordStrategy);
refresh.use(DiscordStrategy);
app.get('/', function(req, res) {
if (!req.session.user) {
res.redirect('/login');
} else {
res.send(`Hello ${req.session.user.username}`);
}
});
app.get('/login', passport.authenticate('discord.js'}));
app.get('/auth/discord/callback', passport.authenticate('discord.js', { failureRedirect: '/' }), function(req, res) {
req.session.user = req.user;
console.log(req.user);
console.log(req.query);
res.redirect('/');
});
app.listen(process.env.SITE_PORT, process.env.SITE_HOST, function() {
console.log(`Express Started`);
});
```
Projected Maintained by: Randolph Aarseth(Bioblaze Payne)