Skip to content

Properly escape ENV variables in generated Dockerfiles #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
talex5 merged 1 commit into from
Nov 30, 2021
Merged

Properly escape ENV variables in generated Dockerfiles #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion lib_spec/docker.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,20 @@ let pp_copy ~ctx f { Spec.from; src; dst; exclude = _ } =
Fmt.(list ~sep:sp string) src
dst

let quote ~escape v =
let len = String.length v in
let buf = Buffer.create len in
let j = ref 0 in
for i = 0 to len - 1 do
if v.[i] = '"' || v.[i] = escape then begin
if i - !j > 0 then Buffer.add_substring buf v !j (i - !j);
Buffer.add_char buf escape;
j := i
end
done;
Buffer.add_substring buf v !j (len - !j);
Buffer.contents buf

let pp_op ~buildkit ctx f : Spec.op -> ctx = function
| `Comment x -> Fmt.pf f "# %s" x; ctx
| `Workdir x -> Fmt.pf f "WORKDIR %s" x; ctx
Expand All @@ -66,7 +80,7 @@ let pp_op ~buildkit ctx f : Spec.op -> ctx = function
| `Run x -> pp_run ~ctx f { x with cache = []; secrets = []}; ctx
| `Copy x -> pp_copy ~ctx f x; ctx
| `User ({ uid; gid } as u) -> Fmt.pf f "USER %d:%d" uid gid; { user = u }
| `Env (k, v) -> Fmt.pf f "ENV %s %s" k v; ctx
| `Env (k, v) -> Fmt.pf f "ENV %s=\"%s\"" k (quote ~escape:'\\' v); ctx

let rec convert ~buildkit f (name, { Spec.child_builds; from; ops }) =
child_builds |> List.iter (fun (name, spec) ->
Expand Down
6 changes: 4 additions & 2 deletions test/test.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -502,7 +502,8 @@ let test_docker () =
command3
COPY a b c
COPY a b c
ENV DEBUG 1
ENV DEBUG="1"
ENV ESCAPE="\"quote\\sla\\sh\""
USER 1:2
COPY --chown=1:2 a b c
|} {|
Expand All @@ -519,6 +520,7 @@ let test_docker () =
(copy (src a b) (dst c))
(copy (src a b) (dst c) (exclude .git _build))
(env DEBUG 1)
(env ESCAPE "\"quote\\sla\\sh\"")
(user (uid 1) (gid 2))
(copy (src a b) (dst c))
) |};
Expand All @@ -531,7 +533,7 @@ let test_docker () =
RUN --mount=type=cache,id=a,target=/data,uid=0 --mount=type=cache,id=b,target=/srv,uid=0 command2
COPY a b c
COPY a b c
ENV DEBUG 1
ENV DEBUG="1"
USER 1:2
COPY --chown=1:2 a b c
|} {|
Expand Down