yukari

Yukari

Web content sanitizer proxy as a service, fork of MortyProxy with some suggestions from the issue tracker applied, named after Yes, that Gap Youkai

Yukari rewrites web pages to exclude malicious HTML tags and attributes. It also replaces external resource references to prevent third party information leaks.

The main goal of yukari is to provide a result proxy for searx, but it can be used as a standalone sanitizer service too.

Features:

• HTML sanitization
• Rewrites HTML/CSS external references to locals
• JavaScript blocking
• No Cookies forwarded
• No Referrers
• No Caching/Etag
• Supports GET/POST forms and IFrames
• Optional HMAC URL verifier key to prevent service abuse

Installation and setup

Requirement: Go version 1.10 or higher.

$ go install marisa.chaotic.ninja/yukari@latest
$ "$GOPATH/bin/yukari" --help

Usage

  -debug
        Debug mode (default true)
  -followredirect
        Follow HTTP GET redirect
  -hashparam string
        User-defined requesting string HASH parameter name (ie: '/?hash=...' or '/?h=...') (default "yukarihash")
  -ipv6
        Allow IPv6 HTTP requests (default true)
  -key string
        HMAC url validation key (base64 encoded) - leave blank to disable validation
  -listen string
        Listen address (default "127.0.0.1:3000")
  -proxy string
        Use the specified HTTP proxy (ie: '[user:pass@]hostname:port'). Overrides -socks5, -ipv6.
  -proxyenv
        Use a HTTP proxy as set in the environment (HTTP_PROXY, HTTPS_PROXY and NO_PROXY). Overrides -proxy, -socks5, -ipv6.
  -socks5 string
        Use a SOCKS5 proxy (ie: 'hostname:port'). Overrides -ipv6.
  -timeout uint
        Request timeout (default 5)
  -urlparam string
        User-defined requesting string URL parameter name (ie: '/?url=...' or '/?u=...') (default "yukariurl")
  -version
        Show version

Environment variables

Yukari can additionally be configured using the following environment variables:

• YUKARI_ADDRESS: Listen address (default to 127.0.0.1:3000)
• YUKARI_KEY: HMAC url validation key (base64 encoded) to prevent direct URL opening. Leave blank to disable validation. Use openssl rand -base64 33 to generate.
• YUKARI_URL_PARAM: User-defined requesting string URL parameter name (ie: /?url=... or /?u=...) (default yukariurl)
• YUKARI_HASH_PARAM: User-defined requesting string HASH parameter name (ie: /?hash=... or /?h=...) (default yukarihash)
• DEBUG: Enable/disable proxy and redirection logs (default to true). Set to false to disable.

Test

$ cd "$GOPATH/src/marisa.chaotic.ninja/yukari"
$ go test

Benchmark

$ cd "$GOPATH/src/marisa.chaotic.ninja/yukari"
$ go test -benchmem -bench .

Bugs

Bugs or suggestions? Visit the issue tracker.