文档首页> Web应用防火墙 WAF> API参考> API> 策略规则管理> 创建全局白名单(原误报屏蔽)规则
更新时间:2024-03-22 GMT+08:00
分享

创建全局白名单(原误报屏蔽)规则

功能介绍

创建全局白名单(原误报屏蔽)规则

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/waf/policy/{policy_id}/ignore

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID

policy_id

String

防护策略id,您可以通过调用查询防护策略列表(ListPolicy)获取策略id

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

内容类型

缺省值:application/json;charset=utf8

表4 请求Body参数

参数

是否必选

参数类型

描述

domain

Array of strings

防护域名或防护网站,数组长度为0时,代表规则对全部域名或防护网站生效

conditions

Array of CreateCondition objects

条件列表

mode

Integer

固定值为1,代表v2版本误报屏蔽规则,v1版本仅用于兼容旧版本,不支持创建

rule

String

需要屏蔽的规则,可屏蔽一个或者多个,屏蔽多个时使用半角符;分隔

  • 当需要屏蔽某一条内置规则时,该参数值为该内置规则id,可以在Web应用防火墙控制台的防护策略->策略名称->Web基础防护的高级设置->防护规则中查询;也可以在防护事件的事件详情中查询内置规则id

  • 当需要屏蔽web基础防护某一类规则时,该参数值为需要屏蔽的web基础防护某一类规则名。其中,xss:xxs攻击;webshell:网站木马;vuln:其他类型攻击;sqli:sql注入攻击;robot:恶意爬虫;rfi:远程文件包含;lfi:本地文件包含;cmdi:命令注入攻击

  • 当需要屏蔽Web基础防护模块,该参数值为:all

  • 当需要屏蔽规则为所有检测模块时,该参数值为:bypass

advanced

Array of Advanced objects

高级配置项。当前该参数类型错误,请用户忽略该参数;正确类型可先参考更新接口,后续将改正。

description

String

屏蔽规则描述

表5 CreateCondition

参数

是否必选

参数类型

描述

category

String

字段类型,可选值有ip、url、params、cookie、header

contents

Array of strings

内容,数组长度限制为1,内容格式根据字段类型变化,例如,字段类型为ip时,contents内容格式需为ip地址或ip地址段;字段类型为url时,contents内容格式需为标准url格式;字段类型为params,cookie,header时,内容的格式不做限制

logic_operation

String

匹配逻辑,匹配逻辑根据字段类型变化,字段类型为ip时,匹配逻辑支持(equal:等于,not_equal:不等于),字段类型为url、header、params、cookie时,匹配逻辑支持(equal:等于,not_equal:不等于,contain:包含,not_contain:不包含,prefix:前缀为,not_prefix:前缀不为,suffix:后缀为,not_suffix:后缀不为)

check_all_indexes_logic

Integer

该参数为预留参数,可忽略。

index

String

字段类型为ip且子字段为客户端ip时,不需要传index参数;子字段类型为X-Forwarded-For时,值为x-forwarded-for;字段类型为params、header、cookie并且子字段为自定义时,index的值为自定义子字段

表6 Advanced

参数

是否必选

参数类型

描述

index

String

字段类型,支持的字段类型有:params、cookie、header、body、multipart。

  • 当选择“params”、“cookie”或者“header”字段时,可以配置“全部”或根据需求配置子字段

  • 当选择“body”或“multipart”字段时,可以配置“全部”

contensts

Array of strings

指定字段类型的子字段,默认值为“全部”

响应参数

状态码: 200

表7 响应Body参数

参数

参数类型

描述

id

String

规则id

policyid

String

策略id

timestamp

Long

创建规则的时间戳

description

String

规则描述

status

Integer

规则状态,0:关闭,1:开启

rule

String

需要屏蔽的规则,可屏蔽一个或者多个,屏蔽多个时使用半角符;分隔

  • 当需要屏蔽某一条内置规则时,该参数值为该内置规则id,可以在Web应用防火墙控制台的防护策略->策略名称->Web基础防护的高级设置->防护规则中查询;也可以在防护事件的事件详情中查询内置规则id

  • 当需要屏蔽web基础防护某一类规则时,该参数值为需要屏蔽的web基础防护某一类规则名。其中,xss:xxs攻击;webshell:网站木马;vuln:其他类型攻击;sqli:sql注入攻击;robot:恶意爬虫;rfi:远程文件包含;lfi:本地文件包含;cmdi:命令注入攻击

  • 当需要屏蔽Web基础防护模块,该参数值为:all

  • 当需要屏蔽规则为所有检测模块时,该参数值为:bypass

mode

Integer

版本号固定值为1,代表v2版本误报屏蔽规则,v1版本仅支持兼容旧版本,不支持创建

conditions

Array of Condition objects

条件列表

advanced

Array of Advanced objects

高级配置项。当前该参数类型错误,请用户忽略该参数;正确类型可先参考更新接口,后续将改正。

domain

Array of strings

防护域名或防护网站

表8 Condition

参数

参数类型

描述

category

String

字段类型,可选值有ip、url、params、cookie、header

contents

Array of strings

内容,数组长度限制为1,内容格式根据字段类型变化,例如,字段类型为ip时,contents内容格式需为ip地址或ip地址段;字段类型为url时,contents内容格式需为标准url格式;字段类型为params、cookie、header时,内容的格式不做限制

logic_operation

String

