nodebb-plugin-sso-github 3.1.3 → 3.2.0

package/.gitattributes

@@ -1,22 +1,22 @@
-# Auto detect text files and perform LF normalization
-* text=auto
-
-# Custom for Visual Studio
-*.cs     diff=csharp
-*.sln    merge=union
-*.csproj merge=union
-*.vbproj merge=union
-*.fsproj merge=union
-*.dbproj merge=union
-
-# Standard to msysgit
-*.doc	 diff=astextplain
-*.DOC	 diff=astextplain
-*.docx diff=astextplain
-*.DOCX diff=astextplain
-*.dot  diff=astextplain
-*.DOT  diff=astextplain
-*.pdf  diff=astextplain
-*.PDF	 diff=astextplain
-*.rtf	 diff=astextplain
-*.RTF	 diff=astextplain
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+*.sln    merge=union
+*.csproj merge=union
+*.vbproj merge=union
+*.fsproj merge=union
+*.dbproj merge=union
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

package/LICENSE

@@ -1,8 +1,8 @@
-Copyright (c) 2013-2014, psychobunny <psycho.bunny@hotmail.com>
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+Copyright (c) 2013-2014, psychobunny <psycho.bunny@hotmail.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,15 +1,15 @@
-# NodeBB GitHub SSO
-
-NodeBB Plugin that allows users to login/register via their GitHub account.
-
-----
-Nov 13, 2020. Fixed a few problems:  
-
-    1. fetch non-public github emails.  
-    2. fetch user's github avatar.  
-    3. add setting of trusting user's github email or not.  
-
-## Installation
-
-    npm install nodebb-plugin-sso-github
-
+# NodeBB GitHub SSO
+
+NodeBB Plugin that allows users to login/register via their GitHub account.
+
+----
+Nov 13, 2020. Fixed a few problems:  
+
+    1. fetch non-public github emails.  
+    2. fetch user's github avatar.  
+    3. add setting of trusting user's github email or not.  
+
+## Installation
+
+    npm install nodebb-plugin-sso-github
+

package/eslint.config.mjs

@@ -0,0 +1,10 @@
+'use strict';
+
+import serverConfig from 'eslint-config-nodebb';
+import publicConfig from 'eslint-config-nodebb/public';
+
+export default [
+	...publicConfig,
+	...serverConfig,
+];
+

package/library.js

