esk 0.8.0

Encrypted Secrets Keeper with multi-target deploy
Documentation
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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
//! Bitwarden Secrets Manager remote — syncs secrets via the `bws` CLI.
//!
//! Bitwarden Secrets Manager is a secrets management service separate from the
//! Bitwarden password manager. It is designed for machine-to-machine secrets
//! (API keys, certificates, database credentials) with project-scoped access.
//!
//! CLI: `bws` (Bitwarden Secrets Manager CLI, distinct from the `bw` vault CLI).
//! Commands: `bws secret list --project-id` / `bws secret create` / `bws secret update`.
//!
//! Requires a `BWS_ACCESS_TOKEN` environment variable for authentication.
//! Secrets are scoped to a project ID and stored one-per-secret (not as a
//! single blob). The esk version metadata and store payload are stored as a
//! specially-named secret within the project.

use anyhow::{Context, Result};
use serde_json::Value;
use std::collections::BTreeMap;

use crate::config::{BitwardenRemoteConfig, Config};
use crate::store::StorePayload;
use crate::targets::{CommandOpts, CommandRunner};

use super::SyncRemote;

pub struct BitwardenRemote<'a> {
    config: &'a Config,
    remote_config: BitwardenRemoteConfig,
    runner: &'a dyn CommandRunner,
}

impl<'a> BitwardenRemote<'a> {
    pub fn new(
        config: &'a Config,
        remote_config: BitwardenRemoteConfig,
        runner: &'a dyn CommandRunner,
    ) -> Self {
        Self {
            config,
            remote_config,
            runner,
        }
    }

    /// Resolve the secret name for an environment.
    fn secret_name(&self, env: &str) -> String {
        self.remote_config
            .secret_name
            .replace("{project}", &self.config.project)
            .replace("{environment}", env)
    }

    /// List secrets in the project, returning the raw JSON array.
    fn list_secrets(&self) -> Result<Vec<Value>> {
        let project_id = &self.remote_config.project_id;
        let output = self
            .runner
            .run(
                "bws",
                &[
                    "secret",
                    "list",
                    "--project-id",
                    project_id,
                    "--output",
                    "json",
                ],
                CommandOpts::default(),
            )
            .context("failed to run bws secret list")?;

        if !output.success {
            let stderr = String::from_utf8_lossy(&output.stderr);
            anyhow::bail!("bws secret list failed: {stderr}");
        }

        let items: Vec<Value> =
            serde_json::from_slice(&output.stdout).context("failed to parse bws output")?;
        Ok(items)
    }

    /// Find a secret by name in the list, returning its ID.
    #[allow(clippy::unused_self)]
    fn find_secret_id(&self, items: &[Value], name: &str) -> Option<String> {
        items.iter().find_map(|item| {
            let item_name = item.get("key")?.as_str()?;
            if item_name == name {
                item.get("id")?
                    .as_str()
                    .map(std::string::ToString::to_string)
            } else {
                None
            }
        })
    }
}

