Files
trufflehog/pkg/detectors/weightsandbiases/base.go

136 lines
3.9 KiB
Go

package weightsandbiases
import (
"bytes"
"context"
"encoding/base64"
"encoding/json"
"fmt"
"io"
"net/http"
"strconv"
regexp "github.com/wasilibs/go-re2"
"github.com/trufflesecurity/trufflehog/v3/pkg/common"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors"
"github.com/trufflesecurity/trufflehog/v3/pkg/pb/detector_typepb"
)
// BaseScanner is a base struct embedded by versioned scanners. It holds the HTTP client and
// shared detection/verification logic.
type BaseScanner struct {
Client *http.Client
}
var defaultClient = common.SaneHttpClient()
// FromData finds and optionally verifies WeightsAndBiases secrets in data using the provided
// pattern. version is included in ExtraData of each result.
func (s BaseScanner) FromData(ctx context.Context, verify bool, data []byte, keyPat *regexp.Regexp, version int) ([]detectors.Result, error) {
dataStr := string(data)
uniqueMatches := make(map[string]struct{})
for _, match := range keyPat.FindAllStringSubmatch(dataStr, -1) {
uniqueMatches[match[1]] = struct{}{}
}
var results []detectors.Result
for match := range uniqueMatches {
r := detectors.Result{
DetectorType: detector_typepb.DetectorType_WeightsAndBiases,
Raw: []byte(match),
SecretParts: map[string]string{"key": match},
}
if verify {
isVerified, extraData, verificationErr := s.verifyMatch(ctx, match)
r.Verified = isVerified
r.ExtraData = extraData
r.SetVerificationError(verificationErr, match)
}
if r.ExtraData == nil {
r.ExtraData = make(map[string]string)
}
r.ExtraData["version"] = strconv.Itoa(version)
results = append(results, r)
}
return results, nil
}
type viewerResponse struct {
Data struct {
Viewer struct {
ID string `json:"id"`
Username string `json:"username"`
Email string `json:"email"`
Admin bool `json:"admin"`
} `json:"viewer"`
} `json:"data"`
}
// verifyMatch checks the credential against the W&B GraphQL /graphql endpoint using the viewer query,
// which requires no special permissions. A 200 with a non-empty username means the token is valid;
// 401 means invalid or revoked.
// Docs: https://docs.wandb.ai/ref/graphql
func (s BaseScanner) verifyMatch(ctx context.Context, token string) (bool, map[string]string, error) {
client := s.Client
if client == nil {
client = defaultClient
}
query := `{"query": "query Viewer { viewer { id username email admin } }"}`
const baseURL = "https://api.wandb.ai/graphql"
req, err := http.NewRequestWithContext(ctx, http.MethodPost, baseURL, bytes.NewBufferString(query))
if err != nil {
return false, nil, err
}
authHeader := base64.StdEncoding.EncodeToString([]byte("api:" + token))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Basic "+authHeader)
res, err := client.Do(req)
if err != nil {
return false, nil, err
}
defer func() {
_, _ = io.Copy(io.Discard, res.Body)
_ = res.Body.Close()
}()
switch res.StatusCode {
case http.StatusOK:
var viewerResp viewerResponse
if err := json.NewDecoder(res.Body).Decode(&viewerResp); err != nil {
return false, nil, err
}
// Only consider it verified if we got back a username.
if viewerResp.Data.Viewer.Username == "" {
return false, nil, nil
}
extraData := map[string]string{
"username": viewerResp.Data.Viewer.Username,
"email": viewerResp.Data.Viewer.Email,
"admin": strconv.FormatBool(viewerResp.Data.Viewer.Admin),
}
return true, extraData, nil
case http.StatusUnauthorized:
return false, nil, nil
default:
return false, nil, fmt.Errorf("unexpected HTTP response status %d", res.StatusCode)
}
}
func (s BaseScanner) Description() string {
return "Weights & Biases is a Machine Learning Operations (MLOps) platform that helps track experiments, version datasets, evaluate model performance, and collaborate with team members"
}
func (s BaseScanner) Type() detector_typepb.DetectorType {
return detector_typepb.DetectorType_WeightsAndBiases
}