CFW服务

概述

本文档主要介绍CFW GO SDK的使用。在使用本文档前，您需要先了解CFW的一些基本知识，并已开通了CFW服务。若您还不了解CFW，可以参考产品描述和操作指南。

初始化

确认Endpoint

云防火墙 API 的服务域名为：cfw.baidubce.com

API支持HTTP和HTTPS两种调用方式。为了提升数据的安全性，建议通过HTTPS调用。

获取密钥

要使用百度云CFW，您需要拥有一个有效的AK(Access Key ID)和SK(Secret Access Key)用来进行签名认证。AK/SK是由系统分配给用户的，均为字符串，用于标识用户，为访问CFW做签名验证。

可以通过如下步骤获得并了解您的AK/SK信息：

注册百度云账号

创建AK/SK

新建CFW Client

CFW Client是CFW服务的客户端，为开发者与CFW服务进行交互提供了一系列的方法。

使用AK/SK新建CFW Client

通过AK/SK方式访问CFW，用户可以参考如下代码新建一个CFW Client：

import (
	"github.com/baidubce/bce-sdk-go/services/cfw"
)

func main() {
	// 用户的Access Key ID和Secret Access Key
	ACCESS_KEY_ID, SECRET_ACCESS_KEY := <your-access-key-id>, <your-secret-access-key>
	
	// 用户指定的Endpoint
	ENDPOINT := <domain-name>

	// 初始化一个CFWClient
	cfwClient, err := cfw.NewClient(AK, SK, ENDPOINT)
}

在上面代码中，ACCESS_KEY_ID对应控制台中的“Access Key ID”，SECRET_ACCESS_KEY对应控制台中的“Access Key Secret”，获取方式请参考《操作指南如何获取AKSK》。第三个参数ENDPOINT支持用户自己指定域名，如果设置为空字符串，会使用默认域名作为CFW的服务地址。

使用STS创建CFW Client

申请STS token

CFW可以通过STS机制实现第三方的临时授权访问。STS（Security Token Service）是百度云提供的临时授权服务。通过STS，您可以为第三方用户颁发一个自定义时效和权限的访问凭证。第三方用户可以使用该访问凭证直接调用百度云的API或SDK访问百度云资源。

通过STS方式访问CFW，用户需要先通过STS的client申请一个认证字符串。

用STS token新建CFW Client

申请好STS后，可将STS Token配置到CFW Client中，从而实现通过STS Token创建CFW Client。

代码示例

GO SDK实现了STS服务的接口，用户可以参考如下完整代码，实现申请STS Token和创建CFW Client对象：

import (
	"fmt"

	"github.com/baidubce/bce-sdk-go/auth"         //导入认证模块
	"github.com/baidubce/bce-sdk-go/services/cfw" //导入CFW服务模块
	"github.com/baidubce/bce-sdk-go/services/sts" //导入STS服务模块
)

func main() {
	// 创建STS服务的Client对象，Endpoint使用默认值
	AK, SK := <your-access-key-id>, <your-secret-access-key>
	stsClient, err := sts.NewClient(AK, SK)
	if err != nil {
		fmt.Println("create sts client object :", err)
		return
	}

	// 获取临时认证token，有效期为60秒，ACL为空
	stsObj, err := stsClient.GetSessionToken(60, "")
	if err != nil {
		fmt.Println("get session token failed:", err)
		return
    }
	fmt.Println("GetSessionToken result:")
	fmt.Println("  accessKeyId:", stsObj.AccessKeyId)
	fmt.Println("  secretAccessKey:", stsObj.SecretAccessKey)
	fmt.Println("  sessionToken:", stsObj.SessionToken)
	fmt.Println("  createTime:", stsObj.CreateTime)
	fmt.Println("  expiration:", stsObj.Expiration)
	fmt.Println("  userId:", stsObj.UserId)

	// 使用申请的临时STS创建CFW服务的Client对象，Endpoint使用默认值
	cfwClient, err := cfw.NewClient(stsObj.AccessKeyId, stsObj.SecretAccessKey, "cfw.baidubce.com")
	if err != nil {
		fmt.Println("create cfw client failed:", err)
		return
	}
	stsCredential, err := auth.NewSessionBceCredentials(
		stsObj.AccessKeyId,
		stsObj.SecretAccessKey,
		stsObj.SessionToken)
	if err != nil {
		fmt.Println("create sts credential object failed:", err)
		return
	}
	cfwClient.Config.Credentials = stsCredential
}

注意：目前使用STS配置CFW Client时，STS的Endpoint需配置为http://sts.bj.baidubce.com。

