Skip to content

API reference

Every package in Nuqs, built from the comments in the code, so it's always up to date. To change something here, change the comment in the code.

Package What it does
checks Lists every check that ships with Nuqs.
checks/ftpanon Checks if an FTP server lets anyone log in as "anonymous".
checks/httpheaders Checks web servers for missing security headers.
checks/redisnoauth Checks if a Redis server allows unauthenticated access.
checks/telnet Flags open Telnet services.
cmd/nuqs The Nuqs vulnerability assessment tool.
internal/check Defines what a check is.
internal/cli The "nuqs" command line.
internal/engine Runs a scan from start to end.
internal/model Holds the small set of types that every part of Nuqs shares.
internal/nmap Runs Nmap and turns its XML output into model.Host values.
internal/output Prints a scan report, either as a table for people or as JSON for tools.
internal/target Checks what the user asked us to scan before it ever reaches Nmap.
internal/version Compares software versions the way each ecosystem does.
lab Validates and fixes the two timestamps in a Nuqs JSON report, and drops Nmap's product guess for the Telnet server, which changes between runs.
tools/apidocs Writes the API reference pages of the website, one page per package, from the doc comments in the code.
tools/archdiagram Writes docs/architecture.md, a diagram and a map of the repo built straight from the code.