hackclub/burrow
1
0
Fork 0
Code Pull requests Releases Packages Activity Actions 4
Burrow is an open source tool for burrowing through firewalls. https://burrow.net
56 commits 40 branches 10 tags 3 MiB
Find a file
Malted 40cc0ba049 🛂 Check for required permissions 
On Linux, checks for the `CAP_NET_ADMIN` capability.
On macOS, checks for root.
2023-06-10 22:01:17 +01:00
.cargo 🔧 Add cargo release aliases 2023-06-10 22:01:17 +01:00
.github Update CODEOWNERS 2023-06-05 01:12:21 -07:00
.vscode Set clippy as the default build task 2023-06-03 13:00:06 -04:00
Apple Fix requesting VPN permission on macOS 2023-05-13 13:15:41 -04:00
burrow 🛂 Check for required permissions 2023-06-10 22:01:17 +01:00
docs Update Getting Started document 2023-06-03 13:00:06 -04:00
tun 🛂 Check for required permissions 2023-06-10 22:01:17 +01:00
tun-async Initial commit 2023-04-10 16:49:23 -04:00
.devcontainer.json Initial commit 2023-04-10 16:49:23 -04:00
.gitignore Initial commit 2023-04-10 16:49:23 -04:00
.gitlint Initial commit 2023-04-10 16:49:23 -04:00
.swiftlint.yml Initial commit 2023-04-10 16:49:23 -04:00
Cargo.lock 🛂 Check for required permissions 2023-06-10 22:01:17 +01:00
Cargo.toml Initial commit 2023-04-10 16:49:23 -04:00
LICENSE.md Create LICENSE.md 2023-04-18 21:56:01 -04:00
README.md Add period to end of line 2023-06-06 19:08:37 -04:00

README.md

Burrow

License Apple Build Status Crate Build Status

Burrow is an open source tool for burrowing through firewalls, built by teenagers at Hack Club.

burrow provides a simple command-line tool to open virtual interfaces and direct traffic through them.

Contributing

Burrow is fully open source, you can fork the repo and start contributing easily. For more information and in-depth discussions, visit the #burrow channel on the Hack Club Slack, here you can ask for help and talk with other people interested in burrow! For more information on how to contribute, please see [CONTRIBUTING.md]

The project structure is divided in the following folders:

Apple/ # Xcode project for burrow on macOS and iOS
burrow/ # Higher-level API library for tun and tun-async
tun/ # Low-level interface to OS networking
    src/
        unix/ # macOS and Linux code
        windows/ # Windows networking code
tun-async/ # Async interface to tun

Installation

To start burrowing, download the latest release build in the release section.

Hack Club

Hack Club is a global community of high-school hackers from all around the world! Start your hack club by visiting the Hack Club Page

License

Burrow is open source and licensed under the GNU General Public License v3.0