Add security macro in controllers (#157)

fishjam-dev · Feb 22, 2024 · 01c9597 · 01c9597
1 parent a27e582
commit 01c9597
Show file tree

Hide file tree

Showing 12 changed files with 100 additions and 7 deletions.
diff --git a/lib/jellyfish_web/api_spec.ex b/lib/jellyfish_web/api_spec.ex
@@ -20,8 +20,7 @@ defmodule JellyfishWeb.ApiSpec do
       paths: Paths.from_router(JellyfishWeb.Router),
       components: %Components{
         securitySchemes: %{"authorization" => %SecurityScheme{type: "http", scheme: "bearer"}}
-      },
-      security: [%{"authorization" => []}]
+      }
     }
     |> OpenApiSpex.resolve_schema_modules()
   end

diff --git a/lib/jellyfish_web/controllers/component_controller.ex b/lib/jellyfish_web/controllers/component_controller.ex
@@ -12,6 +12,8 @@ defmodule JellyfishWeb.ComponentController do
 
   tags [:room]
 
+  security(%{"authorization" => []})
+
   operation :create,
     operation_id: "add_component",
     summary: "Creates the component and adds it to the room",

diff --git a/lib/jellyfish_web/controllers/healthcheck_controller.ex b/lib/jellyfish_web/controllers/healthcheck_controller.ex
@@ -8,6 +8,8 @@ defmodule JellyfishWeb.HealthcheckController do
 
   tags [:health]
 
+  security(%{"authorization" => []})
+
   operation :show,
     operation_id: "healthcheck",
     summary: "Describes the health of Jellyfish",

diff --git a/...llyfish_web/controllers/hls_controller.ex → ...web/controllers/hls_content_controller.ex b/...llyfish_web/controllers/hls_controller.ex → ...web/controllers/hls_content_controller.ex
@@ -1,4 +1,4 @@
-defmodule JellyfishWeb.HLSController do
+defmodule JellyfishWeb.HLSContentController do
   use JellyfishWeb, :controller
   use OpenApiSpex.ControllerSpecs
 

diff --git a/lib/jellyfish_web/controllers/peer_controller.ex b/lib/jellyfish_web/controllers/peer_controller.ex
@@ -13,6 +13,8 @@ defmodule JellyfishWeb.PeerController do
 
   tags [:room]
 
+  security(%{"authorization" => []})
+
   operation :create,
     operation_id: "add_peer",
     summary: "Create peer",

diff --git a/lib/jellyfish_web/controllers/recording_content_controller.ex b/lib/jellyfish_web/controllers/recording_content_controller.ex
@@ -0,0 +1,53 @@
+defmodule JellyfishWeb.RecordingContentController do
+  use JellyfishWeb, :controller
+  use OpenApiSpex.ControllerSpecs
+
+  require Logger
+
+  alias Jellyfish.Component.HLS.RequestHandler
+  alias JellyfishWeb.ApiSpec
+
+  alias Plug.Conn
+
+  action_fallback JellyfishWeb.FallbackController
+
+  @playlist_content_type "application/vnd.apple.mpegurl"
+  @recording_id_spec [in: :path, description: "Recording id", type: :string]
+
+  tags [:recording]
+
+  operation :index,
+    operation_id: "getRecordingContent",
+    summary: "Retrieve Recording (HLS) Content",
+    parameters: [
+      recording_id: @recording_id_spec,
+      filename: [in: :path, description: "Name of the file", type: :string]
+    ],
+    required: [:recording_id, :filename],
+    responses: [
+      ok: ApiSpec.data("File was found", ApiSpec.HLS.Response),
+      not_found: ApiSpec.error("File not found"),
+      bad_request: ApiSpec.error("Invalid request")
+    ]
+
+  def index(conn, %{"recording_id" => recording_id, "filename" => filename}) do
+    with {:ok, file} <-
+           RequestHandler.handle_recording_request(recording_id, filename) do
+      conn =
+        if String.ends_with?(filename, ".m3u8"),
+          do: put_resp_content_type(conn, @playlist_content_type, nil),
+          else: conn
+
+      Conn.send_resp(conn, 200, file)
+    else
+      {:error, :invalid_recording} ->
+        {:error, :bad_request, "Invalid recording, got: #{recording_id}"}
+
+      {:error, :invalid_path} ->
+        {:error, :bad_request, "Invalid filename, got: #{filename}"}
+
+      {:error, _reason} ->
+        {:error, :not_found, "File not found"}
+    end
+  end
+end
diff --git a/lib/jellyfish_web/controllers/recording_controller.ex b/lib/jellyfish_web/controllers/recording_controller.ex
@@ -16,6 +16,8 @@ defmodule JellyfishWeb.RecordingController do
 
   tags [:recording]
 
