* feat: add OpenRouter detector closes #4499 * refactor: correct doc comment referencing OpenAI to OpenRouter * refactor: remove unnecessary `AnalysisInfo` field * fix: data field types Signed-off-by: Luc Georges <[email protected]> * fix: handle float fmt correctly Signed-off-by: Luc Georges <[email protected]> * fix detector type add feature flag for openrouter detector * fix integration tests --------- Signed-off-by: Luc Georges <[email protected]> Co-authored-by: Shahzad Haider <[email protected]> Co-authored-by: Shahzad Haider <[email protected]> Co-authored-by: Muneeb Ullah Khan <[email protected]>
139 lines
3.6 KiB
Go
139 lines
3.6 KiB
Go
package openrouter
|
|
|
|
import (
|
|
"context"
|
|
"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"
|
|
)
|
|
|
|
type Scanner struct {
|
|
client *http.Client
|
|
}
|
|
|
|
// Ensure the Scanner satisfies the interface at compile time.
|
|
var _ detectors.Detector = (*Scanner)(nil)
|
|
|
|
var (
|
|
defaultClient = common.SaneHttpClient()
|
|
|
|
keyPat = regexp.MustCompile(`\b(sk-or-v1-[0-9a-f]{64})\b`)
|
|
)
|
|
|
|
// Keywords are used for efficiently pre-filtering chunks.
|
|
// Use identifiers in the secret preferably, or the provider name.
|
|
func (s Scanner) Keywords() []string {
|
|
return []string{"sk-or-v1-"}
|
|
}
|
|
|
|
// FromData will find and optionally verify OpenRouter secrets in a given set of bytes.
|
|
func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (results []detectors.Result, err error) {
|
|
dataStr := string(data)
|
|
|
|
uniqueMatches := make(map[string]struct{})
|
|
for _, match := range keyPat.FindAllStringSubmatch(dataStr, -1) {
|
|
uniqueMatches[match[1]] = struct{}{}
|
|
}
|
|
|
|
for token := range uniqueMatches {
|
|
s1 := detectors.Result{
|
|
DetectorType: s.Type(),
|
|
// NOTE: we redact the same way it is done in the `Label` field
|
|
Redacted: token[:12] + "..." + token[70:],
|
|
Raw: []byte(token),
|
|
SecretParts: map[string]string{"key": token},
|
|
}
|
|
|
|
if verify {
|
|
client := s.client
|
|
if client == nil {
|
|
client = defaultClient
|
|
}
|
|
|
|
verified, extraData, verificationErr := verifyToken(ctx, client, token)
|
|
s1.Verified = verified
|
|
s1.ExtraData = extraData
|
|
s1.SetVerificationError(verificationErr)
|
|
}
|
|
|
|
results = append(results, s1)
|
|
}
|
|
|
|
return results, err
|
|
}
|
|
|
|
func verifyToken(ctx context.Context, client *http.Client, token string) (bool, map[string]string, error) {
|
|
req, err := http.NewRequestWithContext(ctx, "GET", "https://openrouter.ai/api/v1/key", nil)
|
|
if err != nil {
|
|
return false, nil, err
|
|
}
|
|
|
|
req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", token))
|
|
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 keyResponse keyResponse
|
|
if err = json.NewDecoder(res.Body).Decode(&keyResponse); err != nil {
|
|
return false, nil, err
|
|
}
|
|
|
|
key := keyResponse.Data
|
|
extraData := map[string]string{
|
|
"label": key.Label,
|
|
"limit": fmtFloatPtr(key.Limit),
|
|
"usage": fmt.Sprintf("%f", key.Usage),
|
|
"is_free_tier": strconv.FormatBool(key.IsFreeTier),
|
|
"limit_remaining": fmtFloatPtr(key.LimitRemaining),
|
|
}
|
|
return true, extraData, nil
|
|
case http.StatusUnauthorized:
|
|
// Invalid
|
|
return false, nil, nil
|
|
default:
|
|
return false, nil, fmt.Errorf("unexpected HTTP response status %d", res.StatusCode)
|
|
}
|
|
}
|
|
|
|
func (s Scanner) Type() detector_typepb.DetectorType {
|
|
return detector_typepb.DetectorType_OpenRouter
|
|
}
|
|
|
|
func (s Scanner) Description() string {
|
|
return "OpenRouter provides a unified API that gives you access to hundreds of AI models through a single endpoint, while automatically handling fallbacks and selecting the most cost-effective options."
|
|
}
|
|
|
|
func fmtFloatPtr(f *float64) string {
|
|
if f == nil {
|
|
return "<nil>"
|
|
}
|
|
return fmt.Sprintf("%f", *f)
|
|
}
|
|
|
|
type keyResponse struct {
|
|
Data key `json:"data"`
|
|
}
|
|
|
|
type key struct {
|
|
Label string `json:"label"`
|
|
Limit *float64 `json:"limit"`
|
|
Usage float64 `json:"usage"`
|
|
IsFreeTier bool `json:"is_free_tier"`
|
|
LimitRemaining *float64 `json:"limit_remaining"`
|
|
}
|