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
|
const std = @import("std");
const testing = std.testing;
const Writer = std.Io.Writer;
/// Writer that escapes characters that shells treat specially to reduce the
/// risk of injection attacks or other such weirdness. Specifically excludes
/// linefeeds so that they can be used to delineate lists of file paths.
///
/// T should be a Zig type that follows the `std.Io.Writer` interface.
pub const ShellEscapeWriter = struct {
writer: Writer,
child: *Writer,
pub fn init(child: *Writer) ShellEscapeWriter {
return .{
.writer = .{
// TODO: Actually use a buffer here
.buffer = &.{},
.vtable = &.{ .drain = ShellEscapeWriter.drain },
},
.child = child,
};
}
fn drain(w: *Writer, data: []const []const u8, splat: usize) Writer.Error!usize {
const self: *ShellEscapeWriter = @fieldParentPtr("writer", w);
// TODO: This is a very naive implementation and does not really make
// full use of the post-Writergate API. However, since we know that
// this is going into an Allocating writer anyways, we can be a bit
// less strict here.
var count: usize = 0;
for (data[0 .. data.len - 1]) |chunk| try self.writeEscaped(chunk, &count);
for (0..splat) |_| try self.writeEscaped(data[data.len], &count);
return count;
}
fn writeEscaped(
self: *ShellEscapeWriter,
s: []const u8,
count: *usize,
) Writer.Error!void {
for (s) |byte| {
const buf = switch (byte) {
'\\',
'"',
'\'',
'$',
'`',
'*',
'?',
' ',
'|',
'(',
')',
=> &[_]u8{ '\\', byte },
else => &[_]u8{byte},
};
try self.child.writeAll(buf);
count.* += 1;
}
}
};
test "shell escape 1" {
var buf: [128]u8 = undefined;
var writer: std.Io.Writer = .fixed(&buf);
var shell: ShellEscapeWriter = .{ .child_writer = &writer };
try shell.writer.writeAll("abc");
try testing.expectEqualStrings("abc", writer.buffered());
}
test "shell escape 2" {
var buf: [128]u8 = undefined;
var writer: std.Io.Writer = .fixed(&buf);
var shell: ShellEscapeWriter = .{ .child_writer = &writer };
try shell.writer.writeAll("a c");
try testing.expectEqualStrings("a\\ c", writer.buffered());
}
test "shell escape 3" {
var buf: [128]u8 = undefined;
var writer: std.Io.Writer = .fixed(&buf);
var shell: ShellEscapeWriter = .{ .child_writer = &writer };
try shell.writer.writeAll("a?c");
try testing.expectEqualStrings("a\\?c", writer.buffered());
}
test "shell escape 4" {
var buf: [128]u8 = undefined;
var writer: std.Io.Writer = .fixed(&buf);
var shell: ShellEscapeWriter = .{ .child_writer = &writer };
try shell.writer.writeAll("a\\c");
try testing.expectEqualStrings("a\\\\c", writer.buffered());
}
test "shell escape 5" {
var buf: [128]u8 = undefined;
var writer: std.Io.Writer = .fixed(&buf);
var shell: ShellEscapeWriter = .{ .child_writer = &writer };
try shell.writer.writeAll("a|c");
try testing.expectEqualStrings("a\\|c", writer.buffered());
}
test "shell escape 6" {
var buf: [128]u8 = undefined;
var writer: std.Io.Writer = .fixed(&buf);
var shell: ShellEscapeWriter = .{ .child_writer = &writer };
try shell.writer.writeAll("a\"c");
try testing.expectEqualStrings("a\\\"c", writer.buffered());
}
test "shell escape 7" {
var buf: [128]u8 = undefined;
var writer: std.Io.Writer = .fixed(&buf);
var shell: ShellEscapeWriter = .{ .child_writer = &writer };
try shell.writer.writeAll("a(1)");
try testing.expectEqualStrings("a\\(1\\)", writer.buffered());
}
|
