HTTP Rewrite

HTTP rewriting allows users to match URLs using regular expressions to reject or redirect HTTP(S) requests, commonly used to block ads, prevent privacy tracking, etc.

Configuration format:

http:
  # HTTP(S) rewrite supporting various strategies such as header, 302, 307, reject
  url-rewrite:
    - ^http://g\.cn https://www.google.com transparent
    - ^https?://www\.google\.cn https://www.google.com 302 # Directly returns a 302 redirect response
    - ^https?://ad\.example - reject # Rejects the request
  header-rewrite:
    - ^http://g\.cn request-add DNT 1
    - ^http://g\.cn request-del DNT
    - ^http://g\.cn request-replace DNT 1
    - ^http://g\.cn request-replace-regex User-Agent Go-http-client curl
 
    - ^http://g\.cn response-add DNT 1
    - ^http://g\.cn response-del DNT
    - ^http://g\.cn response-replace DNT 1
    - ^http://g\.cn response-replace-regex User-Agent Go-http-client curl
  mock:
    - match: ^https?://ad\.example
      status-code: 503

URL Rewriting

transparent

Intercepts and modifies the request URL, similar to a transparent proxy, with no awareness by the application, supporting redirecting HTTP / HTTPS.

302 / 307

The HTTP engine returns a 3xx status code and automatically sets the Location field to achieve redirection.

reject

Returns a 404 response with an empty response body.

reject-200

Returns a 200 response with an empty response body.

reject-img

Returns a 200 response with a 1px GIF response body.

reject-dict

Returns a 200 response with a response body of {}.

reject-array

Returns a 200 response with a response body of [].

HTTP Header Rewriting

Header rewriting allows users to add, delete, or replace any HTTP request/response header.

request-add / response-add

Adds headers to the HTTP request/response.

request-del / response-del

Deletes headers from the HTTP request/response.

request-replace / response-replace

Replaces the value of a header in the HTTP request/response.

request-replace-regex / response-replace-regex

Replaces the value of a header in the HTTP request/response using a regular expression.

Mock

The mock feature returns static responses directly. For dynamic responses, consider using the JavaScript engine for rewriting.

http:
  mock:
    - match: ^https?://example.stash\.ws/json
      text: '{}'
      status-code: 200
      headers:
        Content-Type: application/json
    - match: ^https?://example.stash\.ws/base64
      base64: 'eyJ0ZXN0IjogdHJ1ZX0='
      status-code: 200
      headers:
        Content-Type: application/json

• match: Matched regular expression.
• status-code: HTTP status code to return, defaults to 200 if not specified.
• headers: HTTP response headers to return, no need to set Content-Length, as the engine will calculate it automatically.

Response content:

• text: Returned text content encoded in UTF-8.
• base64: Returned content as binary encoded in Base64.

Using JavaScript Engine for Rewriting

If the above functionalities do not meet your needs, please refer to Rewriting HTTP with JavaScript Engine.