envstash 0.1.12

Manage .env files across git branches with versioning, diffing, and optional encryption
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
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
use std::io::Read;
use std::path::Path;

use colored::Colorize;

use crate::cli;
use crate::error::Result;
use crate::export;
use crate::export::transport;
use crate::parser;
use crate::store::queries::{self, SaveInput};

use super::transport as remote;

/// Run the `receive` command: read an exported envelope (possibly encrypted)
/// and insert into the store.
pub fn run(
    cwd: &Path,
    file: Option<&str>,
    key_file: Option<&str>,
    password_file: Option<&Path>,
    from: Option<&str>,
) -> Result<()> {
    let mut conn = cli::require_store()?;
    let aes_key = cli::load_encryption_key(&conn, key_file)?;
    let (project_path, _git_ctx) = cli::resolve_project(cwd)?;

    // Read raw bytes from transport backend, file, or stdin.
    let raw_bytes = if let Some(source) = from {
        remote::fetch(source)?
    } else {
        match file {
            Some(path) => std::fs::read(path)?,
            None => {
                let mut buf = Vec::new();
                std::io::stdin().read_to_end(&mut buf)?;
                buf
            }
        }
    };

    if raw_bytes.is_empty() {
        return Err(crate::error::Error::Other(
            "empty input: nothing to import".to_string(),
        ));
    }

    // Detect transport encryption and decrypt if needed. For password-based
    // transport, resolve via `--password-file`, `ENVSTASH_PASSWORD`, or prompt.
    // We only resolve lazily to avoid prompting when the payload is plaintext.
    let decrypted = if transport::detect(&raw_bytes) == transport::TransportEncryption::Password {
        let pw = crate::crypto::password::resolve_password(password_file)?;
        transport::decrypt_auto(&raw_bytes, Some(&pw))?
    } else {
        transport::decrypt_auto(&raw_bytes, None)?
    };

    // Convert decrypted bytes to string for parsing.
    let input = std::str::from_utf8(&decrypted)
        .map_err(|e| crate::error::Error::Other(format!("invalid UTF-8 in import data: {e}")))?;

    // Auto-detect format and parse.
    let envelope = export::auto_detect(input)?;

    // Reject file paths containing path traversal components.
    if super::apply::has_path_traversal(&envelope.file) {
        return Err(crate::error::Error::Other(format!(
            "Refusing to import: file path '{}' contains path traversal components",
            envelope.file
        )));
    }

    // Convert entries and compute content hash for verification.
    let entries = export::to_env_entries(&envelope);
    let computed_hash = parser::content_hash(&entries);

    // Warn if content hash doesn't match (but still import).
    if !envelope.content_hash.is_empty() && computed_hash != envelope.content_hash {
        eprintln!(
            "{} content hash mismatch (expected {}, computed {})",
            "warning:".yellow(),
            envelope.content_hash,
            computed_hash
        );
    }

    // Insert into the store, preserving message.
    queries::insert_save_input(
        &mut conn,
        &SaveInput {
            project_path: &project_path,
            file_path: &envelope.file,
            branch: &envelope.branch,
            commit_hash: &envelope.commit,
            timestamp: &envelope.timestamp,
            content_hash: &computed_hash,
            entries: &entries,
            aes_key: aes_key.as_deref(),
            message: envelope.message.as_deref(),
        },
    )?;

    println!(
        "{} {} ({} variables, branch: {}, timestamp: {})",
        "Imported".green().bold(),
        envelope.file,
        entries.len(),
        if envelope.branch.is_empty() {
            "(none)"
        } else {
            &envelope.branch
        },
        envelope.timestamp,
    );

    Ok(())
}

#[cfg(test)]
mod tests {
    use crate::export::transport;
    use crate::export::{self, ExportEntry, ExportEnvelope};
    use crate::store::queries;
    use crate::test_helpers::{sample_entries, test_conn};

    fn sample_envelope() -> ExportEnvelope {
        ExportEnvelope {
            version: 1,
            file: ".env".to_string(),
            branch: "main".to_string(),
            commit: "abc123".to_string(),
            timestamp: "2024-06-17T12:00:00Z".to_string(),
            content_hash: "will_be_recomputed".to_string(),
            message: None,
            entries: vec![
                ExportEntry {
                    key: "DB_HOST".to_string(),
                    value: "localhost".to_string(),
                    comment: Some("Host config".to_string()),
                },
                ExportEntry {
                    key: "DB_PORT".to_string(),
                    value: "5432".to_string(),
                    comment: None,
                },
            ],
        }
    }

