Skip to content
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

Jump to bottom

Fix external library path validation #8319 #8366

Merged
merged 8 commits into from
Mar 31, 2024
Merged

Fix external library path validation #8319 #8366

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6f92c95
Fix isImmichPath
pablodre Mar 29, 2024
2121234
prettier write
pablodre Mar 29, 2024
162eda2
Fis isImmichPath code comment
pablodre Mar 29, 2024
cdff02a
Refactor isImmichPath function based on team suggestions
pablodre Mar 30, 2024
19d1af9
Test isImmichPath
pablodre Mar 30, 2024
ac1b645
fix: clean comments
pablodre Mar 30, 2024
014ef1d
Refactor isImmichPath test based on team suggestions
pablodre Mar 31, 2024
0d550c9
Clean code with lintern suggestions
pablodre Mar 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 5 additions & 1 deletion server/src/cores/storage.core.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,11 @@ export class StorageCore {
}

static isImmichPath(path: string) {
return resolve(path) === resolve(APP_MEDIA_LOCATION);
const normalizedPath = resolve(path).endsWith('/') ? resolve(path) : `${resolve(path)}/`;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am very certain resolve() will always return a path without a trailing slash

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm also not sure if it's necessary to add a slash to that path anyways?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least the official docs https://nodejs.org/api/path.html#pathresolvepaths seem to imply this. Or are you aware of a scenario where that isn't the case?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think / is the exception where we wouldn't want to add a forward slash.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm also not sure if it's necessary to add a slash to that path anyways?

If we don't we run into the issue we're currently experiencing; /foo-bar starts with /foo, even though both are different folders and /foo is the media location

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But we need to resolve the media location as that can also be a relative path, right? @bo0tzz

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Making sure both paths are in the same format before you compare them is a smart move.
What is the final decision?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably yes. I think the best way forward would be to create some unit tests for this that spell out all the different paths.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Making sure both paths are in the same format before you compare them is a smart move. What is the final decision?

After all this discussion I think what you currently have is the best (as in most resilient). However, I would like to hear the others chime in as well :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a long discussion about how it might or might not work, but at the end of the day we should definitely just add a few unit tests for the situations we're worried about and make sure it is handling them correctly. The easiest one would just be /photos_old and /photos

const normalizedAppMediaLocation = resolve(APP_MEDIA_LOCATION).endsWith('/')
? resolve(APP_MEDIA_LOCATION)
: `${resolve(APP_MEDIA_LOCATION)}/`;
return normalizedPath.startsWith(normalizedAppMediaLocation);
}

static isGeneratedAsset(path: string) {
Expand Down