ferrosift-cli 0.1.0-alpha.1

Native command-line interface for FerroSift
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

//! Bounded execution through the real CLI process.

use std::fs;

mod support;

const NATIVE_BASE64_ROUND_TRIP: &str = r#"{
  "schema_version": 1,
  "steps": [
    {
      "id": "encode",
      "operation": "encoding.base64.encode@1",
      "arguments": {},
      "disabled": false,
      "breakpoint": false
    },
    {
      "id": "decode",
      "operation": "encoding.base64.decode@1",
      "arguments": {},
      "disabled": false,
      "breakpoint": false
    }
  ],
  "metadata": {}
}"#;

#[test]
fn run_transforms_standard_input_to_raw_standard_output() {
    let directory = support::TempDir::new("run-stdio");
    let recipe = directory.write("recipe.json", r#"[{"op":"To Hex","args":["Space",0]}]"#);
    let output = support::run(
        &[
            "run",
            "--format",
            "cyberchef-v11.3",
            "--input-kind",
            "bytes",
            "--recipe",
            support::path_text(&recipe),
            "--input",
            "-",
        ],
        b"Ferro",
    );

    assert!(output.status.success(), "{}", support::stderr(&output));
    assert_eq!(output.stdout, b"46 65 72 72 6f");
    assert!(output.stderr.is_empty());
}

#[test]
fn run_writes_a_completed_native_recipe_to_the_requested_file() {
    let directory = support::TempDir::new("run-file");
    let recipe = directory.write("recipe.json", NATIVE_BASE64_ROUND_TRIP);
    let input = directory.write("input.bin", [0x00, 0x46, 0xff, 0x10]);
    let result = directory.path("result.bin");
    let output = support::run(
        &[
            "run",
            "--format",
            "ferrosift",
            "--input-kind",
            "bytes",
            "--recipe",
            support::path_text(&recipe),
            "--input",
            support::path_text(&input),
            "--output",
            support::path_text(&result),
        ],
        b"",
    );

    assert!(output.status.success(), "{}", support::stderr(&output));
    assert!(output.stdout.is_empty());
    assert_eq!(
        fs::read(result).expect("result must exist"),
        [0x00, 0x46, 0xff, 0x10]
    );
}

#[test]
fn run_rejects_ambiguous_stdin_and_invalid_utf8() {
    let output = support::run(
        &[
            "run",
            "--format",
            "ferrosift",
            "--input-kind",
            "bytes",
            "--recipe",
            "-",
            "--input",
            "-",
        ],
        b"",
    );
    assert!(!output.status.success());
    assert!(
        support::stderr(&output).contains("cli.io.stdin_conflict"),
        "{}",
        support::stderr(&output)
    );

    let directory = support::TempDir::new("run-utf8");
    let recipe = directory.write(
        "recipe.json",
        r#"[{"op":"From Base64","args":["A-Za-z0-9+/=",true,false]}]"#,
    );
    let output = support::run(
        &[
            "run",
            "--format",
            "cyberchef-v11.3",
            "--input-kind",
            "text",
            "--recipe",
            support::path_text(&recipe),
            "--input",
            "-",
        ],
        &[0xff],
    );
    assert!(!output.status.success());
    assert!(output.stdout.is_empty());
    assert!(
        support::stderr(&output).contains("cli.input.invalid_utf8"),
        "{}",
        support::stderr(&output)
    );
}

#[test]
fn run_does_not_create_output_when_a_breakpoint_pauses_execution() {
    let directory = support::TempDir::new("run-pause");
    let recipe = directory.write(
        "recipe.json",
        r#"{
          "schema_version": 1,
          "steps": [{
            "id": "pause",
            "operation": "encoding.hex.encode@1",
            "arguments": {},
            "disabled": false,
            "breakpoint": true
          }],
          "metadata": {}
        }"#,
    );
    let result = directory.path("must-not-exist.bin");
    let output = support::run(
        &[
            "run",
            "--format",
            "ferrosift",
            "--input-kind",
            "bytes",
            "--recipe",
            support::path_text(&recipe),
            "--input",
            "-",
            "--output",
            support::path_text(&result),
        ],
        b"data",
    );

    assert!(!output.status.success());
    assert!(
        support::stderr(&output).contains("cli.execution.paused"),
        "{}",
        support::stderr(&output)
    );
    assert!(!result.exists());
}