class
Analyzer::Specification::Envoy
Overview
Extracts HTTP endpoints from Envoy proxy route configuration files
(YAML or JSON). virtual_hosts is collected from wherever it sits in the
document, because Envoy nests it differently per layout:
- at the root (xDS RDS RouteConfiguration)
- under
route_config(standalone static RouteConfiguration) - under
resources[](xDS resource array) - under
static_resources.listeners[].filter_chains[].filters[]. typed_config.route_config(bootstrap config — the everyday shape; 30 of the 31virtual_hostsYAMLs in envoyproxy/envoy look like this)
For each route the analyzer extracts:
- Path from
match.prefix,match.path,match.path_separated_prefixormatch.safe_regex.regex - HTTP method from
match.headers[]wherename: ":method" - An additional endpoint for
route.prefix_rewritewhen it differs from the matched path
Defined in:
analyzer/analyzers/specification/envoy.crConstant Summary
-
DOMAINS_KEY =
YAML::Any.new("domains") -
MATCH_KEY =
YAML::Any.new("match") -
MAX_SEARCH_DEPTH =
32 -
See the detector's constant of the same name: a bound that only exists so a pathologically nested document can't blow the stack. Real configs sit around depth 8.
-
ROUTE_KEY =
YAML::Any.new("route") -
ROUTES_KEY =
YAML::Any.new("routes") -
VIRTUAL_HOSTS_KEY =
YAML::Any.new("virtual_hosts") -
Hoisted so the per-node lookups in the walks below do not rebuild the wrappers on every mapping they visit.
Class Method Summary
Instance Method Summary
- #analyze
-
#tech : String
Instance-side view of the same declaration.
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
Instance Method Detail
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.