<?xml version="1.0"?>
<interfaceDefinition>
  <node name="vpn">
    <children>
      <node name="sstp" owner="${vyos_conf_scripts_dir}/vpn_sstp.py">
        <properties>
          <help>Secure Socket Tunneling Protocol (SSTP) server</help>
          <priority>901</priority>
        </properties>
        <children>
          <node name="authentication">
            <properties>
              <help>Authentication for remote access SSTP Server</help>
            </properties>
            <children>
              <node name="local-users">
                <properties>
                  <help>Local user authentication for SSTP server</help>
                </properties>
                <children>
                  <tagNode name="username">
                    <properties>
                      <help>User name for authentication</help>
                    </properties>
                    <children>
                      <leafNode name="disable">
                        <properties>
                          <help>Option to disable a SSTP Server user</help>
                          <valueless />
                        </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>
                      <node name="rate-limit">
                        <properties>
                          <help>Upload/Download speed limits</help>
                        </properties>
                        <children>
                          <leafNode name="upload">
                            <properties>
                              <help>Upload bandwidth limit in kbits/sec</help>
                              <constraint>
                                <validator name="numeric" argument="--range 1-65535"/>
                              </constraint>
                            </properties>
                          </leafNode>
                          <leafNode name="download">
                            <properties>
                              <help>Download bandwidth limit in kbits/sec</help>
                              <constraint>
                                <validator name="numeric" argument="--range 1-65535"/>
                              </constraint>
                            </properties>
                          </leafNode>
                        </children>
                      </node>
                    </children>
                  </tagNode>
                </children>
              </node>
              <leafNode name="mode">
                <properties>
                  <help>Authentication mode for SSTP Server</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>
              <leafNode name="protocols">
                <properties>
                  <help>Authentication protocol for remote access peer SSTP VPN</help>
                  <completionHelp>
                    <list>pap chap mschap mschap-v2</list>
                  </completionHelp>
                  <valueHelp>
                    <format>pap</format>
                    <description>Authentication via PAP (Password Authentication Protocol)</description>
                  </valueHelp>
                  <valueHelp>
                    <format>chap</format>
                    <description>Authentication via CHAP (Challenge Handshake Authentication Protocol)</description>
                  </valueHelp>
                  <valueHelp>
                    <format>mschap</format>
                    <description>Authentication via MS-CHAP (Microsoft Challenge Handshake Authentication Protocol)</description>
                  </valueHelp>
                  <valueHelp>
                    <format>mschap-v2</format>
                    <description>Authentication via MS-CHAPv2 (Microsoft Challenge Handshake Authentication Protocol, version 2)</description>
                  </valueHelp>
                  <constraint>
                    <regex>(pap|chap|mschap|mschap-v2)</regex>
                  </constraint>
                    <multi />
                </properties>
              </leafNode>
              #include <include/radius-server.xml.i>
              <node name="radius">
                <children>
                  <tagNode name="server">
                    <children>
                      <leafNode name="fail-time">
                        <properties>
                          <help>Mark server unavailable for &lt;n&gt; seconds on failure</help>
                          <valueHelp>
                            <format>0-600</format>
                            <description>Fail time penalty</description>
                          </valueHelp>
                          <constraint>
                            <validator name="numeric" argument="--range 0-600"/>
                          </constraint>
                          <constraintErrorMessage>Fail time must be between 0 and 600 seconds</constraintErrorMessage>
                        </properties>
                      </leafNode>
                    </children>
                  </tagNode>
                  <leafNode name="timeout">
                    <properties>
                      <help>Timeout in seconds to wait response from RADIUS server</help>
                      <valueHelp>
                        <format>1-60</format>
                        <description>Timeout in seconds</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-60"/>
                      </constraint>
                      <constraintErrorMessage>Timeout must be between 1 and 60 seconds</constraintErrorMessage>
                    </properties>
                  </leafNode>
                  <leafNode name="acct-timeout">
                    <properties>
                      <help>Timeout for Interim-Update packets, terminate session afterwards (default 3 seconds)</help>
                      <valueHelp>
                        <format>0-60</format>
                        <description>Timeout in seconds, 0 to keep active</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 0-60"/>
                      </constraint>
                      <constraintErrorMessage>Timeout must be between 0 and 60 seconds</constraintErrorMessage>
                    </properties>
                  </leafNode>
                  <leafNode name="max-try">
                    <properties>
                      <help>Number of tries to send Access-Request/Accounting-Request queries</help>
                      <valueHelp>
                        <format>1-20</format>
                        <description>Maximum tries</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-20"/>
                      </constraint>
                      <constraintErrorMessage>Maximum tries must be between 1 and 20</constraintErrorMessage>
                    </properties>
                  </leafNode>
                  <leafNode name="nas-identifier">
                    <properties>
                      <help>NAS-Identifier attribute sent to RADIUS</help>
                    </properties>
                  </leafNode>
                  <leafNode name="nas-ip-address">
                    <properties>
                      <help>NAS-IP-Address attribute sent to RADIUS</help>
                       <constraint>
                        <validator name="ipv4-address"/>
                      </constraint>
                      <valueHelp>
                        <format>ipv4</format>
                        <description>NAS-IP-Address attribute</description>
                      </valueHelp>
                     </properties>
                   </leafNode>
                  <node name="dynamic-author">
                    <properties>
                      <help>Dynamic Authorization Extension/Change of Authorization server</help>
                    </properties>
                    <children>
                      <leafNode name="server">
                        <properties>
                          <help>IP address for Dynamic Authorization Extension server (DM/CoA)</help>
                          <constraint>
                            <validator name="ipv4-address"/>
                          </constraint>
                          <valueHelp>
                            <format>ipv4</format>
                            <description>IPv4 address for aynamic authorization server</description>
                          </valueHelp>
                        </properties>
                      </leafNode>
                      <leafNode name="port">
                        <properties>
                          <help>Port for Dynamic Authorization Extension server (DM/CoA)</help>
                          <valueHelp>
                            <format>number</format>
                            <description>TCP port</description>
                          </valueHelp>
                          <constraint>
                            <validator name="numeric" argument="--range 1-65535"/>
                          </constraint>
                        </properties>
                      </leafNode>
                      <leafNode name="key">
                        <properties>
                          <help>Shared secret for Dynamic Authorization Extension server</help>
                        </properties>
                      </leafNode>
                    </children>
                  </node>
                  <node name="rate-limit">
                    <properties>
                      <help>Upload/Download speed limits</help>
                    </properties>
                    <children>
                      <leafNode name="attribute">
                        <properties>
                          <help>Specifies RADIUS attribute containing rate information (default 'Filter-Id')</help>
                        </properties>
                      </leafNode>
                      <leafNode name="vendor">
                        <properties>
                          <help>Specifies vendor dictionary (needs to be in /usr/share/accel-ppp/radius)</help>
                        </properties>
                      </leafNode>
                      <leafNode name="enable">
                        <properties>
                          <help>Enable RADIUS bandwidth shaping</help>
                          <valueless />
                        </properties>
                      </leafNode>
                    </children>
                  </node>
                </children>
              </node>
            </children>
          </node>
          <node name="ssl">
            <properties>
              <help>SSL Certificate, SSL Key and CA (/config/user-data/sstp)</help>
            </properties>
            <children>
              <leafNode name="ca-cert-file">
                <properties>
                  <help>Certificate Authority certificate</help>
                  <valueHelp>
                    <format>file</format>
                    <description>File in /config/auth directory</description>
                  </valueHelp>
                  <constraint>
                    <validator name="file-exists" argument="--directory /config/auth"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="cert-file">
                <properties>
                  <help>Server Certificate</help>
                  <completionHelp>
                    <script>ls /config</script>
                  </completionHelp>
                  <constraint>
                    <validator name="file-exists" argument="--directory /config/auth"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="key-file">
                <properties>
                  <help>Privat Key of the Server Certificate</help>
                  <valueHelp>
                    <format>file</format>
                    <description>File in /config/auth directory</description>
                  </valueHelp>
                  <constraint>
                    <validator name="file-exists" argument="--directory /config/auth"/>
                  </constraint>
                </properties>
              </leafNode>
            </children>
          </node>
          <node name="network-settings">
            <properties>
              <help>Network settings</help>
            </properties>
            <children>
              <node name="client-ip-settings">
                <properties>
                  <help>Client IP pools and gateway setting</help>
                </properties>
                <children>
                  <leafNode name="subnet">
                    <properties>
                      <help>Client IP subnet (CIDR notation)</help>
                      <valueHelp>
                        <format>ipv4net</format>
                        <description>IPv4 address and prefix length</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv4-prefix"/>
                      </constraint>
                      <constraintErrorMessage>Not a valid CIDR formatted prefix</constraintErrorMessage>
                      <multi />
                    </properties>
                  </leafNode>
                  <leafNode name="gateway-address">
                    <properties>
                      <help>Gateway IP address</help>
                      <constraint>
                        <validator name="ipv4-address"/>
                      </constraint>
                      <constraintErrorMessage>invalid IPv4 address</constraintErrorMessage>
                      <valueHelp>
                        <format>ipv4</format>
                        <description>Default Gateway send to the client</description>
                      </valueHelp>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <leafNode name="name-server">
                <properties>
                  <help>DNS servers propagated to clients</help>
                      <valueHelp>
                        <format>ipv4</format>
                        <description>IPv4 address</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv4-address"/>
                      </constraint>
                      <multi/>
                </properties>
              </leafNode>
              #include <include/interface-mtu-68-1500.xml.i>
            </children>
          </node>
          <node name="ppp-settings">
            <properties>
              <help>PPP (Point-to-Point Protocol) settings</help>
            </properties>
            <children>
              <leafNode name="mppe">
                <properties>
                  <help>Specifies mppe negotiation preferences</help>
                  <completionHelp>
                    <list>require prefer deny</list>
                  </completionHelp>
                  <constraint>
                    <regex>(^require|prefer|deny)</regex>
                  </constraint>
                  <valueHelp>
                    <format>require</format>
                    <description>send mppe request, if client rejects, drop the connection</description>
                  </valueHelp>
                  <valueHelp>
                    <format>prefer</format>
                    <description>send mppe request, if client rejects continue</description>
                  </valueHelp>
                  <valueHelp>
                    <format>deny</format>
                    <description>drop all mppe</description>
                  </valueHelp>
                </properties>
              </leafNode>
              <leafNode name="lcp-echo-interval">
                <properties>
                  <help>LCP echo-requests/sec</help>
                  <constraint>
                    <validator name="numeric" argument="--positive"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="lcp-echo-failure">
                <properties>
                  <help>Maximum number of Echo-Requests may be sent without valid reply</help>
                  <constraint>
                    <validator name="numeric" argument="--positive"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="lcp-echo-timeout">
                <properties>
                  <help>Timeout in seconds to wait for any peer activity. If this option specified it turns on adaptive lcp echo functionality and "lcp-echo-failure" is not used.</help>
                  <constraint>
                    <validator name="numeric" argument="--positive"/>
                  </constraint>
                </properties>
              </leafNode>
            </children>
          </node>
      </children>
    </node>
  </children>
</node>
</interfaceDefinition>