配置HTTPS协议访问CFW

CFW支持HTTPS传输协议，您可以通过在创建CFW Client对象时指定的Endpoint中指明HTTPS的方式，在CFW GO SDK中使用HTTPS访问CFW服务：

// import "github.com/baidubce/bce-sdk-go/services/cfw"

ENDPOINT := "https://cfw.baidubce.com	" //指明使用HTTPS协议
AK, SK := <your-access-key-id>, <your-secret-access-key>
cfwClient, _ := cfw.NewClient(AK, SK, ENDPOINT)

配置CFW Client

如果用户需要配置CFW Client的一些细节的参数，可以在创建CFW Client对象之后，使用该对象的导出字段Config进行自定义配置，可以为客户端配置代理，最大连接数等参数。

使用代理

下面一段代码可以让客户端使用代理访问CFW服务：

// import "github.com/baidubce/bce-sdk-go/services/cfw"

//创建CFW Client对象
AK, SK := <your-access-key-id>, <your-secret-access-key>
ENDPOINT := "cfw.baidubce.com"
client, _ := cfw.NewClient(AK, SK, ENDPOINT)

//代理使用本地的8080端口
client.Config.ProxyUrl = "127.0.0.1:8080"

设置网络参数

用户可以通过如下的示例代码进行网络参数的设置：

// import "github.com/baidubce/bce-sdk-go/services/cfw"

AK, SK := <your-access-key-id>, <your-secret-access-key>
ENDPOINT := "cfw.baidubce.com"
client, _ := cfw.NewClient(AK, SK, ENDPOINT)

// 配置不进行重试，默认为Back Off重试
client.Config.Retry = bce.NewNoRetryPolicy()

// 配置连接超时时间为30秒
client.Config.ConnectionTimeoutInMillis = 30 * 1000

配置生成签名字符串选项

// import "github.com/baidubce/bce-sdk-go/services/cfw"

AK, SK := <your-access-key-id>, <your-secret-access-key>
ENDPOINT := "cfw.baidubce.com"
client, _ := cfw.NewClient(AK, SK, ENDPOINT)

// 配置签名使用的HTTP请求头为`Host`
headersToSign := map[string]struct{}{"Host": struct{}{}}
client.Config.SignOption.HeadersToSign = HeadersToSign

// 配置签名的有效期为30秒
client.Config.SignOption.ExpireSeconds = 30

参数说明

用户使用GO SDK访问CFW时，创建的CFW Client对象的Config字段支持的所有参数如下表所示：

配置项名称	类型	含义
Endpoint	string	请求服务的域名
ProxyUrl	string	客户端请求的代理地址
Region	string	请求资源的区域
UserAgent	string	用户名称，HTTP请求的User-Agent头
Credentials	*auth.BceCredentials	请求的鉴权对象，分为普通AK/SK与STS两种
SignOption	*auth.SignOptions	认证字符串签名选项
Retry	RetryPolicy	连接重试策略
ConnectionTimeoutInMillis	int	连接超时时间，单位毫秒，默认20分钟

说明：

Credentials字段使用auth.NewBceCredentials与auth.NewSessionBceCredentials函数创建，默认使用前者，后者为使用STS鉴权时使用，详见“使用STS创建CFW Client”小节。
SignOption字段为生成签名字符串时的选项，详见下表说明：

名称	类型	含义
HeadersToSign	map[string]struct{}	生成签名字符串时使用的HTTP头
Timestamp	int64	生成的签名字符串中使用的时间戳，默认使用请求发送时的值
ExpireSeconds	int	签名字符串的有效期

 其中，HeadersToSign默认为`Host`，`Content-Type`，`Content-Length`，`Content-MD5`；TimeStamp一般为零值，表示使用调用生成认证字符串时的时间戳，用户一般不应该明确指定该字段的值；ExpireSeconds默认为1800秒即30分钟。

Retry字段指定重试策略，目前支持两种：NoRetryPolicy和BackOffRetryPolicy。默认使用后者，该重试策略是指定最大重试次数、最长重试时间和重试基数，按照重试基数乘以2的指数级增长的方式进行重试，直到达到最大重试测试或者最长重试时间为止。

创建CFW策略

args := &CreateCfwRequest{
		Name:     "hzb_1",
		Description: "desc",
		CfwRules:  []CreateRule{
			{
				IpVersion: 4,
				Priority: 4,
				Protocol: "TCP",
				Direction: "in",
				SourceAddress: "192.168.0.4",
				DestAddress: "192.168.0.5",
				SourcePort: "80",
				DestPort: "88",
				Action: "allow",
			},
		},
	}
