trufflehog/pkg/detectors/aws/appsync/appsync.go

package appsync

import (
	"bytes"
	"context"
	"fmt"
	"io"
	"net/http"

	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
	detectors.DefaultMultiPartCredentialProvider
}

// Compile-time interface check
var _ detectors.Detector = (*Scanner)(nil)

var (
	defaultClient = common.SaneHttpClient()

	apiKeyPat = regexp.MustCompile(
		`\b(da2-[a-z0-9]{26})\b`,
	)

	endpointPat = regexp.MustCompile(
		`(https:\/\/[a-z0-9]{26}\.appsync-api\.[a-z0-9-]+\.amazonaws\.com)([^a-zA-Z0-9.-]|$)`,
	)
)

func (s Scanner) Keywords() []string {
	return []string{"da2-"}
}

func (s Scanner) getClient() *http.Client {
	if s.client != nil {
		return s.client
	}
	return defaultClient
}

func (s Scanner) FromData(
	ctx context.Context,
	verify bool,
	data []byte,
) (results []detectors.Result, err error) {

	dataStr := string(data)

	keys := make(map[string]struct{})
	endpoints := make(map[string]struct{})

	for _, m := range apiKeyPat.FindAllStringSubmatch(dataStr, -1) {
		keys[m[1]] = struct{}{}
	}

	for _, m := range endpointPat.FindAllStringSubmatch(dataStr, -1) {
		normalizedEndpoint := m[1] + "/graphql"
		endpoints[normalizedEndpoint] = struct{}{}
	}

	for key := range keys {
		for endpoint := range endpoints {

			result := detectors.Result{
				DetectorType: detector_typepb.DetectorType_AWSAppSync,
				Raw:          []byte(key),
				RawV2:        []byte(fmt.Sprintf("%s:%s", endpoint, key)),
				SecretParts: map[string]string{
					"key":      key,
					"endpoint": endpoint,
				},
				ExtraData: map[string]string{
					"base_url": endpoint,
				},
			}

			if verify {
				verified, verificationErr := verifyAppSyncKey(
					ctx,
					s.getClient(),
					endpoint,
					key,
				)

				result.SetVerificationError(verificationErr, key)
				result.Verified = verified
			}

			results = append(results, result)
		}
	}

	return
}

func verifyAppSyncKey(
	ctx context.Context,
	client *http.Client,
	endpoint string,
	key string,
) (bool, error) {

	query := `{"query":"query { __typename }"}`

	req, err := http.NewRequestWithContext(
		ctx,
		http.MethodPost,
		endpoint,
		bytes.NewBufferString(query),
	)
	if err != nil {
		return false, err
	}

	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("x-api-key", key)

	res, err := client.Do(req)
	if err != nil {
		return false, err
	}

	defer func() {
		_, _ = io.Copy(io.Discard, res.Body)
		_ = res.Body.Close()
	}()

	// https://docs.aws.amazon.com/appsync/latest/APIReference/CommonErrors.html
	switch res.StatusCode {

	case http.StatusOK:
		return true, nil

	case http.StatusBadGateway:
		bodyBytes, err := io.ReadAll(res.Body)
		if err != nil {
			return false, err
		}
		// Appsync returns 502 with a specific error message in the body when the key is valid but has no schema defined,
		// so we treat that as a valid key
		if bytes.Contains(bodyBytes, []byte("No schema definition exists")) {
			return true, nil
		}
		return false, fmt.Errorf("502 Bad Gateway: unexpected response")

	// Appsync return 401 for invalid keys
	// Appsync return 403 for some time after the token is deleted
	case http.StatusUnauthorized, http.StatusForbidden:
		return false, nil

	default:
		return false, fmt.Errorf(
			"unexpected HTTP response status %d",
			res.StatusCode,
		)
	}
}

func (s Scanner) Type() detector_typepb.DetectorType {
	return detector_typepb.DetectorType_AWSAppSync
}

func (s Scanner) Description() string {
	return "AWS AppSync is a managed GraphQL service. This detector identifies exposed AppSync API keys."
}