class Analyzer::Elixir::PhoenixChannel

Overview

Surfaces Phoenix Channels real-time attack surface as ws:// endpoints. A channel module (use Phoenix.Channel / use MyAppWeb, :channel) handles client messages via handle_in/3 clauses; the socket module maps a topic pattern to the channel with channel "room:*", RoomChannel. Each handle_in event becomes one endpoint ws://<topic>/<event> (bare ws://<topic> when a channel has no handle_in clauses), method "SEND", protocol "ws" — so the existing WebsocketTagger tags them.

Line-scan analyzer. The topic↔module map lives in the socket module while handle_in clauses live in the channel module, so channel declarations are collected across every .ex file first, then joined onto each channel module.

Defined in:

analyzer/analyzers/elixir/phoenix_channel.cr

Constant Summary

CHANNEL_DECL = /^\s*channel\s+["']([^"']+)["']\s*,\s*([\w.]+)/

channel "room:*", RoomChannel / channel "room:" <> _, MyApp.RoomChannel.

CHANNEL_USE = /\buse\s+Phoenix\.Channel\b|\buse\s+[A-Z][\w.]*\s*,\s*:channel\b/

A channel module opts into the behaviour with one of these.

DEFMODULE = /^\s*defmodule\s+([\w.]+)\s+do\b/

defmodule MyAppWeb.RoomChannel do.

HANDLE_IN = /\bhandle_in\s*\(?\s*["']([^"']+)["']/

handle_in("new_msg", payload, socket) / handle_in "ping", _p, socket. A catch-all handle_in(_event, ...) has no string literal, so it is skipped.

Class Method Summary

Instance Method Summary

Instance methods inherited from class Analyzer

analyze analyze, base_path : String base_path, base_paths : Array(String) base_paths, base_relative_path(path : String) : String base_relative_path, callees_needed? : Bool callees_needed?, content_matches?(content : String, markers : Regex) : Bool content_matches?, http_header_name(name : String) : String | Nil http_header_name, line_number_for_index(content : String, char_index : Int32) : Int32 line_number_for_index, logger : NoirLogger logger, parallel_analyze(files : Array(String), &block : String -> Nil) parallel_analyze, read_file_content(path : String) : String read_file_content, result : Array(Endpoint) result, tech : String tech, unique_params(params : Array(Param)) : Array(Param) unique_params, url : String url, web_root_path(path : String, markers : Array(String)) : String web_root_path

Constructor methods inherited from class Analyzer

new(options : Hash(String, YAML::Any)) new

Macros inherited from class Analyzer

analyzer_for(tech) analyzer_for

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, get_files_by_basename(basename : String) : Array(String) get_files_by_basename, get_files_by_extension(extension : String) : Array(String) get_files_by_extension, get_files_by_extensions(extensions : Array(String)) : Array(String) get_files_by_extensions, get_files_by_prefix(prefix : String) : Array(String) get_files_by_prefix, get_files_by_prefix_and_extension(prefix : String, extension : String) : Array(String) get_files_by_prefix_and_extension, get_files_by_relative_path(relative_path : String, root : String = "") : Array(String) get_files_by_relative_path, get_public_dir_files(base_path : String, folder : String) : Array(String) get_public_dir_files, get_public_files(base_path : String, anchors : Array(String) = ["shard.yml", "Gemfile"]) : Array(String) get_public_files, walked_path(expanded : String) : String walked_path

Class Method Detail

def self.tech_name : String #

[View source]

Instance Method Detail

def analyze #

[View source]
def tech : String #

Instance-side view of the same declaration. The per-file rescues live on this base class, which has no way to name the analyzer that is running inside them, so a skipped file could not be attributed to a tech. Deriving it from analyzer_for keeps the name written exactly once.


[View source]