Documentation
¶
Overview ¶
Copyright 2024 Rangertaha. All rights reserved. SPDX-License-Identifier: GPL-3.0-or-later
Copyright 2024 Rangertaha. All rights reserved. SPDX-License-Identifier: GPL-3.0-or-later
Index ¶
Constants ¶
View Source
const ( // VERSION format is loosely based on // [Semantic Versioning](https://semver.org/spec/v2.0.0.html). VERSION = "0.9.0" DEBUG = false )
View Source
const ( // LOGO made as ASCII graphics BANNER = `` /* 381-byte string literal not displayed */ )
Variables ¶
View Source
var COMMIT = "unknown"
COMMIT is the git revision, set at link time by the Makefile:
-ldflags "-X github.com/rangertaha/urlinsane/internal.COMMIT=$(git rev-parse --short HEAD)"
A var rather than a const because only a var can be set by -X, and "unknown" rather than empty so a `go build` with no ldflags still says something true.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package atomicfile publishes a file in one step, so a reader sees either the old contents or the new ones and never half of either.
|
Package atomicfile publishes a file in one step, so a reader sees either the old contents or the new ones and never half of either. |
|
Package config owns the application directory: where it is, what lives in it, and putting the shipped data there on first run.
|
Package config owns the application directory: where it is, what lives in it, and putting the shipped data there on first run. |
|
Package eval measures the algorithm set against names that were actually registered, rather than against itself.
|
Package eval measures the algorithm set against names that were actually registered, rather than against itself. |
|
Package graph implements the typed property graph the scan engine expands: content-addressed nodes, typed relations, positional props and the single writer that applies operator deltas.
|
Package graph implements the typed property graph the scan engine expands: content-addressed nodes, typed relations, positional props and the single writer that applies operator deltas. |
|
dag
Package dag lays out a directed graph for presentation.
|
Package dag lays out a directed graph for presentation. |
|
Package model is the HMM library used by the engine and by plugins alike (docs/DESIGN.md §10.6).
|
Package model is the HMM library used by the engine and by plugins alike (docs/DESIGN.md §10.6). |
|
pkg
|
|
|
dns
Package dns holds the resolver the observation operators query through.
|
Package dns holds the resolver the observation operators query through. |
|
manifest
Package manifest extracts the declared dependency names from common project manifests so urlinsane can typosquat-check the packages a project actually depends on — the highest-value supply-chain surface.
|
Package manifest extracts the declared dependency names from common project manifests so urlinsane can typosquat-check the packages a project actually depends on — the highest-value supply-chain surface. |
|
Package plugins holds everything that acts on the graph, and the registries that let more be added.
|
Package plugins holds everything that acts on the graph, and the registries that let more be added. |
|
all
Package all links in every optional plugin.
|
Package all links in every optional plugin. |
|
decompose
Package decompose splits a composite target into the entities it is made of: an email into a local part and a domain, a domain into its TLD, a repository URL into a platform and an owner, a scoped package into its namespace.
|
Package decompose splits a composite target into the entities it is made of: an email into a local part and a domain, a domain into its TLD, a repository URL into a platform and an owner, a scoped package into its namespace. |
|
decompose/all
Package all composes the shipped decomposers.
|
Package all composes the shipped decomposers. |
|
observe
Package observe holds the observation operators — the former collectors.
|
Package observe holds the observation operators — the former collectors. |
|
report
Package report renders a finished scan.
|
Package report renders a finished scan. |
|
variant
Package variant holds the typo/squatting algorithms as graph operators.
|
Package variant holds the typo/squatting algorithms as graph operators. |
|
variant/fsd
Package fsd is the delegated-subdomain algorithm.
|
Package fsd is the delegated-subdomain algorithm. |
|
variant/sld
Package sld is the wrong second-level domain algorithm.
|
Package sld is the wrong second-level domain algorithm. |
|
variant/tli
Package tli is the TLD insertion algorithm.
|
Package tli is the TLD insertion algorithm. |
|
variant/tos
Package tos is the token order algorithm.
|
Package tos is the token order algorithm. |
|
variant/varianttest
Package varianttest provides fixtures for testing variant algorithms.
|
Package varianttest provides fixtures for testing variant algorithms. |
|
variant/xhs
Package xhs is the cross-language homophone algorithm.
|
Package xhs is the cross-language homophone algorithm. |
|
Package scan assembles a run: schema, operators, plan, expansion, analysis.
|
Package scan assembles a run: schema, operators, plan, expansion, analysis. |
|
Package store persists a graph.Graph as content-addressed dag-cbor blocks: one block per node, one per edge, one side-table block and one scan root linking them all.
|
Package store persists a graph.Graph as content-addressed dag-cbor blocks: one block per node, one per edge, one side-table block and one scan root linking them all. |
|
Package train fits an execution model from recorded scans.
|
Package train fits an execution model from recorded scans. |
Click to show internal directories.
Click to hide internal directories.