Compare commits
14
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3305014847 | ||
|
|
5b5a12e57c | ||
|
|
3222c55009 | ||
|
|
580fa8f26a | ||
|
|
a320407ea5 | ||
|
|
aa19f8b854 | ||
|
|
f2fd9cd734 | ||
|
|
dadd5768d5 | ||
|
|
e6a081134a | ||
|
|
4cb91a4870 | ||
|
|
b9972af6a0 | ||
|
|
c0d9d5787e | ||
|
|
a93243a294 | ||
|
|
f52b1f9ab5 |
No files matched your search
+14
@@ -161,6 +161,20 @@ RUN git checkout --quiet --detach b4b2c785308b1ce785b6155c7fe5f16879080193 \
|
|||||||
# ubuntu 26.04, 2026-09-27
|
# ubuntu 26.04, 2026-09-27
|
||||||
FROM ubuntu@sha256:f144425ff09be612d6d9ad965196e9cdc23dae1f42110a8a11a3e9a8198759f7
|
FROM ubuntu@sha256:f144425ff09be612d6d9ad965196e9cdc23dae1f42110a8a11a3e9a8198759f7
|
||||||
|
|
||||||
|
# The image's own labels, in place of the ones it would inherit from
|
||||||
|
# Ubuntu's. script/docker and script/cibuild pass the build arguments;
|
||||||
|
# a build that passes none labels the image unknown rather than leave
|
||||||
|
# Ubuntu's values.
|
||||||
|
ARG VERSION=unknown
|
||||||
|
ARG CREATED=unknown
|
||||||
|
ARG REVISION=unknown
|
||||||
|
LABEL org.opencontainers.image.title="smallwebwaf" \
|
||||||
|
org.opencontainers.image.description="A web application firewall for self-hosted web apps: sww rproxy in front of an app, and sww waf, which decides." \
|
||||||
|
org.opencontainers.image.version="${VERSION}" \
|
||||||
|
org.opencontainers.image.created="${CREATED}" \
|
||||||
|
org.opencontainers.image.revision="${REVISION}" \
|
||||||
|
org.opencontainers.image.source="https://git.eeqj.de/sneak/smallwebwaf"
|
||||||
|
|
||||||
# runit's install creates its _runit-log user with minsysusers, which
|
# runit's install creates its _runit-log user with minsysusers, which
|
||||||
# reads this file in place of runit's /usr/lib/sysusers.d/runit.conf.
|
# reads this file in place of runit's /usr/lib/sysusers.d/runit.conf.
|
||||||
# runit's line leaves out the shell, and minsysusers prints a Perl
|
# runit's line leaves out the shell, and minsysusers prints a Perl
|
||||||
|
|||||||
@@ -416,8 +416,8 @@ full, and the limits that are fixed rather than settings.
|
|||||||
Each example is a complete `compose.yaml`. `smallwebwaf` is the tag
|
Each example is a complete `compose.yaml`. `smallwebwaf` is the tag
|
||||||
`make docker` gives the image; on another host, use the name you pushed it
|
`make docker` gives the image; on another host, use the name you pushed it
|
||||||
under, by digest. Docker Compose puts the services on a private network of its
|
under, by digest. Docker Compose puts the services on a private network of its
|
||||||
own, where each reaches the others by service name. Each example publishes
|
own, where each reaches the others by service name. Each example but "On the
|
||||||
`rproxy`'s port on the host, for trying it out.
|
open internet" publishes `rproxy`'s port on the host, for trying it out.
|
||||||
|
|
||||||
### Smallest setup
|
### Smallest setup
|
||||||
|
|
||||||
@@ -449,6 +449,142 @@ volumes:
|
|||||||
waf-state:
|
waf-state:
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### On the open internet
|
||||||
|
|
||||||
|
One gitea at `git.example.com`, with traefik in front of `rproxy`. traefik gets
|
||||||
|
the certificate from Let's Encrypt and is the only service with published ports.
|
||||||
|
`waf` sets what most sites set. More `waf` settings follow, commented out, each
|
||||||
|
with what it does and when to set it.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
services:
|
||||||
|
traefik:
|
||||||
|
# traefik v3.7.19, 2026-11-13
|
||||||
|
image: traefik@sha256:a6c0194dda77bcb804824580f36fa7edc56e315b1acfe933366c8b52844a78a4
|
||||||
|
restart: unless-stopped
|
||||||
|
command:
|
||||||
|
- --providers.docker=true
|
||||||
|
- --providers.docker.exposedByDefault=false
|
||||||
|
- --entryPoints.web.address=:80
|
||||||
|
- --entryPoints.websecure.address=:443
|
||||||
|
# Redirect plain HTTP to HTTPS.
|
||||||
|
- --entryPoints.web.http.redirections.entryPoint.to=websecure
|
||||||
|
- --entryPoints.web.http.redirections.entryPoint.scheme=https
|
||||||
|
# A Let's Encrypt certificate for each site, by the TLS-ALPN
|
||||||
|
# challenge on port 443.
|
||||||
|
- --entryPoints.websecure.http.tls.certResolver=le
|
||||||
|
- --certificatesResolvers.le.acme.email=hostmaster@example.com
|
||||||
|
- --certificatesResolvers.le.acme.storage=/letsencrypt/acme.json
|
||||||
|
- --certificatesResolvers.le.acme.tlsChallenge=true
|
||||||
|
# Give a request 10 minutes to arrive, rather than 1, for the
|
||||||
|
# large git pushes the rproxy lines below accept.
|
||||||
|
# - --entryPoints.websecure.transport.respondingTimeouts.readTimeout=600s
|
||||||
|
ports:
|
||||||
|
- "80:80"
|
||||||
|
- "443:443"
|
||||||
|
volumes:
|
||||||
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
||||||
|
- acme:/letsencrypt
|
||||||
|
|
||||||
|
app:
|
||||||
|
# Your app: here a gitea, which listens on port 3000.
|
||||||
|
image: registry.example/app@sha256:0000000000000000000000000000000000000000000000000000000000000000
|
||||||
|
restart: unless-stopped
|
||||||
|
|
||||||
|
rproxy:
|
||||||
|
image: smallwebwaf
|
||||||
|
restart: unless-stopped
|
||||||
|
environment:
|
||||||
|
SWW_RPROXY_WAF_BACKEND: http://waf:8080
|
||||||
|
SWW_RPROXY_UPSTREAM_URL: http://app:3000
|
||||||
|
# Accept git pushes up to 1 GiB, rather than 100 MiB, sent in
|
||||||
|
# up to 10 minutes, rather than 1, with traefik's readTimeout
|
||||||
|
# line above.
|
||||||
|
# SWW_RPROXY_MAX_REQUEST_SIZE: 1G
|
||||||
|
# SWW_RPROXY_MAX_REQUEST_TIME_MS: "600000"
|
||||||
|
labels:
|
||||||
|
- traefik.enable=true
|
||||||
|
- traefik.http.routers.git.rule=Host(`git.example.com`)
|
||||||
|
- traefik.http.routers.git.entryPoints=websecure
|
||||||
|
- traefik.http.services.git.loadBalancer.server.port=8080
|
||||||
|
|
||||||
|
waf:
|
||||||
|
image: smallwebwaf
|
||||||
|
restart: unless-stopped
|
||||||
|
environment:
|
||||||
|
SWW_COMMAND: waf
|
||||||
|
# The name in every log line, alert and metric. The default,
|
||||||
|
# the container's host name, is a random id under Compose.
|
||||||
|
SWW_WAF_INSTANCE_NAME: host1/waf
|
||||||
|
# The app each hostname serves. Only that app's fixes to the
|
||||||
|
# Core Rule Set apply there.
|
||||||
|
SWW_WAF_APPS: git.example.com:gitea
|
||||||
|
# Monitoring skips every check.
|
||||||
|
SWW_WAF_ALLOW_NETS: 192.0.2.10
|
||||||
|
# The office and the CI runner, which would exceed the rate
|
||||||
|
# limits, are never rate limited.
|
||||||
|
SWW_WAF_RATE_LIMIT_EXEMPT_NETS: 203.0.113.0/24,198.51.100.7
|
||||||
|
# WordPress paths, which only scanners ask a gitea for. One
|
||||||
|
# request for one bans the client.
|
||||||
|
SWW_WAF_TRAP_PATHS: /wp-login.php,/xmlrpc.php
|
||||||
|
# Spamhaus's list of netblocks hijacked or leased by
|
||||||
|
# criminals. Their clients are refused.
|
||||||
|
SWW_WAF_BLOCKLIST_URLS: https://www.spamhaus.org/drop/drop.txt
|
||||||
|
# The token for the ban endpoints, to lift a ban without
|
||||||
|
# editing bans.json.
|
||||||
|
SWW_WAF_ADMIN_TOKEN_FILE: /etc/sww/tokens/admin
|
||||||
|
# Alerts, such as one for each ban, to an ntfy topic.
|
||||||
|
SWW_WAF_ALERT_NTFY_URL: https://ntfy.example.com/smallwebwaf
|
||||||
|
|
||||||
|
# Refuse nothing and ban no one, for the first days. Each log
|
||||||
|
# line says what enforce mode would have done.
|
||||||
|
# SWW_WAF_MODE: observe
|
||||||
|
# The access token for an ntfy topic that is not public.
|
||||||
|
# SWW_WAF_ALERT_NTFY_TOKEN_FILE: /etc/sww/tokens/ntfy
|
||||||
|
# The token for /_sww/metrics, for Prometheus. Unset, the
|
||||||
|
# metrics are off.
|
||||||
|
# SWW_WAF_METRICS_TOKEN_FILE: /etc/sww/tokens/metrics
|
||||||
|
# 600 requests an hour rather than 1500, to ban slower
|
||||||
|
# scrapers. A fast human reader can reach it too.
|
||||||
|
# SWW_WAF_RATE_LIMIT_PER_HOUR: "600"
|
||||||
|
# A quarter of every limit for clients in two hosting
|
||||||
|
# networks, where scrapers run rather than people.
|
||||||
|
# SWW_WAF_TAG_LIMIT_PERCENT: asn=14061:25,asn=16276:25
|
||||||
|
# For a site only for people in a few countries. Clients
|
||||||
|
# elsewhere are refused, and so are any the lookup cannot place.
|
||||||
|
# SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES: de,at,ch
|
||||||
|
# Close a refused request's connection rather than answer
|
||||||
|
# 403. traefik then answers 502, so a scraper cannot tell a
|
||||||
|
# ban from a broken site.
|
||||||
|
# SWW_WAF_BAN_RESPONSE: close
|
||||||
|
# A copy of every log line to a syslog server.
|
||||||
|
# SWW_WAF_LOG_REMOTE_URL: syslog+tls://logs.example.com:6514
|
||||||
|
volumes:
|
||||||
|
- waf-state:/var/lib/sww
|
||||||
|
- /srv/sww/tokens:/etc/sww/tokens:ro
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
acme:
|
||||||
|
waf-state:
|
||||||
|
```
|
||||||
|
|
||||||
|
Change these before the first start:
|
||||||
|
|
||||||
|
- `git.example.com`, in the router rule and in `SWW_WAF_APPS`;
|
||||||
|
- the email address for Let's Encrypt;
|
||||||
|
- the ntfy topic's URL;
|
||||||
|
- the app's image and port;
|
||||||
|
- the netblocks, which are documentation addresses.
|
||||||
|
|
||||||
|
Make the admin token file first, as for any token file:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
mkdir -p /srv/sww/tokens
|
||||||
|
openssl rand -hex 32 > /srv/sww/tokens/admin
|
||||||
|
chown 65532:65532 /srv/sww/tokens/admin
|
||||||
|
chmod 0400 /srv/sww/tokens/admin
|
||||||
|
```
|
||||||
|
|
||||||
### Custom per-address limits
|
### Custom per-address limits
|
||||||
|
|
||||||
For a site with no API:
|
For a site with no API:
|
||||||
|
|||||||
@@ -9,6 +9,10 @@
|
|||||||
ARG SWW_IMAGE=smallwebwaf
|
ARG SWW_IMAGE=smallwebwaf
|
||||||
FROM ${SWW_IMAGE}
|
FROM ${SWW_IMAGE}
|
||||||
|
|
||||||
|
# Its own title and description, in place of the smallwebwaf image's.
|
||||||
|
LABEL org.opencontainers.image.title="smallwebwaf-example-app" \
|
||||||
|
org.opencontainers.image.description="An example app built on the smallwebwaf image."
|
||||||
|
|
||||||
# Packages the app needs, from the nixpkgs in the image.
|
# Packages the app needs, from the nixpkgs in the image.
|
||||||
RUN nix-env -iA nixpkgs.busybox
|
RUN nix-env -iA nixpkgs.busybox
|
||||||
|
|
||||||
|
|||||||
@@ -31,10 +31,12 @@ import (
|
|||||||
// this package: Go's resolver counts the queries under way in one
|
// this package: Go's resolver counts the queries under way in one
|
||||||
// sync.WaitGroup for the whole process, and the process fails when
|
// sync.WaitGroup for the whole process, and the process fails when
|
||||||
// queries from two bubbles, or from a bubble and from outside one, are
|
// queries from two bubbles, or from a bubble and from outside one, are
|
||||||
// under way at once. TestMain has the resolver make its configuration,
|
// under way at once. The one test outside a bubble is parallel, so it
|
||||||
// which it makes on its first query, outside every bubble, since the
|
// starts only once every test that is not parallel has ended; no other
|
||||||
// configuration holds a channel, which the bubble it was made in would
|
// parallel test of this package queries a resolver. TestMain has the
|
||||||
// keep to itself.
|
// resolver make its configuration, which it makes on its first query,
|
||||||
|
// outside every bubble, since the configuration holds a channel, which
|
||||||
|
// the bubble it was made in would keep to itself.
|
||||||
|
|
||||||
const (
|
const (
|
||||||
// zone and otherZone are the DNSBL zones the tests name.
|
// zone and otherZone are the DNSBL zones the tests name.
|
||||||
@@ -525,8 +527,9 @@ func TestAtMost100000VerdictsKeptTheOneFetchedLongestAgoDroppedFirst(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
//nolint:paralleltest // one at a time, as the comment at the top of this file says
|
|
||||||
func TestQueriesGoToTheResolverSWWDNSBLResolverNames(t *testing.T) {
|
func TestQueriesGoToTheResolverSWWDNSBLResolverNames(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
resolver := &resolverStandIn{answers: map[string]answer{
|
resolver := &resolverStandIn{answers: map[string]answer{
|
||||||
listedName: {addrs: []string{listing}},
|
listedName: {addrs: []string{listing}},
|
||||||
}}
|
}}
|
||||||
|
|||||||
@@ -20,8 +20,13 @@ main() {
|
|||||||
# the version a build stage derives from the .git in the context.
|
# the version a build stage derives from the .git in the context.
|
||||||
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
||||||
[ -n "$version" ] || version="unknown"
|
[ -n "$version" ] || version="unknown"
|
||||||
|
revision="$(git rev-parse HEAD 2>/dev/null || true)"
|
||||||
|
[ -n "$revision" ] || revision="unknown"
|
||||||
|
created="$(date -u +%Y-%m-%dT%H:%M:%SZ)"
|
||||||
docker build --no-cache \
|
docker build --no-cache \
|
||||||
--build-arg VERSION="$version" \
|
--build-arg VERSION="$version" \
|
||||||
|
--build-arg REVISION="$revision" \
|
||||||
|
--build-arg CREATED="$created" \
|
||||||
-t "$("$SCRIPT_DIR/projectname")" .
|
-t "$("$SCRIPT_DIR/projectname")" .
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -16,8 +16,13 @@ main() {
|
|||||||
# the version a build stage derives from the .git in the context.
|
# the version a build stage derives from the .git in the context.
|
||||||
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
||||||
[ -n "$version" ] || version="unknown"
|
[ -n "$version" ] || version="unknown"
|
||||||
|
revision="$(git rev-parse HEAD 2>/dev/null || true)"
|
||||||
|
[ -n "$revision" ] || revision="unknown"
|
||||||
|
created="$(date -u +%Y-%m-%dT%H:%M:%SZ)"
|
||||||
docker build --no-cache \
|
docker build --no-cache \
|
||||||
--build-arg VERSION="$version" \
|
--build-arg VERSION="$version" \
|
||||||
|
--build-arg REVISION="$revision" \
|
||||||
|
--build-arg CREATED="$created" \
|
||||||
-t "$("$SCRIPT_DIR/projectname")" .
|
-t "$("$SCRIPT_DIR/projectname")" .
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user