Update passport init with saved settings & check if OIDC is configured

This commit is contained in:
advplyr 2022-02-07 17:52:50 -06:00
parent adae905953
commit 9e913b5e17
4 changed files with 97 additions and 97 deletions

View File

@ -1,7 +1,7 @@
const bcrypt = require('bcryptjs') const bcrypt = require('bcryptjs')
const jwt = require('jsonwebtoken') const jwt = require('jsonwebtoken')
const passport = require('passport')
const Logger = require('./Logger') const Logger = require('./Logger')
const User = require('./objects/User')
class Auth { class Auth {
constructor(db) { constructor(db) {
@ -210,5 +210,34 @@ class Auth {
}) })
} }
} }
async handleOIDCVerification(issuer, profile, cb) {
Logger.debug(`[Auth] handleOIDCVerification ${issuer}`)
let user = this.db.users.find(u => u.id === profile.id)
if (!user && this.db.SSOSettings.createNewUser) {
// create a user
let account = {}
account.id = profile.id
account.username = profile.username
account.isActive = true
account.type = "guest"
account.permissions = this.db.SSOSettings.getNewUserPermissions()
account.pash = await this.hashPass(getId(profile.id))
account.token = await this.generateAccessToken({ userId: account.id })
account.createdAt = Date.now()
user = new User(account)
const success = await this.db.insertEntity('user', user)
if (!success) {
cb('Failed to save new user')
}
}
if (!user || !user.isActive) {
Logger.debug(`[Auth] Failed login attempt`)
cb("Invalid user or password")
return
}
cb(null, user)
}
} }
module.exports = Auth module.exports = Auth

View File

