github.com/google/osv-scalibr@v0.4.1/veles/secrets/huggingfaceapikey/validator.go (about)

     1  // Copyright 2025 Google LLC
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package huggingfaceapikey
    16  
    17  import (
    18  	"net/http"
    19  	"time"
    20  
    21  	"github.com/google/osv-scalibr/veles/secrets/common/simplevalidate"
    22  )
    23  
    24  const (
    25  	httpClientTimeout   = 10 * time.Second
    26  	huggingFaceEndpoint = "https://huggingface.co/api/whoami-v2"
    27  )
    28  
    29  // NewValidator creates a validator for HuggingFace API keys.
    30  //
    31  // It performs a GET request to the Huggingface whoami endpoint
    32  // using the API key in the Authorization header. If the request returns
    33  // HTTP 200, the key is considered valid. If 401 Unauthorized, the key
    34  // is invalid. If 429 TooManyRequests, we assume rate limiting and treat
    35  // as valid to avoid false negatives. Other errors return ValidationFailed.
    36  func NewValidator() *simplevalidate.Validator[HuggingfaceAPIKey] {
    37  	return &simplevalidate.Validator[HuggingfaceAPIKey]{
    38  		Endpoint:   huggingFaceEndpoint,
    39  		HTTPMethod: http.MethodGet,
    40  		HTTPHeaders: func(k HuggingfaceAPIKey) map[string]string {
    41  			return map[string]string{
    42  				"Authorization": "Bearer " + k.Key,
    43  			}
    44  		},
    45  		ValidResponseCodes:   []int{http.StatusOK, http.StatusTooManyRequests},
    46  		InvalidResponseCodes: []int{http.StatusUnauthorized},
    47  		HTTPC:                &http.Client{Timeout: httpClientTimeout},
    48  	}
    49  }