clawshell 0.1.0-alpha.1

A security privileged process for the OpenClaw ecosystem.
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};
use std::collections::BTreeMap;
use std::path::{Path, PathBuf};
use std::time::{SystemTime, UNIX_EPOCH};
use uuid::Uuid;

const MANAGED_BY_CLAWSHELL: &str = "clawshell";
const MANAGED_SKILL_SCHEMA_VERSION: u32 = 1;
const MANIFEST_CONFIG_KEY: &str = "managed_openclaw_skills";
pub const MANAGED_SKILL_METADATA_FILE_NAME: &str = ".clawshell-skill.json";

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct ManagedSkillMetadata {
    pub managed_by: String,
    pub schema_version: u32,
    pub skill_name: String,
    pub install_id: String,
    pub created_at_unix_seconds: u64,
    pub files: Vec<String>,
    pub hashes: BTreeMap<String, String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct ManagedSkillManifestEntry {
    pub schema_version: u32,
    pub skill_name: String,
    pub skill_dir: String,
    pub install_id: String,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ManagedSkillUninstallState {
    Missing,
    ManagedUnchanged,
    ManagedModified,
    Unmanaged,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ManagedSkillInspection {
    pub state: ManagedSkillUninstallState,
    pub detail: String,
}

impl ManagedSkillInspection {
    pub fn missing() -> Self {
        Self {
            state: ManagedSkillUninstallState::Missing,
            detail: "skill directory missing".to_string(),
        }
    }
}

fn now_unix_seconds() -> u64 {
    SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .map(|duration| duration.as_secs())
        .unwrap_or(0)
}

fn hash_content(content: &[u8]) -> String {
    let digest = Sha256::digest(content);
    format!("{digest:x}")
}

fn as_unmanaged(detail: impl Into<String>) -> ManagedSkillInspection {
    ManagedSkillInspection {
        state: ManagedSkillUninstallState::Unmanaged,
        detail: detail.into(),
    }
}

fn as_managed_modified(detail: impl Into<String>) -> ManagedSkillInspection {
    ManagedSkillInspection {
        state: ManagedSkillUninstallState::ManagedModified,
        detail: detail.into(),
    }
}

fn canonicalize_or_original(path: &Path) -> PathBuf {
    std::fs::canonicalize(path).unwrap_or_else(|_| path.to_path_buf())
}

pub fn build_managed_skill_metadata(
    skill_name: &str,
    managed_files: &[(String, String)],
) -> ManagedSkillMetadata {
    let mut files = Vec::with_capacity(managed_files.len());
    let mut hashes = BTreeMap::new();
    for (relative_path, content) in managed_files {
        files.push(relative_path.clone());
        hashes.insert(relative_path.clone(), hash_content(content.as_bytes()));
    }
    files.sort();
    files.dedup();

    ManagedSkillMetadata {
        managed_by: MANAGED_BY_CLAWSHELL.to_string(),
        schema_version: MANAGED_SKILL_SCHEMA_VERSION,
        skill_name: skill_name.to_string(),
        install_id: Uuid::new_v4().to_string(),
        created_at_unix_seconds: now_unix_seconds(),
        files,
        hashes,
    }
}

pub fn write_managed_skill_metadata(
    skill_dir: &Path,
    metadata: &ManagedSkillMetadata,
) -> Result<PathBuf, Box<dyn std::error::Error>> {
    let metadata_path = skill_dir.join(MANAGED_SKILL_METADATA_FILE_NAME);
    let payload = serde_json::to_string_pretty(metadata)?;
    std::fs::write(&metadata_path, payload)?;
    Ok(metadata_path)
}

pub fn build_managed_skill_manifest_entry(
    skill_dir: &Path,
    metadata: &ManagedSkillMetadata,
) -> ManagedSkillManifestEntry {
    ManagedSkillManifestEntry {
        schema_version: metadata.schema_version,
        skill_name: metadata.skill_name.clone(),
        skill_dir: skill_dir.to_string_lossy().to_string(),
        install_id: metadata.install_id.clone(),
    }
}

pub fn upsert_managed_skill_manifest_entry(
    clawshell_config_path: &Path,
    entry: &ManagedSkillManifestEntry,
) -> Result<(), Box<dyn std::error::Error>> {
    let content = std::fs::read_to_string(clawshell_config_path)?;
    let mut json = serde_json::from_str::<serde_json::Value>(&content)?;
    let root = json.as_object_mut().ok_or_else(|| {
        format!(
            "Invalid ClawShell config JSON at {}: expected an object",
            clawshell_config_path.display()
        )
    })?;

    let manifest_node = root
        .entry(MANIFEST_CONFIG_KEY)
        .or_insert_with(|| serde_json::Value::Array(Vec::new()));
    if !manifest_node.is_array() {
        *manifest_node = serde_json::Value::Array(Vec::new());
    }

    let manifest_items = manifest_node
        .as_array_mut()
        .expect("manifest_node must be array");
    manifest_items.retain(|item| {
        item.get("skill_name")
            .and_then(|value| value.as_str())
            .is_none_or(|skill_name| skill_name != entry.skill_name)
    });
    manifest_items.push(serde_json::to_value(entry)?);

    std::fs::write(clawshell_config_path, serde_json::to_string_pretty(&json)?)?;
    Ok(())
}

pub fn read_managed_skill_manifest_entry(
    clawshell_config_path: &Path,
    skill_name: &str,
) -> Option<ManagedSkillManifestEntry> {
    let content = std::fs::read_to_string(clawshell_config_path).ok()?;
    let json = serde_json::from_str::<serde_json::Value>(&content).ok()?;
    let manifest = json.get(MANIFEST_CONFIG_KEY)?.as_array()?;
    for item in manifest {
        if let Ok(parsed) = serde_json::from_value::<ManagedSkillManifestEntry>(item.clone())
            && parsed.skill_name == skill_name
        {
            return Some(parsed);
        }
    }
    None
}

pub fn inspect_managed_skill_for_uninstall(
    skill_dir: &Path,
    expected_skill_name: &str,
    manifest_entry: Option<&ManagedSkillManifestEntry>,
) -> ManagedSkillInspection {
    if !skill_dir.exists() {
        return ManagedSkillInspection::missing();
    }

    let metadata_path = skill_dir.join(MANAGED_SKILL_METADATA_FILE_NAME);
    if !metadata_path.exists() {
        return as_unmanaged(format!(
            "ownership marker missing ({})",
            metadata_path.display()
        ));
    }

    let metadata_content = match std::fs::read_to_string(&metadata_path) {
        Ok(content) => content,
        Err(error) => {
            return as_unmanaged(format!(
                "failed to read ownership marker {}: {error}",
                metadata_path.display()
            ));
        }
    };

    let metadata = match serde_json::from_str::<ManagedSkillMetadata>(&metadata_content) {
        Ok(metadata) => metadata,
        Err(error) => {
            return as_unmanaged(format!(
                "ownership marker parse failed at {}: {error}",
                metadata_path.display()
            ));
        }
    };

    if metadata.managed_by != MANAGED_BY_CLAWSHELL {
        return as_unmanaged(format!(
            "ownership marker managed_by mismatch: expected '{MANAGED_BY_CLAWSHELL}', got '{}'",
            metadata.managed_by
        ));
    }
    if metadata.schema_version != MANAGED_SKILL_SCHEMA_VERSION {
        return as_unmanaged(format!(
            "ownership marker schema mismatch: expected {}, got {}",
            MANAGED_SKILL_SCHEMA_VERSION, metadata.schema_version
        ));
    }
    if metadata.skill_name != expected_skill_name {
        return as_unmanaged(format!(
            "ownership marker skill_name mismatch: expected '{expected_skill_name}', got '{}'",
            metadata.skill_name
        ));
    }

    let Some(manifest) = manifest_entry else {
        return as_unmanaged("manifest entry missing in ClawShell config");
    };
    if manifest.schema_version != metadata.schema_version {
        return as_unmanaged(format!(
            "manifest schema mismatch: marker={}, manifest={}",
            metadata.schema_version, manifest.schema_version
        ));
    }
    if manifest.skill_name != metadata.skill_name {
        return as_unmanaged(format!(
            "manifest skill_name mismatch: marker='{}', manifest='{}'",
            metadata.skill_name, manifest.skill_name
        ));
    }
    if manifest.install_id != metadata.install_id {
        return as_unmanaged(format!(
            "manifest install_id mismatch: marker='{}', manifest='{}'",
            metadata.install_id, manifest.install_id
        ));
    }

    let manifest_dir = PathBuf::from(&manifest.skill_dir);
    if canonicalize_or_original(skill_dir) != canonicalize_or_original(&manifest_dir) {
        return as_unmanaged(format!(
            "manifest path mismatch: found '{}', manifest '{}'",
            skill_dir.display(),
            manifest.skill_dir
        ));
    }

    for relative_path in &metadata.files {
        let Some(expected_hash) = metadata.hashes.get(relative_path) else {
            return as_unmanaged(format!(
                "ownership marker missing hash for managed file '{relative_path}'"
            ));
        };

        let full_path = skill_dir.join(relative_path);
        let content = match std::fs::read(&full_path) {
            Ok(content) => content,
            Err(error) => {
                return as_managed_modified(format!(
                    "managed file changed or missing '{}': {error}",
                    full_path.display()
                ));
            }
        };
        let current_hash = hash_content(&content);
        if current_hash != *expected_hash {
            return as_managed_modified(format!(
                "managed file hash changed for '{}'",
                full_path.display()
            ));
        }
    }

    ManagedSkillInspection {
        state: ManagedSkillUninstallState::ManagedUnchanged,
        detail: "ownership marker and manifest verified".to_string(),
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use tempfile::tempdir;

    fn write_files(skill_dir: &Path, files: &[(String, String)]) {
        for (relative_path, content) in files {
            let full_path = skill_dir.join(relative_path);
            if let Some(parent) = full_path.parent() {
                std::fs::create_dir_all(parent).unwrap();
            }
            std::fs::write(full_path, content).unwrap();
        }
    }

    #[test]
    fn test_inspect_managed_skill_unchanged() {
        let temp_dir = tempdir().unwrap();
        let skill_dir = temp_dir.path().join("skills/get-email-messages");
        std::fs::create_dir_all(&skill_dir).unwrap();
        let managed_files = vec![
            ("SKILL.md".to_string(), "hello".to_string()),
            (
                "references/api-usage.md".to_string(),
                "reference".to_string(),
            ),
        ];
        write_files(&skill_dir, &managed_files);

        let metadata = build_managed_skill_metadata("get-email-messages", &managed_files);
        write_managed_skill_metadata(&skill_dir, &metadata).unwrap();
        let manifest = build_managed_skill_manifest_entry(&skill_dir, &metadata);

        let inspection =
            inspect_managed_skill_for_uninstall(&skill_dir, "get-email-messages", Some(&manifest));
        assert_eq!(
            inspection.state,
            ManagedSkillUninstallState::ManagedUnchanged
        );
    }

    #[test]
    fn test_inspect_managed_skill_modified() {
        let temp_dir = tempdir().unwrap();
        let skill_dir = temp_dir.path().join("skills/get-email-messages");
        std::fs::create_dir_all(&skill_dir).unwrap();
        let managed_files = vec![("SKILL.md".to_string(), "before".to_string())];
        write_files(&skill_dir, &managed_files);

        let metadata = build_managed_skill_metadata("get-email-messages", &managed_files);
        write_managed_skill_metadata(&skill_dir, &metadata).unwrap();
        let manifest = build_managed_skill_manifest_entry(&skill_dir, &metadata);

        std::fs::write(skill_dir.join("SKILL.md"), "after").unwrap();

        let inspection =
            inspect_managed_skill_for_uninstall(&skill_dir, "get-email-messages", Some(&manifest));
        assert_eq!(
            inspection.state,
            ManagedSkillUninstallState::ManagedModified
        );
        assert!(inspection.detail.contains("hash changed"));
    }

    #[test]
    fn test_inspect_managed_skill_unmanaged_without_marker() {
        let temp_dir = tempdir().unwrap();
        let skill_dir = temp_dir.path().join("skills/get-email-messages");
        std::fs::create_dir_all(&skill_dir).unwrap();
        std::fs::write(skill_dir.join("SKILL.md"), "content").unwrap();

        let inspection =
            inspect_managed_skill_for_uninstall(&skill_dir, "get-email-messages", None);
        assert_eq!(inspection.state, ManagedSkillUninstallState::Unmanaged);
        assert!(inspection.detail.contains("ownership marker missing"));
    }

    #[test]
    fn test_inspect_managed_skill_unmanaged_on_manifest_mismatch() {
        let temp_dir = tempdir().unwrap();
        let skill_dir = temp_dir.path().join("skills/get-email-messages");
        std::fs::create_dir_all(&skill_dir).unwrap();
        let managed_files = vec![("SKILL.md".to_string(), "hello".to_string())];
        write_files(&skill_dir, &managed_files);

        let metadata = build_managed_skill_metadata("get-email-messages", &managed_files);
        write_managed_skill_metadata(&skill_dir, &metadata).unwrap();
        let mut manifest = build_managed_skill_manifest_entry(&skill_dir, &metadata);
        manifest.install_id = Uuid::new_v4().to_string();

        let inspection =
            inspect_managed_skill_for_uninstall(&skill_dir, "get-email-messages", Some(&manifest));
        assert_eq!(inspection.state, ManagedSkillUninstallState::Unmanaged);
        assert!(inspection.detail.contains("install_id mismatch"));
    }

    #[test]
    fn test_upsert_and_read_manifest_entry() {
        let temp_dir = tempdir().unwrap();
        let config_path = temp_dir.path().join("config.json");
        std::fs::write(
            &config_path,
            r#"{"real_api_key":"x","virtual_api_key":"y","provider":"openai","model":"gpt"}"#,
        )
        .unwrap();

        let entry = ManagedSkillManifestEntry {
            schema_version: 1,
            skill_name: "get-email-messages".to_string(),
            skill_dir: "/tmp/.openclaw/skills/get-email-messages".to_string(),
            install_id: Uuid::new_v4().to_string(),
        };
        upsert_managed_skill_manifest_entry(&config_path, &entry).unwrap();

        let parsed = read_managed_skill_manifest_entry(&config_path, "get-email-messages").unwrap();
        assert_eq!(parsed, entry);

        let mut replacement = parsed.clone();
        replacement.install_id = Uuid::new_v4().to_string();
        upsert_managed_skill_manifest_entry(&config_path, &replacement).unwrap();
        let updated =
            read_managed_skill_manifest_entry(&config_path, "get-email-messages").unwrap();
        assert_eq!(updated, replacement);
    }
}