@@ -1,242 +1,228 @@
-(function(module) {
-	"use strict";
-
-	var User = require.main.require('./src/user');
-	var db = require.main.require('./src/database');
-	var meta = require.main.require('./src/meta');
-	var nconf = require.main.require('nconf');
-	var async = require.main.require('async');
-	var passport = require.main.require('passport');
-	var GithubStrategy = require('passport-github2').Strategy;
-
-	var winston = require.main.require('winston');
-
-	var authenticationController = require.main.require('./src/controllers/authentication');
-
-	var constants = Object.freeze({
-		'name': "GitHub",
-		'admin': {
-			'icon': 'fa-github',
-			'route': '/plugins/sso-github'
-		}
+'use strict';
+
+const User = require.main.require('./src/user');
+const db = require.main.require('./src/database');
+const meta = require.main.require('./src/meta');
+const nconf = require.main.require('nconf');
+const passport = require.main.require('passport');
+const GithubStrategy = require('passport-github2').Strategy;
+
+const constants = Object.freeze({
+	name: 'GitHub',
+	admin: {
+		icon: 'fa-github',
+		route: '/plugins/sso-github',
+	},
+});
+
+const GitHub = module.exports;
+
+GitHub.init = async function (data) {
+	const hostHelpers = require.main.require('./src/routes/helpers');
+
+	hostHelpers.setupAdminPageRoute(data.router, '/admin/plugins/sso-github', function (req, res) {
+		res.render('admin/plugins/sso-github', {
+			title: constants.name,
+			callbackURL: nconf.get('url') + '/auth/github/callback',
+		});
 	});
 
-	var GitHub = {};
-
-	GitHub.getStrategy = function(strategies, callback) {
-		meta.settings.get('sso-github', function(err, settings) {
-			GitHub.settings = settings;
-
-			if (!err && settings.id && settings.secret) {
-				passport.use(new GithubStrategy({
-					clientID: settings.id,
-					clientSecret: settings.secret,
-					callbackURL: nconf.get('url') + '/auth/github/callback',
-					passReqToCallback: true,
-					scope: [ 'user:email' ] // fetches non-public emails as well
-				}, function(req, token, tokenSecret, profile, done) {
-					if (req.hasOwnProperty('user') && req.user.hasOwnProperty('uid') && req.user.uid > 0) {
-						// Save GitHub -specific information to the user
-						User.setUserField(req.user.uid, 'githubid', profile.id);
-						db.setObjectField('githubid:uid', profile.id, req.user.uid);
-						return done(null, req.user);
-					}
-
-					var email = Array.isArray(profile.emails) && profile.emails.length ? profile.emails[0].value : '';
-					var pictureUrl = Array.isArray(profile.photos) && profile.photos.length ? profile.photos[0].value : '';
-					GitHub.login(profile.id, profile.displayName, profile.username, email, pictureUrl, function(err, user) {
-						if (err) {
-							return done(err);
-						}
-
-						authenticationController.onSuccessfulLogin(req, user.uid);
-						done(null, user);
-					});
-				}));
-
-				strategies.push({
-					name: 'github',
-					url: '/auth/github',
-					callbackURL: '/auth/github/callback',
-					icon: constants.admin.icon,
-					icons: {
-						normal: 'fa-brands fa-github',
-						square: 'fa-brands fa-github-square',
-					},
-					labels: {
-						login: '[[social:sign-in-with-github]]',
-						register: '[[social:sign-up-with-github]]',
-					},
-					color: '#25292f',
-					scope: 'user:email'
-				});
-			}
-
-			callback(null, strategies);
+	hostHelpers.setupPageRoute(data.router, '/deauth/github', [data.middleware.requireUser], function (req, res) {
+		res.render('plugins/sso-github/deauth', {
+			service: constants.name,
 		});
-	};
-
-	GitHub.appendUserHashWhitelist = function (data, callback) {
-		data.whitelist.push('githubid');
-		setImmediate(callback, null, data);
-	};
-
-	GitHub.getAssociation = function(data, callback) {
-		User.getUserField(data.uid, 'githubid', function(err, githubid) {
-			if (err) {
-				return callback(err, data);
-			}
-
-			if (githubid) {
-				data.associations.push({
-					associated: true,
-					name: constants.name,
-					icon: constants.admin.icon,
-					deauthUrl: nconf.get('url') + '/deauth/github',
-				});
-			} else {
-				data.associations.push({
-					associated: false,
-					url: nconf.get('url') + '/auth/github',
-					name: constants.name,
-					icon: constants.admin.icon
-				});
-			}
-
-			callback(null, data);
-		})
-	};
-
-	GitHub.login = function(githubID, displayName, username, email, pictureUrl, callback) {
-		if (!email) {
-			email = username + '@users.noreply.github.com';
-		}
-
-		GitHub.getUidByGitHubID(githubID, function(err, uid) {
-			if (err) {
-				return callback(err);
-			}
-
-			if (uid) {
-				// Existing User
-				callback(null, {
-					uid: uid
-				});
-			} else {
-				// New User
-				var success = function(uid) {
-					function checkEmail(next) {
-						if (GitHub.settings.needToVerifyEmail === 'on') {
-							return next();
-						}
-						User.email.confirmByUid(uid, next);
-					}
-
-					function mergeUserData(next) {
-						async.waterfall([
-							async.apply(User.getUserFields, uid, ['picture', 'firstName', 'lastName', 'fullname']),
-							function(info, next) {
-								if (!info.picture && pictureUrl) { // set profile picture
-									User.setUserField(uid, 'uploadedpicture', pictureUrl);
-									User.setUserField(uid, 'picture', pictureUrl);
-								}
-
-								if (!info.fullname && displayName) {
-									User.setUserField(uid, 'fullname', displayName);
-								}
-								next();
-							}
-						], next);
-					}
-
-					// trust the email.
-					async.series([
-					  async.apply(User.setUserField, uid, 'githubid', githubID),
-					  async.apply(db.setObjectField, 'githubid:uid', githubID, uid),
-					  checkEmail,
-					  mergeUserData
-					], function (err) {
-					  callback(err, {
-					    uid: uid
-					  });
-					});
-				};
-
-				User.getUidByEmail(email, function(err, uid) {
-					if (!uid) {
-						// Abort user creation if registration via SSO is restricted
-						if (GitHub.settings.disableRegistration === 'on') {
-							return callback(new Error('[[error:sso-registration-disabled, GitHub]]'));
-						}
-
-						User.create({username: username, email: email}, function(err, uid) {
-							if (err !== null) {
-								callback(err);
-							} else {
-								success(uid);
-							}
-						});
-					} else {
-						success(uid); // Existing account -- merge
-					}
-				});
-			}
+	});
+	data.router.post('/deauth/github', [data.middleware.requireUser, data.middleware.applyCSRF], hostHelpers.tryRoute(async function (req, res) {
+		await GitHub.deleteUserData({
+			uid: req.user.uid,
 		});
-	};
-
-	GitHub.getUidByGitHubID = function(githubID, callback) {
-		db.getObjectField('githubid:uid', githubID, function(err, uid) {
-			if (err) {
-				callback(err);
-			} else {
-				callback(null, uid);
+		res.redirect(nconf.get('relative_path') + '/me/edit');
+	}));
+};
+
+GitHub.getStrategy = async function (strategies) {
+	const settings = await meta.settings.get('sso-github');
+	GitHub.settings = settings;
+
+	if (settings.id && settings.secret) {
+		passport.use(new GithubStrategy({
+			clientID: settings.id,
+			clientSecret: settings.secret,
+			callbackURL: nconf.get('url') + '/auth/github/callback',
+			passReqToCallback: true,
+			scope: ['user:email'], // fetches non-public emails as well
+		}, async function (req, token, tokenSecret, profile, done) {
+			try {
+				if (req.hasOwnProperty('user') && req.user.hasOwnProperty('uid') && req.user.uid > 0) {
+					// Save GitHub -specific information to the user
+					await User.setUserField(req.user.uid, 'githubid', profile.id);
+					await db.setObjectField('githubid:uid', profile.id, req.user.uid);
+					return done(null, req.user);
+				}
+
+				const email = Array.isArray(profile.emails) && profile.emails.length ? profile.emails[0].value : '';
+				const pictureUrl = Array.isArray(profile.photos) && profile.photos.length ? profile.photos[0].value : '';
+				const { queued, uid, message } = await GitHub.login(
+					req, profile.id, profile.displayName, profile.username, email, pictureUrl
+				);
+				if (queued) {
+					return done(null, false, { message });
+				}
+
+				done(null, { uid });
+			} catch (err) {
+				done(err);
 			}
-		});
-	};
+		}));
 
-	GitHub.addMenuItem = function(custom_header, callback) {
-		custom_header.authentication.push({
-			"route": constants.admin.route,
-			"icon": constants.admin.icon,
-			"name": constants.name
+		strategies.push({
+			name: 'github',
+			url: '/auth/github',
+			callbackURL: '/auth/github/callback',
+			icon: constants.admin.icon,
+			icons: {
+				normal: 'fa-brands fa-github',
+				square: 'fa-brands fa-github-square',
+			},
+			labels: {
+				login: '[[social:sign-in-with-github]]',
+				register: '[[social:sign-up-with-github]]',
+			},
+			color: '#25292f',
+			scope: 'user:email',
 		});
-
-		callback(null, custom_header);
-	};
-
-	GitHub.init = function(data, callback) {
-		const hostHelpers = require.main.require('./src/routes/helpers');
-
-		hostHelpers.setupAdminPageRoute(data.router, '/admin/plugins/sso-github', function (req, res) {
-			res.render('admin/plugins/sso-github', {
-				title: constants.name,
-				callbackURL: nconf.get('url') + '/auth/github/callback'
-			});
+	}
+
+	return strategies;
+};
+
+GitHub.appendUserHashWhitelist = function (data) {
+	data.whitelist.push('githubid');
+	return data;
+};
+
+GitHub.getAssociation = async function (data) {
+	const githubid = await User.getUserField(data.uid, 'githubid');
+	if (githubid) {
+		data.associations.push({
+			associated: true,
+			name: constants.name,
+			icon: constants.admin.icon,
+			deauthUrl: nconf.get('url') + '/deauth/github',
 		});
-
-		hostHelpers.setupPageRoute(data.router, '/deauth/github', [data.middleware.requireUser], function (req, res) {
-			res.render('plugins/sso-github/deauth', {
-				service: "GitHub",
-			});
+	} else {
+		data.associations.push({
+			associated: false,
+			url: nconf.get('url') + '/auth/github',
+			name: constants.name,
+			icon: constants.admin.icon,
 		});
-		data.router.post('/deauth/github', [data.middleware.requireUser, data.middleware.applyCSRF], hostHelpers.tryRoute(async function (req, res) {
-			await GitHub.deleteUserData({
-				uid: req.user.uid,
-			});
-			res.redirect(nconf.get('relative_path') + '/me/edit');
-		}));
+	}
+	return data;
+};
+
+GitHub.login = async function (req, githubID, displayName, username, email, pictureUrl) {
+	if (!email) {
+		email = username + '@users.noreply.github.com';
+	}
+
+	let uid = await GitHub.getUidByGitHubID(githubID);
+	if (uid) {
+		return { uid };
+	}
+
+	uid = await User.getUidByEmail(email);
+	if (uid) { // Link github account to existing user with same email
+		await Promise.all([
+			User.setUserField(uid, 'githubid', githubID),
+			db.setObjectField('githubid:uid', githubID, uid),
+		]);
+		return { uid };
+	}
+
+	// Abort user creation if registration via SSO is restricted
+	if (GitHub.settings.disableRegistration === 'on') {
+		throw new Error('[[error:sso-registration-disabled, GitHub]]');
+	}
+
+	return await User.createOrQueue(req, {
+		githubid: githubID,
+		username: username,
+		email: email,
+		fullname: displayName,
+		picture: pictureUrl,
+	}, {
+		emailVerification: GitHub.settings.needToVerifyEmail === 'on' ? 'send' : 'verify',
+	});
+};
+
+GitHub.addToApprovalQueue = async (hookData) => {
+	await saveGitHubSpecificData(hookData.data, hookData.userData);
+	return hookData;
+};
+
+GitHub.filterUserCreate = async (hookData) => {
+	await saveGitHubSpecificData(hookData.user, hookData.data);
+	return hookData;
+};
+
+async function saveGitHubSpecificData(targetObj, sourceObj) {
+	const { githubid, picture } = sourceObj;
+	if (githubid) {
+		const uid = await GitHub.getUidByGitHubID(githubid);
+		if (uid) {
+			throw new Error('[[error:sso-account-exists, GitHub]]');
+		}
+		targetObj.githubid = githubid;
+		if (picture) {
+			targetObj.picture = picture;
+			targetObj.uploadedpicture = picture;
+		}
+	}
+}
+
+GitHub.actionUserCreate = async (hookData) => {
+	const { uid } = hookData.user;
+	const githubid = await User.getUserField(uid, 'githubid');
+	if (githubid) {
+		await db.setObjectField('githubid:uid', githubid, uid);
+	}
+};
+
+GitHub.filterUserGetRegistrationQueue = async (hookData) => {
+	const { users } = hookData;
+	users.forEach((user) => {
+		if (user?.githubid) {
+			user.sso = {
+				icon: 'fa-brands fa-github',
+				name: constants.name,
+			};
+		}
+	});
+	return hookData;
+};
+
+GitHub.getUidByGitHubID = async function (githubID) {
+	const uid = await db.getObjectField('githubid:uid', githubID);
+	return uid;
+};
+
+GitHub.addMenuItem = function (custom_header) {
+	custom_header.authentication.push({
+		route: constants.admin.route,
+		icon: constants.admin.icon,
+		name: constants.name,
+	});
+	return custom_header;
+};
 
-		callback();
-	};
+GitHub.deleteUserData = async function (data) {
+	const { uid } = data;
+	const githubid = await User.getUserField(uid, 'githubid');
+	if (githubid) {
+		await db.deleteObjectField('githubid:uid', githubid);
+		await db.deleteObjectField('user:' + uid, 'githubid');
+	}
+};
 
-	GitHub.deleteUserData = async function(data) {
-		const { uid } = data;
-		const githubid = await User.getUserField(uid, 'githubid');
-		if (githubid) {
-			await db.deleteObjectField('githubid:uid', githubid);
-			await db.deleteObjectField('user:' + uid, 'githubid');
-		}
-	};
 
-	module.exports = GitHub;
-}(module));

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "nodebb-plugin-sso-github",
-  "version": "3.1.3",
+  "version": "3.2.0",
   "description": "NodeBB GitHub SSO",
   "main": "library.js",
   "repository": {
     "type": "git",
     "url": "https://github.com/julianlam/nodebb-plugin-sso-github"
   },
+  "scripts": {
+    "lint": "eslint ."
+  },
   "keywords": [
     "nodebb",
     "plugin",
@@ -45,7 +48,11 @@
   "dependencies": {
     "passport-github2": "^0.1.9"
   },
+  "devDependencies": {
+    "eslint": "10.0.2",
+    "eslint-config-nodebb": "^2.0.0"
+  },
   "nbbpm": {
-    "compatibility": "^4.0.0"
+    "compatibility": "^4.9.0"
   }
 }

package/plugin.json

@@ -1,19 +1,23 @@
-{
-	"id": "nodebb-plugin-sso-github",
-	"name": "NodeBB GitHub SSO",
-	"description": "NodeBB Plugin that allows users to login/register via their GitHub account.",
-	"url": "https://github.com/julianlam/nodebb-plugin-sso-github",
-	"library": "./library.js",
-	"hooks": [
-		{ "hook": "static:app.load", "method": "init" },
-		{ "hook": "filter:auth.init", "method": "getStrategy" },
-		{ "hook": "filter:auth.list", "method": "getAssociation" },
-		{ "hook": "filter:admin.header.build", "method": "addMenuItem" },
-		{ "hook": "static:user.delete", "method": "deleteUserData" },
-		{ "hook": "filter:user.whitelistFields", "method": "appendUserHashWhitelist" }
-	],
-	"templates": "./templates",
-	"modules": {
-		"../admin/plugins/sso-github.js": "static/lib/admin.js"
-	}
+{
+	"id": "nodebb-plugin-sso-github",
+	"name": "NodeBB GitHub SSO",
+	"description": "NodeBB Plugin that allows users to login/register via their GitHub account.",
+	"url": "https://github.com/julianlam/nodebb-plugin-sso-github",
+	"library": "./library.js",
+	"hooks": [
+		{ "hook": "static:app.load", "method": "init" },
+		{ "hook": "filter:auth.init", "method": "getStrategy" },
+		{ "hook": "filter:auth.list", "method": "getAssociation" },
+		{ "hook": "filter:admin.header.build", "method": "addMenuItem" },
+		{ "hook": "static:user.delete", "method": "deleteUserData" },
+		{ "hook": "filter:user.whitelistFields", "method": "appendUserHashWhitelist" },
+		{ "hook": "filter:user.addToApprovalQueue", "method": "addToApprovalQueue" },
+		{ "hook": "filter:user.create", "method": "filterUserCreate" },
+		{ "hook": "action:user.create", "method": "actionUserCreate" },
+		{ "hook": "filter:user.getRegistrationQueue", "method": "filterUserGetRegistrationQueue" }
+	],
+	"templates": "./templates",
+	"modules": {
+		"../admin/plugins/sso-github.js": "static/lib/admin.js"
+	}
 }

package/static/lib/admin.js

@@ -1,22 +1,21 @@
-define('admin/plugins/sso-github', ['settings', 'alerts'], function(Settings, alerts) {
-	'use strict';
-	/* globals $, app, socket, require */
+'use strict';
 
-	var ACP = {};
+define('admin/plugins/sso-github', ['settings', 'alerts'], function (Settings, alerts) {
+	const ACP = {};
 
-	ACP.init = function() {
+	ACP.init = function () {
 		Settings.load('sso-github', $('.sso-github-settings'));
 
-		$('#save').on('click', function() {
-			Settings.save('sso-github', $('.sso-github-settings'), function() {
+		$('#save').on('click', function () {
+			Settings.save('sso-github', $('.sso-github-settings'), function () {
 				alerts.alert({
 					type: 'success',
 					alert_id: 'sso-github-saved',
 					title: 'Settings Saved',
 					message: 'Please reload your NodeBB to apply these settings',
-					clickfn: function() {
+					clickfn: function () {
 						socket.emit('admin.reload');
-					}
+					},
 				});
 			});
 		});

package/templates/admin/plugins/sso-github.tpl

@@ -1,46 +1,46 @@
-<div class="acp-page-container">
-	<!-- IMPORT admin/partials/settings/header.tpl -->
-
-	<div class="row m-0">
-		<div id="spy-container" class="col-12 px-0 mb-4" tabindex="0">
-			<div class="alert alert-info">
-				Register a new <strong>GitHub Application</strong> via
-				<a href="https://github.com/settings/developers">Developer Applications</a> and then paste your application details here.
-			</div>
-			<form class="sso-github-settings">
-				<div class="mb-3">
-					<label for="id">Client ID</label>
-					<input type="text" name="id" title="Client ID" class="form-control" placeholder="Client ID">
-				</div>
-				<div class="mb-3">
-					<label for="secret">Client Secret</label>
-					<input type="text" name="secret" title="Client Secret" class="form-control" placeholder="Client Secret" />
-				</div>
-				<div class="mb-3 alert alert-warning">
-					<label for="callback">Your NodeBB&apos;s "Authorization callback URL"</label>
-					<input type="text" id="callback" title="Authorization callback URL" class="form-control" value="{callbackURL}" readonly />
-					<p class="form-text">
-						Ensure that this value is set in your GitHub application&apos;s settings
-					</p>
-				</div>
-				<div class="form-check">
-					<input type="checkbox" class="form-check-input" id="disableRegistration" name="disableRegistration" />
-					<label for="disableRegistration" class="form-check-label">
-						Disable user registration via SSO
-					</label>
-				</div>
-				<div class="form-check">
-					<input type="checkbox" class="form-check-input" id="needToVerifyEmail" name="needToVerifyEmail" />
-					<label for="needToVerifyEmail" class="form-check-label">
-						Need user to verify email
-					</label>
-				</div>
-				<p class="form-text">
-					Restricting registration means that only registered users can associate their account with this SSO strategy.
-					This restriction is useful if you have uesrs bypassing registration controls by using social media accounts, or
-					if you wish to use the NodeBB registration queue.
-				</p>
-			</form>
-		</div>
-	</div>
-</div>
+<div class="acp-page-container">
+	<!-- IMPORT admin/partials/settings/header.tpl -->
+
+	<div class="row m-0">
+		<div id="spy-container" class="col-12 px-0 mb-4" tabindex="0">
+			<div class="alert alert-info">
+				Register a new <strong>GitHub Application</strong> via
+				<a href="https://github.com/settings/developers">Developer Applications</a> and then paste your application details here.
+			</div>
+			<form class="sso-github-settings">
+				<div class="mb-3">
+					<label for="id">Client ID</label>
+					<input type="text" name="id" title="Client ID" class="form-control" placeholder="Client ID">
+				</div>
+				<div class="mb-3">
+					<label for="secret">Client Secret</label>
+					<input type="text" name="secret" title="Client Secret" class="form-control" placeholder="Client Secret" />
+				</div>
+				<div class="mb-3 alert alert-warning">
+					<label for="callback">Your NodeBB&apos;s "Authorization callback URL"</label>
+					<input type="text" id="callback" title="Authorization callback URL" class="form-control" value="{callbackURL}" readonly />
+					<p class="form-text">
+						Ensure that this value is set in your GitHub application&apos;s settings
+					</p>
+				</div>
+				<div class="form-check">
+					<input type="checkbox" class="form-check-input" id="disableRegistration" name="disableRegistration" />
+					<label for="disableRegistration" class="form-check-label">
+						Disable user registration via SSO
+					</label>
+				</div>
+				<div class="form-check">
+					<input type="checkbox" class="form-check-input" id="needToVerifyEmail" name="needToVerifyEmail" />
+					<label for="needToVerifyEmail" class="form-check-label">
+						Need user to verify email
+					</label>
+				</div>
+				<p class="form-text">
+					Restricting registration means that only registered users can associate their account with this SSO strategy.
+					This restriction is useful if you have uesrs bypassing registration controls by using social media accounts, or
+					if you wish to use the NodeBB registration queue.
+				</p>
+			</form>
+		</div>
+	</div>
+</div>

package/templates/plugins/sso-github/deauth.tpl

@@ -1,17 +1,17 @@
-<div class="col-xs-12 col-sm-8 col-sm-offset-2 col-md-6 col-md-offset-3">
-	<div class="panel panel-default">
-		<div class="panel-heading">
-			<h3 class="panel-title">[[user:sso.dissociate-confirm-title]]</h3>
-		</div>
-		<div class="panel-body">
-			[[user:sso.dissociate-confirm, {service}]]
-
-			<hr>
-
-			<form method="post">
-				<input type="hidden" name="_csrf" value="{config.csrf_token}" />
-				<button class="btn btn-danger">[[user:sso.dissociate]]</button>
-			</form>
-		</div>
-	</div>
+<div class="col-xs-12 col-sm-8 col-sm-offset-2 col-md-6 col-md-offset-3">
+	<div class="panel panel-default">
+		<div class="panel-heading">
+			<h3 class="panel-title">[[user:sso.dissociate-confirm-title]]</h3>
+		</div>
+		<div class="panel-body">
+			[[user:sso.dissociate-confirm, {service}]]
+
+			<hr>
+
+			<form method="post">
+				<input type="hidden" name="_csrf" value="{config.csrf_token}" />
+				<button class="btn btn-danger">[[user:sso.dissociate]]</button>
+			</form>
+		</div>
+	</div>
 </div>