Compare commits
2
Commits
next
...
block-pages
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b157359910 | ||
|
|
5dfa47c97b |
No files matched your search
@@ -308,6 +308,7 @@ Every setting the code reads, with its default:
|
|||||||
| `SWW_RPROXY_MAX_RESPONSE_SIZE` | `1G` | The largest response body, a size or `off`. The visitor gets `502` in place of a larger one, or it is cut off if it has already started. |
|
| `SWW_RPROXY_MAX_RESPONSE_SIZE` | `1G` | The largest response body, a size or `off`. The visitor gets `502` in place of a larger one, or it is cut off if it has already started. |
|
||||||
| `SWW_RPROXY_MAX_REQUEST_TIME_MS` | `60000` | Two time limits, each this long, in milliseconds or `off`: one for the visitor to send its request line and headers, then one for the whole request to reach the app. |
|
| `SWW_RPROXY_MAX_REQUEST_TIME_MS` | `60000` | Two time limits, each this long, in milliseconds or `off`: one for the visitor to send its request line and headers, then one for the whole request to reach the app. |
|
||||||
| `SWW_RPROXY_MAX_RESPONSE_TIME_MS` | `1800000` | How long the answer may take, from the end of the request to its last byte reaching the visitor, in milliseconds or `off`. |
|
| `SWW_RPROXY_MAX_RESPONSE_TIME_MS` | `1800000` | How long the answer may take, from the end of the request to its last byte reaching the visitor, in milliseconds or `off`. |
|
||||||
|
| `SWW_RPROXY_CONTACT_EMAIL` | unset | The email address the refusal pages link to. |
|
||||||
| `SWW_WAF_LISTEN_ADDR` | `:8080` | Where `waf` listens; leave the host part empty. |
|
| `SWW_WAF_LISTEN_ADDR` | `:8080` | Where `waf` listens; leave the host part empty. |
|
||||||
| `SWW_WAF_INSTANCE_NAME` | the container's host name | The name in every line `waf` logs, and in every alert and metric, such as `host1/waf`. |
|
| `SWW_WAF_INSTANCE_NAME` | the container's host name | The name in every line `waf` logs, and in every alert and metric, such as `host1/waf`. |
|
||||||
| `SWW_WAF_MODE` | `enforce` | `observe` refuses nothing and makes no ban; each log line says what `enforce` would have done. |
|
| `SWW_WAF_MODE` | `enforce` | `observe` refuses nothing and makes no ban; each log line says what `enforce` would have done. |
|
||||||
|
|||||||
@@ -2431,8 +2431,9 @@ but the last below carries `X-Sww-Disposition`.
|
|||||||
carries `X-Client-ASN` and `X-Client-Country`, which `rproxy` adds to the
|
carries `X-Client-ASN` and `X-Client-Country`, which `rproxy` adds to the
|
||||||
request it passes on. A header whose value is unknown is left out.
|
request it passes on. A header whose value is unknown is left out.
|
||||||
- `X-Sww-Disposition: deny`, with the status, headers and body the visitor is to
|
- `X-Sww-Disposition: deny`, with the status, headers and body the visitor is to
|
||||||
get. `rproxy` gives them to the visitor, less this header. The status is one
|
get. `rproxy` gives them to the visitor, less this header; a `403` or `429`
|
||||||
of:
|
gets `rproxy`'s own page as its body, linking `SWW_RPROXY_CONTACT_EMAIL` when
|
||||||
|
set. The status is one of:
|
||||||
- `SWW_WAF_BAN_RESPONSE`, for a refusal;
|
- `SWW_WAF_BAN_RESPONSE`, for a refusal;
|
||||||
- `403`, for a `block` rule or the Core Rule Set;
|
- `403`, for a `block` rule or the Core Rule Set;
|
||||||
- `414` or `431`, for a request over the header limits;
|
- `414` or `431`, for a request over the header limits;
|
||||||
|
|||||||
@@ -10,6 +10,9 @@ services:
|
|||||||
SWW_RPROXY_WAF_BACKEND: http://waf:8080
|
SWW_RPROXY_WAF_BACKEND: http://waf:8080
|
||||||
SWW_RPROXY_UPSTREAM_URL: http://exampleapp:8081
|
SWW_RPROXY_UPSTREAM_URL: http://exampleapp:8081
|
||||||
|
|
||||||
|
# The address the refusal pages link to.
|
||||||
|
# SWW_RPROXY_CONTACT_EMAIL: ops@example.com
|
||||||
|
|
||||||
# The netblocks whose X-Forwarded-For rproxy believes. By default
|
# The netblocks whose X-Forwarded-For rproxy believes. By default
|
||||||
# the private ranges, which cover a TLS-terminating proxy on the
|
# the private ranges, which cover a TLS-terminating proxy on the
|
||||||
# Docker network. A proxy elsewhere needs its address added; a
|
# Docker network. A proxy elsewhere needs its address added; a
|
||||||
|
|||||||
@@ -483,6 +483,8 @@ start, and an invalid value stops the start. Any can be given as a file, as a
|
|||||||
answer `rproxy` gives itself always has at least 10 seconds to be sent, and so
|
answer `rproxy` gives itself always has at least 10 seconds to be sent, and so
|
||||||
do the status and headers of the app's answer. A time in milliseconds or
|
do the status and headers of the app's answer. A time in milliseconds or
|
||||||
`off`.
|
`off`.
|
||||||
|
- `SWW_RPROXY_CONTACT_EMAIL` (default unset): the email address the refusal
|
||||||
|
pages link to.
|
||||||
- `SWW_RPROXY_LISTEN_ADDR` (default `:8080`): where `rproxy` listens, such as
|
- `SWW_RPROXY_LISTEN_ADDR` (default `:8080`): where `rproxy` listens, such as
|
||||||
`:9000`.
|
`:9000`.
|
||||||
- `SWW_RPROXY_UPSTREAM_URL` (default `http://127.0.0.1:8081`): the app. An
|
- `SWW_RPROXY_UPSTREAM_URL` (default `http://127.0.0.1:8081`): the app. An
|
||||||
|
|||||||
@@ -46,6 +46,9 @@ type RProxy struct {
|
|||||||
// (SWW_RPROXY_MAX_RESPONSE_TIME_MS).
|
// (SWW_RPROXY_MAX_RESPONSE_TIME_MS).
|
||||||
MaxRequestTime time.Duration
|
MaxRequestTime time.Duration
|
||||||
MaxResponseTime time.Duration
|
MaxResponseTime time.Duration
|
||||||
|
// ContactEmail is the address the pages a refused visitor gets link to,
|
||||||
|
// or "" for no link (SWW_RPROXY_CONTACT_EMAIL). It is taken as given.
|
||||||
|
ContactEmail string
|
||||||
|
|
||||||
// settings are the values read, as given or by default, for the log line
|
// settings are the values read, as given or by default, for the log line
|
||||||
// at start.
|
// at start.
|
||||||
@@ -108,6 +111,7 @@ func RProxyFromEnvironment(v *viper.Viper) (*RProxy, error) {
|
|||||||
"SWW_RPROXY_MAX_RESPONSE_TIME_MS",
|
"SWW_RPROXY_MAX_RESPONSE_TIME_MS",
|
||||||
"1800000",
|
"1800000",
|
||||||
),
|
),
|
||||||
|
ContactEmail: env.value("SWW_RPROXY_CONTACT_EMAIL", ""),
|
||||||
}
|
}
|
||||||
|
|
||||||
if env.err != nil {
|
if env.err != nil {
|
||||||
|
|||||||
@@ -25,6 +25,7 @@ const (
|
|||||||
rproxyMaxResponse = "SWW_RPROXY_MAX_RESPONSE_SIZE"
|
rproxyMaxResponse = "SWW_RPROXY_MAX_RESPONSE_SIZE"
|
||||||
rproxyRequestTime = "SWW_RPROXY_MAX_REQUEST_TIME_MS"
|
rproxyRequestTime = "SWW_RPROXY_MAX_REQUEST_TIME_MS"
|
||||||
rproxyAnswerTime = "SWW_RPROXY_MAX_RESPONSE_TIME_MS"
|
rproxyAnswerTime = "SWW_RPROXY_MAX_RESPONSE_TIME_MS"
|
||||||
|
rproxyContactEmail = "SWW_RPROXY_CONTACT_EMAIL"
|
||||||
backendURL = "http://waf:8080"
|
backendURL = "http://waf:8080"
|
||||||
rproxyNoAnswerAddr = ":8080"
|
rproxyNoAnswerAddr = ":8080"
|
||||||
rproxyNoAnswerApp = "http://127.0.0.1:8081"
|
rproxyNoAnswerApp = "http://127.0.0.1:8081"
|
||||||
@@ -250,6 +251,7 @@ func TestRProxySettingsAreLoggedByName(t *testing.T) {
|
|||||||
rproxyListen, rproxyUpstream, rproxyTrusted, wafBackend, wafBackendTimeout,
|
rproxyListen, rproxyUpstream, rproxyTrusted, wafBackend, wafBackendTimeout,
|
||||||
rproxyNoAnswer,
|
rproxyNoAnswer,
|
||||||
rproxyMaxRequest, rproxyMaxResponse, rproxyRequestTime, rproxyAnswerTime,
|
rproxyMaxRequest, rproxyMaxResponse, rproxyRequestTime, rproxyAnswerTime,
|
||||||
|
rproxyContactEmail,
|
||||||
} {
|
} {
|
||||||
if !slices.Contains(names, name) {
|
if !slices.Contains(names, name) {
|
||||||
t.Errorf("%s is not logged, only %v", name, names)
|
t.Errorf("%s is not logged, only %v", name, names)
|
||||||
|
|||||||
@@ -0,0 +1,71 @@
|
|||||||
|
package rproxy
|
||||||
|
|
||||||
|
import (
|
||||||
|
"embed"
|
||||||
|
"html"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// pageFiles are the pages a refused visitor gets, as HTML with nothing
|
||||||
|
// external: refused.html for a 403, ratelimited.html for a 429.
|
||||||
|
//
|
||||||
|
//go:embed refused.html ratelimited.html
|
||||||
|
var pageFiles embed.FS
|
||||||
|
|
||||||
|
// contactSentence is the sentence of each page that becomes a link to
|
||||||
|
// SWW_RPROXY_CONTACT_EMAIL when that is set.
|
||||||
|
const contactSentence = "contact the site's operator"
|
||||||
|
|
||||||
|
// htmlContentType is the Content-Type of the pages.
|
||||||
|
const htmlContentType = "text/html; charset=utf-8"
|
||||||
|
|
||||||
|
// blockPages are the pages a refused visitor gets, ready to send, made once
|
||||||
|
// at start.
|
||||||
|
type blockPages struct {
|
||||||
|
refused []byte
|
||||||
|
rateLimited []byte
|
||||||
|
}
|
||||||
|
|
||||||
|
// newBlockPages makes the pages. With contactEmail set, each page's
|
||||||
|
// contactSentence is a mailto link to it.
|
||||||
|
func newBlockPages(contactEmail string) blockPages {
|
||||||
|
return blockPages{
|
||||||
|
refused: readPage("refused.html", contactEmail),
|
||||||
|
rateLimited: readPage("ratelimited.html", contactEmail),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// readPage reads the page in name from pageFiles, linking its
|
||||||
|
// contactSentence to contactEmail unless that is "". The files are part of
|
||||||
|
// the binary, so a missing one is a bug, and a panic.
|
||||||
|
func readPage(name, contactEmail string) []byte {
|
||||||
|
contents, err := pageFiles.ReadFile(name)
|
||||||
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if contactEmail == "" {
|
||||||
|
return contents
|
||||||
|
}
|
||||||
|
|
||||||
|
link := `<a href="mailto:` + html.EscapeString(contactEmail) + `">` +
|
||||||
|
contactSentence + `</a>`
|
||||||
|
|
||||||
|
return []byte(
|
||||||
|
strings.Replace(string(contents), contactSentence, link, 1),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// forStatus returns the page for a refusal with status, and whether there is
|
||||||
|
// one: the rate-limited page for a 429, the refused page for a 403.
|
||||||
|
func (p blockPages) forStatus(status int) ([]byte, bool) {
|
||||||
|
switch status {
|
||||||
|
case http.StatusForbidden:
|
||||||
|
return p.refused, true
|
||||||
|
case http.StatusTooManyRequests:
|
||||||
|
return p.rateLimited, true
|
||||||
|
default:
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
<meta name="robots" content="noindex">
|
||||||
|
<title>Too many requests</title>
|
||||||
|
<style>
|
||||||
|
:root{color-scheme:light dark;--fg:#1a1a1a;--muted:#5c5c5c;--bg:#f6f6f4}
|
||||||
|
@media(prefers-color-scheme:dark){:root{--fg:#ebebe8;--muted:#9a9a96;--bg:#161616}}
|
||||||
|
html{background:var(--bg);color:var(--fg);font:16px/1.5 system-ui,-apple-system,"Segoe UI",Roboto,sans-serif}
|
||||||
|
body{margin:0;min-height:100vh;display:flex;align-items:center;justify-content:center;padding:1.5rem}
|
||||||
|
main{max-width:34rem;width:100%}
|
||||||
|
p.code{margin:0 0 .5rem;color:var(--muted);font-size:.8rem;letter-spacing:.08em}
|
||||||
|
h1{margin:0 0 1rem;font-size:1.6rem;font-weight:600;line-height:1.25}
|
||||||
|
p{margin:0 0 1rem}
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<main>
|
||||||
|
<p class="code">429</p>
|
||||||
|
<h1>Too many requests</h1>
|
||||||
|
<p>Your address has sent more requests than this site allows in a short time. Wait a while, then try again.</p>
|
||||||
|
<p>If you think this is a mistake, contact the site's operator.</p>
|
||||||
|
</main>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
<meta name="robots" content="noindex">
|
||||||
|
<title>Request refused</title>
|
||||||
|
<style>
|
||||||
|
:root{color-scheme:light dark;--fg:#1a1a1a;--muted:#5c5c5c;--bg:#f6f6f4}
|
||||||
|
@media(prefers-color-scheme:dark){:root{--fg:#ebebe8;--muted:#9a9a96;--bg:#161616}}
|
||||||
|
html{background:var(--bg);color:var(--fg);font:16px/1.5 system-ui,-apple-system,"Segoe UI",Roboto,sans-serif}
|
||||||
|
body{margin:0;min-height:100vh;display:flex;align-items:center;justify-content:center;padding:1.5rem}
|
||||||
|
main{max-width:34rem;width:100%}
|
||||||
|
p.code{margin:0 0 .5rem;color:var(--muted);font-size:.8rem;letter-spacing:.08em}
|
||||||
|
h1{margin:0 0 1rem;font-size:1.6rem;font-weight:600;line-height:1.25}
|
||||||
|
p{margin:0 0 1rem}
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<main>
|
||||||
|
<p class="code">403</p>
|
||||||
|
<h1>Request refused</h1>
|
||||||
|
<p>This site did not accept your request.</p>
|
||||||
|
<p>If you think this is a mistake, contact the site's operator.</p>
|
||||||
|
</main>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -92,6 +92,7 @@ func New(params Params) *Server {
|
|||||||
Path: wafprotocol.ReportPath,
|
Path: wafprotocol.ReportPath,
|
||||||
}).String(),
|
}).String(),
|
||||||
breakerClock: time.Now,
|
breakerClock: time.Now,
|
||||||
|
pages: newBlockPages(params.Config.ContactEmail),
|
||||||
}
|
}
|
||||||
|
|
||||||
s := &Server{h: h}
|
s := &Server{h: h}
|
||||||
@@ -156,6 +157,8 @@ type handler struct {
|
|||||||
breakerClock func() time.Time
|
breakerClock func() time.Time
|
||||||
// reports are the goroutines sending reports to waf.
|
// reports are the goroutines sending reports to waf.
|
||||||
reports reportGoroutines
|
reports reportGoroutines
|
||||||
|
// pages are the pages a refused visitor gets.
|
||||||
|
pages blockPages
|
||||||
}
|
}
|
||||||
|
|
||||||
// newTransport returns what carries requests to the app. It never goes through
|
// newTransport returns what carries requests to the app. It never goes through
|
||||||
|
|||||||
+180
-29
@@ -11,6 +11,7 @@ import (
|
|||||||
"net"
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
|
"os"
|
||||||
"slices"
|
"slices"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -52,8 +53,56 @@ const (
|
|||||||
maxResponseSize = "SWW_RPROXY_MAX_RESPONSE_SIZE"
|
maxResponseSize = "SWW_RPROXY_MAX_RESPONSE_SIZE"
|
||||||
maxRequestTime = "SWW_RPROXY_MAX_REQUEST_TIME_MS"
|
maxRequestTime = "SWW_RPROXY_MAX_REQUEST_TIME_MS"
|
||||||
maxResponseTime = "SWW_RPROXY_MAX_RESPONSE_TIME_MS"
|
maxResponseTime = "SWW_RPROXY_MAX_RESPONSE_TIME_MS"
|
||||||
|
contactEmail = "SWW_RPROXY_CONTACT_EMAIL"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// The pages rproxy gives a refused visitor in place of waf's body.
|
||||||
|
const (
|
||||||
|
// refusedPageFile and rateLimitedPageFile are the pages' files, beside
|
||||||
|
// the code.
|
||||||
|
refusedPageFile = "refused.html"
|
||||||
|
rateLimitedPageFile = "ratelimited.html"
|
||||||
|
// contactSentence is the sentence of each page that becomes a link to
|
||||||
|
// SWW_RPROXY_CONTACT_EMAIL.
|
||||||
|
contactSentence = "contact the site's operator"
|
||||||
|
htmlContentType = "text/html; charset=utf-8"
|
||||||
|
)
|
||||||
|
|
||||||
|
// page is the page in file, as rproxy serves it without a contact email.
|
||||||
|
func page(t *testing.T, file string) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
//nolint:gosec // a page beside the code
|
||||||
|
contents, err := os.ReadFile(file)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("read the page: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return string(contents)
|
||||||
|
}
|
||||||
|
|
||||||
|
// wantPage checks that got is status with the page in file as its body, and
|
||||||
|
// the headers of a page.
|
||||||
|
func wantPage(t *testing.T, got answered, status int, file string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
if got.status != status || got.body != page(t, file) {
|
||||||
|
t.Errorf(
|
||||||
|
"answered %d %q, want %d and %s",
|
||||||
|
got.status,
|
||||||
|
got.body,
|
||||||
|
status,
|
||||||
|
file,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got.header.Get("Content-Type") != htmlContentType ||
|
||||||
|
got.header.Get("X-Content-Type-Options") != "nosniff" ||
|
||||||
|
got.header.Get("Cache-Control") != "no-store" {
|
||||||
|
t.Errorf("the page's headers are %v", got.header)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// The headers the tests set and look at.
|
// The headers the tests set and look at.
|
||||||
const (
|
const (
|
||||||
dispositionHeader = wafprotocol.DispositionHeader
|
dispositionHeader = wafprotocol.DispositionHeader
|
||||||
@@ -306,6 +355,20 @@ func deny(w http.ResponseWriter, _ *http.Request) {
|
|||||||
_, _ = io.WriteString(w, deniedBody)
|
_, _ = io.WriteString(w, deniedBody)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// answerAs answers a question with status and body, with disposition unless
|
||||||
|
// it is "", and a header of its own.
|
||||||
|
func answerAs(disposition string, status int, body string) http.HandlerFunc {
|
||||||
|
return func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
if disposition != "" {
|
||||||
|
w.Header().Set(dispositionHeader, disposition)
|
||||||
|
}
|
||||||
|
|
||||||
|
w.Header().Set(fromWAFHeader, addedHeaderValue)
|
||||||
|
w.WriteHeader(status)
|
||||||
|
_, _ = io.WriteString(w, body)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// startApp starts app as the app rproxy passes requests to.
|
// startApp starts app as the app rproxy passes requests to.
|
||||||
func startApp(t *testing.T, app http.HandlerFunc) *httptest.Server {
|
func startApp(t *testing.T, app http.HandlerFunc) *httptest.Server {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
@@ -767,7 +830,7 @@ func TestRemovesTheVisitorsLookupHeadersWhenWAFGivesNone(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestDenyGivesTheVisitorWAFsAnswer(t *testing.T) {
|
func TestDenyGivesTheVisitorTheRefusedPageWithWAFsHeaders(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
standIn := startWAF(t, deny)
|
standIn := startWAF(t, deny)
|
||||||
@@ -777,9 +840,10 @@ func TestDenyGivesTheVisitorWAFsAnswer(t *testing.T) {
|
|||||||
addr, out := startRProxy(t, standIn.URL, app.URL, nil)
|
addr, out := startRProxy(t, standIn.URL, app.URL, nil)
|
||||||
|
|
||||||
got := get(t, addr, "/")
|
got := get(t, addr, "/")
|
||||||
if got.status != http.StatusForbidden || got.body != deniedBody ||
|
wantPage(t, got, http.StatusForbidden, refusedPageFile)
|
||||||
got.header.Get(fromWAFHeader) != addedHeaderValue {
|
|
||||||
t.Errorf("answered %+v, want waf's answer", got)
|
if got.header.Get(fromWAFHeader) != addedHeaderValue {
|
||||||
|
t.Errorf("answered %+v, want waf's headers", got)
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(got.header.Values(dispositionHeader)) != 0 {
|
if len(got.header.Values(dispositionHeader)) != 0 {
|
||||||
@@ -788,7 +852,7 @@ func TestDenyGivesTheVisitorWAFsAnswer(t *testing.T) {
|
|||||||
|
|
||||||
report := standIn.report(t)
|
report := standIn.report(t)
|
||||||
if report.Status != http.StatusForbidden ||
|
if report.Status != http.StatusForbidden ||
|
||||||
report.ResponseBytes != int64(len(deniedBody)) ||
|
report.ResponseBytes != int64(len(page(t, refusedPageFile))) ||
|
||||||
report.DurationUpstreamTotalMS != 0 {
|
report.DurationUpstreamTotalMS != 0 {
|
||||||
t.Errorf("report %+v, of a request denied", report)
|
t.Errorf("report %+v, of a request denied", report)
|
||||||
}
|
}
|
||||||
@@ -800,7 +864,7 @@ func TestDenyGivesTheVisitorWAFsAnswer(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestADeniedHeadKeepsWAFsContentLength(t *testing.T) {
|
func TestADeniedHeadGivesThePagesContentLength(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
standIn := startWAF(t, deny)
|
standIn := startWAF(t, deny)
|
||||||
@@ -808,13 +872,13 @@ func TestADeniedHeadKeepsWAFsContentLength(t *testing.T) {
|
|||||||
addr, _ := startRProxy(t, standIn.URL, app.URL, nil)
|
addr, _ := startRProxy(t, standIn.URL, app.URL, nil)
|
||||||
|
|
||||||
got := visit(t, newRequest(t, http.MethodHead, addr, "/", http.NoBody))
|
got := visit(t, newRequest(t, http.MethodHead, addr, "/", http.NoBody))
|
||||||
if got.status != http.StatusForbidden ||
|
if got.status != http.StatusForbidden || got.body != "" ||
|
||||||
got.header.Get(
|
got.header.Get(
|
||||||
contentLengthHeader,
|
contentLengthHeader,
|
||||||
) != strconv.Itoa(
|
) != strconv.Itoa(
|
||||||
len(deniedBody),
|
len(page(t, refusedPageFile)),
|
||||||
) {
|
) {
|
||||||
t.Errorf("answered %+v, want waf's 403 and its length", got)
|
t.Errorf("answered %+v, want waf's 403 and the page's length", got)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -823,11 +887,13 @@ func TestAnAnswerRProxyHoldsWholeIsSentBeforeItsLogLine(t *testing.T) {
|
|||||||
|
|
||||||
const host = " HTTP/1.1\r\nHost: site.example\r\n\r\n"
|
const host = " HTTP/1.1\r\nHost: site.example\r\n\r\n"
|
||||||
|
|
||||||
|
refusedPage := page(t, refusedPageFile)
|
||||||
|
|
||||||
for _, tc := range []struct {
|
for _, tc := range []struct {
|
||||||
name, request, body string
|
name, request, body string
|
||||||
status int
|
status int
|
||||||
}{
|
}{
|
||||||
{"a deny", "GET /" + host, deniedBody, http.StatusForbidden},
|
{"a deny", "GET /" + host, refusedPage, http.StatusForbidden},
|
||||||
{"rproxy's own answer", "GET x:admin" + host, "Bad Request\n", http.StatusBadRequest},
|
{"rproxy's own answer", "GET x:admin" + host, "Bad Request\n", http.StatusBadRequest},
|
||||||
{"the health check", "GET " + wafprotocol.HealthPath + host, "ok\n", http.StatusOK},
|
{"the health check", "GET " + wafprotocol.HealthPath + host, "ok\n", http.StatusOK},
|
||||||
} {
|
} {
|
||||||
@@ -899,6 +965,83 @@ func TestRProxysOwnAnswerIsPlainText(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestADenyOf429GivesTheVisitorTheRateLimitedPage(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
standIn := startWAF(t, func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.Header().Set(dispositionHeader, dispositionDeny)
|
||||||
|
w.Header().Set("Content-Type", "text/plain; charset=utf-8")
|
||||||
|
w.WriteHeader(http.StatusTooManyRequests)
|
||||||
|
_, _ = io.WriteString(w, deniedBody)
|
||||||
|
})
|
||||||
|
app := startApp(t, greet)
|
||||||
|
addr, _ := startRProxy(t, standIn.URL, app.URL, nil)
|
||||||
|
|
||||||
|
wantPage(
|
||||||
|
t,
|
||||||
|
get(t, addr, "/"),
|
||||||
|
http.StatusTooManyRequests,
|
||||||
|
rateLimitedPageFile,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestThePagesLinkTheContactEmail(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
const email = "ops@example.com"
|
||||||
|
|
||||||
|
link := `<a href="mailto:` + email + `">` + contactSentence + `</a>`
|
||||||
|
|
||||||
|
for _, tc := range []struct {
|
||||||
|
file string
|
||||||
|
status int
|
||||||
|
}{
|
||||||
|
{refusedPageFile, http.StatusForbidden},
|
||||||
|
{rateLimitedPageFile, http.StatusTooManyRequests},
|
||||||
|
} {
|
||||||
|
t.Run(tc.file, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
standIn := startWAF(
|
||||||
|
t,
|
||||||
|
func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.Header().Set(dispositionHeader, dispositionDeny)
|
||||||
|
w.WriteHeader(tc.status)
|
||||||
|
},
|
||||||
|
)
|
||||||
|
app := startApp(t, greet)
|
||||||
|
addr, _ := startRProxy(
|
||||||
|
t,
|
||||||
|
standIn.URL,
|
||||||
|
app.URL,
|
||||||
|
map[string]string{contactEmail: email},
|
||||||
|
)
|
||||||
|
|
||||||
|
got := get(t, addr, "/")
|
||||||
|
want := strings.Replace(
|
||||||
|
page(t, tc.file),
|
||||||
|
contactSentence,
|
||||||
|
link,
|
||||||
|
1,
|
||||||
|
)
|
||||||
|
|
||||||
|
if got.status != tc.status || got.body != want {
|
||||||
|
t.Errorf(
|
||||||
|
"answered %d %q, want %d %q",
|
||||||
|
got.status,
|
||||||
|
got.body,
|
||||||
|
tc.status,
|
||||||
|
want,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !strings.Contains(page(t, tc.file), contactSentence) {
|
||||||
|
t.Errorf("%s has no %q to link", tc.file, contactSentence)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestCloseClosesTheConnectionWithoutAnAnswer(t *testing.T) {
|
func TestCloseClosesTheConnectionWithoutAnAnswer(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -1017,17 +1160,28 @@ func noAnswers() map[string]func(t *testing.T) string {
|
|||||||
func TestAnAnswerOtherThanAllowGoesToTheVisitorAsWAFGaveIt(t *testing.T) {
|
func TestAnAnswerOtherThanAllowGoesToTheVisitorAsWAFGaveIt(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
|
const unknownBody = "who knows\n"
|
||||||
|
|
||||||
|
refusedPage := page(t, refusedPageFile)
|
||||||
|
rateLimitedPage := page(t, rateLimitedPageFile)
|
||||||
|
|
||||||
|
// want is the body the visitor gets: waf's, but for a refusal, which gets
|
||||||
|
// rproxy's page for its status.
|
||||||
for _, tc := range []struct {
|
for _, tc := range []struct {
|
||||||
name, disposition, body string
|
name, disposition, body, want string
|
||||||
status int
|
status int
|
||||||
}{
|
}{
|
||||||
{"a refusal", dispositionDeny, deniedBody, http.StatusForbidden},
|
{"a refusal", dispositionDeny, deniedBody, refusedPage, http.StatusForbidden},
|
||||||
{"a refusal, 429", dispositionDeny, deniedBody, http.StatusTooManyRequests},
|
{
|
||||||
{"waf's 400", "", "refused\n", http.StatusBadRequest},
|
"a refusal, 429", dispositionDeny, deniedBody, rateLimitedPage,
|
||||||
{"a 500", "", "broken\n", http.StatusInternalServerError},
|
http.StatusTooManyRequests,
|
||||||
{"a 503 denied", dispositionDeny, "busy\n", http.StatusServiceUnavailable},
|
},
|
||||||
{"no header", "", "who knows\n", http.StatusOK},
|
{"waf's 400", "", "refused\n", "refused\n", http.StatusBadRequest},
|
||||||
{"an unknown disposition", "maybe", "who knows\n", http.StatusOK},
|
{"a 500", "", "broken\n", "broken\n", http.StatusInternalServerError},
|
||||||
|
{"a 503 denied", dispositionDeny, "busy\n", "busy\n", http.StatusServiceUnavailable},
|
||||||
|
{"a 403 without a disposition", "", "nope\n", "nope\n", http.StatusForbidden},
|
||||||
|
{"no header", "", unknownBody, unknownBody, http.StatusOK},
|
||||||
|
{"an unknown disposition", "maybe", unknownBody, unknownBody, http.StatusOK},
|
||||||
} {
|
} {
|
||||||
for _, setting := range []string{dispositionAllow, dispositionDeny} {
|
for _, setting := range []string{dispositionAllow, dispositionDeny} {
|
||||||
subtest := tc.name + " with " + noAnswerSetting + "=" + setting
|
subtest := tc.name + " with " + noAnswerSetting + "=" + setting
|
||||||
@@ -1036,15 +1190,7 @@ func TestAnAnswerOtherThanAllowGoesToTheVisitorAsWAFGaveIt(t *testing.T) {
|
|||||||
|
|
||||||
standIn := startWAF(
|
standIn := startWAF(
|
||||||
t,
|
t,
|
||||||
func(w http.ResponseWriter, _ *http.Request) {
|
answerAs(tc.disposition, tc.status, tc.body),
|
||||||
if tc.disposition != "" {
|
|
||||||
w.Header().Set(dispositionHeader, tc.disposition)
|
|
||||||
}
|
|
||||||
|
|
||||||
w.Header().Set(fromWAFHeader, addedHeaderValue)
|
|
||||||
w.WriteHeader(tc.status)
|
|
||||||
_, _ = io.WriteString(w, tc.body)
|
|
||||||
},
|
|
||||||
)
|
)
|
||||||
app := startApp(t, func(http.ResponseWriter, *http.Request) {
|
app := startApp(t, func(http.ResponseWriter, *http.Request) {
|
||||||
t.Error("the app was asked")
|
t.Error("the app was asked")
|
||||||
@@ -1059,9 +1205,14 @@ func TestAnAnswerOtherThanAllowGoesToTheVisitorAsWAFGaveIt(t *testing.T) {
|
|||||||
)
|
)
|
||||||
|
|
||||||
got := get(t, addr, "/")
|
got := get(t, addr, "/")
|
||||||
if got.status != tc.status || got.body != tc.body ||
|
if got.status != tc.status || got.body != tc.want ||
|
||||||
got.header.Get(fromWAFHeader) != addedHeaderValue {
|
got.header.Get(fromWAFHeader) != addedHeaderValue {
|
||||||
t.Errorf("answered %+v, want waf's answer", got)
|
t.Errorf(
|
||||||
|
"answered %+v, want %d %q",
|
||||||
|
got,
|
||||||
|
tc.status,
|
||||||
|
tc.want,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(got.header.Values(dispositionHeader)) != 0 {
|
if len(got.header.Values(dispositionHeader)) != 0 {
|
||||||
|
|||||||
+24
-1
@@ -7,6 +7,7 @@ import (
|
|||||||
"io"
|
"io"
|
||||||
"maps"
|
"maps"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
|
|
||||||
@@ -187,7 +188,9 @@ func canBeAsked(r *http.Request) bool {
|
|||||||
len(r.Header.Values("User-Agent")) <= 1
|
len(r.Header.Values("User-Agent")) <= 1
|
||||||
}
|
}
|
||||||
|
|
||||||
// answerWith gives the visitor waf's answer, less its disposition.
|
// answerWith gives the visitor waf's answer, less its disposition. A deny of
|
||||||
|
// 403 or 429 gets rproxy's page for that status as its body, in place of
|
||||||
|
// waf's.
|
||||||
func (rq *request) answerWith(answer *wafAnswer) {
|
func (rq *request) answerWith(answer *wafAnswer) {
|
||||||
rq.prepareOwnAnswer(rq.limits.requestDeadline())
|
rq.prepareOwnAnswer(rq.limits.requestDeadline())
|
||||||
|
|
||||||
@@ -195,6 +198,15 @@ func (rq *request) answerWith(answer *wafAnswer) {
|
|||||||
maps.Copy(header, answer.header)
|
maps.Copy(header, answer.header)
|
||||||
header.Del(wafprotocol.DispositionHeader)
|
header.Del(wafprotocol.DispositionHeader)
|
||||||
|
|
||||||
|
if rq.disposition == wafprotocol.DispositionDeny {
|
||||||
|
page, found := rq.h.pages.forStatus(answer.status)
|
||||||
|
if found {
|
||||||
|
rq.sendPage(answer.status, page)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Go's server adds a Content-Type it guesses from the body to a response whose
|
// Go's server adds a Content-Type it guesses from the body to a response whose
|
||||||
// headers have no Content-Type key. The key with no value sends none.
|
// headers have no Content-Type key. The key with no value sends none.
|
||||||
if header.Get("Content-Type") == "" {
|
if header.Get("Content-Type") == "" {
|
||||||
@@ -204,6 +216,17 @@ func (rq *request) answerWith(answer *wafAnswer) {
|
|||||||
rq.send(answer.status, answer.body)
|
rq.send(answer.status, answer.body)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// sendPage sends page as the body of a refusal with status. The length is set
|
||||||
|
// here too, since send leaves a HEAD's as waf gave it, which is of waf's body.
|
||||||
|
func (rq *request) sendPage(status int, page []byte) {
|
||||||
|
header := rq.out.Header()
|
||||||
|
header.Set("Content-Type", htmlContentType)
|
||||||
|
header.Set("X-Content-Type-Options", "nosniff")
|
||||||
|
header.Set("Cache-Control", "no-store")
|
||||||
|
header.Set("Content-Length", strconv.Itoa(len(page)))
|
||||||
|
rq.send(status, page)
|
||||||
|
}
|
||||||
|
|
||||||
// sendReport sends waf report on a goroutine of its own, so that the
|
// sendReport sends waf report on a goroutine of its own, so that the
|
||||||
// visitor does not wait for it. The report goes on after ctx, the request's own
|
// visitor does not wait for it. The report goes on after ctx, the request's own
|
||||||
// context, has ended.
|
// context, has ended.
|
||||||
|
|||||||
Reference in new issue
Block a user