summaryrefslogtreecommitdiff
path: root/interface-definitions/system_login.xml.in
blob: 672c4afc8ca953ccf076e7adb709c200e9baaf69 (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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="system">
    <children>
      <node name="login" owner="${vyos_conf_scripts_dir}/system_login.py">
        <properties>
          <help>System User Login Configuration</help>
          <priority>400</priority>
        </properties>
        <children>
          <tagNode name="user">
            <properties>
              <help>Local user account information</help>
              <constraint>
                #include <include/constraint/login-username.xml.i>
              </constraint>
              <constraintErrorMessage>Username contains illegal characters or\nexceeds 100 character limitation.</constraintErrorMessage>
            </properties>
            <children>
              <node name="authentication">
                <properties>
                  <help>Authentication settings</help>
                </properties>
                <children>
                  <leafNode name="encrypted-password">
                    <properties>
                      <help>Encrypted password</help>
                      <constraint>
                        <regex>(\*|\!)</regex>
                        <regex>[a-zA-Z0-9\.\/]{13}</regex>
                        <regex>\$1\$[a-zA-Z0-9\./]*\$[a-zA-Z0-9\./]{22}</regex>
                        <regex>\$5\$(rounds=[0-9]+\$)?[a-zA-Z0-9\./]*\$[a-zA-Z0-9\./]{43}</regex>
                        <regex>\$6\$(rounds=[0-9]+\$)?[a-zA-Z0-9\./]*\$[a-zA-Z0-9\./]{86}</regex>
                      </constraint>
                      <constraintErrorMessage>Invalid encrypted password for $VAR(../../@).</constraintErrorMessage>
                    </properties>
                    <defaultValue>!</defaultValue>
                  </leafNode>
                  <node name="otp">
                    <properties>
                      <help>One-Time-Pad (two-factor) authentication parameters</help>
                    </properties>
                    <children>
                      <leafNode name="rate-limit">
                        <properties>
                          <help>Limit number of logins (rate-limit) per rate-time</help>
                          <valueHelp>
                            <format>u32:1-10</format>
                            <description>Number of attempts</description>
                          </valueHelp>
                          <constraint>
                            <validator name="numeric" argument="--range 1-10"/>
                          </constraint>
                          <constraintErrorMessage>Number of login attempts must me between 1 and 10</constraintErrorMessage>
                        </properties>
                        <defaultValue>3</defaultValue>
                      </leafNode>
                      <leafNode name="rate-time">
                        <properties>
                          <help>Limit number of logins (rate-limit) per rate-time</help>
                          <valueHelp>
                            <format>u32:15-600</format>
                            <description>Time interval</description>
                          </valueHelp>
                          <constraint>
                            <validator name="numeric" argument="--range 15-600"/>
                          </constraint>
                          <constraintErrorMessage>Rate limit time interval must be between 15 and 600 seconds</constraintErrorMessage>
                        </properties>
                        <defaultValue>30</defaultValue>
                      </leafNode>
                      <leafNode name="window-size">
                        <properties>
                          <help>Set window of concurrently valid codes</help>
                          <valueHelp>
                            <format>u32:1-21</format>
                            <description>Window size</description>
                          </valueHelp>
                          <constraint>
                            <validator name="numeric" argument="--range 1-21"/>
                          </constraint>
                          <constraintErrorMessage>Window of concurrently valid codes must be between 1 and 21</constraintErrorMessage>
                        </properties>
                        <defaultValue>3</defaultValue>
                      </leafNode>
                      <leafNode name="key">
                        <properties>
                          <help>Key/secret the token algorithm (see RFC4226)</help>
                          <valueHelp>
                            <format>txt</format>
                            <description>Base32 encoded key/token</description>
                          </valueHelp>
                          <constraint>
                            <regex>[a-zA-Z2-7]{26,10000}</regex>
                          </constraint>
                          <constraintErrorMessage>Key must only include base32 characters and be at least 26 characters long</constraintErrorMessage>
                        </properties>
                      </leafNode>
                    </children>
                  </node>
                  <leafNode name="plaintext-password">
                    <properties>
                      <help>Plaintext password used for encryption</help>
                    </properties>
                  </leafNode>
                  <tagNode name="public-keys">
                    <properties>
                      <help>Remote access public keys</help>
                      <valueHelp>
                        <format>txt</format>
                        <description>Key identifier used by ssh-keygen (usually of form user@host)</description>
                      </valueHelp>
                    </properties>
                    <children>
                      <leafNode name="key">
                        <properties>
                          <help>Public key value (Base64 encoded)</help>
                          <constraint>
                            <validator name="base64"/>
                          </constraint>
                        </properties>
                      </leafNode>
                      <leafNode name="options">
                        <properties>
                          <help>Optional public key options</help>
                        </properties>
                      </leafNode>
                      <leafNode name="type">
                        <properties>
                          <help>SSH public key type</help>
                          <completionHelp>
                            <list>ssh-dss ssh-rsa ecdsa-sha2-nistp256 ecdsa-sha2-nistp384 ecdsa-sha2-nistp521 ssh-ed25519 sk-ecdsa-sha2-nistp256@openssh.com sk-ssh-ed25519@openssh.com</list>
                          </completionHelp>
                          <valueHelp>
                            <format>ssh-dss</format>
                            <description>Digital Signature Algorithm (DSA) key support</description>
                          </valueHelp>
                          <valueHelp>
                            <format>ssh-rsa</format>
                            <description>Key pair based on RSA algorithm</description>
                          </valueHelp>
                          <valueHelp>
                            <format>ecdsa-sha2-nistp256</format>
                            <description>Elliptic Curve DSA with NIST P-256 curve</description>
                          </valueHelp>
                          <valueHelp>
                            <format>ecdsa-sha2-nistp384</format>
                            <description>Elliptic Curve DSA with NIST P-384 curve</description>
                          </valueHelp>
                          <valueHelp>
                            <format>ecdsa-sha2-nistp521</format>
                            <description>Elliptic Curve DSA with NIST P-521 curve</description>
                          </valueHelp>
                          <valueHelp>
                            <format>ssh-ed25519</format>
                            <description>Edwards-curve DSA with elliptic curve 25519</description>
                          </valueHelp>
                          <valueHelp>
                            <format>sk-ecdsa-sha2-nistp256@openssh.com</format>
                            <description>Elliptic Curve DSA security key</description>
                          </valueHelp>
                          <valueHelp>
                            <format>sk-ssh-ed25519@openssh.com</format>
                            <description>Elliptic curve 25519 security key</description>
                          </valueHelp>
                          <constraint>
                            <regex>(ssh-dss|ssh-rsa|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-ed25519|sk-ecdsa-sha2-nistp256@openssh.com|sk-ssh-ed25519@openssh.com)</regex>
                          </constraint>
                        </properties>
                      </leafNode>
                    </children>
                  </tagNode>
                </children>
              </node>
              <leafNode name="full-name">
                <properties>
                  <help>Full name of the user (use quotes for names with spaces)</help>
                  <constraint>
                    <regex>[^:]*</regex>
                  </constraint>
                  <constraintErrorMessage>Cannot use ':' in full name</constraintErrorMessage>
                </properties>
              </leafNode>
              <leafNode name="home-directory">
                <properties>
                  <help>Home directory</help>
                  <valueHelp>
                    <format>txt</format>
                    <description>Path to home directory</description>
                  </valueHelp>
                  <constraint>
                    <regex>\/$|(\/[a-zA-Z_0-9-.]+)+</regex>
                  </constraint>
                </properties>
              </leafNode>
            </children>
          </tagNode>
          #include <include/radius-server-ipv4-ipv6.xml.i>
          <node name="radius">
            <children>
              <tagNode name="server">
                <children>
                  #include <include/radius-timeout.xml.i>
                  <leafNode name="priority">
                    <properties>
                      <help>Server priority</help>
                      <valueHelp>
                        <format>u32:1-255</format>
                        <description>Server priority</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-255"/>
                      </constraint>
                    </properties>
                    <defaultValue>255</defaultValue>
                  </leafNode>
                </children>
              </tagNode>
              #include <include/interface/vrf.xml.i>
            </children>
          </node>
          <node name="tacacs">
            <properties>
              <help>TACACS+ based user authentication</help>
            </properties>
            <children>
              <tagNode name="server">
                <properties>
                  <help>TACACS+ server configuration</help>
                  <valueHelp>
                    <format>ipv4</format>
                    <description>TACACS+ server IPv4 address</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv4-address"/>
                  </constraint>
                </properties>
                <children>
                  #include <include/generic-disable-node.xml.i>
                  #include <include/radius-server-key.xml.i>
                  #include <include/port-number.xml.i>
                  <leafNode name="port">
                    <defaultValue>49</defaultValue>
                  </leafNode>
                </children>
              </tagNode>
              <leafNode name="security-mode">
                <properties>
                  <help>Security mode for TACACS+ authentication</help>
                  <completionHelp>
                    <list>mandatory optional</list>
                  </completionHelp>
                  <valueHelp>
                    <format>mandatory</format>
                    <description>Deny access immediately if TACACS+ answers with REJECT</description>
                  </valueHelp>
                  <valueHelp>
                    <format>optional</format>
                    <description>Pass to the next authentication method if TACACS+ answers with REJECT</description>
                  </valueHelp>
                  <constraint>
                    <regex>(mandatory|optional)</regex>
                  </constraint>
                </properties>
                <defaultValue>optional</defaultValue>
              </leafNode>
              #include <include/source-address-ipv4.xml.i>
              #include <include/radius-timeout.xml.i>
              #include <include/interface/vrf.xml.i>
            </children>
          </node>
          <leafNode name="max-login-session">
            <properties>
              <help>Maximum number of all login sessions</help>
              <valueHelp>
                <format>u32:1-65536</format>
                <description>Maximum number of all login sessions</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-65536"/>
              </constraint>
              <constraintErrorMessage>Maximum logins must be between 1 and 65536</constraintErrorMessage>
            </properties>
          </leafNode>
          <leafNode name="timeout">
            <properties>
              <help>Session timeout</help>
              <valueHelp>
                <format>u32:5-604800</format>
                <description>Session timeout in seconds</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 5-604800"/>
              </constraint>
              <constraintErrorMessage>Timeout must be between 5 and 604800 seconds</constraintErrorMessage>
            </properties>
          </leafNode>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>