    #[test]
    fn import_json_envelope() {
        let mut conn = test_conn();
        let envelope = sample_envelope();
        let json = export::to_json(&envelope).unwrap();

        let parsed = export::auto_detect(&json).unwrap();
        let entries = export::to_env_entries(&parsed);
        let hash = crate::parser::content_hash(&entries);

        queries::insert_save(
            &mut conn,
            "/proj",
            &parsed.file,
            &parsed.branch,
            &parsed.commit,
            &parsed.timestamp,
            &hash,
            &entries,
            None,
        )
        .unwrap();

        let saves = queries::list_saves(&conn, "/proj", None, None, 10, None).unwrap();
        assert_eq!(saves.len(), 1);
        assert_eq!(saves[0].file_path, ".env");
        assert_eq!(saves[0].branch, "main");

        let loaded = queries::get_save_entries(&conn, saves[0].id, None).unwrap();
        assert_eq!(loaded.len(), 2);
        assert_eq!(loaded[0].key, "DB_HOST");
    }

    #[test]
    fn import_text_envelope() {
        let mut conn = test_conn();
        let envelope = sample_envelope();
        let text = export::to_text(&envelope);

        let parsed = export::auto_detect(&text).unwrap();
        let entries = export::to_env_entries(&parsed);
        let hash = crate::parser::content_hash(&entries);

        queries::insert_save(
            &mut conn,
            "/proj",
            &parsed.file,
            &parsed.branch,
            &parsed.commit,
            &parsed.timestamp,
            &hash,
            &entries,
            None,
        )
        .unwrap();

        let saves = queries::list_saves(&conn, "/proj", None, None, 10, None).unwrap();
        assert_eq!(saves.len(), 1);
        assert_eq!(saves[0].branch, "main");
    }

    #[test]
    fn import_into_encrypted_store() {
        let mut conn = test_conn();
        let key = crate::crypto::aes::generate_key();
        let envelope = sample_envelope();
        let json = export::to_json(&envelope).unwrap();

        let parsed = export::auto_detect(&json).unwrap();
        let entries = export::to_env_entries(&parsed);
        let hash = crate::parser::content_hash(&entries);

        queries::insert_save(
            &mut conn,
            "/proj",
            &parsed.file,
            &parsed.branch,
            &parsed.commit,
            &parsed.timestamp,
            &hash,
            &entries,
            Some(&key),
        )
        .unwrap();

        // Verify we can decrypt.
        let saves = queries::list_saves(&conn, "/proj", None, None, 10, None).unwrap();
        let loaded = queries::get_save_entries(&conn, saves[0].id, Some(&key)).unwrap();
        assert_eq!(loaded.len(), 2);
        assert_eq!(loaded[0].key, "DB_HOST");
        assert_eq!(loaded[0].value, "localhost");
    }

    #[test]
    fn pipe_simulation_json() {
        let mut conn = test_conn();
        let entries = sample_entries();

        // Save.
        queries::insert_save(
            &mut conn,
            "/proj",
            ".env",
            "main",
            "abc",
            "2024-06-17T12:00:00Z",
            "h1",
            &entries,
            None,
        )
        .unwrap();

        // Share (simulate).
        let saves = queries::list_saves(&conn, "/proj", Some("main"), None, 1, None).unwrap();
        let loaded = queries::get_save_entries(&conn, saves[0].id, None).unwrap();
        let envelope = export::build_envelope(&saves[0], &loaded);
        let shared = export::to_json(&envelope).unwrap();

        // Import (simulate pipe: parse the shared output).
        let parsed = export::auto_detect(&shared).unwrap();
        let imported_entries = export::to_env_entries(&parsed);
        let hash = crate::parser::content_hash(&imported_entries);

        queries::insert_save(
            &mut conn,
            "/proj2",
            &parsed.file,
            &parsed.branch,
            &parsed.commit,
            &parsed.timestamp,
            &hash,
            &imported_entries,
            None,
        )
        .unwrap();

        // Verify.
        let proj2_saves = queries::list_saves(&conn, "/proj2", None, None, 10, None).unwrap();
        assert_eq!(proj2_saves.len(), 1);
        let proj2_entries = queries::get_save_entries(&conn, proj2_saves[0].id, None).unwrap();
        assert_eq!(proj2_entries, entries);
    }

