1 import express from 'express'
2 import { UserRole } from '@shared/models'
3 import { MOAuthToken, MUser } from '../models'
5 export type RegisterServerAuthOptions = RegisterServerAuthPassOptions | RegisterServerAuthExternalOptions
7 export interface RegisterServerAuthenticatedResult {
14 export interface RegisterServerExternalAuthenticatedResult extends RegisterServerAuthenticatedResult {
19 interface RegisterServerAuthBase {
20 // Authentication name (a plugin can register multiple auth strategies)
23 // Called by PeerTube when a user from your plugin logged out
24 // Returns a redirectUrl sent to the client or nothing
25 onLogout?(user: MUser, req: express.Request): Promise<string>
27 // Your plugin can hook PeerTube access/refresh token validity
28 // So you can control for your plugin the user session lifetime
29 hookTokenValidity?(options: { token: MOAuthToken, type: 'access' | 'refresh' }): Promise<{ valid: boolean }>
32 export interface RegisterServerAuthPassOptions extends RegisterServerAuthBase {
33 // Weight of this authentication so PeerTube tries the auth methods in DESC weight order
36 // Used by PeerTube to login a user
37 // Returns null if the login failed, or { username, email } on success
41 }): Promise<RegisterServerAuthenticatedResult | null>
44 export interface RegisterServerAuthExternalOptions extends RegisterServerAuthBase {
45 // Will be displayed in a block next to the login form
46 authDisplayName: () => string
48 onAuthRequest: (req: express.Request, res: express.Response) => void
51 export interface RegisterServerAuthExternalResult {
52 userAuthenticated (options: RegisterServerExternalAuthenticatedResult): void