result, err := CfwClient.CreateCfw(args)
ExpectEqual(t.Errorf, nil, err)
CfwId := result.CfwId
log.Debug(CfwId)

查询CFW策略列表

args := &ListCfwArgs{
    Marker: "cfw-ius2qz1btkvm",
}
result, err := CfwClient.ListCfw(args)
ExpectEqual(t.Errorf, nil, err)
r, err := json.Marshal(result)
log.Debug(string(r))

查询指定CFW策略

result, err := CfwClient.GetCfw("cfw-ius2qz1btkvm")
ExpectEqual(t.Errorf, nil, err)
r, err := json.Marshal(result)
log.Debug(string(r))

修改指定CFW策略

args := &UpdateCfwRequest{
    Name: "hzb_1_1",
    Description: "test",
}
err := CfwClient.UpdateCfw("cfw-ius2qz1btkvm", args)
ExpectEqual(t.Errorf, nil, err)

删除指定CFW策略

err := CfwClient.DeleteCfw("cfw-g0hs3v1scskq")
ExpectEqual(t.Errorf, nil, err)

批量创建CFW规则

args := &CreateCfwRuleRequest{
    CfwRules: []CreateRule{
        {
            IpVersion: 4,
            Priority: 5,
            Protocol: "TCP",
            Direction: "in",
            SourceAddress: "192.168.0.3",
            DestAddress: "192.168.0.4",
            SourcePort: "80",
            DestPort: "88",
            Action: "allow",
        },
    },
}
err := CfwClient.CreateCfwRule("cfw-ius2qz1btkvm", args)
ExpectEqual(t.Errorf, nil, err)

修改指定CFW规则

args := &UpdateCfwRuleRequest{
        IpVersion: 4,
        Priority: 2,
        Protocol: "TCP",
        Direction: "in",
        SourceAddress: "192.168.0.1",
        DestAddress: "192.168.0.2",
        SourcePort: "80",
        DestPort: "88",
        Action: "allow",
}
err := CfwClient.UpdateCfwRule("cfw-ius2qz1btkvm", "cfwr-9rjvf28r48s3", args)
ExpectEqual(t.Errorf, nil, err)

批量删除CFW规则

args := &DeleteCfwRuleRequest{
    CfwRuleIds: []string{
        "cfwr-9rjvf28r48s3",
    },
}
err := CfwClient.DeleteCfwRule("cfw-ius2qz1btkvm", args)
ExpectEqual(t.Errorf, nil, err)

防护边界实例列表

args := &ListInstanceRequest{
    InstanceType: "eip",
    MaxKeys: 2,
    Marker: "ip-46d82b8b",
}
result, err := CfwClient.ListInstance(args)
ExpectEqual(t.Errorf, nil, err)
r, err := json.Marshal(result)
log.Debug(string(r))

批量实例绑定CFW

args := &BindCfwRequest{
    InstanceType: "eip",
    Instances: []CfwBind{
        {
            Region: "bj",
            InstanceId: "ip-06583aaf",
        },
        {
            Region: "bj",
            InstanceId: "ip-0ad38b01",
        },
    },
}
err := CfwClient.BindCfw("cfw-ius2qz1btkvm", args)
ExpectEqual(t.Errorf, nil, err)

批量实例解绑CFW

args := &UnbindCfwRequest{
    InstanceType: "eip",
    Instances: []CfwBind{
        {
            Region: "bj",
            InstanceId: "ip-06583aaf",
        },
        {
            Region: "bj",
            InstanceId: "ip-0ad38b01",
        },
    },
}
err := CfwClient.UnbindCfw("cfw-ius2qz1btkvm", args)
ExpectEqual(t.Errorf, nil, err)

实例开启CFW保护

args := &EnableCfwRequest{
    InstanceId: "ip-0ad38b01",
}
err := CfwClient.EnableCfw("cfw-ius2qz1btkvm", args)
ExpectEqual(t.Errorf, nil, err)

实例关闭CFW保护

args := &DisableCfwRequest{
    InstanceId: "ip-0ad38b01",
}
err := CfwClient.DisableCfw("cfw-ius2qz1btkvm", args)
ExpectEqual(t.Errorf, nil, err)

错误处理

GO语言以error类型标识错误，CFW支持两种错误见下表：

错误类型	说明
BceClientError	用户操作产生的错误
BceServiceError	CFW服务返回的错误

用户使用SDK调用CFW相关接口，除了返回所需的结果之外还会返回错误，用户可以获取相关错误进行处理。实例如下：