    #[test]
    fn pipe_simulation_text() {
        let mut conn = test_conn();
        let entries = sample_entries();

        queries::insert_save(
            &mut conn,
            "/proj",
            ".env",
            "dev",
            "def",
            "2024-06-17T12:00:00Z",
            "h2",
            &entries,
            None,
        )
        .unwrap();

        let saves = queries::list_saves(&conn, "/proj", Some("dev"), None, 1, None).unwrap();
        let loaded = queries::get_save_entries(&conn, saves[0].id, None).unwrap();
        let envelope = export::build_envelope(&saves[0], &loaded);
        let shared = export::to_text(&envelope);

        let parsed = export::auto_detect(&shared).unwrap();
        let imported_entries = export::to_env_entries(&parsed);
        let hash = crate::parser::content_hash(&imported_entries);

        queries::insert_save(
            &mut conn,
            "/proj2",
            &parsed.file,
            &parsed.branch,
            &parsed.commit,
            &parsed.timestamp,
            &hash,
            &imported_entries,
            None,
        )
        .unwrap();

        let proj2_saves = queries::list_saves(&conn, "/proj2", None, None, 10, None).unwrap();
        assert_eq!(proj2_saves.len(), 1);
        let proj2_entries = queries::get_save_entries(&conn, proj2_saves[0].id, None).unwrap();
        assert_eq!(proj2_entries, entries);
    }

    // ----- Transport encryption import tests -----

    #[test]
    fn import_auto_detects_plaintext() {
        let envelope = sample_envelope();
        let json = export::to_json(&envelope).unwrap();
        let raw_bytes = json.as_bytes();

        // detect should return None (plaintext).
        assert_eq!(
            transport::detect(raw_bytes),
            transport::TransportEncryption::None,
        );

        // decrypt_auto should return as-is.
        let decrypted = transport::decrypt_auto(raw_bytes, None).unwrap();
        assert_eq!(decrypted, raw_bytes);

        // Parse should work.
        let text = std::str::from_utf8(&decrypted).unwrap();
        let parsed = export::auto_detect(text).unwrap();
        assert_eq!(parsed.entries.len(), 2);
    }

    #[test]
    fn import_auto_detects_password_encrypted() {
        let envelope = sample_envelope();
        let json = export::to_json(&envelope).unwrap();
        let encrypted = transport::encrypt_password(json.as_bytes(), "import-pw").unwrap();

        // detect should return Password.
        assert_eq!(
            transport::detect(&encrypted),
            transport::TransportEncryption::Password,
        );

        // decrypt_auto with correct password should work.
        let decrypted = transport::decrypt_auto(&encrypted, Some("import-pw")).unwrap();
        let text = std::str::from_utf8(&decrypted).unwrap();
        let parsed = export::auto_detect(text).unwrap();
        assert_eq!(parsed.entries.len(), 2);
        assert_eq!(parsed.branch, "main");
    }

    #[test]
    fn import_password_encrypted_wrong_password_fails() {
        let envelope = sample_envelope();
        let json = export::to_json(&envelope).unwrap();
        let encrypted = transport::encrypt_password(json.as_bytes(), "correct").unwrap();

        let result = transport::decrypt_auto(&encrypted, Some("wrong"));
        assert!(result.is_err());
    }

    #[test]
    fn import_password_encrypted_no_password_fails() {
        let envelope = sample_envelope();
        let json = export::to_json(&envelope).unwrap();
        let encrypted = transport::encrypt_password(json.as_bytes(), "pw").unwrap();

        let result = transport::decrypt_auto(&encrypted, None);
        assert!(result.is_err());
    }

    #[test]
    fn full_encrypted_share_import_round_trip() {
        let mut conn = test_conn();
        let entries = sample_entries();

        // Save to store.
        queries::insert_save(
            &mut conn,
            "/proj",
            ".env",
            "main",
            "abc",
            "2024-06-17T12:00:00Z",
            "h1",
            &entries,
            None,
        )
        .unwrap();

        // Share with password encryption.
        let saves = queries::list_saves(&conn, "/proj", Some("main"), None, 1, None).unwrap();
        let loaded = queries::get_save_entries(&conn, saves[0].id, None).unwrap();
        let envelope = export::build_envelope(&saves[0], &loaded);
        let serialized = export::to_json(&envelope).unwrap();
        let encrypted = transport::encrypt_password(serialized.as_bytes(), "roundtrip-pw").unwrap();

        // Import: decrypt and parse.
        let decrypted = transport::decrypt_auto(&encrypted, Some("roundtrip-pw")).unwrap();
        let text = std::str::from_utf8(&decrypted).unwrap();
        let parsed = export::auto_detect(text).unwrap();
        let imported_entries = export::to_env_entries(&parsed);
        let hash = crate::parser::content_hash(&imported_entries);

        queries::insert_save(
            &mut conn,
            "/proj2",
            &parsed.file,
            &parsed.branch,
            &parsed.commit,
            &parsed.timestamp,
            &hash,
            &imported_entries,
            None,
        )
        .unwrap();

        // Verify round-trip.
        let proj2_saves = queries::list_saves(&conn, "/proj2", None, None, 10, None).unwrap();
        assert_eq!(proj2_saves.len(), 1);
        let proj2_entries = queries::get_save_entries(&conn, proj2_saves[0].id, None).unwrap();
        assert_eq!(proj2_entries, entries);
    }

