summaryrefslogtreecommitdiff
path: root/interface-definitions/include/auth-local-users.xml.i
blob: cb456eecf21a7772a6ac53df34a33aae1b940b3c (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
<!-- include start from auth-local-users.xml.i -->
<node name="local-users">
  <properties>
    <help>Local user authentication</help>
  </properties>
  <children>
    <tagNode name="username">
      <properties>
        <help>Username used for authentication</help>
        <valueHelp>
          <format>txt</format>
          <description>Username used for authentication</description>
        </valueHelp>
      </properties>
      <children>
        #include <include/generic-disable-node.xml.i>
        <leafNode name="password">
          <properties>
            <help>Password used for authentication</help>
          </properties>
        </leafNode>
        <node name="otp">
          <properties>
            <help>2FA OTP authentication parameters</help>
          </properties>
          <children>
            <leafNode name="key">
              <properties>
                <help>Token Key Secret key for the token algorithm (see RFC 4226)</help>
                <valueHelp>
                  <format>txt</format>
                  <description>OTP key in hex-encoded format</description>
                </valueHelp>
                <constraint>
                  <regex>[a-fA-F0-9]{20,10000}</regex>
                </constraint>
                <constraintErrorMessage>Key name must only include hex characters and be at least 20 characters long</constraintErrorMessage>
              </properties>
            </leafNode>
            <leafNode name="otp-length">
              <properties>
                <help>Number of digits in OTP code</help>
                <valueHelp>
                  <format>u32:6-8</format>
                  <description>Number of digits in OTP code</description>
                </valueHelp>
                <constraint>
                  <validator name="numeric" argument="--range 6-8"/>
                </constraint>
                <constraintErrorMessage>Number of digits in OTP code must be between 6 and 8</constraintErrorMessage>
              </properties>
              <defaultValue>6</defaultValue>
            </leafNode>
            <leafNode name="interval">
              <properties>
                <help>Time tokens interval in seconds</help>
                <valueHelp>
                  <format>u32:5-86400</format>
                  <description>Time tokens interval in seconds.</description>
                </valueHelp>
                <constraint>
                  <validator name="numeric" argument="--range 5-86400"/>
                </constraint>
                <constraintErrorMessage>Time token interval must be between 5 and 86400 seconds</constraintErrorMessage>
              </properties>
              <defaultValue>30</defaultValue>
            </leafNode>
            <leafNode name="token-type">
              <properties>
                <help>Token type</help>
                <valueHelp>
                  <format>hotp-time</format>
                  <description>Time-based OTP algorithm</description>
                </valueHelp>
                <valueHelp>
                  <format>hotp-event</format>
                  <description>Event-based OTP algorithm</description>
                </valueHelp>
                <constraint>
                  <regex>(hotp-time|hotp-event)</regex>
                </constraint>
                <completionHelp>
                  <list>hotp-time hotp-event</list>
                </completionHelp>
              </properties>
              <defaultValue>hotp-time</defaultValue>
            </leafNode>
          </children>
        </node>
      </children>
    </tagNode>
  </children>
</node>
<!-- include end -->