Skip to content

ActivityPub-federated video streaming platform using P2P directly in your web browser

Support req.cookies for onLogout plugin helpers

Chocobozzz740384889c08
diff --git a/packages/server-commands/src/users/login-command.ts b/packages/server-commands/src/users/login-command.ts
index b3796a89bb..f876781ac9 100644
--- a/packages/server-commands/src/users/login-command.ts
+++ b/packages/server-commands/src/users/login-command.ts
@@ -79,6 +79,7 @@ export class LoginCommand extends AbstractCommand {
logout (
options: OverrideCommandOptions & {
token: string
+ headers?: { [name: string]: string }
}
) {
const path = '/api/v1/users/revoke-token'
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.js
index 65aed82c83..09f07da563 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
@@ -35,7 +35,9 @@ async function register ({
})
},
onLogout: (user, req) => {
- return 'https://example.com/redirectUrl?access_token=' + req.headers['authorization'].split(' ')[1]
+ return 'https://example.com/redirectUrl' +
+ '?access_token=' + req.headers['authorization'].split(' ')[1] +
+ '&session_id=' + req.cookies['session_id']
}
})
}
diff --git a/packages/tests/src/plugins/external-auth.ts b/packages/tests/src/plugins/external-auth.ts
index 3466c8f714..94105435f5 100644
--- a/packages/tests/src/plugins/external-auth.ts
+++ b/packages/tests/src/plugins/external-auth.ts
@@ -444,7 +444,7 @@ describe('Test external auth plugins', function () {
expect(redirectUrl).to.equal('https://example.com/redirectUrl')
})
- it('Should call the plugin\'s onLogout method with the request', async function () {
+ it('Should call the plugin\'s onLogout method with the request headers and cookies', async function () {
const resLogin = await loginExternal({
server,
npmName: 'test-external-auth-three',
@@ -452,8 +452,12 @@ describe('Test external auth plugins', function () {
username: 'cid'
})
- const { redirectUrl } = await server.login.logout({ token: resLogin.access_token })
- expect(redirectUrl).to.equal('https://example.com/redirectUrl?access_token=' + resLogin.access_token)
+ const { redirectUrl } = await server.login.logout({
+ token: resLogin.access_token,
+ headers: { cookie: 'session_id=toto' }
+ })
+
+ expect(redirectUrl).to.equal('https://example.com/redirectUrl?access_token=' + resLogin.access_token + '&session_id=toto')
})
it('Should redirect to an external site after login if externalRedirectUri is set', async function () {
diff --git a/server/core/controllers/api/users/token.ts b/server/core/controllers/api/users/token.ts
index 9c83a9656a..155573eb39 100644
--- a/server/core/controllers/api/users/token.ts
+++ b/server/core/controllers/api/users/token.ts
@@ -22,6 +22,7 @@ import {
} from '@server/middlewares/index.js'
import { manageTokenSessionsValidator, revokeTokenSessionValidator } from '@server/middlewares/validators/token.js'
import { OAuthTokenModel } from '@server/models/oauth/oauth-token.js'
+import cookieParser from 'cookie-parser'
import express from 'express'
const tokensRouter = express.Router()
@@ -42,6 +43,8 @@ tokensRouter.post(
'/revoke-token',
openapiOperationDoc({ operationId: 'revokeOAuthToken' }),
authenticate,
+ // Ensure cookies are available for auth plugins `onLogout`
+ cookieParser(),
asyncMiddleware(handleTokenRevocation)
)
@@ -63,6 +66,8 @@ tokensRouter.post(
authenticate,
asyncMiddleware(manageTokenSessionsValidator),
asyncMiddleware(revokeTokenSessionValidator),
+ // The API router is mounted before the global cookie parser, so parse them here for auth plugins `onLogout`
+ cookieParser(),
asyncMiddleware(revokeTokenSession)
)
diff --git a/support/doc/plugins/guide.md b/support/doc/plugins/guide.md
index 9ccfae6bcf..e5b932ef69 100644
--- a/support/doc/plugins/guide.md
+++ b/support/doc/plugins/guide.md
@@ -336,7 +336,8 @@ function register (...) {
getWeight: () => 60,
// Optional function called by PeerTube when the user clicked on the logout button
- onLogout: user => {
+ // The logout request is also provided, so you can read its headers or its cookies (PeerTube >= 8.3)
+ onLogout: (user, req) => {
console.log('User %s logged out.', user.username')
},