cufflink-cli 0.11.6

CLI for the Cufflink CRUD microservice platform — deploy, init, and manage services
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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
use crate::project_config::ProjectConfig;
use crate::workspace_config::WorkspaceConfig;
use securestore::{KeySource, SecretsManager};
use std::path::{Path, PathBuf};

/// Resolve the secrets directory relative to the Cufflink.toml project directory.
fn secrets_dir(project: &ProjectConfig) -> PathBuf {
    project.project_dir.join("secrets")
}

/// Resolve the securestore vault path for a given environment.
fn vault_path(project: &ProjectConfig, env_name: &str) -> PathBuf {
    secrets_dir(project).join(format!("{}.json", env_name))
}

/// Resolve the key file path for a given environment.
fn key_path(project: &ProjectConfig, env_name: &str) -> PathBuf {
    secrets_dir(project).join(format!("{}.key", env_name))
}

/// Load the securestore for a given environment.
/// Key lookup: CUFFLINK_SECRETS_KEY env var (base64) → secrets/{env}.key file
pub fn load_store(project: &ProjectConfig, env_name: &str) -> eyre::Result<SecretsManager> {
    let vault = vault_path(project, env_name);
    if !vault.exists() {
        eyre::bail!(
            "Secrets vault not found at {}. Run: cufflink secrets init --env {}",
            vault.display(),
            env_name
        );
    }

    // Try env var first (for CI), then key file
    if let Ok(key_b64) = std::env::var("CUFFLINK_SECRETS_KEY") {
        let key_bytes =
            base64::Engine::decode(&base64::engine::general_purpose::STANDARD, key_b64.trim())
                .map_err(|e| eyre::eyre!("Failed to decode CUFFLINK_SECRETS_KEY: {}", e))?;

        // Write to temp file since securestore only accepts file paths
        let tmp = tempfile::NamedTempFile::new()?;
        std::fs::write(tmp.path(), &key_bytes)?;
        let store = SecretsManager::load(vault, KeySource::Path(tmp.path()))
            .map_err(|e| eyre::eyre!("Failed to load secrets vault: {}", e))?;
        return Ok(store);
    }

    let key = key_path(project, env_name);
    if !key.exists() {
        eyre::bail!(
            "Secrets key not found. Either:\n  \
             - Set CUFFLINK_SECRETS_KEY env var (base64-encoded)\n  \
             - Place key file at {}",
            key.display()
        );
    }

    let store = SecretsManager::load(vault, KeySource::Path(&key))
        .map_err(|e| eyre::eyre!("Failed to load secrets vault: {}", e))?;
    Ok(store)
}

/// Initialize a new securestore vault for an environment.
pub fn init(env: Option<&str>) -> eyre::Result<()> {
    let project =
        ProjectConfig::find_and_load()?.ok_or_else(|| eyre::eyre!("No Cufflink.toml found"))?;

    let env_name = resolve_env_name(&project, env)?;

    let dir = secrets_dir(&project);
    std::fs::create_dir_all(&dir)?;

    let vault = vault_path(&project, &env_name);
    let key = key_path(&project, &env_name);

    if vault.exists() {
        eyre::bail!("Secrets vault already exists at {}", vault.display());
    }

    let store = SecretsManager::new(KeySource::Csprng)
        .map_err(|e| eyre::eyre!("Failed to create secrets vault: {}", e))?;
    store
        .export_key(&key)
        .map_err(|e| eyre::eyre!("Failed to export key: {}", e))?;
    store
        .save_as(&vault)
        .map_err(|e| eyre::eyre!("Failed to save vault: {}", e))?;

    ensure_gitignore(&dir)?;

    println!("Secrets initialized for '{}':", env_name);
    println!("  Vault:  {}", vault.display());
    println!("  Key:    {}", key.display());
    println!("  .gitignore created (key files excluded)");
    println!();
    println!("Add secrets with:");
    println!(
        "  cufflink secrets set \"name\" \"value\" --env {}",
        env_name
    );

    Ok(())
}

/// Set a secret in the securestore vault.
pub fn set(name: &str, value: &str, env: Option<&str>) -> eyre::Result<()> {
    let project =
        ProjectConfig::find_and_load()?.ok_or_else(|| eyre::eyre!("No Cufflink.toml found"))?;

    let env_name = resolve_env_name(&project, env)?;
    let mut store = load_store(&project, &env_name)?;

    store.set(name, value);
    store
        .save()
        .map_err(|e| eyre::eyre!("Failed to save vault: {}", e))?;

    println!("Secret '{}' set for '{}'", name, env_name);
    Ok(())
}

