a13aa42ba5
Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja> git-svn-id: file:///srv/svn/repo/yukari/trunk@150 f3bd38d9-da89-464d-a02a-eb04e43141b5
47 lines
1.4 KiB
Markdown
47 lines
1.4 KiB
Markdown
# Yukari's Gap
|
|
Web content sanitizer proxy as a service[^1], fork of [MortyProxy](https://github.com/asciimoo/morty) with some suggestions from the issue tracker applied, named after [the youkai you shouldn't ever come near](https://en.touhouwiki.net/wiki/Yukari_Yakumo)
|
|
|
|
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](https://asciimoo.github.com/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)`
|
|
|
|
### Test
|
|
|
|
```
|
|
$ make test
|
|
```
|
|
|
|
### Benchmark
|
|
|
|
```
|
|
$ make bench
|
|
```
|
|
|
|
## Bugs
|
|
Bugs or suggestions? Mail [yukari-dev@chaotic.ninja](mailto:yukari-dev@chaotic.ninja)
|
|
|
|
---
|
|
|
|
[^1]: or WCPaaS, mind you, also I didn't come up with that, it was already there when I arrived
|