mirror of https://github.com/htrgouvea/nipe.git
update README.md and SECURITY.md
This commit is contained in:
GouveaHeitor
parent
a86f4a167e
commit
e0d9d2910a
90
README.md
90
README.md
|
|
@ -1,5 +1,5 @@
|
|||
<p align="center">
|
||||
<h3 align="center">Nipe</h3>
|
||||
<img src="https://heitorgouvea.me/images/publications/nipe-overview/logo.png">
|
||||
<p align="center">A script to make Tor Network your default gateway.</p>
|
||||
|
||||
<p align="center">
|
||||
|
|
@ -7,77 +7,63 @@
|
|||
<img src="https://img.shields.io/badge/license-MIT-blue.svg">
|
||||
</a>
|
||||
<a href="https://github.com/GouveaHeitor/nipe/releases">
|
||||
<img src="https://img.shields.io/badge/version-1.0.1-blue.svg">
|
||||
<img src="https://img.shields.io/badge/version-0.9-blue.svg">
|
||||
</a>
|
||||
</p>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
|
||||
### How it works
|
||||
```
|
||||
[+] AUTOR: Heitor Gouvêa
|
||||
[+] SITE: https://heitorgouvea.me
|
||||
[+] EMAIL: hi@heitorgouvea.me
|
||||
[+] GITHUB: https://github.com/GouveaHeitor
|
||||
The TOR project allows users to surf the Internet, chat and send instant messages anonymously through its own mechanism. It is used by a wide variety of people, companies and organizations, both for lawful activities and for other illicit purposes. TOR is already gone and is used for example by criminal companies, hacking groups, intelligence agencies and even ordinary users who care about privacy in the digital world.
|
||||
|
||||
Nipe is a engine, developed in Perl, that aims to make the TOR network your default network gateway. Through Nipe, we can directly route traffic from our computer to the TOR network through which you can surf the Internet having a more formidable stance on privacy and anonymity in cyberspace.
|
||||
|
||||
Currently, only IPv4 is supported by Nipe, but we are working on a solution to add IPv6 support. Also, only traffic other than DNS requests destined for local and / or loopback addresses is not trafficked.through the TOR. All non-local UDP / ICMP traffic is also blocked by the TOR project.
|
||||
```
|
||||
|
||||
[**See complete documentation here**](https://heitorgouvea.me/nipe/)
|
||||
|
||||
#### How it works
|
||||
### Download and install:
|
||||
```bash
|
||||
# Download
|
||||
$ git clone https://github.com/GouveaHeitor/nipe
|
||||
$ cd nipe
|
||||
|
||||
Tor enables users to surf the internet, chat and send instant messages
|
||||
anonymously, and is used by a wide variety of people for both licit and
|
||||
illicit purposes. Tor has, for example, been used by criminals enterprises,
|
||||
hacktivism groups, and law enforcement agencies at cross purposes, sometimes
|
||||
simultaneously.
|
||||
|
||||
Nipe is a script to make the Tor network your default gateway.
|
||||
|
||||
This Perl script enables you to directly route all your traffic from your
|
||||
computer to the Tor network through which you can surf the internet anonymously
|
||||
without having to worry about being tracked or traced back.
|
||||
# Automatic installation
|
||||
$ chmod +x setup.sh
|
||||
$ ./setup.sh
|
||||
|
||||
Currently Nipe only supports IPV4, we are working on a solution to add IPV6 support and
|
||||
also only traffic other than DNS requests destined for local/loopback addresses is not passed
|
||||
through Tor. All non-local UDP/ICMP traffic is blocked.
|
||||
|
||||
#### Download and install:
|
||||
```
|
||||
# Download
|
||||
$ git clone https://github.com/GouveaHeitor/nipe
|
||||
$ cd nipe
|
||||
|
||||
# Automatic installation
|
||||
$ chmod +x setup.sh
|
||||
$ ./setup.sh
|
||||
|
||||
# Manual installation
|
||||
$ cpan install Switch JSON LWP::UserAgent Config::Simple
|
||||
$ perl nipe.pl install
|
||||
# Manual installation
|
||||
$ cpan install Switch JSON LWP::UserAgent Config::Simple
|
||||
$ perl nipe.pl install
|
||||
```
|
||||
|
||||
#### Commands:
|
||||
```
|
||||
COMMAND FUNCTION
|
||||
install Install dependencies
|
||||
start Start routing
|
||||
stop Stop routing
|
||||
restart Restart the Nipe process
|
||||
status See status
|
||||
### Commands:
|
||||
```bash
|
||||
COMMAND FUNCTION
|
||||
install Install dependencies
|
||||
start Start routing
|
||||
stop Stop routing
|
||||
restart Restart the Nipe process
|
||||
status See status
|
||||
|
||||
Examples:
|
||||
Examples:
|
||||
|
||||
perl nipe.pl install
|
||||
perl nipe.pl start
|
||||
perl nipe.pl stop
|
||||
perl nipe.pl restart
|
||||
perl nipe.pl status
|
||||
perl nipe.pl install
|
||||
perl nipe.pl start
|
||||
perl nipe.pl stop
|
||||
perl nipe.pl restart
|
||||
perl nipe.pl status
|
||||
```
|
||||
|
||||
#### Contribution
|
||||
### Contribution
|
||||
|
||||
- Your contributions and suggestions are heartily♥ welcome. [**See here the contribution guidelines.**](/.github/CONTRIBUTING.md) Please, report bugs via [**issues page.**](https://github.com/GouveaHeitor/nipe/issues)(✿◕‿◕)
|
||||
|
||||
#### License
|
||||
- Interested in better understanding how the Nipe really works? Maybe this post can help you: [**A techinical Overview about Nipe**](https://heitorgouvea.me/2019/11/19/Nipe-Overview)
|
||||
|
||||
### License
|
||||
|
||||
- This work is licensed under [**MIT License.**](https://github.com/GouveaHeitor/nipe/blob/master/LICENSE.md)
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
# Security Policy
|
||||
|
||||
If you find a security issue with Nipe, please DO NOT submit it via the issue tracker! Instead, please follow responsible disclosure practices and send information about security issues directly to hi@heitorgouvea.me so that a proper assessment can be made and a fix prepared before a wide announcement. You will receive an acknowledgement within 24 hours.
|
||||
If you find a security issue with Nipe, please DO NOT submit it via the issue tracker! Instead, please follow responsible disclosure practices and send information about security issues directly to [hi@heitorgouvea.me](mailto:hi@heitorgouvea.me) so that a proper assessment can be made and a fix prepared before a wide announcement. You will receive an acknowledgement within 24 hours.
|
||||
|
||||
Even in cases where you have limited or incomplete information, or you're not sure whether or not a problem constitutes a security issue, please make contact as soon as possible. We can work together to investigate, debug, and assess.
|
||||
|
||||
|
|
|
|||
12
nipe.pl
12
nipe.pl
|
|
@ -1,17 +1,5 @@
|
|||
#!/usr/bin/env perl
|
||||
|
||||
#########################################################
|
||||
# Nipe developed by Heitor Gouvêa #
|
||||
# This work is licensed under MIT License #
|
||||
# Copyright (c) 2015 - 2019 Heitor Gouvêa #
|
||||
# #
|
||||
# [+] AUTOR: Heitor Gouvêa #
|
||||
# [+] EMAIL: hi@heitorgouvea.me #
|
||||
# [+] SITE: https://heitorgouvea.me #
|
||||
# [+] GITHUB: https://github.com/GouveaHeitor #
|
||||
# [+] TWITTER: @GouveaHeitor #
|
||||
#########################################################
|
||||
|
||||
use Switch;
|
||||
use lib "./lib/";
|
||||
use Nipe::Stop;
|
||||
|
|
|
|||
Loading…
Reference in New Issue