Improve .gitmodules file handling in scan_content_warn - #1
Open
0xScratch wants to merge 1 commit into
Open
Conversation
This file contains hidden or 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
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.
While exploring coldclone, I ran into a weird
TypeErrorrelated to.gitmoduleswhen scanning a Sherlock audit repository (TARE). Here's the.gitmodulespresent in the repo:And when coldclone was run on this repo, I got the following error:
After digging in the issue, and checking the two main functions i.e.
_warn_gitmodulesandscan_content_warn, it turns out that the issue is related to some newline thing which even has a comment explaining why it's there:The issue is that,
Path.read_text()only accepts thenewlineparameter starting from Python 3.13, causing.gitmodulesscanning to fail with aTypeErroron Python 3.11 and 3.12, despite the project indicating support for Python >= 3.11.So I think a better approach is to use
Path.open(..., newline=""), which preserves the intended behaviour while remaining compatible with earlier supported python versions. The fixed code snippet looks like:This removes the
TypeErrorwhile preserving the intended newline behaviour. Additionally, just for precaution sake, I also checked whether this new fix doesn't break anything related to.gitmodulesby adding various weird urls. Thankfully, it doesn't and still gives warning for weird stuff!