
Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja> git-svn-id: file:///srv/svn/repo/yukari/trunk@149 f3bd38d9-da89-464d-a02a-eb04e43141b5
Yukari's Gap
Web content sanitizer proxy as a service, fork of MortyProxy with some suggestions from the issue tracker applied, named after the youkai you shouldn't ever come near
Yukari's Gap 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 this tool 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.16 or higher (thus making it incompatible with MortyProxy's own requirement, but also to use go embed
)
$ go install marisa.chaotic.ninja/yukari/cmd/yukari@latest
$ "$GOPATH/bin/yukari" --help
Usage
See yukari(1)
Environment variables
Yukari can additionally be configured using the following environment variables:
YUKARI_ADDRESS
: Listen address (default to127.0.0.1:3000
)YUKARI_KEY
: HMAC url validation key (base64 encoded) to prevent direct URL opening. Leave blank to disable validation. Useopenssl rand -base64 33
to generate.YUKARI_URL_PARAM
: User-defined requesting string URL parameter name (ie:/?url=...
or/?u=...
) (defaultyukariurl
)YUKARI_HASH_PARAM
: User-defined requesting string HASH parameter name (ie:/?hash=...
or/?h=...
) (defaultyukarihash
)DEBUG
: Enable/disable proxy and redirection logs (default totrue
). Set tofalse
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? Mail yukari-dev@chaotic.ninja
Description
Web content sanitizer proxy as a service (meant for SearX, but can be used standalone)
https://suzunaan.yakumo.dev/yukari/
Languages
Go
88.3%
Roff
5.9%
HTML
3.2%
Makefile
1.6%
Shell
1%