summaryrefslogtreecommitdiff
path: root/interface-definitions/pptp-server.xml
blob: 54c2aac630053f268e66a6ec1d8e282753764115 (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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="vpn">
    <children>
      <node name="pptp" owner="${vyos_conf_scripts_dir}/accel_pptp.py">
        <properties>
          <help>Point to Point Tunneling Protocol (PPTP) Virtual Private Network (VPN)</help>
        </properties>
        <children>
          <node name="remote-access">
            <properties>
              <help>Remote access PPTP VPN</help>
            </properties>
            <children>
              <leafNode name="mtu">
                <properties>
                  <help>Maximum Transmission Unit (MTU)</help>
                  <constraint>
                    <validator name="numeric" argument="--range 128-16384"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="outside-address">
                <properties>
                  <help>External IP address to which VPN clients will connect</help>
                  <constraint>
                    <validator name="ipv4-address"/>
                  </constraint>
                </properties>
              </leafNode>
              <node name="dns-servers">
                <properties>
                  <help>IPv4 Domain Name Service (DNS) server</help>
                </properties>
                <children>
                  <leafNode name="server-1">
                    <properties>
                      <help>Primary DNS server</help>
                      <valueHelp>
                        <format>ipv4</format>
                        <description>IPv4 address</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv4-address"/>
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="server-2">
                    <properties>
                      <help>Secondary DNS server</help>
                      <valueHelp>
                        <format>ipv4</format>
                        <description>IPv4 address</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv4-address"/>
                      </constraint>
                    </properties>
                  </leafNode>
                </children>
              </node> 
              <node name="wins-servers">
                <properties>
                  <help>Windows Internet Name Service (WINS) server settings</help>
                </properties>
                <children>
                  <leafNode name="server-1">
                    <properties>
                      <help>Primary WINS server</help>
                      <constraint>
                        <validator name="ipv4-address"/>
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="server-2">
                    <properties>
                      <help>Secondary WINS server</help>
                    <constraint>
                      <validator name="ipv4-address"/>
                    </constraint>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <node name="client-ip-pool">
                <properties>
                  <help>Pool of client IP addresses (must be within a /24)</help>
                </properties>
                <children>
                  <leafNode name="start">
                    <properties>
                      <help>First IP address in the pool (will be used as gateway address)</help>
                      <constraint>
                        <validator name="ipv4-address"/>
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="stop">
                    <properties>
                      <help>Last IP address in the pool</help>
                      <constraint>
                        <validator name="ipv4-address"/>
                      </constraint>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <leafNode name="gateway-address">
                <properties>
                  <help>Gatway address uses as client tunnel termination point</help>
                  <constraint>
                    <validator name="ipv4-address"/>
                  </constraint>
                </properties>
              </leafNode>
              <node name="authentication">
                <properties>
                  <help>Authentication for remote access PPTP VPN</help>
                </properties>
                <children>
                  <leafNode name="require">
                    <properties>
                      <help>Authentication protocol for remote access peer PPTP VPN</help>
                      <valueHelp>
                        <format>pap</format>
                        <description>Require the peer to authenticate itself using PAP [Password Authentication Protocol].</description>
                      </valueHelp>
                      <valueHelp>
                        <format>chap</format>
                        <description>Require the peer to authenticate itself using CHAP [Challenge Handshake Authentication Protocol].</description>
                      </valueHelp>
                      <valueHelp>
                        <format>mschap</format>
                        <description>Require the peer to authenticate itself using CHAP [Challenge Handshake Authentication Protocol].</description>
                      </valueHelp>
                      <valueHelp>
                        <format>mschap-v2</format>
                        <description>Require the peer to authenticate itself using MS-CHAPv2 [Microsoft Challenge Handshake Authentication Protocol, Version 2].</description>
                      </valueHelp>
                    </properties>
                  </leafNode>
                  <leafNode name="mppe">
                    <properties>
                      <help>Specifies mppe negotioation preference. (default require mppe 128-bit stateless</help>
                      <valueHelp>
                        <format>deny</format>
                        <description>deny mppe</description>
                      </valueHelp>
                      <valueHelp>
                        <format>prefer</format>
                        <description>ask client for mppe, if it rejects don't fail</description>
                      </valueHelp>
                      <valueHelp>
                        <format>require</format>
                        <description>ask client for mppe, if it rejects drop connection</description>
                      </valueHelp>
                    </properties>
                  </leafNode>
                  <leafNode name="mode">
                    <properties>
                      <help>Authentication mode for remote access PPTP VPN</help>
                      <valueHelp>
                        <format>local</format>
                        <description>Use local username/password configuration</description>
                      </valueHelp>
                      <valueHelp>
                        <format>radius</format>
                        <description>Use a RADIUS server to autenticate users</description>
                      </valueHelp>
                      <constraint>
                        <regex>^(local|radius)</regex>
                      </constraint>
                      <completionHelp>
                        <list>local radius</list>
                      </completionHelp>
                    </properties>
                  </leafNode>
                  <node name="local-users">
                    <properties>
                      <help>Local user authentication for remote access PPTP VPN</help>
                    </properties>
                    <children>
                      <tagNode name="username">
                        <properties>
                          <help>User name for authentication</help>
                        </properties>
                        <children>
                          <leafNode name="disable">
                            <properties>
                              <help>Option to disable a PPTP Server user</help>
                            </properties>
                          </leafNode>
                          <leafNode name="password">
                            <properties>
                              <help>Password for authentication</help>
                            </properties>
                          </leafNode>
                          <leafNode name="static-ip">
                            <properties>
                              <help>Static client IP address</help>
                            </properties>
                          </leafNode>
                        </children>
                      </tagNode>
                    </children>
                  </node>
                  <node name="radius">
                    <properties>
                      <help>RADIUS specific configuration</help>
                    </properties>
                    <children>
                      <tagNode name="server">
                        <properties>
                          <help>IP address of radius server</help>
                          <valueHelp>
                            <format>ipv4</format>
                            <description>IP address of RADIUS server</description>
                          </valueHelp>
                        </properties>
                        <children>
                          <leafNode name="key">
                            <properties>
                              <help>Key for accessing the specified server</help>
                            </properties>
                          </leafNode>
                          <leafNode name="req-limit">
                            <properties>
                              <help>Maximum number of simultaneous requests to server (default: unlimited)</help>
                            </properties>
                          </leafNode>
                          <leafNode name="fail-time">
                            <properties>
                              <help>If server doesn't responds mark it as unavailable for this amount of time in seconds</help>
                            </properties>
                          </leafNode>
                        </children>
                      </tagNode>
                    </children>
                  </node>
                </children>
              </node>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>