fix: update README docs for shallow cloning #4137
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
Current example for using trufflehog in GitHub actions with shallow
cloning is unfortunately susceptible to a quoting injection.
Specifically, if any of the commits include the single quote mark, the
whole workflow terminates with a syntax error because the `jq` can no
longer calculate length of the commits array. In fact, `jq` is not even
launched because it's really bash waiting for the single quote to be
terminated when evaluating this expression:
```bash
$(jq length <<< '${{ toJson(github.event.commits) }}')
```
This can be triggered with an example commit message of `that's my
commit`. In such case, the `toJson()` produces something similar to
this:
```jsonc
[
{
"author": {
"email": "skrobul@skrobul.com",
"name": "Marek Skrobacki",
"username": "skrobul"
},
// ...
"id": "1743e414cff505efac7e38128974cfa39cd56332",
"message": "that's my commit",
"timestamp": "2025-05-13T10:33:04-05:00",
// ...
}
]
```
While technically the input here could be sanitized with additional
filtering, I believe using shell scripting for this is far from ideal.
My alternative proposal uses GitHub's native `github-script` which
offers slightly more safety and avoids shell escaping issues.
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Current example for using trufflehog in GitHub actions with shallow cloning is unfortunately susceptible to a quoting injection.
Specifically, if any of the commits include the single quote mark, the whole workflow terminates with a syntax error because the
jqcan no longer calculate length of the commits array. In fact,jqis not even launched because it's really bash waiting for the single quote to be terminated when evaluating this expression:$(jq length <<< '${{ toJson(github.event.commits) }}')This can be triggered with an example commit message of
that's my commit. In such case, thetoJson()produces something similar to this:[ { "author": { "email": "skrobul@skrobul.com", "name": "Marek Skrobacki", "username": "skrobul" }, // ... "id": "1743e414cff505efac7e38128974cfa39cd56332", "message": "that's my commit", "timestamp": "2025-05-13T10:33:04-05:00", // ... } ]While technically the input here could be sanitized with additional filtering, I believe using shell scripting for this is far from ideal.
My alternative proposal uses GitHub's native
github-scriptwhich offers slightly more safety and avoids shell escaping issues.