    #[test]
    fn full_encrypted_text_format_round_trip() {
        let mut conn = test_conn();
        let entries = sample_entries();

        queries::insert_save(
            &mut conn,
            "/proj",
            ".env",
            "dev",
            "def",
            "2024-06-17T12:00:00Z",
            "h2",
            &entries,
            None,
        )
        .unwrap();

        // Share as text with password encryption.
        let saves = queries::list_saves(&conn, "/proj", Some("dev"), None, 1, None).unwrap();
        let loaded = queries::get_save_entries(&conn, saves[0].id, None).unwrap();
        let envelope = export::build_envelope(&saves[0], &loaded);
        let serialized = export::to_text(&envelope);
        let encrypted = transport::encrypt_password(serialized.as_bytes(), "text-rt").unwrap();

        // Import.
        let decrypted = transport::decrypt_auto(&encrypted, Some("text-rt")).unwrap();
        let text = std::str::from_utf8(&decrypted).unwrap();
        let parsed = export::auto_detect(text).unwrap();
        let imported_entries = export::to_env_entries(&parsed);
        let hash = crate::parser::content_hash(&imported_entries);

        queries::insert_save(
            &mut conn,
            "/proj2",
            &parsed.file,
            &parsed.branch,
            &parsed.commit,
            &parsed.timestamp,
            &hash,
            &imported_entries,
            None,
        )
        .unwrap();

        let proj2_saves = queries::list_saves(&conn, "/proj2", None, None, 10, None).unwrap();
        let proj2_entries = queries::get_save_entries(&conn, proj2_saves[0].id, None).unwrap();
        assert_eq!(proj2_entries, entries);
    }

    // ----- Path traversal rejection -----

    #[test]
    fn import_rejects_path_traversal() {
        use super::super::apply::has_path_traversal;

        assert!(has_path_traversal("../../.bashrc"));
        assert!(has_path_traversal("../secret"));
        assert!(has_path_traversal("apps/../../.bashrc"));
        assert!(!has_path_traversal(".env"));
        assert!(!has_path_traversal("apps/backend/.env"));
    }

    // ----- Import preserves message -----

    #[test]
    fn import_preserves_message_json() {
        let mut conn = test_conn();
        let mut envelope = sample_envelope();
        envelope.message = Some("important config".to_string());
        let json = export::to_json(&envelope).unwrap();

        let parsed = export::auto_detect(&json).unwrap();
        assert_eq!(parsed.message.as_deref(), Some("important config"));

        let entries = export::to_env_entries(&parsed);
        let hash = crate::parser::content_hash(&entries);

        queries::insert_save_with_message(
            &mut conn,
            "/proj",
            &parsed.file,
            &parsed.branch,
            &parsed.commit,
            &parsed.timestamp,
            &hash,
            &entries,
            None,
            parsed.message.as_deref(),
        )
        .unwrap();

        let saves = queries::list_saves(&conn, "/proj", None, None, 10, None).unwrap();
        assert_eq!(saves[0].message.as_deref(), Some("important config"));
    }

    #[test]
    fn import_preserves_message_text() {
        let mut conn = test_conn();
        let mut envelope = sample_envelope();
        envelope.message = Some("text format message".to_string());
        let text = export::to_text(&envelope);

        let parsed = export::auto_detect(&text).unwrap();
        assert_eq!(parsed.message.as_deref(), Some("text format message"));

        let entries = export::to_env_entries(&parsed);
        let hash = crate::parser::content_hash(&entries);

        queries::insert_save_with_message(
            &mut conn,
            "/proj",
            &parsed.file,
            &parsed.branch,
            &parsed.commit,
            &parsed.timestamp,
            &hash,
            &entries,
            None,
            parsed.message.as_deref(),
        )
        .unwrap();

        let saves = queries::list_saves(&conn, "/proj", None, None, 10, None).unwrap();
        assert_eq!(saves[0].message.as_deref(), Some("text format message"));
    }
}