Documentation
¶
Overview ¶
Package adapter groups the implementations of the app ports: upstream sources, on-demand registries, reference lists shipped with the binary, storage, and the inbound HTTP and MCP servers (ADR 0002).
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package alert tells the operator that a source could not be synced or reloaded: an error line in the log, and a JSON POST to a webhook when one is configured.
|
Package alert tells the operator that a source could not be synced or reloaded: an error line in the log, and a JSON POST to a webhook when one is configured. |
|
Package assembly builds a check and the list of its sources from the lists the configuration turns on, the snapshots in service and the registries: the one assembly every command shares, so that none of them consults fewer sources than another without saying so.
|
Package assembly builds a check and the list of its sources from the lists the configuration turns on, the snapshots in service and the registries: the one assembly every command shares, so that none of them consults fewer sources than another without saying so. |
|
Package backupseal encrypts the backups of the key store with age (filippo.io/age), for the public key of the owner (#75): the process that seals a backup cannot open it.
|
Package backupseal encrypts the backups of the key store with age (filippo.io/age), for the public key of the owner (#75): the process that seals a backup cannot open it. |
|
Package contracttest checks answers against the public contract, api/openapi.yaml.
|
Package contracttest checks answers against the public contract, api/openapi.yaml. |
|
Package corpus reads the labelled evaluation corpus of testdata/corpus: scam.csv, inputs an authority blacklisted, and legit.csv, inputs of verified legitimate entities.
|
Package corpus reads the labelled evaluation corpus of testdata/corpus: scam.csv, inputs an authority blacklisted, and legit.csv, inputs of verified legitimate entities. |
|
Package githubapp writes the secrets of a GitHub environment as a GitHub App, for the key rotation job (ADR 0007): it signs a JWT of the App with its private key, trades it for an installation token restricted to one repository and to writing its environments, and seals each secret for the public key of the environment.
|
Package githubapp writes the secrets of a GitHub environment as a GitHub App, for the key rotation job (ADR 0007): it signs a JWT of the App with its private key, trades it for an installation token restricted to one repository and to writing its environments, and seals each secret for the public key of the environment. |
|
Package httpapi serves the public HTTP API, following its contract (api/openapi.yaml): the server and its timeouts, the probes, and the middleware every request goes through (request identifier, access log, panic recovery, security headers).
|
Package httpapi serves the public HTTP API, following its contract (api/openapi.yaml): the server and its timeouts, the probes, and the middleware every request goes through (request identifier, access log, panic recovery, security headers). |
|
Package mcp serves Arnakoff over the Model Context Protocol: an AI assistant checks an input or lists the sources with the same use cases, the same fields and the same wording as the HTTP API.
|
Package mcp serves Arnakoff over the Model Context Protocol: an AI assistant checks an input or lists the sources with the same use cases, the same fields and the same wording as the HTTP API. |
|
reference
|
|
|
hosting
Package hosting reads the reference list of shared platforms that host their users' pages under a path of their own domain, shipped with the binary (platforms.csv, documented in docs/sources.md).
|
Package hosting reads the reference list of shared platforms that host their users' pages under a path of their own domain, shipped with the binary (platforms.csv, documented in docs/sources.md). |
|
official
Package official reads the reference list of official domains often imitated, shipped with the binary (domains.csv, documented in docs/sources.md).
|
Package official reads the reference list of official domains often imitated, shipped with the binary (domains.csv, documented in docs/sources.md). |
|
registry
|
|
|
bodacc
Package bodacc reads the notices the BODACC (DILA, Licence Ouverte; docs/sources.md) published about a company, by SIREN only: collective procedures, radiations, conciliations and professional recoveries.
|
Package bodacc reads the notices the BODACC (DILA, Licence Ouverte; docs/sources.md) published about a company, by SIREN only: collective procedures, radiations, conciliations and professional recoveries. |
|
live
Package live builds the registries a check consults online: RDAP, SIRENE and BODACC, each through an HTTP client allowed its own hosts only.
|
Package live builds the registries a check consults online: RDAP, SIRENE and BODACC, each through an HTTP client allowed its own hosts only. |
|
rdap
Package rdap reads the registration date of a domain from the RDAP server of its registry (RFC 9082, RFC 9083), found through the IANA bootstrap file (RFC 9224), never through a third-party aggregator (docs/sources.md).
|
Package rdap reads the registration date of a domain from the RDAP server of its registry (RFC 9082, RFC 9083), found through the IANA bootstrap file (RFC 9224), never through a third-party aggregator (docs/sources.md). |
|
replay
Package replay records the answers of the registries and plays them back, so that the evaluation corpus is scored without the network.
|
Package replay records the answers of the registries and plays them back, so that the evaluation corpus is scored without the network. |
|
sirene
Package sirene reads a company's name, creation date and head office state from the API Recherche d'entreprises (DINUM, INSEE data, Licence Ouverte 2.0; docs/sources.md), by SIREN only.
|
Package sirene reads a company's name, creation date and head office state from the API Recherche d'entreprises (DINUM, INSEE data, Licence Ouverte 2.0; docs/sources.md), by SIREN only. |
|
Package scaleway is the client of the Scaleway API the key rotation job uses (ADR 0007): it creates and deletes the API keys of a closed list of IAM applications, writes them to Secret Manager and to the secrets of a Serverless Container.
|
Package scaleway is the client of the Scaleway API the key rotation job uses (ADR 0007): it creates and deletes the API keys of a closed list of IAM applications, writes them to Secret Manager and to the secrets of a Serverless Container. |
|
Package signaldoc writes the table of docs/signals.md from the signal catalog, so that the public list cannot drift from the rules.
|
Package signaldoc writes the table of docs/signals.md from the signal catalog, so that the public list cannot drift from the rules. |
|
Package smtpmail sends the mails of the API, such as login links, through an authenticated SMTP server reached over implicit TLS (RFC 8314).
|
Package smtpmail sends the mails of the API, such as login links, through an authenticated SMTP server reached over implicit TLS (RFC 8314). |
|
source
|
|
|
acpr
Package acpr holds the connector of the blacklist the Autorité de contrôle prudentiel et de résolution and the AMF publish through Assurance Banque Épargne Info Service (docs/sources.md).
|
Package acpr holds the connector of the blacklist the Autorité de contrôle prudentiel et de résolution and the AMF publish through Assurance Banque Épargne Info Service (docs/sources.md). |
|
amf
Package amf holds the connectors of the lists the Autorité des marchés financiers publishes daily on data.gouv.fr under the Licence Ouverte 2.0 (docs/sources.md): the blacklist, and the white lists of digital asset service providers (PSAN) and of offers in goods (biens divers).
|
Package amf holds the connectors of the lists the Autorité des marchés financiers publishes daily on data.gouv.fr under the Licence Ouverte 2.0 (docs/sources.md): the blacklist, and the white lists of digital asset service providers (PSAN) and of offers in goods (biens divers). |
|
arcep
Package arcep holds the connector of the national numbering plan the Autorité de régulation des communications électroniques, des postes et de la distribution de la presse publishes under the Licence Ouverte (docs/sources.md): the ranges of phone numbers it has assigned (MAJNUM), joined with the name and SIREN of the operator each range is assigned to (identifiants_CE).
|
Package arcep holds the connector of the national numbering plan the Autorité de régulation des communications électroniques, des postes et de la distribution de la presse publishes under the Licence Ouverte (docs/sources.md): the ranges of phone numbers it has assigned (MAJNUM), joined with the name and SIREN of the operator each range is assigned to (identifiants_CE). |
|
catalog
Package catalog lists the sources Arnakoff syncs, how often, and the hosts they reach: the one list the sync and API processes are built from.
|
Package catalog lists the sources Arnakoff syncs, how often, and the hosts they reach: the one list the sync and API processes are built from. |
|
listing
Package listing turns the entries of the published lists into the keys their snapshot rows are looked up by: a site's normalised host and path, an address, an E.164 phone number or a SIREN, normalised by the domain value objects.
|
Package listing turns the entries of the published lists into the keys their snapshot rows are looked up by: a site's normalised host and path, an address, an E.164 phone number or a SIREN, normalised by the domain value objects. |
|
Package store keeps the last valid snapshot of each source on disk, shared by the sync and API processes and kept across restarts.
|
Package store keeps the last valid snapshot of each source on disk, shared by the sync and API processes and kept across restarts. |
|
objectstore
Package objectstore keeps the last valid snapshot of each source in an S3 bucket, the production store of ADR 0005: Scaleway Object Storage in fr-par, shared by the sync job and the API container, which have no volume in common.
|
Package objectstore keeps the last valid snapshot of each source in an S3 bucket, the production store of ADR 0005: Scaleway Object Storage in fr-par, shared by the sync job and the API container, which have no volume in common. |
|
postgres
Package postgres keeps the records of the API keys in PostgreSQL (ADR 0004), through jackc/pgx: their keyed digests, never the keys.
|
Package postgres keeps the records of the API keys in PostgreSQL (ADR 0004), through jackc/pgx: their keyed digests, never the keys. |
|
Package turnstile checks a Cloudflare Turnstile token with the siteverify API, as documented at https://developers.cloudflare.com/turnstile/get-started/server-side-validation/: a form POST of the widget's secret key and the token, answered by a JSON object.
|
Package turnstile checks a Cloudflare Turnstile token with the siteverify API, as documented at https://developers.cloudflare.com/turnstile/get-started/server-side-validation/: a form POST of the widget's secret key and the token, answered by a JSON object. |
|
Package wire is the public representation of what Arnakoff answers: a report and the list of sources, as the contract api/openapi.yaml describes them.
|
Package wire is the public representation of what Arnakoff answers: a report and the list of sources, as the contract api/openapi.yaml describes them. |
Click to show internal directories.
Click to hide internal directories.