go-sophos: Sophos UTM REST API 客户端库

go-sophos 是一个用于与 Sophos UTM (Unified Threat Management) 设备 REST API 交互的 Go 语言客户端库。它提供了简单易用的接口来管理 Sophos UTM 设备。

基本用法

安装

go get github.com/esurdam/go-sophos

初始化客户端

package main

import (
	"context"
	"fmt"
	"log"

	"github.com/esurdam/go-sophos"
)

func main() {
	// 创建客户端配置
	config := sophos.ClientConfig{
		Endpoint:   "https://your-utm-ip:4444", // UTM管理地址
		Username:   "admin",                    // 管理员用户名
		Password:   "your-password",            // 管理员密码
		SkipVerify: true,                       // 如果使用自签名证书，可以跳过验证
	}

	// 创建客户端
	client, err := sophos.NewClient(config)
	if err != nil {
		log.Fatalf("创建客户端失败: %v", err)
	}

	// 测试连接
	ctx := context.Background()
	version, err := client.GetVersion(ctx)
	if err != nil {
		log.Fatalf("获取版本信息失败: %v", err)
	}
	fmt.Printf("Sophos UTM 版本: %s\n", version.Version)
}

常用功能示例

1. 获取防火墙规则

func listFirewallRules(client *sophos.Client) {
	rules, err := client.GetFirewallRules(context.Background())
	if err != nil {
		log.Fatalf("获取防火墙规则失败: %v", err)
	}

	fmt.Println("防火墙规则列表:")
	for _, rule := range rules {
		fmt.Printf("ID: %s, 名称: %s, 动作: %s, 源: %s, 目标: %s\n",
			rule.ID, rule.Name, rule.Action, rule.Source, rule.Destination)
	}
}

2. 创建新的防火墙规则

func createFirewallRule(client *sophos.Client) {
	newRule := sophos.FirewallRule{
		Name:        "Allow HTTP from LAN",
		Action:      "accept",
		Source:      []string{"LAN"},
		Destination: []string{"Any"},
		Service:     []string{"HTTP"},
		Comment:     "允许LAN访问HTTP",
		Status:      true,
	}

	createdRule, err := client.CreateFirewallRule(context.Background(), newRule)
	if err != nil {
		log.Fatalf("创建防火墙规则失败: %v", err)
	}

	fmt.Printf("成功创建规则: ID=%s, 名称=%s\n", createdRule.ID, createdRule.Name)
}

3. 获取网络接口信息

func listInterfaces(client *sophos.Client) {
	interfaces, err := client.GetInterfaces(context.Background())
	if err != nil {
		log.Fatalf("获取接口信息失败: %v", err)
	}

	fmt.Println("网络接口列表:")
	for _, iface := range interfaces {
		fmt.Printf("名称: %s, IP: %s, 状态: %s\n", 
			iface.Name, iface.Address, iface.Status)
	}
}

4. 更新对象

func updateHostObject(client *sophos.Client) {
	// 首先获取现有对象
	host, err := client.GetHostObject(context.Background(), "example-host")
	if err != nil {
		log.Fatalf("获取主机对象失败: %v", err)
	}

	// 修改属性
	host.Address = "192.168.1.100"
	host.Comment = "更新后的服务器IP"

	// 提交更新
	updatedHost, err := client.UpdateHostObject(context.Background(), host.Name, *host)
	if err != nil {
		log.Fatalf("更新主机对象失败: %v", err)
	}

	fmt.Printf("成功更新主机: %s (%s)\n", updatedHost.Name, updatedHost.Address)
}

高级用法

批量操作

func batchOperations(client *sophos.Client) {
	// 创建批量操作请求
	batch := sophos.NewBatchRequest()
	
	// 添加多个操作
	batch.AddGet("/api/objects/network/host/example-host")
	batch.AddGet("/api/objects/network/network/LAN")
	batch.AddGet("/api/objects/service/http/HTTP")
	
	// 执行批量请求
	results, err := client.Batch(context.Background(), batch)
	if err != nil {
		log.Fatalf("批量操作失败: %v", err)
	}
	
	// 处理结果
	for i, res := range results {
		if res.Error != nil {
			fmt.Printf("操作 %d 失败: %v\n", i, res.Error)
		} else {
			fmt.Printf("操作 %d 成功\n", i)
		}
	}
}

监听事件

func listenEvents(client *sophos.Client) {
	// 创建事件监听器
	listener, err := client.NewEventListener(context.Background())
	if err != nil {
		log.Fatalf("创建事件监听器失败: %v", err)
	}
	defer listener.Close()

	fmt.Println("开始监听事件...")
	for event := range listener.Events {
		fmt.Printf("收到事件: 类型=%s, 消息=%s\n", event.Type, event.Message)
	}
}

错误处理

func handleErrors(client *sophos.Client) {
	_, err := client.GetHostObject(context.Background(), "non-existent-host")
	if err != nil {
		if sophosErr, ok := err.(*sophos.Error); ok {
			// 处理API返回的错误
			fmt.Printf("API错误: 状态码=%d, 消息=%s\n", 
				sophosErr.StatusCode, sophosErr.Message)
		} else {
			// 处理其他类型的错误
			fmt.Printf("其他错误: %v\n", err)
		}
		return
	}
}

注意事项

1. 安全性: 在生产环境中，建议使用证书验证而不是跳过验证(SkipVerify)
2. 性能: 批量操作可以显著减少API调用次数
3. 错误处理: 总是检查错误并适当处理
4. 并发: 客户端是线程安全的，可以在多个goroutine中使用
5. API限制: Sophos UTM API可能有速率限制，注意不要过度调用

go-sophos 库提供了对 Sophos UTM 大多数功能的访问，包括防火墙规则、网络对象、用户管理、VPN配置等。完整的API文档可以参考库的GitHub页面和Sophos UTM官方REST API文档。