/// Delete a secret from the securestore vault.
pub fn delete(name: &str, env: Option<&str>) -> eyre::Result<()> {
    let project =
        ProjectConfig::find_and_load()?.ok_or_else(|| eyre::eyre!("No Cufflink.toml found"))?;

    let env_name = resolve_env_name(&project, env)?;
    let mut store = load_store(&project, &env_name)?;

    store
        .remove(name)
        .map_err(|e| eyre::eyre!("Secret '{}' not found: {}", name, e))?;
    store
        .save()
        .map_err(|e| eyre::eyre!("Failed to save vault: {}", e))?;

    println!("Secret '{}' deleted from '{}'", name, env_name);
    Ok(())
}

/// List secret names in the securestore vault.
pub fn list(env: Option<&str>, reveal: bool) -> eyre::Result<()> {
    let project =
        ProjectConfig::find_and_load()?.ok_or_else(|| eyre::eyre!("No Cufflink.toml found"))?;

    let env_name = resolve_env_name(&project, env)?;
    let store = load_store(&project, &env_name)?;

    let names: Vec<&str> = store.keys().collect();
    if names.is_empty() {
        println!("No secrets stored for '{}'.", env_name);
    } else {
        println!("Secrets for '{}':", env_name);
        for name in names {
            if reveal {
                let value: String = store
                    .get(name)
                    .map_err(|e| eyre::eyre!("Failed to read '{}': {}", name, e))?;
                println!("  {} = {}", name, value);
            } else {
                println!("  {}", name);
            }
        }
    }

    Ok(())
}

fn resolve_env_name(project: &ProjectConfig, env: Option<&str>) -> eyre::Result<String> {
    let name = env
        .map(|s| s.to_string())
        .or_else(|| project.service.default_env.clone())
        .ok_or_else(|| {
            eyre::eyre!(
                "No environment specified. Use --env <name> or set default_env in Cufflink.toml"
            )
        })?;
    Ok(name)
}

fn ensure_gitignore(dir: &Path) -> eyre::Result<()> {
    let gitignore = dir.join(".gitignore");
    if !gitignore.exists() {
        std::fs::write(&gitignore, "*.key\n")?;
    }
    Ok(())
}

/// Resolve a sibling service's directory from cufflink-workspace.toml by name.
fn resolve_workspace_service(from: &str) -> eyre::Result<PathBuf> {
    let (ws, root) = WorkspaceConfig::find_and_load()?;
    let svc = ws.services.iter().find(|s| s.name == from).ok_or_else(|| {
        let names: Vec<&str> = ws.services.iter().map(|s| s.name.as_str()).collect();
        eyre::eyre!(
            "Service '{}' not found in cufflink-workspace.toml. Available: {:?}",
            from,
            names,
        )
    })?;
    Ok(root.join(&svc.path))
}

/// List every `<env>.key` file in the given service directory's `secrets/`.
fn list_store_keys(service_dir: &Path) -> eyre::Result<Vec<(String, PathBuf)>> {
    let dir = service_dir.join("secrets");
    if !dir.is_dir() {
        return Ok(Vec::new());
    }
    let mut out = Vec::new();
    for entry in std::fs::read_dir(&dir)? {
        let entry = entry?;
        let path = entry.path();
        if path.extension().and_then(|e| e.to_str()) == Some("key") {
            if let Some(stem) = path.file_stem().and_then(|s| s.to_str()) {
                out.push((stem.to_string(), path));
            }
        }
    }
    out.sort_by(|a, b| a.0.cmp(&b.0));
    Ok(out)
}

