2020-04-23 19:13:43 +08:00
|
|
|
|
IP Registration Directory Format Specification
|
2020-04-23 22:56:26 +08:00
|
|
|
|
==============================================
|
2020-04-23 19:13:43 +08:00
|
|
|
|
|
|
|
|
|
According to the common usage of this VPN network, the IP allocation can be
|
|
|
|
|
classified into the following rules, with its format normalized, as the
|
|
|
|
|
file name of the routing distribution definition file:
|
|
|
|
|
|
2020-05-10 18:32:01 +08:00
|
|
|
|
1. /30 Tunnel: `10.127.0.x/30` (where x is divisible by 4) **DEPRECATED**
|
2020-05-06 19:46:24 +08:00
|
|
|
|
2. Normal Subnet: `10.127.x.y/z` (where z must be greater than 16)
|
2020-04-23 22:56:26 +08:00
|
|
|
|
4. Loopback Address: `10.127.255.x/32`
|
2020-04-23 19:13:43 +08:00
|
|
|
|
|
|
|
|
|
Definition Format
|
2020-04-23 22:56:26 +08:00
|
|
|
|
=================
|
2020-04-23 19:13:43 +08:00
|
|
|
|
|
|
|
|
|
The content of the file can be divided into the following fields.
|
|
|
|
|
To simplify processing, Shell Script variable definition syntax
|
|
|
|
|
will be used as the syntax of the definition file. In addition, variables must
|
2020-05-06 19:46:24 +08:00
|
|
|
|
be present if it's not optional and defined in the same order as the following:
|
2020-04-23 19:13:43 +08:00
|
|
|
|
|
|
|
|
|
TYPE=
|
2020-05-10 18:32:01 +08:00
|
|
|
|
PROTO= (only for peer-to-peer /30 tunnels)
|
2020-04-25 12:46:47 +08:00
|
|
|
|
NAME= (optional for anything other than Contiguous Subnet and Loopback Address)
|
2020-04-29 16:23:55 +08:00
|
|
|
|
ASN= (only for Contiguous Subnet and Loopback Address)
|
2020-05-10 18:32:01 +08:00
|
|
|
|
UPSTREAM= (only for peer-to-peer /30 tunnels)
|
|
|
|
|
DOWNSTREAM= (only for peer-to-peer /30 tunnels)
|
2020-04-25 12:46:47 +08:00
|
|
|
|
DESC=
|
2020-04-23 19:13:43 +08:00
|
|
|
|
|
|
|
|
|
Detailed Information of Each Variable
|
2020-04-23 22:56:26 +08:00
|
|
|
|
=====================================
|
2020-04-23 19:13:43 +08:00
|
|
|
|
|
|
|
|
|
1. TYPE: IP Usage Type
|
2020-04-28 22:10:41 +08:00
|
|
|
|
Available options are: TUN30, SUBNET, PTP, LO (corresponding to the IP address
|
2020-04-23 22:56:26 +08:00
|
|
|
|
allocation type in the first section respectively)
|
2020-04-23 19:13:43 +08:00
|
|
|
|
|
|
|
|
|
2. PROTO: VPN Protocol Used
|
2020-04-28 22:10:41 +08:00
|
|
|
|
Available options are: Tinc, WireGuard, L2TP, GRE, IPsec/L2TP, IPsec/GRE, OpenVPN, SLIRP, PPP
|
2020-04-23 19:13:43 +08:00
|
|
|
|
|
2020-04-25 12:46:47 +08:00
|
|
|
|
3. NAME: Name
|
2020-05-22 18:13:08 +08:00
|
|
|
|
4. ASN: ASN (without prefix "AS")
|
2020-04-29 16:23:55 +08:00
|
|
|
|
5. UPSTREAM: Upstream Node Name
|
|
|
|
|
6. DOWNSTREAM: Downstream Node Name
|
|
|
|
|
7. DESC: Description
|