CLI symlink fixes #12046
Open
CLI symlink fixes #12046
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
github-actions
bot
added
documentation
new-cli
edolstra
reviewed
Dec 13, 2024
Mic92
reviewed
Dec 13, 2024
edolstra
reviewed
Dec 13, 2024
|
@mergify rebase |
✅ Branch has been successfully rebased |
Mic92
force-pushed
the
cli-symlink-fixes
branch
from
6a91e0f to
e762825
Compare
roberth
force-pushed
the
cli-symlink-fixes
branch
from
e762825 to
8b53c6c
Compare
13 tasks
Mic92
reviewed
Dec 15, 2024
|
Tests seem to pass now. @roberth do you want to squash things a bit, so we can backport patches? |
roberth
force-pushed
the
cli-symlink-fixes
branch
from
abd9287 to
0c9be56
Compare
|
roberth
commented
Dec 16, 2024
Mic92
force-pushed
the
cli-symlink-fixes
branch
2 times, most recently
from
5b521cf to
12d4c8d
Compare
roberth
commented
Dec 16, 2024
src/libutil/posix-source-accessor.hh
Outdated
| * callers do not accidentally introduce symlink-related security vulnerabilities. | ||
| * Furthermore, `createAtRoot` does not know whether the file pointed to by | ||
| * `path` should be resolved if it is itself a symlink. In other words, | ||
| * `createAtRoot` can not decide between aforemention `canonical`, `makeParentCanonical`, etc. for its callers. |
There was a problem hiding this comment.
Suggested change
| * `createAtRoot` can not decide between aforemention `canonical`, `makeParentCanonical`, etc. for its callers. | |
| * `createAtRoot` can not decide between aforementioned `canonical`, `makeParentCanonical`, etc. for its callers. |
src/nix/hash.cc
Outdated
| @@ -87,18 +87,35 @@ struct CmdHashBase : Command | |||
| return std::make_unique<HashSink>(hashAlgo); | |||
| }; | |||
|
|
|||
| auto path2 = PosixSourceAccessor::createAtRoot(path); | |||
| auto makeSourcePath = [&]() -> SourcePath { | |||
| return PosixSourceAccessor::createAtRoot(std::filesystem::weakly_canonical(path)); | |||
There was a problem hiding this comment.
Suggested change
| return PosixSourceAccessor::createAtRoot(std::filesystem::weakly_canonical(path)); | |
| return PosixSourceAccessor::createAtRoot(makeParentCanonical(path)); |
Needs test!
src/nix/hash.cc
Outdated
| h = hashSink->finish().first; | ||
| break; | ||
| } | ||
| case FileIngestionMethod::Git: { | ||
| auto sourcePath = PosixSourceAccessor::createAtRoot(path); |
There was a problem hiding this comment.
Suggested change
| auto sourcePath = PosixSourceAccessor::createAtRoot(path); | |
| auto sourcePath = makeSourcePath(); |
| # nix hash --mode nar does not canonicalize a symlink argument. | ||
| # Otherwise it can't generate a NAR whose root is a symlink. | ||
| # If you want to follow the symlink, pass $(realpath -s ...) instead. | ||
| ln -s /non-existent-48cujwe8ndf4as0bne "$TEST_ROOT/symlink-to-nowhere" |
There was a problem hiding this comment.
Suggested change
| ln -s /non-existent-48cujwe8ndf4as0bne "$TEST_ROOT/symlink-to-nowhere" | |
| ln -s /non-existent-48cujwe8ndf4as0bne "$TEST_ROOT/symlink-to-nowhere" | |
| [[ -e /bin ]] # assumption | |
| ln -s /bin "$TEST_ROOT/symlink-to-bin" |
or something, do both.
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2024-12-16-nix-team-meeting-minutes-203/57483/1 |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2024-12-18-nix-team-meeting-minutes-204/57602/1 |
Tested with
nix run nix/2.3-maintenance#nix-store -- --add some_symlink
nix run nix/2.3-maintenance#nix-store -- --add-fixed sha256 --recursive some_symlink
roberth
force-pushed
the
cli-symlink-fixes
branch
from
12d4c8d to
518538b
Compare
|
Please undraft, if you need a new review. |
…makeParentCanonical I'd messed up a rebase in my previous iteration, causing `weakly_canonical` to reappear, but not trigger a test failure. These two functions behave similarly when the argument is a path that points to a broken symlink. `weakly_canonical` would not resolve it because the target doesn't exist, and `makeParentCanonical` would not resolve it, because it never resolves the final path element. This new test case now also tests a valid symlink, "differentiating" the two.
|
Thanks for the reminder. I was still adding a regression test, 73871f2 when I was interrupted (rudely ;) ) by the maintainer meeting today. |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2024-12-23-nix-team-meeting-minutes-205/57783/1 |
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.
Motivation
PosixSourceAccessordoes not operate on non-canonical paths, yet manycreateAtRootcalls did not canonicalize their inputs.See commit messages and comments for details.
Probably more
createAtRootcalls need this kind of treatment, but that's not a prerequisite for reviewing what's probably the bulk of the change, and the ideas behind it.Context
nix-store --add-fixedno longer accepts symlinks #11941error: path '/dev/fd/63' is a symlinkon Arch Linux #11681Add 👍 to pull requests you find important.
The Nix maintainer team uses a GitHub project board to schedule and track reviews.