class Analyzer::Swift::Cli

Overview

Surfaces the command-line attack surface of Swift programs as cli:// endpoints: one endpoint per (sub)command with named options (param_type "flag"), positional arguments ("argument") and consumed environment variables ("env"). Covers swift-argument-parser plus builtin CommandLine.arguments / ProcessInfo.environment / getenv.

Line-scan analyzer (Go/Ruby/Rust CLI house style) merging endpoints by URL. Subclasses Analyzer directly (SwiftEngine#analyze_file is abstract) and reuses SwiftEngine.swift_test_path? to skip tests.

Included Modules

Defined in:

analyzer/analyzers/swift/cli.cr

Constant Summary

ARGS_IDX = /\bCommandLine\.arguments\s*\[\s*(\d+)\s*\]/
ARGUMENT_WRAP = /@Argument\b/
COMMAND_NAME = /\bcommandName:\s*"([^"]+)"/
CUSTOM_LONG = /name:\s*\.(?:customLong|long)\s*\(\s*"([^"]+)"/
GETENV = /\bgetenv\s*\(\s*"([^"]+)"/
OPTION_FLAG = /@(?:Option|Flag)\b/
PARSABLE_STRUCT = /\b(?:struct|enum|class)\s+(\w+)\s*:\s*[^\{]*\b(?:Async)?ParsableCommand\b/
PROC_ENV = /ProcessInfo(?:\.processInfo|\(\))?\.environment\s*\[\s*"([^"]+)"\s*\]/
SUBCOMMANDS_KEY = /\bsubcommands:/
VAR_DECL = /\bvar\s+(\w+)/
WEB_FRAMEWORK_RE = /\bimport\s+(?:Vapor|Hummingbird\w*|Kitura\w*)\b|\bapp\.environment\b/

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]