ActivityPub-federated video streaming platform using P2P directly in your web browser
Allow auth plugins to redirect to external url (#7179)
Jakob Meierfc986076c98b
diff --git a/packages/tests/fixtures/peertube-plugin-test-external-auth-three/main.js b/packages/tests/fixtures/peertube-plugin-test-external-auth-three/main.jsindex 30cedccc60..65aed82c83 100644--- a/packages/tests/fixtures/peertube-plugin-test-external-auth-three/main.js+++ b/packages/tests/fixtures/peertube-plugin-test-external-auth-three/main.js@@ -39,6 +39,24 @@ async function register ({}})}++ const result = registerExternalAuth({+ authName: 'external-auth-9',+ authDisplayName: () => 'External Auth 9',+ onAuthRequest: (req, res) => {+ result.userAuthenticated({+ req,+ res,+ username: 'cid',+ email: '[email protected]',+ displayName: 'Cid Marquez',+ externalRedirectUri: 'https://external.com/some/redirect/path'+ })+ },+ onLogout: (user, req) => {+ return 'https://example.com/redirectUrl'+ }+ })}async function unregister () {diff --git a/packages/tests/src/plugins/external-auth.ts b/packages/tests/src/plugins/external-auth.tsindex d5195ae155..8bb624ebbe 100644--- a/packages/tests/src/plugins/external-auth.ts+++ b/packages/tests/src/plugins/external-auth.ts@@ -77,7 +77,7 @@ describe('Test external auth plugins', function () {const config = await server.config.getConfig()const auths = config.plugin.registeredExternalAuths- expect(auths).to.have.lengthOf(9)+ expect(auths).to.have.lengthOf(10)const auth2 = auths.find((a) => a.authName === 'external-auth-2')expect(auth2).to.exist@@ -319,7 +319,7 @@ describe('Test external auth plugins', function () {const config = await server.config.getConfig()const auths = config.plugin.registeredExternalAuths- expect(auths).to.have.lengthOf(8)+ expect(auths).to.have.lengthOf(9)const auth1 = auths.find(a => a.authName === 'external-auth-2')expect(auth1).to.not.exist@@ -400,7 +400,7 @@ describe('Test external auth plugins', function () {const config = await server.config.getConfig()const auths = config.plugin.registeredExternalAuths- expect(auths).to.have.lengthOf(7)+ expect(auths).to.have.lengthOf(8)const auth2 = auths.find((a) => a.authName === 'external-auth-2')expect(auth2).to.not.exist@@ -433,4 +433,29 @@ describe('Test external auth plugins', function () {const { redirectUrl } = await server.login.logout({ token: resLogin.access_token })expect(redirectUrl).to.equal('https://example.com/redirectUrl?access_token=' + resLogin.access_token)})++ it('Should redirect to an external site after login if externalRedirectUri is set', async function () {++ const res = await server.plugins.getExternalAuth({+ npmName: 'test-external-auth-three',+ npmVersion: '0.0.1',+ authName: 'external-auth-9',+ query: {+ username: 'cid'+ },+ expectedStatus: HttpStatusCode.FOUND_302+ })++ const location = res.header.location+ expect(location.startsWith('https://external.com/some/redirect/path?')).to.be.true++ const searchParams = decodeQueryString(location)++ expect(searchParams.externalAuthToken).to.exist+ expect(searchParams.username).to.equal('cid')++ externalAuthToken = searchParams.externalAuthToken as string++ await server.login.loginUsingExternalToken({ username: 'cid', externalAuthToken, expectedStatus: HttpStatusCode.OK_200 })+ })})diff --git a/server/core/lib/auth/external-auth.ts b/server/core/lib/auth/external-auth.tsindex e1879aa013..35fecb860c 100644--- a/server/core/lib/auth/external-auth.ts+++ b/server/core/lib/auth/external-auth.ts@@ -45,7 +45,7 @@ async function onExternalUserAuthenticated (options: {return}- const { res } = authResult+ const { res, externalRedirectUri } = authResultif (!isAuthResultValid(npmName, authName, authResult)) {res.redirect('/login?externalAuthError=true')@@ -76,7 +76,14 @@ async function onExternalUserAuthenticated (options: {}}- res.redirect(`/login?externalAuthToken=${bypassToken}&username=${user.username}`)+ if (externalRedirectUri) {+ const url = new URL(externalRedirectUri)+ url.searchParams.set('externalAuthToken', bypassToken)+ url.searchParams.set('username', user.username)+ res.redirect(url.href)+ } else {+ res.redirect(`/login?externalAuthToken=${bypassToken}&username=${user.username}`)+ }}async function getAuthNameFromRefreshGrant (refreshToken?: string) {diff --git a/server/core/types/plugins/register-server-auth.model.ts b/server/core/types/plugins/register-server-auth.model.tsindex ea22d36f96..b955f6183a 100644--- a/server/core/types/plugins/register-server-auth.model.ts+++ b/server/core/types/plugins/register-server-auth.model.ts@@ -33,6 +33,8 @@ export interface RegisterServerAuthenticatedResult {export interface RegisterServerExternalAuthenticatedResult extends RegisterServerAuthenticatedResult {req: express.Requestres: express.Response+ // Redirect the user to this external URI after the external auth has been verified.+ externalRedirectUri?: string}interface RegisterServerAuthBase {