// Package wafprotocol holds the three messages rproxy and waf send each // other, as "`waf`" in SPEC.md gives them. rproxy asks waf a question about // each visitor's request, and waf answers it. Once the visitor's answer has // ended, rproxy sends waf a report. This package writes and reads each // message, and declares every name and limit both sides must agree on. package wafprotocol // The headers of the question and of the answer. Go writes every header name // in this form, as it sends it and as it receives it, so X-Client-ASN arrives // as X-Client-Asn; header names are not case-sensitive. const ( // ClientHeader marks a request as rproxy's question, and gives the // visitor's address. ClientHeader = "X-Sww-Client" // PeerHeader gives the address of rproxy's own TCP peer. PeerHeader = "X-Sww-Peer" // ContentLengthHeader gives the body length the visitor announced. ContentLengthHeader = "X-Sww-Content-Length" // RequestIDHeader gives the request's id, which rproxy makes. rproxy // also sets it on the request it passes to the app. RequestIDHeader = "X-Request-ID" // DispositionHeader gives waf's answer. DispositionHeader = "X-Sww-Disposition" // ASNHeader and CountryHeader give the client's AS number and country in // an answer of allow. rproxy passes them to the app. ASNHeader = "X-Client-Asn" CountryHeader = "X-Client-Country" ) // The values of DispositionHeader. const ( // DispositionAllow tells rproxy to pass the request to the app. DispositionAllow = "allow" // DispositionDeny tells rproxy to give the visitor the answer's status, // headers and body. DispositionDeny = "deny" // DispositionClose tells rproxy to close the visitor's connection // without an answer, which SWW_WAF_BAN_RESPONSE asks for when it is close. // waf closing the question's connection instead would read as // waf being down, and rproxy would then let the request through. DispositionClose = "close" ) // OwnEndpointPrefix starts the path of every request for sww itself: waf's // own endpoints and rproxy's health endpoint. The app never sees a path under // it. const OwnEndpointPrefix = "/_sww/" // HealthPath is the health endpoint of waf and of rproxy, which the // container's health check asks. const HealthPath = "/_sww/healthz" // ReportPath is where rproxy sends the report of each request waf // answered. const ReportPath = "/_sww/report" // QuestionBodyMaxBytes is the most of a visitor's body a question carries. const QuestionBodyMaxBytes = 64 << 10 // ReportStatusMax is the highest status a report may give. const ReportStatusMax = 599