hippox-drivers 0.3.5

🦛All indivisible atomic driver units in Hippox.
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

//! Random generation driver
//!
//! This driver provides functionality to generate cryptographically secure random data.
use super::common::{generate_random_bytes, generate_random_hex, generate_random_string};
use crate::DriverCallback;
use crate::DriverContext;
use crate::types::{Driver, DriverParameter};
use crate::{DriverError, DriverResult};
use serde_json::{Value, json};
use std::collections::HashMap;
use tracing::{debug, info, warn};
/// Driver for generating random data
///
/// Generates cryptographically secure random data in various formats: bytes, hex, or string.
#[derive(Debug)]
pub struct GenerateRandomDriver;
#[async_trait::async_trait]
impl Driver for GenerateRandomDriver {
    /// Returns the unique name of this driver
    fn name(&self) -> &str {
        "generate_random"
    }
    /// Returns a brief description of the driver's functionality
    fn description(&self) -> &str {
        "Generate cryptographically secure random data (bytes, hex, or string)"
    }
    /// Returns detailed usage guidance for LLMs
    fn usage_hint(&self) -> &str {
        "Use this skill when you need random data for keys, tokens, or testing purposes."
    }
    /// Returns the parameter definitions for this driver
    fn parameters(&self) -> Vec<DriverParameter> {
        return vec![
            DriverParameter {
                name: "length".to_string(),
                param_type: "integer".to_string(),
                description: "Length of random data to generate".to_string(),
                required: true,
                default: None,
                example: Some(Value::Number(16.into())),
                enum_values: None,
            },
            DriverParameter {
                name: "format".to_string(),
                param_type: "string".to_string(),
                description: "Output format: 'bytes', 'hex', or 'string'".to_string(),
                required: false,
                default: Some(Value::String("hex".to_string())),
                example: Some(Value::String("string".to_string())),
                enum_values: Some(vec!["bytes".to_string(), "hex".to_string(), "string".to_string()]),
            },
        ];
    }
    /// Returns an example call for this driver
    fn example_call(&self) -> DriverResult<Value> {
        return Ok(json!({
            "action": "generate_random",
            "parameters": {
                "length": 16,
                "format": "hex"
            }
        }));
    }
    /// Returns an example output from this driver
    fn example_output(&self) -> String {
        return "Random hex: 7f83b1657ff1fc53b92dc18148a1d65d".to_string();
    }
    /// Returns the category of this driver
    fn category(&self) -> crate::DriverCategory {
        return crate::DriverCategory::Cryptography;
    }
    /// Executes the driver with the given parameters
    async fn execute(
        &self,
        parameters: &HashMap<String, Value>,
        callback: Option<&dyn DriverCallback>,
        context: Option<&DriverContext>,
    ) -> DriverResult<String> {
        debug!("Executing generate_random driver");
        let length = parameters.get("length").and_then(|v| v.as_u64()).ok_or_else(|| {
            debug!("Missing 'length' parameter");
            DriverError::missing_parameter("length")
        })? as usize;
        let format = parameters.get("format").and_then(|v| v.as_str()).unwrap_or("hex");
        debug!("Random generation parameters: length={}, format={}", length, format);
        if length == 0 {
            warn!("Length is zero");
            return Err(DriverError::validation("length", "Length must be greater than 0"));
        }
        let result = match format {
            "bytes" => {
                let bytes = generate_random_bytes(length).map_err(|e| DriverError::execution(format!("Failed to generate random bytes: {}", e)))?;
                format!("Random bytes: {:?}", bytes)
            }
            "hex" => {
                let hex = generate_random_hex(length).map_err(|e| DriverError::execution(format!("Failed to generate random hex: {}", e)))?;
                format!("Random hex: {}", hex)
            }
            "string" => {
                let string =
                    generate_random_string(length).map_err(|e| DriverError::execution(format!("Failed to generate random string: {}", e)))?;
                format!("Random string: {}", string)
            }
            _ => {
                warn!("Unsupported format: {}", format);
                return Err(DriverError::execution(format!("Unsupported format: {}", format)));
            }
        };
        info!("Random data generated successfully");
        return Ok(result);
    }
    /// Validate parameters before execution
    fn validate(&self, parameters: &HashMap<String, Value>) -> DriverResult<()> {
        debug!("Validating generate_random parameters");
        if parameters.get("length").is_none() {
            return Err(DriverError::missing_parameter("length"));
        }
        debug!("Parameter validation passed");
        return Ok(());
    }
}