fix: enable double slashes for optional path variables

Closes #754

This implementation is flawed, it's making the pass-challenge route
return 404s. I'm not entirely sure why this is happening, but I'm
pushing this for now in case there's some low hanging fruit.

Signed-off-by: Xe Iaso <me@xeiaso.net>

.github/actions/spelling/expect.txt

@@ -1,5 +1,4 @@
 acs
-aeacus
 Aibrew
 alrest
 amazonbot
@@ -175,13 +174,13 @@ lgbt
 licend
 licstart
 lightpanda
-LIMSA
+limsa
 Linting
 linuxbrew
 LLU
 loadbalancer
 lol
-LOMINSA
+lominsa
 maintainership
 malware
 mcr
@@ -345,6 +344,7 @@ yeet
 yeetfile
 yourdomain
 yoursite
+yyz
 Zenos
 zizmor
 zombocom

.github/workflows/docs-deploy.yml

@@ -49,14 +49,14 @@ jobs:
           platforms: linux/amd64
           push: true
 
-      - name: Apply k8s manifests to aeacus
+      - name: Apply k8s manifests to limsa lominsa
         uses: actions-hub/kubectl@d50394b7d704525f93faefce1e65a6329ff67271 # v1.33.2
         env:
           KUBE_CONFIG: ${{ secrets.LIMSA_LOMINSA_KUBECONFIG }}
         with:
           args: apply -k docs/manifest
 
-      - name: Apply k8s manifests to aeacus
+      - name: Apply k8s manifests to limsa lominsa
         uses: actions-hub/kubectl@d50394b7d704525f93faefce1e65a6329ff67271 # v1.33.2
         env:
           KUBE_CONFIG: ${{ secrets.LIMSA_LOMINSA_KUBECONFIG }}

docs/.dockerignore

@@ -19,5 +19,3 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 
-# Kubernetes manifests
-/manifest

docs/Dockerfile

@@ -5,6 +5,7 @@ COPY . .
 
 RUN npm ci && npm run build
 
-FROM docker.io/library/nginx:alpine
-COPY --from=build /app/build /usr/share/nginx/html
+FROM ghcr.io/xe/nginx-micro
+COPY --from=build /app/build /www
+COPY ./manifest/cfg/nginx/nginx.conf /conf
 LABEL org.opencontainers.image.source="https://github.com/TecharoHQ/anubis"

docs/docs/CHANGELOG.md

@@ -13,12 +13,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- This changes the project to: -->
 