匹配逻辑,匹配逻辑根据字段类型变化,字段类型为ip时,匹配逻辑支持(equal:等于,not_equal:不等于),字段类型为url、header、params、cookie时,匹配逻辑支持(equal:等于,not_equal:不等于,contain:包含,not_contain:不包含,prefix:前缀为,not_prefix:前缀不为,suffix:后缀为,not_suffix:后缀不为)

check_all_indexes_logic

Integer

该参数为预留参数,可忽略。

index

String

字段类型为ip且子字段为客户端ip时,不存在index参数;子字段类型为X-Forwarded-For时,值为x-forwarded-for,字段类型为params、header、cookie并且子字段为自定义时,index的值为自定义子字段

表9 Advanced

参数

参数类型

描述

index

String

字段类型,支持的字段类型有:params、cookie、header、body、multipart。

  • 当选择“params”、“cookie”或者“header”字段时,可以配置“全部”或根据需求配置子字段

  • 当选择“body”或“multipart”字段时,可以配置“全部”

contensts

Array of strings

指定字段类型的子字段,默认值为“全部”

状态码: 400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 401

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

在项目id为project_id和防护策略id为policy_id的防护策略下创建全局白名单(原误报屏蔽)规则。防护域名为we.test.418lab.cn,条件为url中包含”x.x.x.x“,描述为”demo“,需要屏蔽的规则id为091004

POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/ignore?enterprise_project_id=0

{
  "domain" : [ "we.test.418lab.cn" ],
  "conditions" : [ {
    "category" : "url",
    "logic_operation" : "contain",
    "contents" : [ "x.x.x.x" ],
    "index" : null
  } ],
  "mode" : 1,
  "description" : "demo",
  "rule" : "091004"
}

响应示例

状态码: 200

OK

{
  "id" : "a57f20ced01e4e0d8bea8e7c49eea254",
  "policyid" : "f385eceedf7c4c34a4d1def19eafbe85",
  "timestamp" : 1650522310447,
  "description" : "demo",
  "status" : 1,
  "rule" : "091004",
  "mode" : 1,
  "conditions" : [ {
    "category" : "url",
    "contents" : [ "x.x.x.x" ],
    "logic_operation" : "contain"
  } ],
  "domain" : [ "we.test.418lab.cn" ]
}

SDK代码示例

SDK代码示例如下。

在项目id为project_id和防护策略id为policy_id的防护策略下创建全局白名单(原误报屏蔽)规则。防护域名为we.test.418lab.cn,条件为url中包含”x.x.x.x“,描述为”demo“,需要屏蔽的规则id为091004

 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
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateIgnoreRuleSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        WafClient client = WafClient.newBuilder()
                .withCredential(auth)
                .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateIgnoreRuleRequest request = new CreateIgnoreRuleRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        CreateIgnoreRuleRequestBody body = new CreateIgnoreRuleRequestBody();
        List<String> listConditionsContents = new ArrayList<>();
        listConditionsContents.add("x.x.x.x");
        List<CreateCondition> listbodyConditions = new ArrayList<>();
        listbodyConditions.add(
            new CreateCondition()
                .withCategory("url")
                .withContents(listConditionsContents)
                .withLogicOperation("contain")
        );
        List<String> listbodyDomain = new ArrayList<>();
        listbodyDomain.add("we.test.418lab.cn");
        body.withDescription("demo");
        body.withRule("091004");
        body.withMode(1);
        body.withConditions(listbodyConditions);
        body.withDomain(listbodyDomain);
        request.withBody(body);
        try {
            CreateIgnoreRuleResponse response = client.createIgnoreRule(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

在项目id为project_id和防护策略id为policy_id的防护策略下创建全局白名单(原误报屏蔽)规则。防护域名为we.test.418lab.cn,条件为url中包含”x.x.x.x“,描述为”demo“,需要屏蔽的规则id为091004

 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
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = WafClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(WafRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateIgnoreRuleRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        listContentsConditions = [
            "x.x.x.x"
        ]
        listConditionsbody = [
            CreateCondition(
                category="url",
                contents=listContentsConditions,
                logic_operation="contain"
            )
        ]
        listDomainbody = [
            "we.test.418lab.cn"
        ]
        request.body = CreateIgnoreRuleRequestBody(
            description="demo",
            rule="091004",
            mode=1,
            conditions=listConditionsbody,
            domain=listDomainbody
        )
        response = client.create_ignore_rule(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

在项目id为project_id和防护策略id为policy_id的防护策略下创建全局白名单(原误报屏蔽)规则。防护域名为we.test.418lab.cn,条件为url中包含”x.x.x.x“,描述为”demo“,需要屏蔽的规则id为091004

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := waf.NewWafClient(
        waf.WafClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateIgnoreRuleRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	var listContentsConditions = []string{
        "x.x.x.x",
    }
	var listConditionsbody = []model.CreateCondition{
        {
            Category: "url",
            Contents: listContentsConditions,
            LogicOperation: "contain",
        },
    }
	var listDomainbody = []string{
        "we.test.418lab.cn",
    }
	descriptionCreateIgnoreRuleRequestBody:= "demo"
	request.Body = &model.CreateIgnoreRuleRequestBody{
		Description: &descriptionCreateIgnoreRuleRequestBody,
		Rule: "091004",
		Mode: int32(1),
		Conditions: listConditionsbody,
		Domain: listDomainbody,
	}
	response, err := client.CreateIgnoreRule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码

分享:

    相关文档

    相关产品