使用指南

本节提供了实用的示例，演示如何在实际场景中使用 CPE 库。每个示例都包含完整的、可运行的代码和解释。

下面的脑图概览了本指南涵盖的主题：

可用示例

基础用法

• 基础解析 - 解析 CPE 字符串并访问组件
• CPE 匹配 - 比较和匹配 CPE 对象
• WFN 转换 - CPE 和 WFN 格式之间的转换

高级功能

• 版本比较 - 比较版本字符串和范围
• 适用性语言 - 使用 CPE 适用性表达式
• CPE 集合 - 处理 CPE 集合
• 高级匹配 - 使用复杂的匹配算法

集成

• 存储操作 - 使用不同后端持久化 CPE 数据
• NVD 集成 - 下载和使用 NVD 数据
• CVE 映射 - 将 CPE 映射到漏洞

快速开始示例

这是一个简单的示例来帮助你开始：

package main

import (
    "fmt"
    "log"
    "github.com/scagogogo/cpe-skills"
)

func main() {
    // 解析CPE字符串
    cpeObj, err := cpeskills.ParseCpe23("cpe:2.3:a:microsoft:windows:10:*:*:*:*:*:*:*")
    if err != nil {
        log.Fatal(err)
    }
    
    // 访问组件
    fmt.Printf("供应商: %s\n", cpeObj.Vendor)
    fmt.Printf("产品: %s\n", cpeObj.ProductName)
    fmt.Printf("版本: %s\n", cpeObj.Version)
    
    // 创建匹配模式
    pattern, _ := cpeskills.ParseCpe23("cpe:2.3:a:microsoft:*:*:*:*:*:*:*:*:*")
    
    // 测试匹配
    if pattern.Match(cpeObj) {
        fmt.Println("CPE匹配Microsoft模式！")
    }
}

示例分类

🔍 解析和格式化

学习如何解析 CPE 字符串、处理不同格式，以及在 CPE 2.2 和 2.3 之间转换。

🎯 匹配和比较

发现各种匹配技术，从基本的通配符匹配到带有评分的高级模糊匹配。

📊 数据管理

探索如何高效地存储、检索和管理大量 CPE 数据集合。

🔗 外部集成

了解如何与国家漏洞数据库等外部数据源集成。

🛡️ 安全应用

学习如何使用 CPE 进行漏洞管理、资产清单和安全扫描。

运行示例

所有示例都是完整的、独立的程序。要运行它们：

1. 安装库：

   go get github.com/scagogogo/cpe-skills

2. 创建新的 Go 文件 包含示例代码

3. 运行示例：

   go run example.go

示例结构

每个示例都遵循一致的结构：

• 概览 - 示例演示的内容
• 完整代码 - 完整的、可运行的程序
• 解释 - 逐步分解
• 输出 - 预期结果
• 变化 - 替代方法或扩展

常见模式

错误处理

cpeObj, err := cpeskills.ParseCpe23(cpeString)
if err != nil {
    if cpeskills.IsInvalidFormatError(err) {
        fmt.Printf("无效格式: %s\n", cpeString)
        return
    }
    log.Fatal(err)
}

资源清理

storage, err := cpeskills.NewFileStorage("./data", true)
if err != nil {
    log.Fatal(err)
}
defer storage.Close()

err = storage.Initialize()
if err != nil {
    log.Fatal(err)
}

批处理

cpeStrings := []string{
    "cpe:2.3:a:microsoft:windows:10:*:*:*:*:*:*:*",
    "cpe:2.3:a:apache:tomcat:9.0:*:*:*:*:*:*:*",
}

for _, cpeStr := range cpeStrings {
    cpeObj, err := cpeskills.ParseCpe23(cpeStr)
    if err != nil {
        log.Printf("解析失败 %s: %v", cpeStr, err)
        continue
    }
    
    // 处理CPE
    fmt.Printf("已处理: %s\n", cpeObj.GetURI())
}

最佳实践

1. 始终处理错误

// 好的做法
cpeObj, err := cpeskills.ParseCpe23(input)
if err != nil {
    return fmt.Errorf("解析CPE失败: %w", err)
}

// 不好的做法
cpeObj, _ := cpeskills.ParseCpe23(input) // 忽略错误

2. 使用适当的存储

// 用于测试
storage := cpeskills.NewMemoryStorage()

// 用于生产
storage, err := cpeskills.NewFileStorage("./cpe-data", true)

3. 验证输入

// Parse 接受 CPE 2.3 或 2.2 字符串并校验其格式。
cpe, err := cpeskills.Parse(userInput)
if err != nil {
    return fmt.Errorf("无效的CPE格式: %w", err)
}
// 可选：对解析后的 CPE 执行更深入的字段校验。
if err := cpeskills.ValidateCPE(cpe); err != nil {
    return fmt.Errorf("无效的CPE字段: %w", err)
}

4. 对集合使用 Sets

// 对大集合高效
cpeSet := cpeskills.NewCPESet("my-collection", "用于过滤的 CPE 集合")
cpeSet.Add(cpe1)
cpeSet.Add(cpe2)
cpeSet.Add(cpe3)

// 高效过滤（FilterByVendor 是包级函数）
microsoftCPEs := cpeskills.FilterByVendor(cpeSet.ToSlice(), "microsoft")

性能提示

1. 启用缓存

storage, _ := cpeskills.NewFileStorage("./data", true) // 启用缓存

2. 使用批操作

// 比单个操作更好
cpeSet := cpeskills.FromArray(cpeArray, "batch", "批处理 CPE")
results := cpeskills.FilterByVendor(cpeSet.ToSlice(), "microsoft")

3. 重用匹配选项

options := cpeskills.DefaultMatchOptions()
// 为多个匹配重用选项
for _, cpe := range cpes {
    if cpeskills.MatchCPE(pattern, cpe, options) {
        // 处理匹配
    }
}

获取帮助

如果你需要示例帮助：

1. 查看API 参考获取详细的函数文档
2. 查看完整的示例代码以获取上下文
3. 查看错误处理模式
4. 查看GitHub 仓库的问题和讨论

贡献示例

我们欢迎新示例的贡献！如果你有一个有用的示例来演示特定用例，请考虑为项目贡献。

下一步

从基础解析示例开始学习基础知识，然后根据你的具体需求探索更高级的示例。