args := &ListInstanceRequest{
    InstanceType: "eip",
}
result, err := CfwClient.ListInstance(args)
if err != nil {
	switch realErr := err.(type) {
	case *bce.BceClientError:
		fmt.Println("client occurs error:", realErr.Error())
	case *bce.BceServiceError:
		fmt.Println("service occurs error:", realErr.Error())
	default:
		fmt.Println("unknown error:", err)
	}
}

客户端异常

客户端异常表示客户端尝试向CFW发送请求以及数据传输时遇到的异常。例如，当发送请求时网络连接不可用时，则会返回BceClientError。

服务端异常

当CFW服务端出现异常时，CFW服务端会返回给用户相应的错误信息，以便定位问题。常见服务端异常可参见CFW错误码

SDK日志

CFW GO SDK支持六个级别、三种输出（标准输出、标准错误、文件）、基本格式设置的日志模块，导入路径为github.com/baidubce/bce-sdk-go/util/log。输出为文件时支持设置五种日志滚动方式（不滚动、按天、按小时、按分钟、按大小），此时还需设置输出日志文件的目录。

默认日志

CFW GO SDK自身使用包级别的全局日志对象，该对象默认情况下不记录日志，如果需要输出SDK相关日志需要用户自定指定输出方式和级别，详见如下示例：

// import "github.com/baidubce/bce-sdk-go/util/log"

// 指定输出到标准错误，输出INFO及以上级别
log.SetLogHandler(log.STDERR)
log.SetLogLevel(log.INFO)

// 指定输出到标准错误和文件，DEBUG及以上级别，以1GB文件大小进行滚动
log.SetLogHandler(log.STDERR | log.FILE)
log.SetLogDir("/tmp/gosdk-log")
log.SetRotateType(log.ROTATE_SIZE)
log.SetRotateSize(1 << 30)

// 输出到标准输出，仅输出级别和日志消息
log.SetLogHandler(log.STDOUT)
log.SetLogFormat([]string{log.FMT_LEVEL, log.FMT_MSG})

说明：

日志默认输出级别为DEBUG
如果设置为输出到文件，默认日志输出目录为/tmp，默认按小时滚动
如果设置为输出到文件且按大小滚动，默认滚动大小为1GB
默认的日志输出格式为：FMT_LEVEL, FMT_LTIME, FMT_LOCATION, FMT_MSG

项目使用

该日志模块无任何外部依赖，用户使用GO SDK开发项目，可以直接引用该日志模块自行在项目中使用，用户可以继续使用GO SDK使用的包级别的日志对象，也可创建新的日志对象，详见如下示例：

// 直接使用包级别全局日志对象（会和GO SDK自身日志一并输出）
log.SetLogHandler(log.STDERR)
log.Debugf("%s", "logging message using the log package in the CFW go sdk")

// 创建新的日志对象（依据自定义设置输出日志，与GO SDK日志输出分离）
myLogger := log.NewLogger()
myLogger.SetLogHandler(log.FILE)
myLogger.SetLogDir("/home/log")
myLogger.SetRotateType(log.ROTATE_SIZE)
myLogger.Info("this is my own logger from the CFW go sdk")

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CFW.md

CFW.md

CFW服务

概述

初始化

确认Endpoint

获取密钥

新建CFW Client

使用AK/SK新建CFW Client

使用STS创建CFW Client

配置HTTPS协议访问CFW

配置CFW Client

使用代理

设置网络参数

配置生成签名字符串选项

创建CFW策略

查询CFW策略列表

查询指定CFW策略

修改指定CFW策略

删除指定CFW策略

批量创建CFW规则

修改指定CFW规则

批量删除CFW规则

防护边界实例列表

批量实例绑定CFW

批量实例解绑CFW

实例开启CFW保护

实例关闭CFW保护

错误处理

客户端异常

服务端异常

SDK日志

默认日志

项目使用

Files

CFW.md

Latest commit

History

CFW.md

File metadata and controls

CFW服务

概述

初始化

确认Endpoint

获取密钥

新建CFW Client

使用AK/SK新建CFW Client

使用STS创建CFW Client

配置HTTPS协议访问CFW

配置CFW Client

使用代理

设置网络参数

配置生成签名字符串选项

创建CFW策略

查询CFW策略列表

查询指定CFW策略

修改指定CFW策略

删除指定CFW策略

批量创建CFW规则

修改指定CFW规则

批量删除CFW规则

防护边界实例列表

批量实例绑定CFW

批量实例解绑CFW

实例开启CFW保护

实例关闭CFW保护

错误处理

客户端异常

服务端异常

SDK日志

默认日志

项目使用