/// Initialize empty vaults in the current service using another service's key files.
pub fn init_from(from: &str, store: Option<&str>, env: Option<&str>) -> eyre::Result<()> {
    let project =
        ProjectConfig::find_and_load()?.ok_or_else(|| eyre::eyre!("No Cufflink.toml found"))?;

    let target = store.or(env);
    let source_dir = resolve_workspace_service(from)?;
    let mut src_keys = list_store_keys(&source_dir)?;

    if let Some(t) = target {
        src_keys.retain(|(name, _)| name == t);
    }

    if src_keys.is_empty() {
        match target {
            Some(t) => eyre::bail!("Source service '{}' has no secrets/{}.key", from, t),
            None => eyre::bail!("Source service '{}' has no *.key files in secrets/", from),
        }
    }

    let dir = secrets_dir(&project);
    std::fs::create_dir_all(&dir)?;
    ensure_gitignore(&dir)?;

    for (env_name, src_key_path) in src_keys {
        let dst_vault = vault_path(&project, &env_name);
        if dst_vault.exists() {
            eyre::bail!(
                "Vault already exists at {}. Remove it or run `cufflink secrets rekey --from {}` instead.",
                dst_vault.display(),
                from,
            );
        }
        let dst_key = key_path(&project, &env_name);

        std::fs::copy(&src_key_path, &dst_key).map_err(|e| {
            eyre::eyre!(
                "Failed to copy {} → {}: {}",
                src_key_path.display(),
                dst_key.display(),
                e,
            )
        })?;

        let store = SecretsManager::new(KeySource::Path(&dst_key))
            .map_err(|e| eyre::eyre!("Failed to create vault for '{}': {}", env_name, e))?;
        store
            .save_as(&dst_vault)
            .map_err(|e| eyre::eyre!("Failed to save vault for '{}': {}", env_name, e))?;

        println!("Initialized '{}' vault from '{}'", env_name, from);
        println!("  Vault: {}", dst_vault.display());
        println!("  Key:   {} (copied)", dst_key.display());
    }

    Ok(())
}

/// Re-encrypt a single vault in place: decrypt with `current_key`, encrypt with `new_key`.
/// Returns the number of secrets preserved. Pure with respect to the key files —
/// the caller is responsible for moving `new_key` into any permanent location.
pub fn rekey_vault_in_place(
    vault: &Path,
    current_key: &Path,
    new_key: &Path,
) -> eyre::Result<usize> {
    if !vault.exists() {
        eyre::bail!("No vault at {}", vault.display());
    }
    let old = SecretsManager::load(vault, KeySource::Path(current_key))
        .map_err(|e| eyre::eyre!("Failed to load vault with current key: {}", e))?;

    let pairs: Vec<(String, String)> = old
        .keys()
        .map(String::from)
        .map(|name| {
            old.get(&name)
                .map(|value: String| (name.clone(), value))
                .map_err(|e| eyre::eyre!("Failed to read '{}' during rekey: {}", name, e))
        })
        .collect::<eyre::Result<_>>()?;

    let mut new_store = SecretsManager::new(KeySource::Path(new_key))
        .map_err(|e| eyre::eyre!("Failed to create new vault: {}", e))?;
    for (name, value) in &pairs {
        new_store.set(name, value.as_str());
    }
    new_store
        .save_as(vault)
        .map_err(|e| eyre::eyre!("Failed to save rekeyed vault: {}", e))?;

    Ok(pairs.len())
}

/// Re-encrypt existing vaults in the current service so they use another service's keys.
pub fn rekey(from: &str, store: Option<&str>, env: Option<&str>) -> eyre::Result<()> {
    let project =
        ProjectConfig::find_and_load()?.ok_or_else(|| eyre::eyre!("No Cufflink.toml found"))?;

    let target = store.or(env);
    let source_dir = resolve_workspace_service(from)?;
    let mut candidates = list_store_keys(&source_dir)?;

    if let Some(t) = target {
        candidates.retain(|(name, _)| name == t);
    } else {
        // Only rekey envs we already have a vault for; otherwise rekey has nothing to preserve.
        candidates.retain(|(name, _)| vault_path(&project, name).exists());
    }

    if candidates.is_empty() {
        match target {
            Some(t) => eyre::bail!(
                "Nothing to rekey: source service '{}' has no secrets/{}.key, or current service has no matching vault.",
                from,
                t,
            ),
            None => eyre::bail!(
                "Nothing to rekey: no env names have both a source `.key` in '{}' and a local vault.",
                from,
            ),
        }
    }

    let env_tmp = materialize_env_key()?;

    for (env_name, src_key_path) in candidates {
        let current_vault = vault_path(&project, &env_name);
        if !current_vault.exists() {
            eyre::bail!(
                "No vault to rekey at {}. Use `cufflink secrets init --from {} --store {}` first.",
                current_vault.display(),
                from,
                env_name,
            );
        }

        let current_key = key_path(&project, &env_name);
        let key_for_decrypt: &Path = match env_tmp.as_ref() {
            Some(tmp) => tmp.path(),
            None => &current_key,
        };

        let preserved = rekey_vault_in_place(&current_vault, key_for_decrypt, &src_key_path)?;

        std::fs::copy(&src_key_path, &current_key).map_err(|e| {
            eyre::eyre!(
                "Failed to persist new key to {}: {}",
                current_key.display(),
                e
            )
        })?;

        println!(
            "Rekeyed '{}' vault — now uses '{}' key ({} secrets preserved)",
            env_name, from, preserved,
        );
    }

    Ok(())
}