@ -7,8 +7,8 @@ const SocketIO = require('socket.io')
const fs = require('fs-extra') const fs = require('fs-extra')
const fileUpload = require('express-fileupload') const fileUpload = require('express-fileupload')
const rateLimit = require('express-rate-limit') const rateLimit = require('express-rate-limit')
const passport = require('passport'); const passport = require('passport')
const OidcStrategy = require('passport-openidconnect').Strategy; const OidcStrategy = require('passport-openidconnect').Strategy
const { version } = require('../package.json') const { version } = require('../package.json')
@ -32,7 +32,6 @@ const RssFeeds = require('./RssFeeds')
const DownloadManager = require('./DownloadManager') const DownloadManager = require('./DownloadManager')
const CoverController = require('./CoverController') const CoverController = require('./CoverController')
const CacheManager = require('./CacheManager') const CacheManager = require('./CacheManager')
const User = require('./objects/User')
class Server { class Server {
constructor(PORT, UID, GID, CONFIG_PATH, METADATA_PATH, AUDIOBOOK_PATH) { constructor(PORT, UID, GID, CONFIG_PATH, METADATA_PATH, AUDIOBOOK_PATH) {
@ -44,10 +43,6 @@ class Server {
this.AudiobookPath = Path.normalize(AUDIOBOOK_PATH) this.AudiobookPath = Path.normalize(AUDIOBOOK_PATH)
this.MetadataPath = Path.normalize(METADATA_PATH) this.MetadataPath = Path.normalize(METADATA_PATH)
console.info(this.ConfigPath)
console.info(this.MetadataPath)
console.info(this.AudiobookPath)
fs.ensureDirSync(CONFIG_PATH, 0o774) fs.ensureDirSync(CONFIG_PATH, 0o774)
fs.ensureDirSync(METADATA_PATH, 0o774) fs.ensureDirSync(METADATA_PATH, 0o774)
fs.ensureDirSync(AUDIOBOOK_PATH, 0o774) fs.ensureDirSync(AUDIOBOOK_PATH, 0o774)
@ -74,54 +69,6 @@ class Server {
this.io = null this.io = null
this.clients = {} this.clients = {}
passport.serializeUser((user, next) => {
next(null, user);
});
passport.deserializeUser((obj, next) => {
next(null, obj);
});
passport.use(new OidcStrategy({
issuer: process.env.OIDC_ISSUER,
authorizationURL: process.env.OIDC_AUTHORIZATION_URL,
tokenURL: process.env.OIDC_TOKEN_URL,
userInfoURL: process.env.OIDC_USER_INFO_URL,
clientID: process.env.OIDC_CLIENT_ID,
clientSecret: process.env.OIDC_CLIENT_SECRET,
callbackURL: '/oidc/callback',
scope: "openid email profile"
}, async (issuer, profile, cb) => {
let user = this.db.users.find(u => u.id === profile.id)
if (!user) {
// create a user
let account = {}
account.id = profile.id
account.username = profile.username
account.type = "guest"
account.permissions = {
download: false,
update: false,
delete: false,
upload: false,
accessAllLibraries: false
}
account.pash = await this.auth.hashPass(getId(profile.id))
account.token = await this.auth.generateAccessToken({ userId: account.id })
account.createdAt = Date.now()
user = new User(account)
const success = await this.db.insertEntity('user', user)
if (!success) {
cb('Failed to save new user')
}
}
if (!user || !user.isActive) {
Logger.debug(`[Auth] Failed login attempt`)
cb("Invalid user or password")
return
}
cb(null, user)
})
)
} }
get audiobooks() { get audiobooks() {
@ -186,6 +133,26 @@ class Server {
this.watcher.initWatcher(this.libraries) this.watcher.initWatcher(this.libraries)
this.watcher.on('files', this.filesChanged.bind(this)) this.watcher.on('files', this.filesChanged.bind(this))
this.passportInit()
}
passportInit() {
if (this.db.SSOSettings.isOIDCConfigured) {
Logger.debug(`[Server] passportInit OIDC is configured - init`)
passport.serializeUser((user, next) => {
next(null, user);
})
passport.deserializeUser((obj, next) => {
next(null, obj);
})
// Initialize passport OIDC verification
passport.use(new OidcStrategy(this.db.SSOSettings.getOIDCSettings(), this.auth.handleOIDCVerification))
} else {
Logger.debug(`[Server] passportInit OIDC not configured`)
}
} }
async start() { async start() {
@ -298,7 +265,7 @@ class Server {
app.get("/oidc/callback", app.get("/oidc/callback",
passport.authenticate('openidconnect', { failureRedirect: '/oidc/login', failureMessage: true }), passport.authenticate('openidconnect', { failureRedirect: '/oidc/login', failureMessage: true }),
async (req, res) => { async (req, res) => {
const token = this.auth.generateAccessToken({userId: req.user.id}) const token = this.auth.generateAccessToken({ userId: req.user.id })
res.cookie('token', token, { httpOnly: true /* TODO: Set secure: true */ }); res.cookie('token', token, { httpOnly: true /* TODO: Set secure: true */ });
res.cookie('sso', true, { httpOnly: false /* TODO: Set secure: true */ }); res.cookie('sso', true, { httpOnly: false /* TODO: Set secure: true */ });

View File

@ -1,6 +1,6 @@
const { CoverDestination, BookCoverAspectRatio, BookshelfView } = require('../utils/constants')
const Logger = require('../Logger') const Logger = require('../Logger')
const User = require('./User') const User = require('./User')
const { isObject } = require('../utils')
const defaultSettings = { const defaultSettings = {
oidc: { oidc: {
@ -13,57 +13,61 @@ const defaultSettings = {
callbackURL: "/oidc/callback", callbackURL: "/oidc/callback",
scope: "openid email profile" scope: "openid email profile"
}, },
user: {
createNewUser: false, createNewUser: false,
isActive: true, userPermissions: User.getDefaultUserPermissions('guest')
userSettings: {
mobileOrderBy: 'recent',
mobileOrderDesc: true,
mobileFilterBy: 'all',
orderBy: 'book.title',
orderDesc: false,
filterBy: 'all',
playbackRate: 1,
bookshelfCoverSize: 120,
collapseSeries: false
},
permissions: {
download: false,
update: false,
delete: false,
upload: false,
accessAllLibraries: false
}
}
} }
class SSOSettings { class SSOSettings {
constructor(settings = defaultSettings) { constructor(settings = defaultSettings) {
this.id = 'sso-settings' this.id = 'sso-settings'
this.oidc = { ...settings.oidc } this.oidc = { ...settings.oidc }
this.user = { ...settings.user } this.createNewUser = !!settings.createNewUser
this.userPermissions = { ...settings.userPermissions }
}
get isOIDCConfigured() {
// Check required OIDC settings are set
return !['issue', 'authorizationURL', 'tokenURL', 'clientID', 'clientSecret'].some(key => !this.oidc[key])
} }
toJSON() { toJSON() {
return { return {
id: this.id, id: this.id,
oidc: { ...this.oidc }, oidc: { ...this.oidc },
user: { ...this.user } createNewUser: this.createNewUser,
userPermissions: { ...this.userPermissions }
} }
} }
update(payload) { update(payload) {
let hasUpdates = false let hasUpdates = false
for (const key in payload) { for (const key in payload) {
for (const setting in payload) { if (isObject(payload[key])) {
for (const setting in payload[key]) {
if (!this[key] || this[key][setting] === payload[key][setting]) { if (!this[key] || this[key][setting] === payload[key][setting]) {
continue continue
} }
this[key][setting] = payload[key][setting] this[key][setting] = payload[key][setting]
hasUpdates = true hasUpdates = true
} }
} else if (this[key] !== undefined && this[key] !== payload[key]) {
this[key] = payload[key]
hasUpdates = true
}
} }
return hasUpdates return hasUpdates
} }
getNewUserPermissions() {
return {
...this.userPermissions
}
}
getOIDCSettings() {
return {
...this.oidc
}
}
} }
module.exports = SSOSettings module.exports = SSOSettings

View File

@ -46,7 +46,7 @@ class User {
return !!this.pash && !!this.pash.length return !!this.pash && !!this.pash.length
} }
getDefaultUserSettings() { static getDefaultUserSettings() {
return { return {
mobileOrderBy: 'recent', mobileOrderBy: 'recent',
mobileOrderDesc: true, mobileOrderDesc: true,
@ -60,12 +60,12 @@ class User {
} }
} }
getDefaultUserPermissions() { static getDefaultUserPermissions(type) {
return { return {
download: true, download: type !== 'guest',
update: true, update: type !== 'guest',
delete: this.type === 'root', delete: type === 'root',
upload: this.type === 'root' || this.type === 'admin', upload: type === 'root' || type === 'admin',
accessAllLibraries: true accessAllLibraries: true
} }
} }
@ -152,8 +152,8 @@ class User {
this.isLocked = user.type === 'root' ? false : !!user.isLocked this.isLocked = user.type === 'root' ? false : !!user.isLocked
this.lastSeen = user.lastSeen || null this.lastSeen = user.lastSeen || null
this.createdAt = user.createdAt || Date.now() this.createdAt = user.createdAt || Date.now()
this.settings = user.settings || this.getDefaultUserSettings() this.settings = user.settings || User.getDefaultUserSettings()
this.permissions = user.permissions || this.getDefaultUserPermissions() this.permissions = user.permissions || User.getDefaultUserPermissions(this.type)
// Upload permission added v1.1.13, make sure root user has upload permissions // Upload permission added v1.1.13, make sure root user has upload permissions
if (this.type === 'root' && !this.permissions.upload) this.permissions.upload = true if (this.type === 'root' && !this.permissions.upload) this.permissions.upload = true