summaryrefslogtreecommitdiff
path: root/interface-definitions/wireguard.xml
blob: 5e9c41ace90a3b68a59963de57d4f274b7997645 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="interfaces">
    <children>
      <tagNode name="wireguard" owner="${vyos_conf_scripts_dir}/wireguard.py">
        <properties>
          <help>WireGuard interface name</help>
          <priority>459</priority> <!-- subsequent ones may be removed, just make sure ethernet ifs are present -->
          <constraint>
            <regex>^wg[0-9]{1,4}</regex>
          </constraint>
          <constraintErrorMessage>illegal interface name</constraintErrorMessage>
          <valueHelp>
            <format>wgN</format>
            <description>WireGuard interface name</description>
          </valueHelp>
        </properties>
        <children>
          <leafNode name="address">
            <properties>
              <help>IP address</help> 
              <valueHelp>
                <format>ipv4net</format>
                <description>IPv4 address and prefix length</description>
              </valueHelp>
              <valueHelp>
                <format>ipv6net</format>
                <description>IPv6 address and prefix length</description>
              </valueHelp>
              <multi/>
              <constraint>
                <validator name="interface-address"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="description">
            <properties>
              <help>description</help>
              <constraint>
                <regex>.[^ ]{1,100}$</regex>
              </constraint>
              <constraintErrorMessage>interface description is too long (limit 100 characters)</constraintErrorMessage>
            </properties>
          </leafNode>
          <leafNode name="port">
            <properties>
              <help>Local port number to accept connections</help>
              <constraint>
                <validator name="numeric" argument="--range 1024-65535"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="mtu">
            <properties>
              <help>interface mtu size(default: 1420)</help>
              <constraint>
                <validator name="numeric" argument="--range 68-9000"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="fwmark">
            <properties>
              <help>A 32-bit fwmark value set on all outgoing packets</help>
              <valueHelp>
                <format>number</format>
                <description>value which marks the packet for QoS/shaper</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-255"/>
              </constraint>
            </properties>
          </leafNode>
          <tagNode name="peer">
            <properties>
              <help>peer alias</help>
              <constraint>
                <regex>.[^ ]{1,100}$</regex>
              </constraint>
              <constraintErrorMessage>peer alias too long (limit 100 characters)</constraintErrorMessage>
            </properties>
            <children>
              <leafNode name="pubkey">
                <properties>
                  <help>base64 encoded public key</help>
                  <constraint>
                    <regex>^[0-9a-zA-Z\+/]{43}=$</regex>
                  </constraint>
                  <constraintErrorMessage>Key is not valid 44-character (32-bytes) base64</constraintErrorMessage>
                </properties>
              </leafNode>
                <leafNode name="preshared-key">
                <properties>
                  <help>base64 encoded preshared key</help>
                  <constraint>
                    <regex>^[0-9a-zA-Z\+/]{43}=$</regex>
                  </constraint>
                  <constraintErrorMessage>Key is not valid 44-character (32-bytes) base64</constraintErrorMessage>
                </properties>
              </leafNode>
              <leafNode name="allowed-ips">
                <properties>
                  <help>IP addresses allowed to traverse the peer</help>
                <multi/>
                </properties>
              </leafNode>
              <!--  eventually check format IP:port -->
              <leafNode name="endpoint">
                <properties>
                  <help>Remote endpoint (IP:port)</help>
                </properties>
              </leafNode>
              <leafNode name="persistent-keepalive">
                <properties>
                  <help>how often send keep alives in seconds</help>
                  <constraint>
                    <validator name="numeric" argument="--range 1-65535"/> 
                  </constraint>
                </properties>
              </leafNode>
            </children>
          </tagNode>
        </children>
      </tagNode>
    </children>
  </node>
</interfaceDefinition>