Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.11.1.2
openapi_dos.h
Go to the documentation of this file.
1 
9 /**********************************************************************
10 *
11 * Copyright 2022-2023 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 ***********************************************************************
26 *
27 * @filename openapi_dos.h
28 *
29 * @purpose Denial of Service OpEN API
30 *
31 * @component OPEN
32 *
33 * @create 11/18/2022
34 *
35 * @end
36 *
37 *********************************************************************/
38 #ifndef OPENAPI_DOS_H_INCLUDED
39 #define OPENAPI_DOS_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 
44 /*************************************************************************/
61 
62 /*************************************************************************/
79 
80 /*************************************************************************/
97 
98 /*************************************************************************/
114 open_error_t openapiDoSFirstFragSizeSet(openapiClientHandle_t *client_handle, uint32_t minTCPHdrSize);
115 
116 /*************************************************************************/
133 
134 /*************************************************************************/
151 
152 /*************************************************************************/
169 
170 /*************************************************************************/
187 
188 /*************************************************************************/
205 
206 /*************************************************************************/
223 
224 /*************************************************************************/
241 
242 /*************************************************************************/
259 
260 /*************************************************************************/
277 
278 /*************************************************************************/
295 
296 /*************************************************************************/
313 
314 /*************************************************************************/
330 open_error_t openapiDoSICMPSizeSet(openapiClientHandle_t *client_handle, uint32_t maxICMPSize);
331 
332 /*************************************************************************/
348 open_error_t openapiDoSICMPv6SizeSet(openapiClientHandle_t *client_handle, uint32_t maxICMPv6Size);
349 
350 /*************************************************************************/
367 
368 /*************************************************************************/
384 
385 /*************************************************************************/
401 
402 /*************************************************************************/
418 
419 /*************************************************************************/
435 
436 /*************************************************************************/
451 open_error_t openapiDoSFirstFragSizeGet(openapiClientHandle_t *client_handle, uint32_t *pMinTCPHdrSize);
452 
453 /*************************************************************************/
469 
470 /*************************************************************************/
486 
487 /*************************************************************************/
503 
504 /*************************************************************************/
520 
521 /*************************************************************************/
537 
538 /*************************************************************************/
554 
555 /*************************************************************************/
571 
572 /*************************************************************************/
588 
589 /*************************************************************************/
605 
606 /*************************************************************************/
622 
623 /*************************************************************************/
639 
640 /*************************************************************************/
655 open_error_t openapiDoSICMPSizeGet(openapiClientHandle_t *client_handle, uint32_t *pMaxICMPSize);
656 
657 /*************************************************************************/
675 open_error_t openapiDoSIntfPingFloodingModeSet(openapiClientHandle_t *client_handle, uint32_t interface, OPEN_CONTROL_t mode, uint32_t param);
676 
677 /*************************************************************************/
694 open_error_t openapiDoSIntfPingFloodingModeGet(openapiClientHandle_t *client_handle, uint32_t interface, OPEN_CONTROL_t *pMode, uint32_t *pParam);
695 
696 /*************************************************************************/
714 
715 /*************************************************************************/
731 open_error_t openapiDoSIntfSmurfAttackModeGet(openapiClientHandle_t *client_handle, uint32_t interface, OPEN_CONTROL_t *pMode);
732 
733 /*************************************************************************/
750 open_error_t openapiDoSIntfSynAckFloodingModeGet(openapiClientHandle_t *client_handle, uint32_t interface, OPEN_CONTROL_t *pMode, uint32_t *pParam);
751 
752 /*************************************************************************/
770 
771 /*************************************************************************/
788 
789 /*************************************************************************/
806 
807 /*************************************************************************/
823 
824 /*************************************************************************/
842 
843 /*************************************************************************/
860 
861 /*************************************************************************/
876 open_error_t openapiDoSICMPv4SizeGet(openapiClientHandle_t *client_handle, uint32_t *pMaxICMPSize);
877 
878 /*************************************************************************/
893 open_error_t openapiDoSICMPv6SizeGet(openapiClientHandle_t *client_handle, uint32_t *pMaxICMPSize);
894 
895 /*************************************************************************/
911 
912 /*************************************************************************/
928 
929 /*************************************************************************/
946 
947 /*************************************************************************/
963 
964 /*************************************************************************/
981 
982 /*************************************************************************/
998 
999 /*************************************************************************/
1016 
1017 /*************************************************************************/
1033 
1034 /*************************************************************************/
1051 
1052 #endif /* OPENAPI_DOS_H_INCLUDED */
1053 
open_error_t openapiDoSIntfPingFloodingModeSet(openapiClientHandle_t *client_handle, uint32_t interface, OPEN_CONTROL_t mode, uint32_t param)
Sets ping flooding denial of service protection on an interface.
open_error_t openapiDoSICMPSizeSet(openapiClientHandle_t *client_handle, uint32_t maxICMPSize)
Sets maximum ICMP size denial of service protection.
open_error_t openapiDoSL4PortModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets L4 Port denial of service protection.
open_error_t openapiDoSUDPPortModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets UDP port denial of service protection mode.
open_error_t openapiDoSGlobalPingFloodingModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode, uint32_t *pParam)
Gets ping flooding denial of service protection mode.
open_error_t openapiDoSICMPv6ModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets ICMPv6 denial of service protection mode.
open_error_t openapiDoSSMACDMACModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets source MAC address=destination MAC address (SMAC=DMAC) denial of service protection mode...
open_error_t openapiDoSGlobalSmurfAttackModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets preventing Smurf denial of service protection.
open_error_t openapiDoSICMPModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets ICMP denial of service protection mode.
open_error_t openapiDoSTCPOffsetModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets TCP Offset denial of service protection mode.
open_error_t openapiDoSSIPDIPModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets source IP address=destination IP address (SIP=DIP) denial of service protection.
open_error_t openapiDoSSMACDMACModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets source MAC address=destination MAC address (SMAC=DMAC) denial of service protection.
open_error_t openapiDoSSIPDIPModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets source IP address=destination IP address (SIP=DIP) denial of service protection mode...
open_error_t openapiDoSTCPSynModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets TCP SYN denial of service protection.
open_error_t openapiDoSTCPPortModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets TCP port denial of service protection.
open_error_t openapiDoSICMPSizeGet(openapiClientHandle_t *client_handle, uint32_t *pMaxICMPSize)
Gets denial of service protection maximum ICMP size.
open_error_t
OPEN uses these enumerators to indicate the error codes.
open_error_t openapiDoSICMPv6SizeGet(openapiClientHandle_t *client_handle, uint32_t *pMaxICMPSize)
Gets denial of service protection Maximum ICMPv6 payload size.
open_error_t openapiDoSGlobalSynAckFloodingModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode, uint32_t param)
Sets preventing SynAck Flooding denial of service protection.
open_error_t openapiDoSTCPSynFinModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets TCP SYN and FIN denial of service protection.
open_error_t openapiDoSPortDdisableModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets port D-disable for denial of service protection.
open_error_t openapiDoSVlan0TaggedSnapDropModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets Vlan0 Tagged and SNAP Drop denial of service protection.
open_error_t openapiDoSGlobalSynAckFloodingModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode, uint32_t *pParam)
Gets preventing SynAck Flooding denial of service protection mode.
open_error_t openapiDoSICMPModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets ICMP denial of service protection.
open_error_t openapiDoSTCPOffsetModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets TCP offset denial of service protection.
open_error_t openapiDoSTCPSynFinModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets TCP SYN and FIN denial of service protection mode.
open_error_t openapiDoSPortDdisableModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets port D-disable state for denial of service protection.
open_error_t openapiDoSFirstFragModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets first fragment denial of service protection mode.
open_error_t openapiDoSICMPv6SizeSet(openapiClientHandle_t *client_handle, uint32_t maxICMPv6Size)
Sets maximum ICMPv6 size denial of service protection.
open_error_t openapiDoSICMPv4SizeGet(openapiClientHandle_t *client_handle, uint32_t *pMaxICMPSize)
Gets denial of service protection Maximum ICMPv4 payload size.
open_error_t openapiDoSTCPFinUrgPshModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets TCP FIN,URG and PSH denial of service protection mode.
open_error_t openapiDoSTCPFlagModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets TCP flag denial of service protection.
open_error_t openapiDoSFirstFragSizeGet(openapiClientHandle_t *client_handle, uint32_t *pMinTCPHdrSize)
Gets denial of service protection Minimum TCP Header Size.
open_error_t openapiDoSICMPFragModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets ICMP Fragment denial of service protection.
open_error_t openapiDoSTCPFlagSeqModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets TCP flag and sequence denial of service protection.
open_error_t openapiDoSIntfSynAckFloodingModeGet(openapiClientHandle_t *client_handle, uint32_t interface, OPEN_CONTROL_t *pMode, uint32_t *pParam)
Gets SynAck Flooding denial of service protection mode on an interface.
open_error_t openapiDoSUDPPortModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets UDP port denial of service protection.
open_error_t openapiDoSTCPPartialModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets TCP Partial denial of service protection mode.
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
open_error_t openapiDoSAutoModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets Auto denial of service protection.
open_error_t openapiDoSFirstFragSizeSet(openapiClientHandle_t *client_handle, uint32_t minTCPHdrSize)
Sets minimum TCP header size denial of service protection.
open_error_t openapiDoSAutoModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets Auto denial of service protection mode.
open_error_t openapiDoSTCPPortModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets TCP port denial of service protection mode.
open_error_t openapiDoSVlan0TaggedSnapDropModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets Vlan0 Tagged and SNAP Drop denial of service protection mode.
open_error_t openapiDoSTCPSynModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets TCP SYN denial of service protection mode.
open_error_t openapiDoSGlobalPingFloodingModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode, uint32_t param)
Sets ping flooding denial of service protection.
open_error_t openapiDoSTCPFlagModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets TCP flag denial of service protection mode.
open_error_t openapiDoSFirstFragModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets first fragment denial of service protection.
open_error_t openapiDoSIntfPingFloodingModeGet(openapiClientHandle_t *client_handle, uint32_t interface, OPEN_CONTROL_t *pMode, uint32_t *pParam)
Gets ping flooding denial of service protection mode on an interface.
open_error_t openapiDoSICMPv6ModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets ICMPv6 denial of service protection.
open_error_t openapiDoSIntfSmurfAttackModeGet(openapiClientHandle_t *client_handle, uint32_t interface, OPEN_CONTROL_t *pMode)
Gets Smurf denial of service protection mode on an interface.
open_error_t openapiDoSIntfSmurfAttackModeSet(openapiClientHandle_t *client_handle, uint32_t interface, OPEN_CONTROL_t mode)
Sets preventing Smurf denial of service protection on an interface.
open_error_t openapiDoSGlobalSmurfAttackModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets Smurf denial of service protection mode.
open_error_t openapiDoSICMPFragModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets ICMP Fragment denial of service protection mode.
open_error_t openapiDoSTCPFragModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets TCP Fragment denial of service protection mode.
open_error_t openapiDoSTCPFlagSeqModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets TCP flag and sequence denial of service protection mode.
open_error_t openapiDoSL4PortModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
Gets L4 Port denial of service protection mode.
open_error_t openapiDoSTCPFinUrgPshModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets TCP FIN,URG and PSH denial of service protection.
open_error_t openapiDoSTCPFragModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets TCP fragment denial of service protection.