Feature/password protected videos (#5836)

* Add server endpoints

* Refactoring test suites

* Update server and add openapi documentation

* fix compliation and tests

* upload/import password protected video on client

* add server error code

* Add video password to update resolver

* add custom message when sharing pw protected video

* improve confirm component

* Add new alert in component

* Add ability to watch protected video on client

* Cannot have password protected replay privacy

* Add migration

* Add tests

* update after review

* Update check params tests

* Add live videos test

* Add more filter test

* Update static file privacy test

* Update object storage tests

* Add test on feeds

* Add missing word

* Fix tests

* Fix tests on live videos

* add embed support on password protected videos

* fix style

* Correcting data leaks

* Unable to add password protected privacy on replay

* Updated code based on review comments

* fix validator and command

* Updated code based on review comments

1 files changed, 119 insertions, 1 deletions

diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index cd50e86a6..ff94f802b 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -300,6 +300,8 @@ tags:
   - name: Runner Registration Token
     description: |
       Manage runner registration token
+  - name: Video Passwords
+    description: Operation on video passwords
 
 x-tagGroups:
   - name: Static endpoints
@@ -337,6 +339,7 @@ x-tagGroups:
       - Video Transcoding
       - Live Videos
       - Channels Sync
+      - Video Passwords
   - name: Search
     tags:
       - Search
@@ -2359,6 +2362,7 @@ paths:
         - OAuth2: []
       parameters:
         - $ref: '#/components/parameters/idOrUUID'
+        - $ref: '#/components/parameters/videoPasswordHeader'
       responses:
         '200':
           description: successful operation
@@ -2578,6 +2582,8 @@ paths:
                   format: date-time
                 scheduleUpdate:
                   $ref: '#/components/schemas/VideoScheduledUpdate'
+                videoPasswords:
+                  $ref: '#/components/schemas/AddVideoPasswords'
             encoding:
               thumbnailfile:
                 contentType: image/jpeg
@@ -2590,6 +2596,7 @@ paths:
         - Video
       parameters:
         - $ref: '#/components/parameters/idOrUUID'
+        - $ref: '#/components/parameters/videoPasswordHeader'
       responses:
         '200':
           description: successful operation
@@ -2597,6 +2604,8 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/VideoDetails'
+        '403':
+          description: provide a correct password to access this password protected video
     delete:
       summary: Delete a video
       operationId: delVideo
@@ -2618,6 +2627,7 @@ paths:
         - Video
       parameters:
         - $ref: '#/components/parameters/idOrUUID'
+        - $ref: '#/components/parameters/videoPasswordHeader'
       responses:
         '200':
           description: successful operation
@@ -3267,6 +3277,7 @@ paths:
         - Live Videos
       parameters:
         - $ref: '#/components/parameters/idOrUUID'
+        - $ref: '#/components/parameters/videoPasswordHeader'
       responses:
         '200':
           description: successful operation
@@ -3665,6 +3676,7 @@ paths:
         - Video Captions
       parameters:
         - $ref: '#/components/parameters/idOrUUID'
+        - $ref: '#/components/parameters/videoPasswordHeader'
       responses:
         '200':
           description: successful operation
@@ -3728,6 +3740,70 @@ paths:
         '404':
           description: video or language or caption for that language not found
 
+  /api/v1/videos/{id}/passwords:
+    get:
+      summary: List video passwords
+      security:
+        - OAuth2:
+          - user
+      tags:
+        - Video Passwords
+      parameters:
+        - $ref: '#/components/parameters/idOrUUID'
+        - $ref: '#/components/parameters/start'
+        - $ref: '#/components/parameters/count'
+        - $ref: '#/components/parameters/sort'
+      responses:
+        '204':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/VideoPasswordList'
+        '400':
+          description: video is not password protected
+    put:
+      summary: Update video passwords
+      security:
+        - OAuth2:
+          - user
+      tags:
+        - Video Passwords
+      parameters:
+        - $ref: '#/components/parameters/idOrUUID'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                passwords:
+                  $ref: '#/components/schemas/AddVideoPasswords' 
+      responses:
+        '204':
+          description: successful operation
+        '400':
+          description: video is not password protected
+
+  /api/v1/videos/{id}/passwords/{videoPasswordId}:
+    delete:
+      summary: Delete a video password
+      security:
+        - OAuth2:
+          - user
+      tags:
+        - Video Passwords
+      parameters:
+        - $ref: '#/components/parameters/idOrUUID'
+        - $ref: '#/components/parameters/videoPasswordId'
+      responses:
+        '204':
+          description: successful operation
+        '403':
+          description: cannot delete the last password of the protected video
+        '400':
+          description: video is not password protected
+
   /api/v1/video-channels:
     get:
       summary: List video channels
@@ -4554,6 +4630,7 @@ paths:
         - $ref: '#/components/parameters/start'
         - $ref: '#/components/parameters/count'
         - $ref: '#/components/parameters/commentsSort'
+        - $ref: '#/components/parameters/videoPasswordHeader'
       responses:
         '200':
           description: successful operation
@@ -4600,6 +4677,7 @@ paths:
       parameters:
         - $ref: '#/components/parameters/idOrUUID'
         - $ref: '#/components/parameters/threadId'
+        - $ref: '#/components/parameters/videoPasswordHeader'
       responses:
         '200':
           description: successful operation
@@ -4618,6 +4696,7 @@ paths:
       parameters:
         - $ref: '#/components/parameters/idOrUUID'
         - $ref: '#/components/parameters/commentId'
+        - $ref: '#/components/parameters/videoPasswordHeader'
       responses:
         '200':
           description: successful operation
@@ -4668,6 +4747,7 @@ paths:
         - Video Rates
       parameters:
         - $ref: '#/components/parameters/idOrUUID'
+        - $ref: '#/components/parameters/videoPasswordHeader'
       requestBody:
         content:
           application/json:
@@ -6525,7 +6605,20 @@ components:
       required: true
       schema:
         $ref: '#/components/schemas/UUIDv4'
-
+    videoPasswordId:
+      name: videoPasswordId
+      in: path
+      required: true
+      description: The video password id
+      schema:
+        $ref: '#/components/schemas/id'
+    videoPasswordHeader:
+      name: x-peertube-video-password
+      description: Required on password protected video
+      in: header
+      required: false
+      schema:
+        type: string
   securitySchemes:
     OAuth2:
       description: |
@@ -8228,6 +8321,8 @@ components:
           description: Video preview file
           type: string
           format: binary
+        videoPasswords:
+          $ref: '#/components/schemas/AddVideoPasswords'
       required:
         - channelId
         - name
@@ -9616,6 +9711,29 @@ components:
             privatePayload:
               type: object
 
+    VideoPassword:
+      properties:
+        id:
+          $ref: '#/components/schemas/id'
+        password:
+          type: string
+          minLength: 2
+        videoId: 
+          $ref: '#/components/schemas/id'
+    VideoPasswordList:
+      properties:
+        total:
+          type: integer
+          example: 1
+        data:
+          type: array
+          items:
+              $ref: '#/components/schemas/VideoPassword'
+    AddVideoPasswords:
+      type: array
+      items:
+        $ref: "#/components/schemas/VideoPassword/properties/password"
+      uniqueItems: true
   callbacks:
     searchIndex:
       'https://search.example.org/api/v1/search/videos':