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.

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

Fix external library path validation #8319 #8366

Merged

Conversation

pablodre
Copy link
Contributor

Hi its my first PR here, i chose a easy one
This is the fix for this the issue #8319

Copy link
Member

@danieldietzler danieldietzler left a comment

Choose a reason for hiding this comment

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

I don't think === is what we want. If your APP_MEDIA_LOCATION is /foo, /foo/bar should be an immich path. However, this is not given with this change.

@mertalev
Copy link
Contributor

mertalev commented Mar 29, 2024

I think the right change here would be to still use startsWith, but make sure both paths have a trailing forward slash at the end.

@pablodre
Copy link
Contributor Author

@danieldietzler @mertalev Thank you very much, both of you are right and I was wrong, fixed.

@@ -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

@mertalev
Copy link
Contributor

I think this approach is good. Could you move the resolved paths to separate variables before doing the string concatenation? It would be cleaner. It would also be more expressive with + "/" rather than a string template.

Copy link
Member

@danieldietzler danieldietzler left a comment

Choose a reason for hiding this comment

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

Nice! Thanks a lot! :)

@alextran1502
Copy link
Contributor

Can we please add some tests for this method?

Copy link
Contributor

@mertalev mertalev left a comment

Choose a reason for hiding this comment

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

Thanks for working on this!

server/src/cores/storage.core.spec.ts Outdated Show resolved Hide resolved
@jrasm91 jrasm91 merged commit 6a4bc77 into immich-app:main Mar 31, 2024
23 checks passed
@kingvuke
Copy link

Awesome! Thanks a lot for the fast fixing

@pablodre pablodre deleted the fix/#8319-external-library-path-validation branch March 31, 2024 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants