module Xssmaze::Banner

Overview

Everything XSSMaze prints before it starts serving: the startup banner, --help, --version, and CLI errors. Kept in one place so the wording and the spacing stay consistent.

Defined in:

banner.cr

Constant Summary

CATALOG_ROUTES = ["/map/json", "/map/text", "/map/markdown", "/map/openapi"] of ::String
HOMEPAGE = "https://github.com/hahwul/xssmaze"
PROBE_ROUTES = ["/health", "/stats", "/version", "/random"] of ::String
TAGLINE = "Cross-site scripting proving ground"

Class Method Summary

Class Method Detail

def self.fail(message : String, hint : String = "try `xssmaze --help`") : NoReturn #

Anything that stops the server before it serves: say what was wrong, then what to try next.


[View source]
def self.help(io : IO) : Nil #

[View source]
def self.lockup(io : IO) : Nil #

A single identity line for contexts where the mark would be noise.


[View source]
def self.startup(io : IO, url : String, endpoints : Int32, categories : Int32, classified : Int32, exposed : Bool) : Nil #

Printed once, after the CLI has been parsed, so every number and the URL are the real ones this process is about to serve.


[View source]
def self.version(io : IO) : Nil #

[View source]