https://github.com/hanhui03/KidVPN
The world's smallest VPN server and client.
https://github.com/hanhui03/KidVPN
edgeros iot sylixos vpn vpn-client vpn-free vpn-server
Last synced: about 1 month ago
JSON representation
The world's smallest VPN server and client.
- Host: GitHub
- URL: https://github.com/hanhui03/KidVPN
- Owner: hanhui03
- License: gpl-3.0
- Created: 2018-08-13T07:44:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-03T13:44:38.000Z (over 2 years ago)
- Last Synced: 2024-07-30T05:18:29.930Z (9 months ago)
- Topics: edgeros, iot, sylixos, vpn, vpn-client, vpn-free, vpn-server
- Language: C
- Homepage:
- Size: 47.9 KB
- Stars: 76
- Watchers: 9
- Forks: 28
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-network-stuff - **50**星
README
# KidVPN
The world's smallest VPN server and client (For SylixOS and Linux).
## Configure File
* Configure file is a ini format:
>
|keywords| description |
|:----:|:----|
|**mode**|KidVPN run mode, `'server'` or `'client'`|
|**key_file**|KidVPN AES Key file|
|**iv_file**|Cipher initial vector (Optional default use ECB)|
|**vnd_id**|Virtual network device ID (Only for SylixOS)|
|**tap_name**|Virtual network device name (Only for Linux)|
|**mtu**|`1280` ~ `1472` (Optional default: `1464`)|
|**local_ip**|Local IP address (Only for Server)|
|**server**|Server IP address (Only for Client)|
|**port**|Local port (Optional default: `10088`)|
|**hole_punching**|UDP Hole punching (Optional default: `0`)|
\* *If too many client in one VPN net you can use UDP hole punching to reduce server forwarding pressure.*
* Server configure like this:
``` ini
[server_0]
mode=server
key_file=serv.key
iv_file=serv.iv
vnd_id=0
tap_name=tap0
mtu=1464
local_ip=192.168.0.1
port=10088
```
* Client configure like this:
``` ini
[client_0]
mode=client
key_file=cli.key
iv_file=cli.iv
vnd_id=0
tap_name=tap0
mtu=1464
server=123.123.123.123
port=10088
```
\* KidVPN daemon allow dynamic update of IV parameters using `SIGUSR1` signal.*
## For SylixOS
* Step 1: Add vnd interface parameter in **/etc/ifparam.ini**
``` ini
[vnd-X]
# X is a number of vnd ID)
enable=1
# Enable(up) this interface
ipaddr=x.x.x.x
# Virtual network ip address
netmask=x.x.x.x
# Virtual network netmask
mac=xx:xx:xx:xx:xx:xx
# Virtual network MAC address, If not, the system will use random numbers
```
* Step 2: Use **'vnd'** command add a virtual net device.
``` sh
vnd add X
# X is a number of vnd ID
```
* Step 3: Use **'kidvpn'** to create a VPN connect.
``` sh
kidvpn x.ini sector password
# 'x.ini' is vpn config file, 'sector' is ini sector which we will use, 'password' is password
```
* Step 4: Use **'route'** command add some route entry to system, make route rules.
## For Linux
* Prepare for work:
``` sh
sudo apt-get install openssl
# Install OpenSSL library
sudo apt-get install libssl-dev
# Install OpenSSL develop library
make
# Build kidvpn target
```
* Step 1: Add tap interface
``` sh
sudo tunctl -t tapX -u root
# X is tap number
sudo ifconfig tapX up
# Enable tapX network
```
* Step 2: Use **'ifconfig'** command set tapX address
``` sh
ifconfig tapX inet x.x.x.x netmask x.x.x.x
```
* Step 3: Use **'kidvpn'** to create a VPN connect.
``` sh
sudo ./kidvpn x.ini sector password
# 'x.ini' is vpn config file, 'sector' is ini sector which we will use, 'password' is password
```
* Step 4: Use **'route'** command add some route entry to system, make route rules.
Enjoy yourself \^\_\^