summaryrefslogtreecommitdiff
path: root/interface-definitions/ssh.xml
blob: 35fe792146e9a2efb183e9563041499f5dd2c7c6 (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
<?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 the following order: deny-users, allow-users, deny-groups and
                allow-groups.</help>
            </properties>
            <children>
              <node name="allow">
                <properties>
                  <help>Allow user/group SSH access</help>
                </properties>
                <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">
                <properties>
                  <help>Deny user/group SSH access</help>
                </properties>
                <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>