+  security(%{"authorization" => []})
+
   operation :index,
     operation_id: "getRecordingContent",
     summary: "Retrieve Recording (HLS) Content",

diff --git a/lib/jellyfish_web/controllers/room_controller.ex b/lib/jellyfish_web/controllers/room_controller.ex
@@ -11,6 +11,8 @@ defmodule JellyfishWeb.RoomController do
 
   tags [:room]
 
+  security(%{"authorization" => []})
+
   operation :index,
     operation_id: "get_all_rooms",
     summary: "Show information about all rooms",

diff --git a/lib/jellyfish_web/controllers/sip_call_controller.ex b/lib/jellyfish_web/controllers/sip_call_controller.ex
@@ -11,6 +11,8 @@ defmodule JellyfishWeb.SIPCallController do
 
   tags [:sip]
 
+  security(%{"authorization" => []})
+
   operation :create,
     operation_id: "dial",
     summary: "Make a call from the SIP component to the provided phone number",

diff --git a/lib/jellyfish_web/controllers/subscription_controller.ex b/lib/jellyfish_web/controllers/subscription_controller.ex
@@ -11,6 +11,8 @@ defmodule JellyfishWeb.SubscriptionController do
 
   tags [:hls]
 
+  security(%{"authorization" => []})
+
   operation :create,
     operation_id: "subscribe_hls_to",
     summary: "Subscribe the HLS component to the tracks of peers or components",

diff --git a/lib/jellyfish_web/router.ex b/lib/jellyfish_web/router.ex
@@ -42,8 +42,8 @@ defmodule JellyfishWeb.Router do
 
   # Paths which DO NOT require auth
   scope "/", JellyfishWeb do
-    get "/hls/:room_id/:filename", HLSController, :index
-    get "/recording/:recording_id/:filename", RecordingController, :index
+    get "/hls/:room_id/:filename", HLSContentController, :index
+    get "/recording/:recording_id/:filename", RecordingContentController, :index
   end
 
   # Enable LiveDashboard in development

diff --git a/openapi.yaml b/openapi.yaml
@@ -768,6 +768,8 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
           description: Unauthorized
+      security:
+        - authorization: []
       summary: Describes the health of Jellyfish
       tags:
         - health
@@ -810,6 +812,8 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
           description: Room doesn't exist
+      security:
+        - authorization: []
       summary: Subscribe the HLS component to the tracks of peers or components
       tags:
         - hls
@@ -900,6 +904,8 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
           description: Unable to obtain recordings
+      security:
+        - authorization: []
       summary: Lists all available recordings
       tags:
         - recording
@@ -935,6 +941,8 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
           description: Recording doesn't exist
+      security:
+        - authorization: []
       summary: Deletes the recording
       tags:
         - recording
@@ -995,6 +1003,8 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
           description: Unauthorized
+      security:
+        - authorization: []
       summary: Show information about all rooms
       tags:
         - room
@@ -1028,6 +1038,8 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
           description: Unauthorized
+      security:
+        - authorization: []
       summary: Creates a room
       tags:
         - room
@@ -1057,6 +1069,8 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
           description: Room doesn't exist
+      security:
+        - authorization: []
       summary: Delete the room
       tags:
         - room
@@ -1089,6 +1103,8 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
           description: Room doesn't exist
+      security:
+        - authorization: []
       summary: Shows information about the room
       tags:
         - room
@@ -1142,6 +1158,8 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
           description: Room doesn't exist
+      security:
+        - authorization: []
       summary: Creates the component and adds it to the room
       tags:
         - room
@@ -1177,6 +1195,8 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
           description: Either component or the room doesn't exist
+      security:
+        - authorization: []
       summary: Delete the component from the room
       tags:
         - room
@@ -1237,6 +1257,8 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
           description: Peer limit has been reached
+      security:
+        - authorization: []
       summary: Create peer
       tags:
         - room
@@ -1272,6 +1294,8 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
           description: Room ID or Peer ID references a resource that doesn't exist
+      security:
+        - authorization: []
       summary: Delete peer
       tags:
         - room
@@ -1313,6 +1337,8 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
           description: Room doesn't exist
+      security:
+        - authorization: []
       summary: Finish call made by SIP component
       tags:
         - sip
@@ -1360,10 +1386,11 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
           description: Room doesn't exist
+      security:
+        - authorization: []
       summary: Make a call from the SIP component to the provided phone number
       tags:
         - sip
-security:
-  - authorization: []
+security: []
 servers: []
 tags: []