| Rev | Line | |
|---|
| [4a5f10f] | 1 | # Yukari's Gap
|
|---|
| 2 | 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)
|
|---|
| 3 |
|
|---|
| 4 | 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.
|
|---|
| 5 |
|
|---|
| 6 | 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.
|
|---|
| 7 |
|
|---|
| 8 | Features:
|
|---|
| 9 |
|
|---|
| 10 | * HTML sanitization
|
|---|
| 11 | * Rewrites HTML/CSS external references to locals
|
|---|
| 12 | * JavaScript blocking
|
|---|
| 13 | * No Cookies forwarded
|
|---|
| 14 | * No Referrers
|
|---|
| 15 | * No Caching/Etag
|
|---|
| 16 | * Supports GET/POST forms and IFrames
|
|---|
| 17 | * Optional HMAC URL verifier key to prevent service abuse
|
|---|
| 18 |
|
|---|
| 19 | ## Installation and setup
|
|---|
| 20 | Requirement: Go version 1.16 or higher (thus making it incompatible with MortyProxy's own requirement, but also to use `go embed`)
|
|---|
| 21 |
|
|---|
| 22 | ```
|
|---|
| 23 | $ go install marisa.chaotic.ninja/yukari/cmd/yukari@latest
|
|---|
| 24 | $ "$GOPATH/bin/yukari" --help
|
|---|
| 25 | ```
|
|---|
| 26 | ### Usage
|
|---|
| 27 | See `yukari(1)`
|
|---|
| 28 |
|
|---|
| 29 | ### Test
|
|---|
| 30 |
|
|---|
| 31 | ```
|
|---|
| 32 | $ make test
|
|---|
| 33 | ```
|
|---|
| 34 |
|
|---|
| 35 | ### Benchmark
|
|---|
| 36 |
|
|---|
| 37 | ```
|
|---|
| 38 | $ make bench
|
|---|
| 39 | ```
|
|---|
| 40 |
|
|---|
| 41 | ## Bugs
|
|---|
| 42 | Bugs or suggestions? Mail [yukari-dev@chaotic.ninja](mailto:yukari-dev@chaotic.ninja)
|
|---|
| 43 |
|
|---|
| 44 | ---
|
|---|
| 45 |
|
|---|
| 46 | [^1]: or WCPaaS, mind you, also I didn't come up with that, it was already there when I arrived
|
|---|
Note:
See
TracBrowser
for help on using the repository browser.
