Add ability for auth plugins to hook tokens validity

[github/Chocobozzz/PeerTube.git] / shared / models / plugins / register-server-auth.model.ts

diff --git a/shared/models/plugins/register-server-auth.model.ts b/shared/models/plugins/register-server-auth.model.ts
index 34ebbe71223e45bc98e5e86b98158c4f93bd90ce..403a499946bf2c221d11b1c2d556ecac9645923d 100644 (file)
--- a/shared/models/plugins/register-server-auth.model.ts
+++ b/shared/models/plugins/register-server-auth.model.ts
@@ -1,14 +1,22 @@
 import { UserRole } from '@shared/models'
+import { MOAuthToken } from '@server/typings/models'
 
 export type RegisterServerAuthOptions = RegisterServerAuthPassOptions | RegisterServerAuthExternalOptions
 
 export interface RegisterServerAuthPassOptions {
-  type: 'id-and-pass'
+  // Authentication name (a plugin can register multiple auth strategies)
+  authName: string
 
-  onLogout?: Function
+  // Called by PeerTube when a user from your plugin logged out
+  onLogout?(): void
 
+  // Weight of this authentication so PeerTube tries the auth methods in DESC weight order
   getWeight(): number
 
+  // Your plugin can hook PeerTube access/refresh token validity
+  // So you can control for your plugin the user session lifetime
+  hookTokenValidity?(options: { token: MOAuthToken, type: 'access' | 'refresh' }): Promise<{ valid: boolean }>
+
   // Used by PeerTube to login a user
   // Returns null if the login failed, or { username, email } on success
   login(body: {
@@ -23,7 +31,8 @@ export interface RegisterServerAuthPassOptions {
 }
 
 export interface RegisterServerAuthExternalOptions {
-  type: 'external'
+  // Authentication name (a plugin can register multiple auth strategies)
+  authName: string
 
   onLogout?: Function
 }