<?xml version="1.0"?>

<!--SSH configuration -->

<interfaceDefinition>
  <node name="service">
    <children>
      <node name="ssh" owner="${vyos_conf_scripts_dir}/ssh.py">
        <properties>
          <help>Secure SHell (SSH) protocol</help>
          <priority>500</priority>
        </properties>
        <children>
          <node name="access-control">
            <properties>
              <help>SSH user/group access controls. Directives are processed in this order: deny-users, allow-users, deny-groups and allow-groups</help>
            </properties>
            <children>
              <node name="allow">
                <children>
                  <leafNode name="group">
                    <properties>
                      <help>Allow members of a group to login</help>
                        <constraint>
                          <regex>^[a-z_][a-z0-9_-]{1,31}[$]?</regex>
                        </constraint>
                        <constraintErrorMessage>illegal characters or more than 32 characters</constraintErrorMessage>
                      <multi/>
                    </properties>
                  </leafNode>
                  <leafNode name="user">
                    <properties>
                      <help>Allow specific users to login</help>
                      <constraint>
                        <regex>^[a-z_][a-z0-9_-]{1,31}[$]?</regex>
                      </constraint>
                      <constraintErrorMessage>illegal characters or more than 32 characters</constraintErrorMessage>
                      <multi/>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <node name="deny">
                <children>
                  <leafNode name="group">
                    <properties>
                      <help>Disallow members of a group to login</help>
                      <constraint>
                        <regex>^[a-z_][a-z0-9_-]{1,31}[$]?</regex>
                      </constraint>
                      <constraintErrorMessage>illegal characters or more than 32 characters</constraintErrorMessage>
                      <multi/>
                    </properties>
                  </leafNode>
                  <leafNode name="user">
                    <properties>
                      <help>Disallow specific users to login</help>
                      <constraint>
                        <regex>^[a-z_][a-z0-9_-]{1,31}[$]?</regex>
                      </constraint>
                      <constraintErrorMessage>illegal characters or more than 32 characters</constraintErrorMessage>
                      <multi/>
                    </properties>
                  </leafNode>
                </children>
              </node>
            </children>
          </node>
          <leafNode name="allow-root">
            <properties>
              <help>Allow the root user to login</help>
              <valueless/>
            </properties>
          </leafNode>
          <leafNode name="ciphers">
            <properties>
              <help>Allowed ciphers</help>
              <completionHelp>
                <script>ssh -Q cipher | tr '\n' ' '</script>
              </completionHelp>
              <multi/>
            </properties>
          </leafNode>
          <leafNode name="disable-host-validation">
            <properties>
              <help>Don't validate the remote host name with DNS</help>
              <valueless/>
            </properties>
          </leafNode>
          <leafNode name="disable-password-authentication">
            <properties>
              <help>Disable password-based authentication</help>
              <valueless/>
            </properties>
          </leafNode>
          <leafNode name="key-exchange">
            <properties>
              <help>Allowed key exchange (KEX) algorithms</help>
              <completionHelp>
                <script>ssh -Q kex | tr '\n' ' '</script>
              </completionHelp>
              <multi/>
            </properties>
          </leafNode>
          <leafNode name="listen-address">
            <properties>
              <help>Local addresses SSH service should listen on</help>
              <valueHelp>
                <format>ipv4</format>
                <description>IP address to listen for incoming connections</description>
              </valueHelp>
              <valueHelp>
                <format>ipv6</format>
                <description>IPv6 address to listen for incoming connections</description>
              </valueHelp>
              <multi/>
              <constraint>
                <validator name="ipv4-address"/>
                <validator name="ipv6-address"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="loglevel">
            <properties>
              <help>Log level</help>
              <valueHelp>
                <format>QUIET</format>
                <description>stay silent</description>
              </valueHelp>
              <valueHelp>
                <format>FATAL</format>
                <description>log fatals only</description>
              </valueHelp>
              <valueHelp>
                <format>ERROR</format>
                <description>log errors and fatals only</description>
              </valueHelp>
              <valueHelp>
                <format>INFO</format>
                <description>default log level</description>
              </valueHelp>
              <valueHelp>
                <format>VERBOSE</format>
                <description>enable logging of failed login attempts</description>
              </valueHelp>
            </properties>
          </leafNode>
          <leafNode name="mac">
            <properties>
                <help>Allowed message authentication code (MAC) algorithms</help>
              <completionHelp>
                <script>ssh -Q mac | tr '\n' ' '</script>
              </completionHelp>
              <multi/>
            </properties>
          </leafNode>
          <leafNode name="port">
            <properties>
              <help>Port for SSH service</help>
              <valueHelp>
                <format>1-65535</format>
                <description>Numeric IP port</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-65535"/>
              </constraint>
            </properties>
          </leafNode>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>