impl SyncRemote for BitwardenRemote<'_> {
    fn name(&self) -> &'static str {
        "bitwarden"
    }

    fn passes_value_as_cli_arg(&self) -> bool {
        true
    }

    fn preflight(&self) -> Result<()> {
        crate::targets::check_command(self.runner, "bws").map_err(|_| {
            anyhow::anyhow!(
                "Bitwarden Secrets Manager CLI (bws) is not installed or not in PATH. Install it from: https://bitwarden.com/help/secrets-manager-cli/"
            )
        })?;

        // Verify auth by listing secrets (requires BWS_ACCESS_TOKEN)
        let project_id = &self.remote_config.project_id;
        let output = self
            .runner
            .run(
                "bws",
                &["secret", "list", "--project-id", project_id],
                CommandOpts::default(),
            )
            .context("failed to run bws secret list")?;

        if !output.success {
            let stderr = String::from_utf8_lossy(&output.stderr);
            anyhow::bail!("Bitwarden authentication failed (is BWS_ACCESS_TOKEN set?): {stderr}");
        }

        Ok(())
    }

    fn push(&self, payload: &StorePayload, _config: &Config, env: &str) -> Result<()> {
        let Some((env_secrets, version)) = payload.env_secrets(env) else {
            return Ok(());
        };

        // Build JSON payload with bare keys + version
        let mut data: BTreeMap<String, Value> = env_secrets
            .into_iter()
            .map(|(k, v)| (k, Value::String(v)))
            .collect();
        data.insert(
            super::ESK_VERSION_KEY.to_string(),
            Value::Number(version.into()),
        );

        let json = serde_json::to_string(&data).context("failed to serialize secrets")?;
        let secret_name = self.secret_name(env);

        // Check if the secret already exists
        let items = self.list_secrets()?;
        let existing_id = self.find_secret_id(&items, &secret_name);

        // SECURITY: `bws` CLI requires `--value` as an argument for both `secret edit` and
        // `secret create`. There is no stdin/file support. Secret values are exposed in process
        // arguments (visible via `ps aux`). No workaround available.
        if let Some(id) = existing_id {
            // Update existing secret
            let output = self
                .runner
                .run(
                    "bws",
                    &["secret", "edit", &id, "--value", &json],
                    CommandOpts::default(),
                )
                .context("failed to run bws secret edit")?;
            if !output.success {
                let stderr = String::from_utf8_lossy(&output.stderr);
                anyhow::bail!("bws secret edit failed: {stderr}");
            }
        } else {
            // Create new secret
            let project_id = &self.remote_config.project_id;
            let output = self
                .runner
                .run(
                    "bws",
                    &[
                        "secret",
                        "create",
                        &secret_name,
                        &json,
                        "--project-id",
                        project_id,
                    ],
                    CommandOpts::default(),
                )
                .context("failed to run bws secret create")?;
            if !output.success {
                let stderr = String::from_utf8_lossy(&output.stderr);
                anyhow::bail!("bws secret create failed: {stderr}");
            }
        }

        Ok(())
    }

    fn pull(&self, _config: &Config, env: &str) -> Result<Option<(BTreeMap<String, String>, u64)>> {
        let secret_name = self.secret_name(env);
        let items = self.list_secrets()?;

        // Find the secret by name
        let Some(item) = items.iter().find(|item| {
            item.get("key")
                .and_then(|v| v.as_str())
                .is_some_and(|s| s == secret_name)
        }) else {
            return Ok(None);
        };

        // Parse the value as JSON
        let value_str = item
            .get("value")
            .and_then(|v| v.as_str())
            .context("bws secret has no value field")?;

        let data: BTreeMap<String, Value> =
            serde_json::from_str(value_str).context("failed to parse secret value as JSON")?;

        let mut secrets = BTreeMap::new();
        let mut version = 0u64;

        for (k, v) in &data {
            if k == super::ESK_VERSION_KEY {
                version = v
                    .as_u64()
                    .or_else(|| v.as_str().and_then(|s| s.parse().ok()))
                    .unwrap_or(0);
                continue;
            }
            let val = v.as_str().unwrap_or_default();
            secrets.insert(format!("{k}:{env}"), val.to_string());
        }

        Ok(Some((secrets, version)))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::targets::CommandOutput;
    use crate::test_support::{ConfigFixture, ErrorCommandRunner, MockCommandRunner};
    use serde_json::json;

    fn ok_output(stdout: &[u8]) -> CommandOutput {
        CommandOutput {
            success: true,
            stdout: stdout.to_vec(),
            stderr: Vec::new(),
        }
    }

    fn fail_output(stderr: &[u8]) -> CommandOutput {
        CommandOutput {
            success: false,
            stdout: Vec::new(),
            stderr: stderr.to_vec(),
        }
    }

    #[test]
    fn preflight_success() {
        let yaml = r#"
project: myapp
environments: [dev]
remotes:
  bitwarden:
    project_id: "proj-123"
    secret_name: "{project}-{environment}"
"#;
        let fixture = ConfigFixture::new(yaml).expect("fixture");
        let remote_config: BitwardenRemoteConfig =
            fixture.config().remote_config("bitwarden").unwrap();
        let runner =
            MockCommandRunner::from_outputs(vec![ok_output(b"bws 0.4.0"), ok_output(b"[]")]);
        let remote = BitwardenRemote::new(fixture.config(), remote_config, &runner);
        assert!(remote.preflight().is_ok());
        let calls = runner.calls();
        assert_eq!(calls.len(), 2);
        assert_eq!(calls[0].args, vec!["--version"]);
        assert!(calls[1].args.contains(&"secret".to_string()));
    }

    #[test]
    fn preflight_bws_not_installed() {
        let yaml = r#"
project: myapp
environments: [dev]
remotes:
  bitwarden:
    project_id: "proj-123"
    secret_name: "{project}-{environment}"
"#;
        let fixture = ConfigFixture::new(yaml).expect("fixture");
        let remote_config: BitwardenRemoteConfig =
            fixture.config().remote_config("bitwarden").unwrap();
        let runner = ErrorCommandRunner::missing_command();
        let remote = BitwardenRemote::new(fixture.config(), remote_config, &runner);
        let err = remote.preflight().unwrap_err();
        assert!(err.to_string().contains("bws) is not installed"));
    }

    #[test]
    fn preflight_auth_failure() {
        let yaml = r#"
project: myapp
environments: [dev]
remotes:
  bitwarden:
    project_id: "proj-123"
    secret_name: "{project}-{environment}"
"#;
        let fixture = ConfigFixture::new(yaml).expect("fixture");
        let remote_config: BitwardenRemoteConfig =
            fixture.config().remote_config("bitwarden").unwrap();
        let runner = MockCommandRunner::from_outputs(vec![
            ok_output(b"bws 0.4.0"),
            fail_output(b"Unauthorized"),
        ]);
        let remote = BitwardenRemote::new(fixture.config(), remote_config, &runner);
        let err = remote.preflight().unwrap_err();
        assert!(err.to_string().contains("Bitwarden authentication failed"));
    }

    #[test]
    fn push_creates_new_secret() {
        let yaml = r#"
project: myapp
environments: [dev]
remotes:
  bitwarden:
    project_id: "proj-123"
    secret_name: "{project}-{environment}"
"#;
        let fixture = ConfigFixture::new(yaml).expect("fixture");
        let remote_config: BitwardenRemoteConfig =
            fixture.config().remote_config("bitwarden").unwrap();

        // list returns empty array (no existing secret), then create succeeds
        let runner = MockCommandRunner::from_outputs(vec![ok_output(b"[]"), ok_output(b"{}")]);
        let remote = BitwardenRemote::new(fixture.config(), remote_config, &runner);

        let mut secrets = BTreeMap::new();
        secrets.insert("API_KEY:dev".to_string(), "sk_test".to_string());
        let payload = StorePayload {
            secrets,
            version: 3,
            ..Default::default()
        };

        remote.push(&payload, fixture.config(), "dev").unwrap();

        let calls = runner.calls();
        assert_eq!(calls.len(), 2);
        // Second call is create
        assert_eq!(calls[1].args[0], "secret");
        assert_eq!(calls[1].args[1], "create");
        assert_eq!(calls[1].args[2], "myapp-dev");
    }

    #[test]
    fn push_updates_existing_secret() {
        let yaml = r#"
project: myapp
environments: [dev]
remotes:
  bitwarden:
    project_id: "proj-123"
    secret_name: "{project}-{environment}"
"#;
        let fixture = ConfigFixture::new(yaml).expect("fixture");
        let remote_config: BitwardenRemoteConfig =
            fixture.config().remote_config("bitwarden").unwrap();

        let existing = json!([
            {"id": "secret-456", "key": "myapp-dev", "value": "{}"}
        ]);
        let runner = MockCommandRunner::from_outputs(vec![
            ok_output(&serde_json::to_vec(&existing).unwrap()),
            ok_output(b"{}"),
        ]);
        let remote = BitwardenRemote::new(fixture.config(), remote_config, &runner);

        let mut secrets = BTreeMap::new();
        secrets.insert("API_KEY:dev".to_string(), "sk_test".to_string());
        let payload = StorePayload {
            secrets,
            version: 5,
            ..Default::default()
        };

        remote.push(&payload, fixture.config(), "dev").unwrap();

        let calls = runner.calls();
        assert_eq!(calls.len(), 2);
        // Second call is edit
        assert_eq!(calls[1].args[0], "secret");
        assert_eq!(calls[1].args[1], "edit");
        assert_eq!(calls[1].args[2], "secret-456");
    }

    #[test]
    fn push_skips_empty_env() {
        let yaml = r#"
project: myapp
environments: [dev, prod]
remotes:
  bitwarden:
    project_id: "proj-123"
    secret_name: "{project}-{environment}"
"#;
        let fixture = ConfigFixture::new(yaml).expect("fixture");
        let remote_config: BitwardenRemoteConfig =
            fixture.config().remote_config("bitwarden").unwrap();
        let runner = MockCommandRunner::from_outputs(vec![]);
        let remote = BitwardenRemote::new(fixture.config(), remote_config, &runner);

        let mut secrets = BTreeMap::new();
        secrets.insert("KEY:prod".to_string(), "val".to_string());
        let payload = StorePayload {
            secrets,
            version: 1,
            ..Default::default()
        };

        remote.push(&payload, fixture.config(), "dev").unwrap();
        assert!(runner.calls().is_empty());
    }

    #[test]
    fn pull_finds_secret_by_name() {
        let yaml = r#"
project: myapp
environments: [dev]
remotes:
  bitwarden:
    project_id: "proj-123"
    secret_name: "{project}-{environment}"
"#;
        let fixture = ConfigFixture::new(yaml).expect("fixture");
        let remote_config: BitwardenRemoteConfig =
            fixture.config().remote_config("bitwarden").unwrap();

        let inner_value = json!({"API_KEY": "sk_test", "DB_URL": "postgres://localhost", crate::remotes::ESK_VERSION_KEY: 7});
        let items = json!([
            {"id": "s1", "key": "myapp-dev", "value": serde_json::to_string(&inner_value).unwrap()},
            {"id": "s2", "key": "myapp-prod", "value": "{}"}
        ]);
        let runner =
            MockCommandRunner::from_outputs(vec![ok_output(&serde_json::to_vec(&items).unwrap())]);
        let remote = BitwardenRemote::new(fixture.config(), remote_config, &runner);

        let (secrets, version) = remote.pull(fixture.config(), "dev").unwrap().unwrap();
        assert_eq!(version, 7);
        assert_eq!(secrets.get("API_KEY:dev").unwrap(), "sk_test");
        assert_eq!(secrets.get("DB_URL:dev").unwrap(), "postgres://localhost");
        assert!(!secrets.contains_key("_esk_version:dev"));
    }

    #[test]
    fn pull_not_found_returns_none() {
        let yaml = r#"
project: myapp
environments: [dev]
remotes:
  bitwarden:
    project_id: "proj-123"
    secret_name: "{project}-{environment}"
"#;
        let fixture = ConfigFixture::new(yaml).expect("fixture");
        let remote_config: BitwardenRemoteConfig =
            fixture.config().remote_config("bitwarden").unwrap();
        let runner = MockCommandRunner::from_outputs(vec![ok_output(b"[]")]);
        let remote = BitwardenRemote::new(fixture.config(), remote_config, &runner);

        assert!(remote.pull(fixture.config(), "dev").unwrap().is_none());
    }

    #[test]
    fn secret_name_interpolation() {
        struct DummyRunner;
        impl CommandRunner for DummyRunner {
            fn run(&self, _: &str, _: &[&str], _: CommandOpts) -> Result<CommandOutput> {
                Ok(CommandOutput {
                    success: true,
                    stdout: Vec::new(),
                    stderr: Vec::new(),
                })
            }
        }

        let yaml = r#"
project: myapp
environments: [dev, prod]
remotes:
  bitwarden:
    project_id: "proj-123"
    secret_name: "{project}-{environment}"
"#;
        let fixture = ConfigFixture::new(yaml).expect("fixture");
        let remote_config: BitwardenRemoteConfig =
            fixture.config().remote_config("bitwarden").unwrap();

        let remote = BitwardenRemote::new(fixture.config(), remote_config, &DummyRunner);
        assert_eq!(remote.secret_name("dev"), "myapp-dev");
        assert_eq!(remote.secret_name("prod"), "myapp-prod");
    }

    #[test]
    fn pull_version_as_string() {
        let yaml = r#"
project: myapp
environments: [dev]
remotes:
  bitwarden:
    project_id: "proj-123"
    secret_name: "{project}-{environment}"
"#;
        let fixture = ConfigFixture::new(yaml).expect("fixture");
        let remote_config: BitwardenRemoteConfig =
            fixture.config().remote_config("bitwarden").unwrap();

        let inner_value = json!({"KEY": "val", crate::remotes::ESK_VERSION_KEY: "42"});
        let items = json!([
            {"id": "s1", "key": "myapp-dev", "value": serde_json::to_string(&inner_value).unwrap()}
        ]);
        let runner =
            MockCommandRunner::from_outputs(vec![ok_output(&serde_json::to_vec(&items).unwrap())]);
        let remote = BitwardenRemote::new(fixture.config(), remote_config, &runner);

        let (secrets, version) = remote.pull(fixture.config(), "dev").unwrap().unwrap();
        assert_eq!(version, 42);
        assert_eq!(secrets.get("KEY:dev").unwrap(), "val");
    }
}