This document provides a brief description of the Denial of Service(DoS) API It provides the following services:

Sets source IP address=destination IP address (SIP=DIP) denial of service protection.
Gets source IP address=destination IP address (SIP=DIP) denial of service protection mode.
Sets source MAC address=destination MAC address (SMAC=DMAC) denial of service protection.
Gets source MAC address=destination MAC address (SMAC=DMAC) denial of service protection mode.
Sets first fragment denial of service protection.
Gets first fragment denial of service protection mode.
Gets TCP Partial denial of service protection mode.
Sets minimum TCP header size denial of service protection.
Gets denial of service protection Minimum TCP Header Size.
Sets TCP fragment denial of service protection.
Gets TCP Fragment denial of service protection mode.
Sets TCP offset denial of service protection.
Gets TCP Offset denial of service protection mode.
Sets TCP flag denial of service protection.
Gets TCP flag denial of service protection mode.
Sets TCP flag and sequence denial of service protection.
Gets TCP flag and sequence denial of service protection mode.
Sets TCP port denial of service protection.
Gets TCP port denial of service protection mode.
Sets UDP port denial of service protection.
Gets UDP port denial of service protection mode.
Sets TCP SYN denial of service protection.
Gets TCP SYN denial of service protection mode.
Sets TCP SYN and FIN denial of service protection.
Gets TCP SYN and FIN denial of service protection mode.
Sets TCP FIN,URG and PSH denial of service protection.
Gets TCP FIN,URG and PSH denial of service protection mode.
Sets L4 Port denial of service protection.
Gets L4 Port denial of service protection mode.
Sets ICMP denial of service protection.
Gets ICMP denial of service protection mode.
Sets maximum ICMP size denial of service protection.
Gets denial of service protection maximum ICMP size.
Gets denial of service protection Maximum ICMPv4 payload size.
Sets maximum ICMPv6 size denial of service protection.
Gets denial of service protection Maximum ICMPv6 payload size.
Sets ICMP Fragment denial of service protection.
Gets ICMP Fragment denial of service protection mode.
Sets ICMPv6 denial of service protection.
Gets ICMPv6 denial of service protection mode.
Sets ping flooding denial of service protection on an interface.
Gets ping flooding denial of service protection mode on an interface.
Sets preventing Smurf denial of service protection on an interface.
Gets Smurf denial of service protection mode on an interface.
Gets SynAck Flooding denial of service protection mode on an interface.
Sets ping flooding denial of service protection.
Gets ping flooding denial of service protection mode.
Sets preventing Smurf denial of service protection.
Gets Smurf denial of service protection mode.
Sets preventing SynAck Flooding denial of service protection.
Gets preventing SynAck Flooding denial of service protection mode.
Sets port D-disable for denial of service protection.
Gets port D-disable state for denial of service protection.
Sets Auto denial of service protection.
Gets Auto denial of service protection mode.
Sets Vlan0 Tagged and SNAP Drop denial of service protection.
Gets Vlan0 Tagged and SNAP Drop denial of service protection mode.

Example C Application dos_example

Initialization

In the main function, the sample application initializes the OpEN API RPC service by calling openapiClientRegister() and waits for the RPC service in switchdrvr to start. A Client Handle is returned by openapiClientRegister() which is used while invoking the OpEN APIs. The application then exercises the associated OpEN APIs and logs informational and/or error messages on the console. The example application runs to its completion and exits.

dos_example

dos_example.c is a sample application that demonstrates the use of OpEN's DoS APIs. dos_example is started from the command line and can be used to exercise the various APIs by specifying arguments on the command line.

Sample Output

