Add File.target validation and escaping
#222
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change adds these in `files.ncl`:
- `File.target` validation with `ValidTarget`,
- `File.target` shell-escaping in `regenerate_one`.
Before this change, the `files` field has `File` with possibly
pathological `target | String`, e.g.:
- Empty target, i.e., `""`,
- Absolute target, e.g., `"/etc/passwd"`,
- Parent traversals, e.g,. `"../../../../../../../etc/passwd"`.
This change adds `ValidTarget`, such that `File.target | ValidTarget`
has no such cases.
Also, in `regenerate_one`, we add `shell_escape` to `file_descr.target`:
```
nix-s%"regenerate_function "%{copy_command}" "%{file_descr.file}" "%{shell_escape file_descr.target}""%
```
This correctly handles paths with characters such as `"`, `'`, `*`, `\`,
`\n` (newline), `\t` (tabs).
Chan-Siu-Man
force-pushed
the
add-file-target-validation
branch
from
970fa89
to
c4cfe48
Compare
yannham
reviewed
Oct 25, 2024
Chan-Siu-Man
force-pushed
the
add-file-target-validation
branch
2 times, most recently
from
f21c7e7
to
2c6314d
Compare
This change addresses [the code review](https://github.com/nickel-lang/organist/pull/222/files/c4cfe488040f5630dfe78104f5648d506e9d334b): - Use `$'…'` (dollar-sign with *single*-quotes) instead of `"…"` (*double*-quotes) for escape shell argument (`file.target`) in `regenerate_one`, to handle paths with characters such as `"`, `'`, `*`, `\`, `\n` (newline), `\t` (tab), `$`. - Rename `NoTraveral` to `NoParentTraveral` for more accurate naming. - Rewrite implementations of contracts `RelativePath` and `NoParentTraveral` in idiomatic nickel.
Chan-Siu-Man
force-pushed
the
add-file-target-validation
branch
from
2c6314d
to
6d80d90
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change adds these in
files.ncl:File.targetvalidation withstd.string.NonEmpty,RelativePath,NoParentTraversal,File.targetshell-escaping inregenerate_one.Before this change, the
filesfield hasFilewith possibly pathologicaltarget | String, e.g.:"","/etc/passwd","../../../../../../../etc/passwd".This change adds schemas to eliminate such cases.
Also, in
regenerate_one, we addshell_escapetofile_descr.target:By quoting with
$'…'(dollar-sign and single-quotes) instead of"…"(double-quotes), this correctly handles paths with characters such as",',*,\,\n(newline),\t(tabs),$.