summaryrefslogtreecommitdiff
path: root/interface-definitions/interfaces-wireguard.xml.in
blob: 7b6c717b9541dde0ddf2e6ed99ab8a7978a8b97c (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
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="interfaces">
    <children>
      <tagNode name="wireguard" owner="${vyos_conf_scripts_dir}/interfaces-wireguard.py">
        <properties>
          <help>WireGuard Interface</help>
          <priority>459</priority>
          <constraint>
            <regex>^wg[0-9]+$</regex>
          </constraint>
          <constraintErrorMessage>WireGuard interface must be named wgN</constraintErrorMessage>
          <valueHelp>
            <format>wgN</format>
            <description>WireGuard interface name</description>
          </valueHelp>
        </properties>
        <children>
          #include <include/interface/address-ipv4-ipv6.xml.i>
          #include <include/interface/interface-description.xml.i>
          #include <include/interface/interface-disable.xml.i>
          #include <include/interface/interface-vrf.xml.i>
          #include <include/port-number.xml.i>
          #include <include/interface/interface-mtu-68-16000.xml.i>
          <leafNode name="mtu">
            <defaultValue>1420</defaultValue>
          </leafNode>
          #include <include/interface/interface-ipv4-options.xml.i>
          #include <include/interface/interface-ipv6-options.xml.i>
          <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 0-4294967295"/>
              </constraint>
            </properties>
            <defaultValue>0</defaultValue>
          </leafNode>
          <leafNode name="private-key">
            <properties>
              <help>Base64 encoded private key</help>
              <constraint>
                <regex>[0-9a-zA-Z\+/]{43}=$</regex>
              </constraint>
              <constraintErrorMessage>Key is not valid 44-character (32-bytes) base64</constraintErrorMessage>
            </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>
              #include <include/generic-disable-node.xml.i>
              <leafNode name="public-key">
                <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>
                  <constraint>
                    <validator name="ip-prefix"/>
                  </constraint>
                  <multi/>
                </properties>
              </leafNode>
              <leafNode name="address">
                <properties>
                  <help>IP address of tunnel endpoint</help>
                  <valueHelp>
                    <format>ipv4</format>
                    <description>IPv4 address of remote tunnel endpoint</description>
                  </valueHelp>
                  <valueHelp>
                    <format>ipv6</format>
                    <description>IPv6 address of remote tunnel endpoint</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ip-address"/>
                  </constraint>
                </properties>
              </leafNode>
              #include <include/port-number.xml.i>
              <leafNode name="persistent-keepalive">
                <properties>
                  <help>Interval to send keepalive messages</help>
                  <valueHelp>
                    <format>1-65535</format>
                    <description>Interval in seconds</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-65535"/>
                  </constraint>
                </properties>
              </leafNode>
            </children>
          </tagNode>
        </children>
      </tagNode>
    </children>
  </node>
</interfaceDefinition>