summaryrefslogtreecommitdiff
path: root/interface-definitions/service-ids-ddos-protection.xml.in
blob: 0a0d78948fe11db11f8d5efa0f9780e068801532 (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
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="service">
    <children>
      <node name="ids">
        <properties>
          <help>Intrusion Detection System</help>
        </properties>
        <children>
          <node name="ddos-protection" owner="${vyos_conf_scripts_dir}/service_ids_fastnetmon.py">
            <properties>
              <help>FastNetMon detection and protection parameters</help>
              <priority>731</priority>
            </properties>
            <children>
              <leafNode name="alert-script">
                <properties>
                  <help>Path to fastnetmon alert script</help>
                </properties>
              </leafNode>
              <leafNode name="ban-time">
                <properties>
                  <help>How long we should keep an IP in blocked state</help>
                  <valueHelp>
                    <format>u32:60-4294967294</format>
                    <description>Time in seconds</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 60-4294967294"/>
                  </constraint>
                </properties>
                <defaultValue>1900</defaultValue>
              </leafNode>
              <leafNode name="direction">
                <properties>
                  <help>Direction for processing traffic</help>
                  <completionHelp>
                    <list>in out</list>
                  </completionHelp>
                  <constraint>
                    <regex>(in|out)</regex>
                  </constraint>
                  <multi/>
                </properties>
              </leafNode>
              <leafNode name="listen-interface">
                <properties>
                  <help>Listen interface for mirroring traffic</help>
                  <completionHelp>
                    <script>${vyos_completion_dir}/list_interfaces.py</script>
                  </completionHelp>
                  <multi/>
                </properties>
              </leafNode>
              <node name="mode">
                <properties>
                  <help>Traffic capture modes</help>
                </properties>
                <children>
                  <!-- Future modes "mirror" "netflow" "combine (both)" -->
                  <leafNode name="mirror">
                    <properties>
                      <help>Listen mirrored traffic mode</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <leafNode name="network">
                <properties>
                  <help>Specify IPv4 and IPv6 networks which belong to you</help>
                  <valueHelp>
                    <format>ipv4net</format>
                    <description>Your IPv4 prefix(es)</description>
                  </valueHelp>
                  <valueHelp>
                    <format>ipv6net</format>
                    <description>Your IPv6 prefix(es)</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv4-prefix"/>
                    <validator name="ipv6-prefix"/>
                  </constraint>
                  <multi/>
                </properties>
              </leafNode>
              <node name="threshold">
                <properties>
                  <help>Attack limits thresholds</help>
                </properties>
                <children>
                  <leafNode name="fps">
                    <properties>
                      <help>Flows per second</help>
                      <valueHelp>
                        <format>u32:0-4294967294</format>
                        <description>Flows per second</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 0-4294967294"/>
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="mbps">
                    <properties>
                      <help>Megabits per second</help>
                      <valueHelp>
                        <format>u32:0-4294967294</format>
                        <description>Megabits per second</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 0-4294967294"/>
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="pps">
                    <properties>
                      <help>Packets per second</help>
                      <valueHelp>
                        <format>u32:0-4294967294</format>
                        <description>Packets per second</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 0-4294967294"/>
                      </constraint>
                    </properties>
                  </leafNode>
                </children>
              </node>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>