Documentation
¶
Index ¶
- Constants
- func AddListToSetString(set map[string]struct{}, list []string) map[string]struct{}
- func ApplyDeclaredRouteTemplates(routes []*discover.RouteDetails) []*discover.RouteDetails
- func CaptureStaticAssetReference(urls map[string]struct{}, scopeURL string, fullURL string, ...) bool
- func DeclaredParamName(segment string) (string, bool)
- func EvidenceRank(evidence *string) int
- func ExtractDomain(rawURL string, maxDomainLevel int) string
- func HasDeclaredParamSyntax(path string) bool
- func InterpolatedParamName(expression string, segmentPrefix string, previousSegment string) string
- func IsAbsoluteURL(u string) bool
- func IsKnownProviderNoiseURL(rawURL string) bool
- func IsKnownProviderRouteNoise(route *discover.RouteDetails) bool
- func IsProvenanceEvidence(evidence string) bool
- func IsSubdomain(baseURL string, targetURL string) bool
- func IsTemplatedPath(path string) bool
- func IsURLAllowed(scopeURL string, targetURL string, ignoreCrossDomain bool, ...) bool
- func MergeBodyParams(params1 []*discover.RouteBodyParam, params2 []*discover.RouteBodyParam) []*discover.RouteBodyParam
- func MergePathParams(params1 []*discover.RoutePathParam, params2 []*discover.RoutePathParam) []*discover.RoutePathParam
- func MergeQueryParams(params1 []*discover.RouteQueryParam, params2 []*discover.RouteQueryParam) []*discover.RouteQueryParam
- func MergeStaticAssets(staticAssets []string) []string
- func MergeWebRoutes(routes []*discover.RouteDetails) []*discover.RouteDetails
- func NormalizeBaseURLForIdentity(rawURL string) string
- func NormalizeDeclaredTemplate(path string) (string, []*discover.RoutePathParam, bool)
- func NormalizeURLForIdentity(rawURL string) string
- func ParseBodyParams(postData string) ([]*discover.RouteBodyParam, error)
- func ParseQueryParams(reqURL *url.URL) []*discover.RouteQueryParam
- func ResolveURL(base, ref string) string
- func SetToListString(set map[string]struct{}) []string
- func SplitURLBaseAndPath(rawURL string) (string, string, error)
- func URLRemoveQueryParams(rawURL string) (string, error)
- func UniqueParamName(name string, taken map[string]struct{}) string
Constants ¶
const DeclaredRouteEvidence = "route-table"
DeclaredRouteEvidence marks a route the application itself declares, not one merely observed.
const InterpolatedRouteEvidence = "interpolated"
InterpolatedRouteEvidence marks a route whose parameter is proven but only loosely named.
Variables ¶
This section is empty.
Functions ¶
func AddListToSetString ¶
AddListToSetString adds elements from a list of strings to a set of strings.
func ApplyDeclaredRouteTemplates ¶ added in v0.18.0
func ApplyDeclaredRouteTemplates(routes []*discover.RouteDetails) []*discover.RouteDetails
ApplyDeclaredRouteTemplates folds observed literals into templates the application declares.
func CaptureStaticAssetReference ¶ added in v0.0.279
func CaptureStaticAssetReference(urls map[string]struct{}, scopeURL string, fullURL string, ignoreCrossDomain bool, captureStaticAssets bool) bool
CaptureStaticAssetReference centralizes the static-asset-vs-route decision so every route extractor behaves identically. It reports whether fullURL refers to a static asset (e.g. a PDF, image, or archive), in which case the caller must NOT record it as a route. When it is a static asset and static-asset collection is enabled (and the asset is in scope), the asset is added to the urls set so it surfaces in the StaticAssets output instead. A non-asset URL returns false and is left for the caller to handle as a normal route. scopeURL is the scope anchor (config.Target) used for the in-scope check.
func DeclaredParamName ¶ added in v0.18.0
DeclaredParamName returns the parameter a declaration segment names, if it names one.
func EvidenceRank ¶ added in v0.18.0
EvidenceRank orders a declaration above an interpolation above where the content was found.
func ExtractDomain ¶
ExtractDomain extracts the domain from a URL up to a specified domain level.
func HasDeclaredParamSyntax ¶ added in v0.18.0
HasDeclaredParamSyntax reports parameter syntax even in forms that yield no usable template.
func InterpolatedParamName ¶ added in v0.18.0
InterpolatedParamName derives a name; unlike a declaration it is a best effort, not authoritative.
func IsAbsoluteURL ¶
IsAbsoluteURL returns true if the given URL is absolute.
func IsKnownProviderNoiseURL ¶ added in v0.17.0
IsKnownProviderNoiseURL reports URL-only provider infrastructure endpoints that should never be returned as application routes.
func IsKnownProviderRouteNoise ¶ added in v0.17.0
func IsKnownProviderRouteNoise(route *discover.RouteDetails) bool
IsKnownProviderRouteNoise reports provider-generated routes that may need request context beyond the URL itself to identify safely.
func IsProvenanceEvidence ¶ added in v0.18.0
IsProvenanceEvidence reports evidence recording how a route was derived, not where it was found.
func IsSubdomain ¶
IsSubdomain checks if 'sub' is a subdomain of 'base'.
func IsTemplatedPath ¶ added in v0.18.0
IsTemplatedPath reports a declaration rather than a URL that can be requested.
func IsURLAllowed ¶
func IsURLAllowed(scopeURL string, targetURL string, ignoreCrossDomain bool, captureStaticAssets bool) bool
IsURLAllowed checks if a target URL is allowed based on the scope anchor, host matching, and static-asset policy. When captureStaticAssets is false, static asset URLs (e.g. PDFs, images, archives, and JS bundles) are rejected so they are not recorded as routes or queued for spidering. When ignoreCrossDomain is true, scope is anchored on the full host of scopeURL — which callers set to the original discovery target (config.Target), NOT the per-page post-redirect host — so scope stays tight to the target the user requested: the target host and its subdomains (children) are in scope, while the apex domain and sibling subdomains (e.g. careers.example.com when the target is www.example.com) are treated as out of scope. JS bundle fetching for route discovery is gated separately by MaxBundles in the bundle extractors and intentionally bypasses this allowlist; endpoints discovered inside a bundle are still filtered through IsURLAllowed against the target host.
func MergeBodyParams ¶
func MergeBodyParams(params1 []*discover.RouteBodyParam, params2 []*discover.RouteBodyParam) []*discover.RouteBodyParam
MergeBodyParams merges two slices of RouteBodyParam, retaining unique params and merging example values.
func MergePathParams ¶ added in v0.18.0
func MergePathParams(params1 []*discover.RoutePathParam, params2 []*discover.RoutePathParam) []*discover.RoutePathParam
MergePathParams merges two slices of RoutePathParam, retaining unique params and merging example values.
func MergeQueryParams ¶
func MergeQueryParams(params1 []*discover.RouteQueryParam, params2 []*discover.RouteQueryParam) []*discover.RouteQueryParam
MergeQueryParams merges two slices of RouteQueryParam, retaining unique params and merging example values.
func MergeStaticAssets ¶
MergeStaticAssets merges static asset URLs, retaining only unique static assets.
func MergeWebRoutes ¶
func MergeWebRoutes(routes []*discover.RouteDetails) []*discover.RouteDetails
MergeWebRoutes merges WebRoutes, retaining only unique routes (by method and URL).
func NormalizeBaseURLForIdentity ¶ added in v0.12.0
NormalizeBaseURLForIdentity returns a stable origin key for route comparison and result bucketing without changing the URL used for outbound requests. HTTP(S) origins include their effective port so implicit and explicit default ports collapse into the same identity. Userinfo is intentionally excluded.
func NormalizeDeclaredTemplate ¶ added in v0.18.0
func NormalizeDeclaredTemplate(path string) (string, []*discover.RoutePathParam, bool)
NormalizeDeclaredTemplate rewrites a declaration into the `{name}` form ConstructURL substitutes.
func NormalizeURLForIdentity ¶ added in v0.12.0
NormalizeURLForIdentity returns a stable request URL key for visited-route deduplication while preserving the original URL for the actual request.
func ParseBodyParams ¶
func ParseBodyParams(postData string) ([]*discover.RouteBodyParam, error)
ParseBodyParams parses body parameters from a JSON or form-urlencoded string into RouteBodyParam structs.
func ParseQueryParams ¶
func ParseQueryParams(reqURL *url.URL) []*discover.RouteQueryParam
ParseQueryParams parses query parameters from a URL into RouteQueryParam structs.
func ResolveURL ¶
ResolveURL resolves a reference URL relative to a base URL.
func SetToListString ¶
SetToListString converts a set of strings to a list of strings.
func SplitURLBaseAndPath ¶ added in v0.0.237
SplitURLBaseAndPath returns the URL origin and escaped path as separate route fields.
func URLRemoveQueryParams ¶
URLRemoveQueryParams removes query parameters from a URL string.
func UniqueParamName ¶ added in v0.18.0
Names must be unique per route: the ontology keys on (parameter_name, parameter_location).
Types ¶
This section is empty.
Source Files
Directories