Skip to content
This repository has been archived by the owner on Oct 18, 2022. It is now read-only.

Latest commit

 

History

History
54 lines (29 loc) · 2.42 KB

README.md

File metadata and controls

54 lines (29 loc) · 2.42 KB
Raw

Build Your Own Shecan

IMPORTANT NOTE: sniproxy is byosh's eventual successor, which will offer a simpler architecture with better performance. Eventually byosh will be archived.

Shecan is an anti-sanction service offered by a group of researchers in Iran. It allows you to use a different DNS server and have a transparent proxy for the whitelisted domains.

Since Security and Privacy audits have no place in Iran, and Shecan obviously hasn't been through proper vetting, I decided to re-engineer something similar to it for personal use.

Requirements

  • Docker/podman(recommended)

Proxied Domains

  • Included in domains file inside the repository. "borrowed" from fod

How to Use

  • make sure ports 80, 443 and 53 are not used in your system (probably a good idea to disable systemd-resolvd service)
  • run the command in your server (remember to replace YOUR_PUBLIC_IP with you public facing IP address)

docker run -d -p 53:53/udp -p 443:443 -p 80:80 --net=host -e PUB_IP=YOUR_PUBLIC_IP --name some-byosh mosajjal/byosh:latest

FAQ

Why all these ports and also --net=host

Port 53 is used to recieve DNS and act as a DNS server. port 80 and 443 recieve HTTP traffic and handle the proxy side.

--net=host is needed because your Container engine will use NAT to push traffic to 443, and since your original IP will be masked from Nginx, it won't be able to handle proxy requests.

Can I have my own list

Sure! do the following

  • clone the repo
  • edit the domains file and add/remove your domains
  • run docker build . -t byosh:myown
  • run the command as before but from your own image tag:

docker run -d -p 53:53/udp -p 443:443 -p 80:80 --net=host -e PUB_IP=YOUR_PUBLIC_IP --name some-byosh byosh:myown

Can I have this for ALL domains not just a list

run the following command (not tested):

docker run -d -p 53:53/udp -p 443:443 -p 80:80 --net=host -e PUB_IP=YOUR_PUBLIC_IP -e DNS_ALLOW_ALL=YES --name some-byosh mosajjal/byosh:latest

NOTE: you still have to provide a list file, albiet an empty one. It'll get ignored once the service is started

Limitation

This Project is at Alpha stage so expect weird behaviour! I've turned off ipv6 everywhere so that's a known limitation. Other than that, the dns.py script is acting like a DNS server which is not a good practice for enterprise. Feel free to send PRs to make this better :)