Possibility to configure an OpenID Connect provider on the instance level WIP (#128).
This commit is contained in:
@ -12,6 +12,13 @@ import { URL } from 'url'
|
||||
|
||||
type UserInfoField = 'username' | 'last_name' | 'first_name' | 'nickname'
|
||||
|
||||
interface UnserializedToken {
|
||||
jid: string
|
||||
password: string
|
||||
nickname: string
|
||||
expire: Date
|
||||
}
|
||||
|
||||
let singleton: ExternalAuthOIDC | undefined
|
||||
|
||||
async function getRandomBytes (size: number): Promise<Buffer> {
|
||||
@ -328,16 +335,28 @@ class ExternalAuthOIDC {
|
||||
nickname ??= username
|
||||
|
||||
// Computing the JID (can throw Error/ExternalAuthenticationError).
|
||||
const jid = this.computeJID(username)
|
||||
const jid = this.computeJID(username).toString(false)
|
||||
|
||||
// Computing a random Password
|
||||
// (16 bytes in hex => 32 chars (but only numbers and abdcef), 256^16 should be enougth).
|
||||
const password = (await getRandomBytes(16)).toString('hex')
|
||||
|
||||
return {
|
||||
jid: jid.toString(false),
|
||||
// Now we will encrypt jid + password, and return it to the browser.
|
||||
// The browser will be able to use this encrypted data with the api/configuration/room API.
|
||||
const tokenContent: UnserializedToken = {
|
||||
jid,
|
||||
password,
|
||||
nickname,
|
||||
password
|
||||
// expires in 12 hours (user will just have to do the whole process again).
|
||||
expire: (new Date(Date.now() + 12 * 3600 * 1000))
|
||||
}
|
||||
const token = await this.encrypt(JSON.stringify(tokenContent))
|
||||
|
||||
return {
|
||||
jid,
|
||||
nickname,
|
||||
password,
|
||||
token
|
||||
}
|
||||
}
|
||||
|
||||
@ -365,6 +384,54 @@ class ExternalAuthOIDC {
|
||||
return decipher.update(encrypted as any, outputEncoding, inputEncoding) + decipher.final(inputEncoding)
|
||||
}
|
||||
|
||||
/**
|
||||
* Decrypt and unserialize a token associated to a previous authentication.
|
||||
* @param token the token stored by the browser.
|
||||
* @return authentication informations, or null if:
|
||||
* if the token is expired, if the token is invalid.
|
||||
* Can also fail (and return null) when server was restarted, or settings saved, as the secret key may have changed
|
||||
* (this is not an issue, users just have to start the process again).
|
||||
*/
|
||||
public async unserializeToken (token: string): Promise<UnserializedToken | null> {
|
||||
try {
|
||||
const decrypted = await this.decrypt(token)
|
||||
const o = JSON.parse(decrypted) // can fail
|
||||
|
||||
if (typeof o !== 'object') {
|
||||
throw new Error('Invalid encrypted data')
|
||||
}
|
||||
if (typeof o.jid !== 'string' || o.jid === '') {
|
||||
throw new Error('No jid')
|
||||
}
|
||||
if (typeof o.password !== 'string' || o.password === '') {
|
||||
throw new Error('No password')
|
||||
}
|
||||
if (typeof o.nickname !== 'string' || o.nickname === '') {
|
||||
throw new Error('No nickname')
|
||||
}
|
||||
|
||||
const expire = new Date(Date.parse(o.expire))
|
||||
if (!(expire instanceof Date) || isNaN(expire.getTime())) {
|
||||
throw new Error('Invalid expire date')
|
||||
}
|
||||
|
||||
if (expire <= new Date()) {
|
||||
throw new Error('Token expired')
|
||||
}
|
||||
|
||||
return {
|
||||
jid: o.jid,
|
||||
password: o.password,
|
||||
nickname: o.nickname,
|
||||
expire
|
||||
}
|
||||
} catch (err) {
|
||||
// This is not an error, as there are many legitimate cases (token expired, ...)
|
||||
this.logger.info('Cant unserialize the token: ' + (err as string))
|
||||
return null
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an attribute from the userInfos.
|
||||
* @param userInfos userInfos returned by the remote OIDC Provider
|
||||
|
@ -2,6 +2,7 @@ interface ExternalAccountInfos {
|
||||
nickname: string
|
||||
jid: string
|
||||
password: string
|
||||
token: string
|
||||
// TODO: avatar
|
||||
}
|
||||
|
||||
|
@ -4,6 +4,7 @@ import { asyncMiddleware } from '../../middlewares/async'
|
||||
import { getProsodyDomain } from '../../prosody/config/domain'
|
||||
import { prosodyRegisterUser, prosodyCheckUserPassword, prosodyUserRegistered } from '../../prosody/auth'
|
||||
import { getUserNickname } from '../../helpers'
|
||||
import { ExternalAuthOIDC } from '../../external-auth/oidc'
|
||||
|
||||
/**
|
||||
* Instanciate the authentication API.
|
||||
@ -14,6 +15,31 @@ async function initAuthApiRouter (options: RegisterServerOptions, router: Router
|
||||
router.get('/auth', asyncMiddleware(
|
||||
async (req: Request, res: Response, _next: NextFunction) => {
|
||||
const user = await options.peertubeHelpers.user.getAuthUser(res)
|
||||
|
||||
if (!user) {
|
||||
// No Peertube user, but perhaps an external authentication?
|
||||
const token = req.header('X-Peertube-Plugin-Livechat-OIDC-Token')
|
||||
if (token) {
|
||||
try {
|
||||
const oidc = ExternalAuthOIDC.singleton()
|
||||
if (await oidc.isOk()) {
|
||||
const unserializedToken = await oidc.unserializeToken(token)
|
||||
if (unserializedToken) {
|
||||
res.status(200).json({
|
||||
jid: unserializedToken.jid,
|
||||
password: unserializedToken.password,
|
||||
nickname: unserializedToken.nickname
|
||||
})
|
||||
return
|
||||
}
|
||||
}
|
||||
} catch (err) {
|
||||
options.peertubeHelpers.logger.error(err)
|
||||
// Just continue with the normal flow.
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (!user) {
|
||||
res.sendStatus(403)
|
||||
return
|
||||
|
@ -71,7 +71,8 @@ async function initOIDCRouter (options: RegisterServerOptions): Promise<Router>
|
||||
{},
|
||||
externalAccountInfos,
|
||||
{
|
||||
password: '**removed**' // removing the password from logs!
|
||||
password: '**removed**', // removing the password from logs!
|
||||
token: '**removed**' // same as password
|
||||
}
|
||||
)
|
||||
))
|
||||
@ -85,8 +86,7 @@ async function initOIDCRouter (options: RegisterServerOptions): Promise<Router>
|
||||
|
||||
res.send(popupResultHTML({
|
||||
ok: true,
|
||||
jid: externalAccountInfos.jid,
|
||||
password: externalAccountInfos.password
|
||||
token: externalAccountInfos.token
|
||||
}))
|
||||
} catch (err) {
|
||||
logger.error('[oidc router] Failed to process the OIDC callback: ' + (err as string))
|
||||
|
Reference in New Issue
Block a user