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

Make archive handler configurable #1077

Merged
merged 2 commits into from
Feb 7, 2023
Merged

Make archive handler configurable #1077

merged 2 commits into from
Feb 7, 2023

Conversation

bill-rich
Copy link
Collaborator

Went with making vars in the handler package rather than a configuration that is passed along because of the awkwardness of A) passing the settings through each source type that can scan files, and B) the way handlers are set up to be self-contained units that implement the Handler interface.

Also included handling canceled contexts so we can use timeouts along with max size or depth. This will allow us to up the max size without letting extraction time get out of control.

@bill-rich bill-rich requested a review from a team as a code owner February 7, 2023 00:58
Copy link
Collaborator

@mcastorina mcastorina left a comment

Choose a reason for hiding this comment

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

Nice! If it's not time-consuming, could we add a test for timing out? Otherwise lgtm

Comment on lines 175 to 195
select {
case <-ctx.Done():
return nil, ctx.Err()
default:
fileChunk := make([]byte, 512)
bRead, err := reader.Read(fileChunk)
if err != nil && !errors.Is(err, io.EOF) {
return []byte{}, err
}
d.size += bRead
if len(fileChunk) > 0 {
fileContent.Write(fileChunk[0:bRead])
}
if bRead < 512 {
return fileContent.Bytes(), nil
}
if d.size >= maxSize && bRead == 512 {
log.Debug("Max archive size reached.")
return fileContent.Bytes(), nil
}
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nit (optional): I think we can use common.IsDone(ctx) at the start of the loop and remove the select. That could help de-indent the body.

@bill-rich bill-rich merged commit 7dd2b74 into main Feb 7, 2023
@bill-rich bill-rich deleted the archive_handler_flags branch February 7, 2023 23:25
javajawa added a commit to mewbotorg/mewbot that referenced this pull request Feb 12, 2023
Sourced from trufflesecurity/trufflehog's releases.

v3.27.0
What's Changed
Bump golang.org/x/oauth2 from 0.3.0 to 0.4.0 by @​dependabot in trufflesecurity/trufflehog#1039
add bodyclose linter to help prevent file handle leaks by @​dustin-decker in trufflesecurity/trufflehog#1048
braintree detector: use production API URL instead of the test sandbo… by @​swdbo in trufflesecurity/trufflehog#1054
Update float detector with correct User-Agent and regex by @​ahrav in trufflesecurity/trufflehog#1061
update webex detector regex by @​ahrav in trufflesecurity/trufflehog#1062
Handle errors in a thread safe manner by @​ahrav in trufflesecurity/trufflehog#1052
Add TruffleHog version input for GitHub action by @​mcastorina in trufflesecurity/trufflehog#1064
Revert "Add TruffleHog version input for GitHub action (#1064)" by @​mcastorina in trufflesecurity/trufflehog#1068
Pull gitparse config options out of pkg consts by @​bill-rich in trufflesecurity/trufflehog#1072
Add include exclude spaces for confluence source. by @​ahrav in trufflesecurity/trufflehog#1073
Add max commit size by @​bill-rich in trufflesecurity/trufflehog#1079
Make archive handler configurable by @​bill-rich in trufflesecurity/trufflehog#1077
[chore] - Add tests for errors by @​ahrav in trufflesecurity/trufflehog#1071
Skip repo and continue scanning when encountering an error by @​mcastorina in trufflesecurity/trufflehog#1080
[chore] - Dont pre-allocate errors slice by @​ahrav in trufflesecurity/trufflehog#1083
Add Type() to detector interface by @​trufflesteeeve in trufflesecurity/trufflehog#1088
[chore] Remove logrus from engine package by @​mcastorina in trufflesecurity/trufflehog#1085
[chore] Remove logrus from github source by @​mcastorina in trufflesecurity/trufflehog#1086
Bump github.com/joho/godotenv from 1.4.0 to 1.5.1 by @​dependabot in trufflesecurity/trufflehog#1075
[chore] Remove logrus from circleci, filesystem, gitlab, and s3 sources by @​mcastorina in trufflesecurity/trufflehog#1089
[chore] - Remove monolithic config struct by @​ahrav in trufflesecurity/trufflehog#1091
Make detectors configurable by @​ahrav in trufflesecurity/trufflehog#1084
New Contributors
@​swdbo made their first contribution in trufflesecurity/trufflehog#1054
Full Changelog: trufflesecurity/trufflehog@v3.26.0...v3.27.0

v3.26.0
What's Changed
Add openssh-client to trufflehog container by @​mcastorina in trufflesecurity/trufflehog#1045
Bump github.com/rabbitmq/amqp091-go from 1.5.0 to 1.6.0 by @​dependabot in trufflesecurity/trufflehog#1036
filesystem support for exclude and include filters (2nd attemp) by @​mac2000 in trufflesecurity/trufflehog#1033
Fix the typo "programatic" by @​nezakoo in trufflesecurity/trufflehog#1046
Add file to confluence proto. by @​ahrav in trufflesecurity/trufflehog#1049
Remove false positive detection for CustomRegex by @​mcastorina in trufflesecurity/trufflehog#1050
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants