# hin2n
**Repository Path**: apnode/hin2n
## Basic Information
- **Project Name**: hin2n
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-10-20
- **Last Updated**: 2023-10-20
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# Hin2n 
[README](README.md) | [中文文档](README_zh.md)
N2N is a VPN project that supports p2p. It was originally developed and open sourced by `Luca Deri` , `Richard Andrews` of ntop.org, and `Meyerd` continues to do optimization work. Our goal is to provide **mobile version** support.
[](https://docs.gradle.org/2.14.1/userguide/userguide.html)
[](https://android-arsenal.com/api?level=15)
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://github.com/switch-iot/hin2n/releases)
[](https://github.com/switch-iot/hin2n/releases)
[](https://travis-ci.org/switch-iot/hin2n)
The original n2n supports many platforms, including Windows, Linux, OSX, BSD, OpenWrt, Raspberry Pie, etc., except for mobile phones (non-root). Therefore, we have developed the Hin2n project.
### What is Hin2n
- Hin2n is a mobile VPN app that supports the n2n protocol
- Hin2n does not need to root your phone
- Hin2n only supports Android phones for now, iPhone version will be developed in the future
- Hin2n is currently in continuous development and will gradually provide more complete versions
- Hin2n now supports all v1/v2s/v2/v3 protocols
### Hin2n latest version [CHANGELOG](Hin2n_android/CHANGELOG)
The latest version of Hin2n is available for download at [release link](https://github.com/switch-iot/hin2n/releases).
### Hin2n Development Plan
View the development plan at [`Projects`](https://github.com/switch-iot/hin2n/projects).
If you have new features and ideas, you can submit them in [`Issues`](https://github.com/switch-iot/hin2n/issues), and we will arrange development plans as appropriate. Your concern is our motivation.
### Technical principle
- VPNService
> Hin2n is based on Android's native VPNService. It builds a tun virtual network card through VPNService and communicates with supernode and edges.
- tun2tap
> Android only supports tun virtual network card, only support network layer, and n2n requires tap virtual network card, which needs data link layer support. So we simulated the data link layer and ARP protocol.
- n2n protocol
> Hin2n supports the n2n protocol by using the native method of jni to reuse the code of the original n2n project as far as possible.
## N2N protocol version
There are four popular versions of the n2n project
- Version v1 developed by ntop.org, not being updated. Project address: [github.com/switch-iot/n2n_meyerd/v1](https://github.com/switch-iot/n2n_meyerd/tree/master/n2n_v1)
- Version v2s developed by meyerd, not being updated. Project address: [github.com/switch-iot/n2n_meyerd/v2s](https://github.com/switch-iot/n2n_meyerd/tree/master/n2n_v2)
- Version v2 developed by ntop.org, been sealed. Project address: [github.com/ntop/n2n/v2.8_r540](https://github.com/ntop/n2n/tree/2.8-stable)
- Version v3 developed by ntop.org, in updating. Project address: [github.com/ntop/n2n](https://github.com/ntop/n2n)
### About v2s version
The v2s is the renaming of the v2 (also known as v2.1) developed by master Meyerd in the QQ group (5804301), that is, the v2 upgrade version. The v2s version is not compatible with the v2 version developed by the ntop.org masters. To avoid confusion, the QQ group members named the project separately.
## Development and compilation
### Project Structure
The n2n source code is linked to the hin2n directory via git submodules, which are located into the `bundles` directory. Hin2n provides the [CMakeLists.txt](https://github.com/switch-iot/hin2n/blob/dev_android/Hin2n_android/app/CMakeLists.txt) file to build all the supported n2n versions from the corresponding submodule. The submodules actually link a fork of the official n2n source code repositories (e.g. https://github.com/switch-iot/n2n_ntop) in order to guaranteed that the compilation of hin2n always succedes. The ntop v2 fork is a 1:1 copy of the official repository, which will be periodically updated to reflect the upstream changes.
### How to compile on Linux
You need to install Java and Android SDK before compile.
- `git clone https://github.com/switch-iot/hin2n.git --depth=1 --recurse-submodules` # download source
- `cd hin2n/Hin2n_android` # hin2n_android directory is the hin2n project android source directory
- `./gradlew assemble` # compile hin2n (You can compile one of the files by running `./gradlew assembleNormalAllarchDebug`). If you are using Android Studio, use "Import Project", then select the `Hin2n_android` directory and build the `app` module. The compiled files are in `hin2n/Hin2n_android/app/build/outputs/apk/`
- When switching branches, you need to execute `git submodule update` to synchronize the code of the submodules
### How to compile on Windows
You need to install Java and Android SDK before compile, and the git compatible symbolic link needs to be set in the Windows environment.
- Launch `gpedit.msc`, and add the account(s) to `Computer Configuration/Windows Setting/Security Settings/Local Policies/User Rights Assignment/Create symbolic links`
- Or run `git-cmd` as an administrator user, and execute the following command
- `git clone -c core.symlinks=true https://github.com/switch-iot/hin2n.git --depth=1 --recurse-submodules && cd hin2n && link.bat`
- `cd Hin2n_android` # hin2n_android directory is the hin2n project android source directory
- `gradlew assemble` # compile hin2n (You can compile one of the files by running `gradlew assembleNormalAllarchDebug`). If you are using Android Studio, use "Import Project", then select the `Hin2n_android` directory and build the `app` module. The compiled files are here: `hin2n\Hin2n_android\app\build\outputs\apk\`
- When switching branches, you need to execute `git submodule update` to synchronize the code of the submodules
### About open source agreement
The project is open sourced under the [`GPLv3`](LICENSE) agreement, and is consistent with the original open source agreement of n2n. We also hope that everyone will support and comply with the open source agreement of this project.
## Contribute to Hin2n
Hin2n is a free and open source n2n project, and we welcome anyone to contribute to it.
- Any problems in use can be fed back through [`Issues`](https://github.com/switch-iot/hin2n/issues)
- Bug fixes can submit `Pull Request` to `android_dev` branch
- If you want to add a new feature, please create an [`Issues`](https://github.com/switch-iot/hin2n/issues) first to describe the new feature, as well as the implementation approach. Once a proposal is accepted, create an implementation of the new features and submit it as a pull request.
- Sorry for my poor English and improvement for this document is welcome even some typo fix.
- Welcome to watch the project and give the project a `Star`!
### Thanks
- [`zhangbz`](https://github.com/zhangbz)
- [`emanuele-f`](https://github.com/emanuele-f)
- [`ozyb`](https://github.com/ozyb)
- [`lucktu`](https://github.com/lucktu)
- Thanks to their selfless dedication, and everyone's support to Hin2n project.
## QQ group
- Hin2n QQ group: 769731491
- N2N QQ group: 256572040