blob: 43f0feba5f2430ccfb8d4ee2524b9888645a7905 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
# Powxy – anti-scraper reverse proxy
Powxy uses a SHA-256 proof-of-work challenge to protect upstream resources from
scraper bots.
## Demo
A demo instance is available at [forge.runxiyu.org](https://forge.runxiyu.org/).
I intend to remove this in the near future and set up an actual demo instance
on somewhere sensible; forge.runxiyu.org doesn't get much bot traffic so it's
a bit unnecessary.
## Bugs
- **The cryptography hasn't been audited.** I wrote this after a tiring school
week and this definitely needs some review.
- We should allow Git clients and RSS readers.
- If a user is attempting to submit a POST request but their powxy cookie is
invalid, powxy would redirect them to a challenge, and their POST data will
be lost.
- It does not work when duplex connections are needed, e.g. with Git's Smart
HTTP protocol.
- Currently we round times to the nearest week for persistence, but this could
cause issues if a user completes the challenge at the end of a rounded week.
## Installation
You need a working Go installation. Then either
```
go install go.lindenii.runxiyu.org/powxy@latest
```
or
```
git clone ssh://forge.lindenii.runxiyu.org/powxy/:/repos/powxy/
cd powxy
go install
```
## Usage
```
Usage of ./powxy:
-difficulty uint
leading zero bits required for the challenge (default 17)
-listen string
address to listen on (default ":8081")
-secondary
trust X-Forwarded-For headers
-upstream string
destination url base to proxy to (default "http://127.0.0.1:8080")
```
## Contribute
Create a branch that begins with `contrib/` and push to
[the repo on our home forge](https://forge.lindenii.runxiyu.org/powxy/:/repos/powxy/)
via SSH.
```
git clone ssh://forge.lindenii.runxiyu.org/powxy/:/repos/powxy/
cd powxy
git checkout -b contrib/whatever
# edit and commit stuff
git push -u origin HEAD
```
## Support
[`#chat`](https://webirc.runxiyu.org/kiwiirc/#chat)
on
[irc.runxiyu.org](https://irc.runxiyu.org/).
## Credits
Inspired by [Anubis](https://github.com/TecharoHQ/anubis). But much simpler.
## License
We are currently using the
[GNU Affero General Public License version 3](https://www.gnu.org/licenses/agpl-3.0.html).
|
