Rust的CDDL验证库cddl-cat使用指南：高效解析和验证符合CDDL规范的数据结构

cddl-cat是一个用于验证编码数据是否符合CDDL文档描述的预期结构的库。CDDL是RFC8610描述的文本文档，用于描述数据结构。CDDL不绑定任何特定的序列化或编码方法，可用于验证CBOR或JSON格式的数据。

实现细节

• 支持CBOR和JSON编码，由serde_cbor和serde_json特性控制
• 从CDDL AST构建"中间验证树"(IVT)，简化了验证过程
• 验证代码使用LookupContext对象执行所有规则查找
• 包含全面的测试(覆盖率90%+)

示例

验证JSON数据

use cddl_cat::validate_json_str;

let cddl_input = "person = {name: tstr, age: int}";
let json_str = r#"{ "name": "Bob", "age": 43 }"#;

validate_json_str("person", cddl_input, &json_str).unwrap();

如果JSON数据不符合预期结构，会返回错误：

use cddl_cat::validate_json_str;

let cddl_input = "person = {name: tstr, age: int}";
let json_str = r#"{ "name": "Bob", "age": "forty three" }"#;

assert!(validate_json_str("person", cddl_input, &json_str).is_err());

验证CBOR数据

use cddl_cat::validate_cbor_bytes;
use serde::Serialize;

#[derive(Serialize)]
struct PersonStruct {
    name: String,
    age: u32,
}

let input = PersonStruct {
    name: "Bob".to_string(),
    age: 43,
};
let cbor_bytes = serde_cbor::to_vec(&input).unwrap();
let cddl_input = "person = {name: tstr, age: int}";
validate_cbor_bytes("person", cddl_input, &cbor_bytes).unwrap();

完整示例代码

// 添加依赖到Cargo.toml
// [dependencies]
// cddl-cat = "0.6.2"
// serde = { version = "1.0", features = ["derive"] }
// serde_cbor = "0.11"

use cddl_cat::{validate_json_str, validate_cbor_bytes};
use serde::Serialize;

fn main() {
    // 示例1: 验证JSON数据
    json_validation_example();
    
    // 示例2: 验证CBOR数据
    cbor_validation_example();
}

fn json_validation_example() {
    // CDDL schema定义
    let cddl_schema = r#"
        person = {
            name: tstr,
            age: int,
            address?: {
                street: tstr,
                city: tstr,
                zip: uint
            }
        }
    "#;
    
    // 有效的JSON数据
    let valid_json = r#"
        {
            "name": "Alice",
            "age": 30,
            "address": {
                "street": "123 Main St",
                "city": "Anytown",
                "zip": 12345
            }
        }
    "#;
    
    // 无效的JSON数据(age应该是int)
    let invalid_json = r#"
        {
            "name": "Bob",
            "age": "thirty"
        }
    "#;
    
    // 验证有效数据
    validate_json_str("person", cddl_schema, valid_json).unwrap();
    println!("JSON validation passed for valid data!");
    
    // 验证无效数据
    assert!(validate_json_str("person", cddl_schema, invalid_json).is_err());
    println!("JSON validation correctly failed for invalid data!");
}

fn cbor_validation_example() {
    // CDDL schema定义
    let cddl_schema = r#"
        product = {
            id: uint,
            name: tstr,
            price: float,
            in_stock: bool
        }
    "#;
    
    // 定义数据结构
    #[derive(Serialize)]
    struct Product {
        id: u32,
        name: String,
        price: f32,
        in_stock: bool,
    }
    
    // 创建有效产品
    let valid_product = Product {
        id: 1001,
        name: "Rust Programming Book".to_string(),
        price: 39.99,
        in_stock: true,
    };
    
    // 序列化为CBOR
    let cbor_data = serde_cbor::to_vec(&valid_product).unwrap();
    
    // 验证CBOR数据
    validate_cbor_bytes("product", cddl_schema, &cbor_data).unwrap();
    println!("CBOR validation passed for valid data!");
}

支持的类型和特性

支持的预定义类型

• any, uint, nint, int, bstr, bytes, tstr, text
• float, float16, float32, float64, float16-32, float32-64

支持的CDDL特性

• 基本预定义类型
• 字面量(int, float, bool, UTF-8文本字符串)
• 字节字符串(UTF-8, hex或base64)
• 数组和映射
• 规则名称查找
• 组
• 选择(使用/或//语法)
• 出现次数(?, *, +, 或m*n)
• 范围(如1..7或1...8)
• 解包(~)
• 将组转换为选择(&)
• 带cut语法的映射键(^ =>)
• 泛型类型
• 控制运算符.cbor, .size, 和.regexp

安装

在项目目录中运行以下Cargo命令：

cargo add cddl-cat

或在Cargo.toml中添加：

cddl-cat = "0.6.2"