Files
trufflehog/pkg/handlers/arhandler.go

97 lines
2.5 KiB
Go

package handlers
import (
"context"
"errors"
"fmt"
"io"
"time"
"pault.ag/go/debian/deb"
logContext "github.com/trufflesecurity/trufflehog/v3/pkg/context"
)
// arHandler specializes defaultHandler to handle AR archive formats. By embedding defaultHandler,
// arHandler inherits and can further customize the common handling behavior such as skipping binaries.
type arHandler struct {
*defaultHandler
metrics *metrics
}
// newARHandler creates an arHandler with the provided metrics.
func newARHandler() *arHandler {
return &arHandler{
defaultHandler: newDefaultHandler(arHandlerType),
metrics: newHandlerMetrics(arHandlerType),
}
}
// HandleFile processes AR formatted files. This function needs to be implemented to extract or
// manage data from AR files according to specific requirements.
func (h *arHandler) HandleFile(ctx logContext.Context, input readSeekCloser) (chan []byte, error) {
archiveChan := make(chan []byte, defaultBufferSize)
go func() {
ctx, cancel := logContext.WithTimeout(ctx, maxTimeout)
defer cancel()
defer close(archiveChan)
// Update the metrics for the file processing.
var err error
defer func(start time.Time) {
if err != nil {
h.metrics.incErrors()
if errors.Is(err, context.DeadlineExceeded) {
h.metrics.incFileProcessingTimeouts()
}
return
}
h.metrics.observeHandleFileLatency(time.Since(start).Milliseconds())
}(time.Now())
var arReader *deb.Ar
arReader, err = deb.LoadAr(input)
if err != nil {
ctx.Logger().Error(err, "error reading AR")
return
}
if err = h.processARFiles(ctx, arReader, archiveChan); err != nil {
ctx.Logger().Error(err, "error processing AR files")
}
}()
return archiveChan, nil
}
func (h *arHandler) processARFiles(ctx logContext.Context, reader *deb.Ar, archiveChan chan []byte) error {
for {
select {
case <-ctx.Done():
return ctx.Err()
default:
arEntry, err := reader.Next()
if err != nil {
if errors.Is(err, io.EOF) {
ctx.Logger().V(3).Info("AR archive fully processed")
return nil
}
return fmt.Errorf("error reading AR payload: %w", err)
}
fileSize := arEntry.Size
fileCtx := logContext.WithValues(ctx, "filename", arEntry.Name, "size", fileSize)
if err := h.handleNonArchiveContent(fileCtx, arEntry.Data, archiveChan); err != nil {
fileCtx.Logger().Error(err, "error handling archive content in AR")
h.metrics.incErrors()
}
h.metrics.incFilesProcessed()
h.metrics.observeFileSize(fileSize)
}
}
}