/// If `CUFFLINK_SECRETS_KEY` is set, decode it and write to a temp file so
/// `SecretsManager::load` can read it from disk (the only path the crate
/// supports). Returns `None` when the env var is unset.
fn materialize_env_key() -> eyre::Result<Option<tempfile::NamedTempFile>> {
    let Ok(b64) = std::env::var("CUFFLINK_SECRETS_KEY") else {
        return Ok(None);
    };
    let bytes = base64::Engine::decode(&base64::engine::general_purpose::STANDARD, b64.trim())
        .map_err(|e| eyre::eyre!("Failed to decode CUFFLINK_SECRETS_KEY: {}", e))?;
    let tmp = tempfile::NamedTempFile::new()?;
    std::fs::write(tmp.path(), &bytes)?;
    Ok(Some(tmp))
}

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

    fn write_key(dir: &Path, name: &str) -> PathBuf {
        let path = dir.join(format!("{name}.key"));
        let store = SecretsManager::new(KeySource::Csprng).unwrap();
        store.export_key(&path).unwrap();
        path
    }

    #[test]
    fn list_store_keys_returns_sorted_env_names() {
        let tmp = tempfile::tempdir().unwrap();
        let svc = tmp.path().join("svc_a");
        let secrets = svc.join("secrets");
        std::fs::create_dir_all(&secrets).unwrap();
        write_key(&secrets, "staging");
        write_key(&secrets, "local");
        write_key(&secrets, "production");
        std::fs::write(secrets.join("README.md"), "ignore me").unwrap();

        let keys = list_store_keys(&svc).unwrap();
        let names: Vec<&str> = keys.iter().map(|(n, _)| n.as_str()).collect();
        assert_eq!(names, vec!["local", "production", "staging"]);
    }

    #[test]
    fn list_store_keys_empty_when_no_secrets_dir() {
        let tmp = tempfile::tempdir().unwrap();
        let keys = list_store_keys(tmp.path()).unwrap();
        assert!(keys.is_empty());
    }

    #[test]
    fn new_vault_with_existing_keyfile_roundtrips() {
        let tmp = tempfile::tempdir().unwrap();
        let key = write_key(tmp.path(), "staging");
        let vault = tmp.path().join("staging.json");

        let mut store = SecretsManager::new(KeySource::Path(&key)).unwrap();
        store.set("NEXTAUTH_SECRET", "super-secret");
        store.save_as(&vault).unwrap();

        let loaded = SecretsManager::load(&vault, KeySource::Path(&key)).unwrap();
        let got: String = loaded.get("NEXTAUTH_SECRET").unwrap();
        assert_eq!(got, "super-secret");
    }

    #[test]
    fn rekey_vault_in_place_preserves_values_and_leaves_keyfiles_alone() {
        let tmp = tempfile::tempdir().unwrap();
        let key_old = write_key(tmp.path(), "staging");
        let key_new = write_key(tmp.path(), "staging-new-source");
        let vault = tmp.path().join("staging.json");

        let mut seed = SecretsManager::new(KeySource::Path(&key_old)).unwrap();
        seed.set("A", "alpha");
        seed.set("B", "bravo");
        seed.save_as(&vault).unwrap();

        let key_old_before = std::fs::read(&key_old).unwrap();
        let key_new_before = std::fs::read(&key_new).unwrap();

        let preserved = rekey_vault_in_place(&vault, &key_old, &key_new).unwrap();
        assert_eq!(preserved, 2);

        assert_eq!(std::fs::read(&key_old).unwrap(), key_old_before);
        assert_eq!(std::fs::read(&key_new).unwrap(), key_new_before);

        let reloaded = SecretsManager::load(&vault, KeySource::Path(&key_new)).unwrap();
        let a: String = reloaded.get("A").unwrap();
        let b: String = reloaded.get("B").unwrap();
        assert_eq!(a, "alpha");
        assert_eq!(b, "bravo");
    }

    #[test]
    fn rekey_vault_in_place_errors_when_vault_missing() {
        let tmp = tempfile::tempdir().unwrap();
        let key = write_key(tmp.path(), "staging");
        let err = rekey_vault_in_place(&tmp.path().join("missing.json"), &key, &key).unwrap_err();
        assert!(err.to_string().contains("No vault"));
    }
}