Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Discord Authentication Module to allow optionally filtering based on Server Roles. #6323

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,4 @@ test-results/

# Localization Resources
/server/locales/**/*.yml
yarn.lock
TomDakan marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@
"dependency-graph": "0.11.0",
"diff": "4.0.2",
"diff2html": "3.1.14",
"discord-oauth2": "2.11.0",
"dompurify": "2.4.3",
"dotize": "0.3.0",
"elasticsearch6": "npm:@elastic/elasticsearch@6",
Expand Down
4 changes: 4 additions & 0 deletions server/helpers/error.js
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,10 @@ module.exports = {
message: 'You are not authorized to register. Your domain is not whitelisted.',
code: 1011
}),
AuthDiscordRoleUnauthorized: CustomError('AuthDiscordRoleUnauthorized', {
message: 'You are not authorized to register. You lack the necessary Server Roles.',
code: 1012
}),
AuthRequired: CustomError('AuthRequired', {
message: 'You must be authenticated to access this resource.',
code: 1019
Expand Down
21 changes: 20 additions & 1 deletion server/modules/authentication/discord/authentication.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,18 @@

const DiscordStrategy = require('passport-discord').Strategy
const _ = require('lodash')
const DiscordOauth2 = require('./node_modules/discord-oauth2/index.js') //I don't remember why I
TomDakan marked this conversation as resolved.
Show resolved Hide resolved

// Checks for the existence of all of the required role IDs in the member's guild role IDs.
function hasRoles(memberRoles, authRoles) {
if (authRoles.every(value => {
return memberRoles.includes(value)
})) {
return true
} else {
return false
}
};
TomDakan marked this conversation as resolved.
Show resolved Hide resolved
TomDakan marked this conversation as resolved.
Show resolved Hide resolved

module.exports = {
init (passport, conf) {
Expand All @@ -19,9 +31,16 @@ module.exports = {
passReqToCallback: true
}, async (req, accessToken, refreshToken, profile, cb) => {
try {
if (conf.guildId && !_.some(profile.guilds, { id: conf.guildId })) {
if (conf.roles) {
const discord = new DiscordOauth2()
TomDakan marked this conversation as resolved.
Show resolved Hide resolved
const memberRoles = await discord.getGuildMember(accessToken, conf.guildId)
TomDakan marked this conversation as resolved.
Show resolved Hide resolved
if (!hasRoles(memberRoles.roles, conf.roles.split())) {
TomDakan marked this conversation as resolved.
Show resolved Hide resolved
throw new WIKI.Error.AuthLoginFailed()
}
TomDakan marked this conversation as resolved.
Show resolved Hide resolved
} else if (conf.guildId && !_.some(profile.guilds, { id: conf.guildId })) {
throw new WIKI.Error.AuthLoginFailed()
}

const user = await WIKI.models.users.processProfile({
providerKey: req.params.strategy,
profile: {
Expand Down
5 changes: 5 additions & 0 deletions server/modules/authentication/discord/definition.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,8 @@ props:
title: Server ID
hint: Optional - Your unique server identifier, such that only members are authorized
order: 3
roles:
type: String
title: Required Roles
hint: Optional - Comma-separated list of server role IDs that are required for access (you must hae a Server ID configured to use this.)
TomDakan marked this conversation as resolved.
Show resolved Hide resolved
order: 4
22 changes: 22 additions & 0 deletions server/modules/authentication/discord/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 19 additions & 0 deletions server/modules/authentication/discord/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "wikijs-discord-oauth2",
"version": "1.0.0",
"description": "Supports using Discord as a SSO source, and allows the administrator to configure discord groups that are required for authentication.",
"main": "authentication.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [
"wikijs",
"discord",
"sso"
],
"author": "Tom Dakan",
"license": "AGPL-3.0-or-later",
"dependencies": {
"discord-oauth2": "^2.11.0"
}
}
TomDakan marked this conversation as resolved.
Show resolved Hide resolved
5 changes: 5 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -8490,6 +8490,11 @@ dir-glob@^3.0.1:
dependencies:
path-type "^4.0.0"

discord-oauth2@2.11.0:
version "2.11.0"
resolved "https://registry.yarnpkg.com/discord-oauth2/-/discord-oauth2-2.11.0.tgz#799acc6777a216f8fbbf72d5ea29086eb4303f85"
integrity sha512-pIbgXm498f7vqNd8/7JwoLd36YMFOFASSJdqyCGdwQpaG7ULHu9nLyifpVXI1b88xvNLqQwqugS8jxkn8Ypd1Q==

doctrine@1.5.0:
version "1.5.0"
resolved "https://registry.yarnpkg.com/doctrine/-/doctrine-1.5.0.tgz#379dce730f6166f76cefa4e6707a159b02c5a6fa"
Expand Down