class Analyzer::Lua::Cli

Overview

Surfaces the command-line attack surface of Lua programs as cli:// endpoints: the argparse library (option/flag/argument/command, attributed by receiver variable), the cliargs (lua_cliargs) library (add_argument/add_option/add_flag, attributed by receiver variable), plus arg indexing and os.getenv. Line-scan, merged by URL.

Included Modules

Defined in:

analyzer/analyzers/lua/cli.cr

Constant Summary

ARG_IDX = /\barg\s*\[\s*(\d+)\s*\]/
ARGPARSE_CTOR = /(?:local\s+)?([A-Za-z_]\w*)\s*=\s*argparse\s*\(\s*(?:['"]([^'"]*)['"])?/
ARGUMENT = /([A-Za-z_]\w*)\s*:\s*argument\s*\(\s*['"]([^'"]+)['"]/
CLIARGS_ARG = /([A-Za-z_]\w*)\s*:\s*add_argument\s*\(\s*['"]([^'"]+)['"]/
CLIARGS_CTOR = /(?:local\s+)?([A-Za-z_]\w*)\s*=\s*require\s*\(?\s*['"]cliargs['"]/
CLIARGS_FLAG = /([A-Za-z_]\w*)\s*:\s*add_flag\s*\(\s*['"]([^'"]+)['"]/
CLIARGS_NAME = /([A-Za-z_]\w*)\s*:\s*set_name\s*\(\s*['"]([^'"]+)['"]/
CLIARGS_OPTION = /([A-Za-z_]\w*)\s*:\s*add_option\s*\(\s*['"]([^'"]+)['"]/
GET_ENV = /\bos\.getenv\s*\(\s*['"]([^'"]+)['"]/
MARKERS = /\brequire\s*\(?\s*['"]argparse['"]|\bargparse\s*\(|\barg\s*\[\s*\d+\s*\]|\brequire\s*\(?\s*['"]cliargs['"]/
OPTION = /([A-Za-z_]\w*)\s*:\s*(?:option|flag)\s*\(\s*['"]([^'"]+)['"]/
SUBCOMMAND = /(?:local\s+)?(?:([A-Za-z_]\w*)\s*=\s*)?([A-Za-z_]\w*)\s*:\s*command\s*\(\s*['"]([^'"]+)['"]/
TEST_PATH_RE = Regex.union("_spec.", "/test/")

cli_test_path?'s two OR-ed String#includes? scans, folded into one precompiled union so the per-file boolean gate costs a single PCRE2 match instead of up to two naive substring scans.

WEB_RE = /\brequire\s*\(?\s*['"](?:lapis|lor)['"]/

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]