-### Added
-
-Anubis now supports these new languages:
-
-- [Italian](https://github.com/TecharoHQ/anubis/pull/778)
-
 ## v1.21.0: Minfilia Warde
 
 > Please, be at ease. You are among friends here.
@@ -40,11 +34,16 @@ Anubis now is able to store things persistently [in memory](./admin/policies.mdx
 Anubis now supports localized responses. Locales can be added in [lib/localization/locales/](https://github.com/TecharoHQ/anubis/tree/main/lib/localization/locales). This release includes support for the following languages:
 
 - [Brazilian Portugese](https://github.com/TecharoHQ/anubis/pull/726)
+- [Chinese (Simplified)](https://github.com/TecharoHQ/anubis/pull/774)
 - [Chinese (Traditional)](https://github.com/TecharoHQ/anubis/pull/759)
 - English
 - [Estonian](https://github.com/TecharoHQ/anubis/pull/783)
+- [Filipino](https://github.com/TecharoHQ/anubis/pull/775)
 - [French](https://github.com/TecharoHQ/anubis/pull/716)
 - [German](https://github.com/TecharoHQ/anubis/pull/741)
+- [Icelandic](https://github.com/TecharoHQ/anubis/pull/780)
+- [Italian](https://github.com/TecharoHQ/anubis/pull/778)
+- [Japanese](https://github.com/TecharoHQ/anubis/pull/772)
 - [Spanish](https://github.com/TecharoHQ/anubis/pull/716)
 - [Turkish](https://github.com/TecharoHQ/anubis/pull/751)
 
@@ -103,6 +102,18 @@ There are a bunch of other assorted features and fixes too:
 
 ### Potentially breaking changes
 
+We try to introduce breaking changes as much as possible, but these are the changes that may be relevant for you as an administrator:
+
+#### Challenge format change
+
+Previously Anubis did no accounting for challenges that it issued. This means that if Anubis restarted during a client, the client would be able to proceed once Anubis came back online.
+
+During the upgrade to v1.21.0 and when v1.21.0 (or later) restarts with the [in-memory storage backend](./admin/policies.mdx#memory), you may see a higher rate of failed challenges than normal. If this persists beyond a few minutes, [open an issue](https://github.com/TecharoHQ/anubis/issues/new).
+
+If you are using the in-memory storage backend, please consider using [a different storage backend](./admin/policies.mdx#storage-backends).
+
+#### Systemd service changes
+
 The following potentially breaking change applies to native installs with systemd only:
 
 Each instance of systemd service template now has a unique `RuntimeDirectory`, as opposed to each instance of the service sharing a `RuntimeDirectory`. This change was made to avoid [the `RuntimeDirectory` getting nuked any time one of the Anubis instances restarts](https://github.com/TecharoHQ/anubis/issues/748).

docs/docs/admin/native-install.mdx

@@ -137,7 +137,7 @@ Test to make sure it's running with `curl`:
 curl http://localhost:8240/metrics
 ```
 
-Then set up your reverse proxy (Nginx, Caddy, etc.) to point to the Anubis port. Anubis will then reverse proxy all requests that meet the policies in `/etc/anubis/gitea.botPolicies.json` to the target service.
+Then set up your reverse proxy (Nginx, Caddy, etc.) to point to the Anubis port. Anubis will then reverse proxy all requests that meet the policies in `/etc/anubis/gitea.botPolicies.yaml` to the target service.
 
 For more details on particular reverse proxies, see here:
 

docs/docs/admin/policies.mdx

@@ -268,6 +268,12 @@ The memory backend is an in-memory cache. This backend works best if you don't u
 
 The biggest downside is that there is not currently a limit to how much data can be stored in memory. This will be addressed at a later time.
 
+:::warning
+
+The in-memory backend exists mostly for validation, testing, and to ensure that the default configuration of Anubis works as expected. Do not use this persistently in production.
+
+:::
+
 #### Configuration
 
 The memory backend does not require any configuration to use.

docs/docs/user/known-instances.md

@@ -53,6 +53,10 @@ This page contains a non-exhaustive list with all websites using Anubis.
 - https://marginalia-search.com/
 - https://repositorio.ufrn.br/home/
 - https://mozillazine.org/
+- https://clew.se/
+- https://tumfatig.net/
+- https://rpmfusion.org/
+- https://wiki.freepascal.org/
 - <details>
   <summary>FreeCAD</summary>
   - https://forum.freecad.org/

docs/fly.toml

@@ -0,0 +1,19 @@
+app = 'anubis-docs'
+primary_region = 'yyz'
+
+[build]
+  image = "ghcr.io/techarohq/anubis/docs:main"
+
+[http_service]
+  internal_port = 80
+  force_https = true
+  auto_stop_machines = true
+  auto_start_machines = true
+  min_machines_running = 0
+  processes = ['app']
+
+[[vm]]
+  cpu_kind = 'shared'
+  cpus = 1
+  memory_mb = 256
+

docs/manifest/cfg/nginx/mime.types

@@ -0,0 +1,99 @@
+
+types {
+  text/html html htm shtml;
+  text/css css;
+  text/xml xml;
+  image/gif gif;
+  image/jpeg jpeg jpg;
+  application/javascript js;
+  application/atom+xml atom;
+  application/rss+xml rss;
+
+  text/mathml mml;
+  text/plain txt;
+  text/vnd.sun.j2me.app-descriptor jad;
+  text/vnd.wap.wml wml;
+  text/x-component htc;
+
+  image/avif avif;
+  image/png png;
+  image/svg+xml svg svgz;
+  image/tiff tif tiff;
+  image/vnd.wap.wbmp wbmp;
+  image/webp webp;
+  image/x-icon ico;
+  image/x-jng jng;
+  image/x-ms-bmp bmp;
+
+  font/woff woff;
+  font/woff2 woff2;
+
+  application/java-archive jar war ear;
+  application/json json;
+  application/mac-binhex40 hqx;
+  application/msword doc;
+  application/pdf pdf;
+  application/postscript ps eps ai;
+  application/rtf rtf;
+  application/vnd.apple.mpegurl m3u8;
+  application/vnd.google-earth.kml+xml kml;
+  application/vnd.google-earth.kmz kmz;
+  application/vnd.ms-excel xls;
+  application/vnd.ms-fontobject eot;
+  application/vnd.ms-powerpoint ppt;
+  application/vnd.oasis.opendocument.graphics odg;
+  application/vnd.oasis.opendocument.presentation odp;
+  application/vnd.oasis.opendocument.spreadsheet ods;
+  application/vnd.oasis.opendocument.text odt;
+  application/vnd.openxmlformats-officedocument.presentationml.presentation
+  pptx;
+  application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
+  xlsx;
+  application/vnd.openxmlformats-officedocument.wordprocessingml.document
+  docx;
+  application/vnd.wap.wmlc wmlc;
+  application/wasm wasm;
+  application/x-7z-compressed 7z;
+  application/x-cocoa cco;
+  application/x-java-archive-diff jardiff;
+  application/x-java-jnlp-file jnlp;
+  application/x-makeself run;
+  application/x-perl pl pm;
+  application/x-pilot prc pdb;
+  application/x-rar-compressed rar;
+  application/x-redhat-package-manager rpm;
+  application/x-sea sea;
+  application/x-shockwave-flash swf;
+  application/x-stuffit sit;
+  application/x-tcl tcl tk;
+  application/x-x509-ca-cert der pem crt;
+  application/x-xpinstall xpi;
+  application/xhtml+xml xhtml;
+  application/xspf+xml xspf;
+  application/zip zip;
+
+  application/octet-stream bin exe dll;
+  application/octet-stream deb;
+  application/octet-stream dmg;
+  application/octet-stream iso img;
+  application/octet-stream msi msp msm;
+
+  audio/midi mid midi kar;
+  audio/mpeg mp3;
+  audio/ogg ogg;
+  audio/x-m4a m4a;
+  audio/x-realaudio ra;
+
+  video/3gpp 3gpp 3gp;
+  video/mp2t ts;
+  video/mp4 mp4;
+  video/mpeg mpeg mpg;
+  video/quicktime mov;
+  video/webm webm;
+  video/x-flv flv;
+  video/x-m4v m4v;
+  video/x-mng mng;
+  video/x-ms-asf asx asf;
+  video/x-ms-wmv wmv;
+  video/x-msvideo avi;
+}

docs/manifest/cfg/nginx/nginx.conf

@@ -0,0 +1,31 @@
+user nginx;
+worker_processes 2;
+error_log /dev/stdout warn;
+pid /nginx.pid;
+
+events {
+  worker_connections 1024;
+}
+
+http {
+  include mime.types;
+  default_type application/octet-stream;
+  access_log /dev/stdout;
+
+  sendfile on;
+  keepalive_timeout 65;
+
+  server {
+    listen 80 default_server;
+    server_name _;
+
+    error_page 404 /404.html;
+
+    root /www;
+    index index.html;
+
+    location / {
+      try_files $uri $uri/ =404;
+    }
+  }
+}

docs/manifest/deployment.yaml

@@ -15,6 +15,9 @@ spec:
         - name: anubis
           configMap:
             name: anubis-cfg
+        - name: nginx
+          configMap:
+            name: nginx-cfg
         - name: temporary-data
           emptyDir: {}
       containers:
@@ -28,6 +31,9 @@ spec:
             requests:
               cpu: 250m
               memory: 128Mi
+          volumeMounts:
+            - name: nginx
+              mountPath: /conf
           ports:
             - containerPort: 80
         - name: anubis

docs/manifest/kustomization.yaml

@@ -11,3 +11,8 @@ configMapGenerator:
     behavior: create
     files:
       - ./cfg/anubis/botPolicies.yaml
+  - name: nginx-cfg
+    behavior: create
+    files:
+      - ./cfg/nginx/mime.types
+      - ./cfg/nginx/nginx.conf

go.mod

@@ -97,6 +97,7 @@ require (
 	github.com/goreleaser/chglog v0.7.0 // indirect
 	github.com/goreleaser/fileglob v1.3.0 // indirect
 	github.com/goreleaser/nfpm/v2 v2.42.1 // indirect
+	github.com/gorilla/mux v1.8.1 // indirect
 	github.com/hashicorp/go-version v1.7.0 // indirect
 	github.com/huandu/xstrings v1.5.0 // indirect
 	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect

go.sum

@@ -212,6 +212,8 @@ github.com/goreleaser/fileglob v1.3.0 h1:/X6J7U8lbDpQtBvGcwwPS6OpzkNVlVEsFUVRx9+
 github.com/goreleaser/fileglob v1.3.0/go.mod h1:Jx6BoXv3mbYkEzwm9THo7xbr5egkAraxkGorbJb4RxU=
 github.com/goreleaser/nfpm/v2 v2.42.1 h1:xu2pLRgQuz2ab+YZFoeIzwU/M5jjjCKDGwv1lRbVGvk=
 github.com/goreleaser/nfpm/v2 v2.42.1/go.mod h1:dY53KWYKebkOocxgkmpM7SRX0Nv5hU+jEu2kIaM4/LI=
+github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY=
+github.com/gorilla/mux v1.8.1/go.mod h1:AKf9I4AEqPTmMytcMc0KkNouC66V3BtZ4qD5fmWSiMQ=
 github.com/grpc-ecosystem/go-grpc-middleware/providers/prometheus v1.1.0 h1:QGLs/O40yoNK9vmy4rhUGBVyMf1lISBGtXRpsu/Qu/o=
 github.com/grpc-ecosystem/go-grpc-middleware/providers/prometheus v1.1.0/go.mod h1:hM2alZsMUni80N33RBe6J0e423LB+odMj7d3EMP9l20=
 github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.3.2 h1:sGm2vDRFUrQJO/Veii4h4zG2vvqG6uWNkBHSTqXOZk0=

lib/anubis.go

@@ -18,6 +18,7 @@ import (
 	"github.com/golang-jwt/jwt/v5"
 	"github.com/google/cel-go/common/types"
 	"github.com/google/uuid"
+	"github.com/gorilla/mux"
 
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/promauto"
@@ -68,7 +69,7 @@ var (
 
 type Server struct {
 	next        http.Handler
-	mux         *http.ServeMux
+	mux         *mux.Router
 	policy      *policy.ParsedConfig
 	OGTags      *ogtags.OGTagCache
 	ed25519Priv ed25519.PrivateKey

lib/challenge/interface.go

@@ -10,6 +10,7 @@ import (
 	"github.com/TecharoHQ/anubis/lib/policy/config"
 	"github.com/TecharoHQ/anubis/lib/store"
 	"github.com/a-h/templ"
+	"github.com/gorilla/mux"
 )
 
 var (
@@ -58,7 +59,7 @@ type ValidateInput struct {
 
 type Impl interface {
 	// Setup registers any additional routes with the Impl for assets or API routes.
-	Setup(mux *http.ServeMux)
+	Setup(r *mux.Router)
 
 	// Issue a new challenge to the user, called by the Anubis.
 	Issue(r *http.Request, lg *slog.Logger, in *IssueInput) (templ.Component, error)

lib/challenge/metarefresh/metarefresh.go

@@ -11,6 +11,7 @@ import (
 	"github.com/TecharoHQ/anubis/lib/localization"
 	"github.com/TecharoHQ/anubis/web"
 	"github.com/a-h/templ"
+	"github.com/gorilla/mux"
 )
 
 //go:generate go tool github.com/a-h/templ/cmd/templ generate
@@ -21,7 +22,7 @@ func init() {
 
 type Impl struct{}
 
-func (i *Impl) Setup(mux *http.ServeMux) {}
+func (i *Impl) Setup(r *mux.Router) {}
 
 func (i *Impl) Issue(r *http.Request, lg *slog.Logger, in *challenge.IssueInput) (templ.Component, error) {
 	u, err := r.URL.Parse(anubis.BasePrefix + "/.within.website/x/cmd/anubis/api/pass-challenge")

lib/challenge/proofofwork/proofofwork.go

@@ -13,6 +13,7 @@ import (
 	"github.com/TecharoHQ/anubis/lib/localization"
 	"github.com/TecharoHQ/anubis/web"
 	"github.com/a-h/templ"
+	"github.com/gorilla/mux"
 )
 
 func init() {
@@ -24,7 +25,7 @@ type Impl struct {
 	Algorithm string
 }
 
-func (i *Impl) Setup(mux *http.ServeMux) {
+func (i *Impl) Setup(r *mux.Router) {
 	/* no implementation required */
 }
 

lib/challenge/proofofwork/proofofwork_test.go

@@ -9,6 +9,7 @@ import (
 	"github.com/TecharoHQ/anubis/lib/challenge"
 	"github.com/TecharoHQ/anubis/lib/policy"
 	"github.com/TecharoHQ/anubis/lib/policy/config"
+	"github.com/gorilla/mux"
 )
 
 func mkRequest(t *testing.T, values map[string]string) *http.Request {
@@ -124,7 +125,7 @@ func TestBasic(t *testing.T) {
 		t.Run(cs.name, func(t *testing.T) {
 			lg := slog.With()
 
-			i.Setup(http.NewServeMux())
+			i.Setup(mux.NewRouter())
 
 			inp := &challenge.IssueInput{
 				Rule: bot,

lib/config.go

@@ -24,6 +24,7 @@ import (
 	"github.com/TecharoHQ/anubis/web"
 	"github.com/TecharoHQ/anubis/xess"
 	"github.com/a-h/templ"
+	"github.com/gorilla/mux"
 )
 
 type Options struct {
@@ -110,25 +111,33 @@ func New(opts Options) (*Server, error) {
 		store:       opts.Policy.Store,
 	}
 
-	mux := http.NewServeMux()
-	xess.Mount(mux)
+	r := mux.NewRouter()
+	xess.Mount(r)
 
 	// Helper to add global prefix
 	registerWithPrefix := func(pattern string, handler http.Handler, method string) {
-		if method != "" {
-			method = method + " " // methods must end with a space to register with them
-		}
-
 		// Ensure there's no double slash when concatenating BasePrefix and pattern
 		basePrefix := strings.TrimSuffix(anubis.BasePrefix, "/")
-		prefix := method + basePrefix
 
 		// If pattern doesn't start with a slash, add one
 		if !strings.HasPrefix(pattern, "/") {
 			pattern = "/" + pattern
 		}
 
-		mux.Handle(prefix+pattern, handler)
+		var route *mux.Route
+
+		switch strings.HasSuffix(pattern, "/") {
+		case true:
+			route = r.PathPrefix(basePrefix + pattern)
+		case false:
+			route = r.Path(basePrefix + pattern)
+		}
+
+		if method != "" {
+			route = route.Methods(method)
+		}
+
+		route.Handler(handler)
 	}
 
 	// Ensure there's no double slash when concatenating BasePrefix and StaticPath
@@ -164,10 +173,10 @@ func New(opts Options) (*Server, error) {
 
 	for _, implKind := range challenge.Methods() {
 		impl, _ := challenge.Get(implKind)
-		impl.Setup(mux)
+		impl.Setup(r)
 	}
 
-	result.mux = mux
+	result.mux = r
 
 	return result, nil
 }

xess/xess.go

@@ -10,6 +10,7 @@ import (
 
 	"github.com/TecharoHQ/anubis"
 	"github.com/TecharoHQ/anubis/internal"
+	"github.com/gorilla/mux"
 )
 
 var (
@@ -20,8 +21,6 @@ var (
 )
 
 func init() {
-	Mount(http.DefaultServeMux)
-
 	//goland:noinspection GoBoolExpressions
 	if anubis.Version != "devel" {
 		URL = filepath.Join(filepath.Dir(URL), "xess.min.css")
@@ -31,8 +30,10 @@ func init() {
 }
 
 // Mount registers the xess static file handlers on the given mux
-func Mount(mux *http.ServeMux) {
+func Mount(r *mux.Router) {
 	prefix := anubis.BasePrefix + "/.within.website/x/xess/"
 
-	mux.Handle(prefix, internal.UnchangingCache(http.StripPrefix(prefix, http.FileServerFS(Static))))
+	r.PathPrefix(prefix).
+		Handler(internal.UnchangingCache(http.StripPrefix(prefix, http.FileServerFS(Static)))).
+		Name("xess")
 }