Usage: ./dos_example <test#> <arg1> <arg2> ...
Test 1: Sets source IP address=destination IP address (SIP=DIP) denial of service protection: dos_example 1 <mode>
Test 2: Sets source MAC address=destination MAC address (SMAC=DMAC) denial of service protection: dos_example 2 <mode>
Test 3: Sets first fragment denial of service protection: dos_example 3 <mode>
Test 4: Sets minimum TCP header size denial of service protection: dos_example 4 <minTCPHdrSize>
Test 5: Sets TCP fragment denial of service protection: dos_example 5 <mode>
Test 6: Sets TCP offset denial of service protection: dos_example 6 <mode>
Test 7: Sets TCP flag denial of service protection: dos_example 7 <mode>
Test 8: Sets TCP flag and sequence denial of service protection: dos_example 8 <mode>
Test 9: Sets TCP port denial of service protection: dos_example 9 <mode>
Test 10: Sets UDP port denial of service protection: dos_example 10 <mode>
Test 11: Sets TCP SYN denial of service protection: dos_example 11 <mode>
Test 12: Sets TCP SYN and FIN denial of service protection: dos_example 12 <mode>
Test 13: Sets TCP FIN,URG and PSH denial of service protection: dos_example 13 <mode>
Test 14: Sets L4 Port denial of service protection: dos_example 14 <mode>
Test 15: Sets ICMP denial of service protection: dos_example 15 <mode>
Test 16: Sets maximum ICMP size denial of service protection: dos_example 16 <maxICMPSize>
Test 17: Sets maximum ICMPv6 size denial of service protection: dos_example 17 <maxICMPv6Size>
Test 18: Sets ICMP Fragment denial of service protection: dos_example 18 <mode>
Test 19: Gets source IP address=destination IP address (SIP=DIP) denial of service protection mode: dos_example 19
Test 20: Gets source MAC address=destination MAC address (SMAC=DMAC) denial of service protection mode: dos_example 20
Test 21: Gets first fragment denial of service protection mode: dos_example 21
Test 22: Gets TCP Partial denial of service protection mode: dos_example 22
Test 23: Gets denial of service protection Minimum TCP Header Size: dos_example 23
Test 24: Gets TCP Offset denial of service protection mode: dos_example 24
Test 25: Gets TCP port denial of service protection mode: dos_example 25
Test 26: Gets UDP port denial of service protection mode: dos_example 26
Test 27: Gets TCP Fragment denial of service protection mode: dos_example 27
Test 28: Gets TCP flag denial of service protection mode: dos_example 28
Test 29: Gets TCP flag and sequence denial of service protection mode: dos_example 29
Test 30: Gets TCP SYN denial of service protection mode: dos_example 30
Test 31: Gets TCP SYN and FIN denial of service protection mode: dos_example 31
Test 32: Gets TCP FIN,URG and PSH denial of service protection mode: dos_example 32
Test 33: Gets L4 Port denial of service protection mode: dos_example 33
Test 34: Gets ICMP denial of service protection mode: dos_example 34
Test 35: Gets denial of service protection maximum ICMP size: dos_example 35
Test 36: Sets ping flooding denial of service protection on an interface: dos_example 36 <interface><mode>
Test 37: Gets ping flooding denial of service protection mode on an interface: dos_example 37 <interface>
Test 38: Sets preventing Smurf denial of service protection on an interface: dos_example 38 <interface><mode>
Test 39: Gets Smurf denial of service protection mode on an interface: dos_example 39 <interface>
Test 40: Gets SynAck Flooding denial of service protection mode on an interface: dos_example 40 <interface>
Test 41: Sets ping flooding denial of service protection: dos_example 41 <mode>
Test 42: Gets ping flooding denial of service protection mode: dos_example 42
Test 43: Sets preventing Smurf denial of service protection: dos_example 43 <mode>
Test 44: Gets Smurf denial of service protection mode: dos_example 44
Test 45: Sets preventing SynAck Flooding denial of service protection: dos_example 45 <mode>
Test 46: Gets preventing SynAck Flooding denial of service protection mode: dos_example 46
Test 47: Gets denial of service protection Maximum ICMPv4 payload size: dos_example 47
Test 48: Gets denial of service protection Maximum ICMPv6 payload size: dos_example 48
Test 49: Gets ICMP Fragment denial of service protection mode: dos_example 49
Test 50: Gets ICMPv6 denial of service protection mode: dos_example 50
Test 51: Sets ICMPv6 denial of service protection: dos_example 51 <mode>
Test 52: Gets port D-disable state for denial of service protection: dos_example 52
Test 53: Sets port D-disable for denial of service protection: dos_example 53 <mode>
Test 54: Gets Auto denial of service protection mode: dos_example 54
Test 55: Sets Auto denial of service protection: dos_example 55 <mode>
Test 56: Gets Vlan0 Tagged and SNAP Drop denial of service protection mode: dos_example 56
Test 57: Sets Vlan0 Tagged and SNAP Drop denial of service protection: dos_example 57 <mode>
Test 58: Run API sanity checks: dos_example 58

DoS CLI/API Cross Reference

CLI Command	OpEN API Reference
(Config)# [no] dos-control sipdip	openapiDoSSIPDIPModeSet()
(Config)# [no] dos-control smacdmac	openapiDoSSMACDMACModeSet()
(Config)# [no] dos-control firstfrag	openapiDoSFirstFragModeSet()
(Config)# [no] dos-control firstfrag <0-255>	openapiDoSFirstFragSizeSet()
(Config)# [no] dos-control icmpfrag	openapiDoSICMPFragModeSet()
(Config)# [no] dos-control icmpv4	openapiDoSICMPModeSet()
(Config)# [no] dos-control icmpv4 <0-16376>	openapiDoSICMPSizeSet()
(Config)# [no] dos-control icmpv6	openapiDoSICMPv6ModeSet()
(Config)# [no] dos-control icmpv6 <0-16376>	openapiDoSICMPv6SizeSet()
(Config)# [no] dos-control l4port	openapiDoSL4PortModeSet()
(Config)# [no] dos-control port-ddisable	openapiDoSPortDdisableModeSet()
(Config)# [no] dos-control tcpfinurgpsh	openapiDoSTCPFinUrgPshModeSet()
(Config)# [no] dos-control tcpflag	openapiDoSTCPFlagModeSet()
(Config)# [no] dos-control tcpflagseq	openapiDoSTCPFlagSeqModeSet()
(Config)# [no] dos-control tcpfrag	openapiDoSTCPFragModeSet()
(Config)# [no] dos-control tcpoffset	openapiDoSTCPOffsetModeSet()
(Config)# [no] dos-control tcpport	openapiDoSTCPPortModeSet()
(Config)# [no] dos-control tcpsyn	openapiDoSTCPSynModeSet()
(Config)# [no] dos-control tcpsynfin	openapiDoSTCPSynFinModeSet()
(Config)# [no] dos-control udpport	openapiDoSUDPPortModeSet()
#show dos-control	openapiDoSSIPDIPModeGet() openapiDoSSMACDMACModeGet() openapiDoSFirstFragModeGet() openapiDoSFirstFragSizeGet() openapiDoSICMPFragModeGet() openapiDoSICMPModeGet() openapiDoSICMPSizeGet() openapiDoSICMPv6ModeGet() openapiDoSICMPv6SizeGet() openapiDoSL4PortModeGet() openapiDoSPortDdisableModeGet() openapiDoSTCPFinUrgPshModeGet() openapiDoSTCPFlagModeGet() openapiDoSTCPFlagSeqModeGet() openapiDoSTCPFragModeGet() openapiDoSTCPOffsetModeGet() openapiDoSTCPPortModeGet() openapiDoSTCPSynModeGet() openapiDoSTCPSynFinModeGet() openapiDoSUDPPortModeGet()