github.com/google/osv-scalibr@v0.4.1/veles/secrets/huggingfaceapikey/detector.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 contains a Veles Secret type and a Detector for
    16  // Huggingface API keys (prefix `hf_`).
    17  package huggingfaceapikey
    18  
    19  import (
    20  	"regexp"
    21  
    22  	"github.com/google/osv-scalibr/veles"
    23  	"github.com/google/osv-scalibr/veles/secrets/common/simpletoken"
    24  )
    25  
    26  // maxTokenLength is the maximum size of a Huggingface API key.
    27  const maxTokenLength = 37
    28  
    29  // keyRe is a regular expression that matches a Huggingface API key.
    30  // Huggingface API keys have the form: `hf_` followed by 34
    31  // alphabet characters.
    32  var keyRe = regexp.MustCompile(`hf_[A-Za-z]{34}`)
    33  
    34  // NewDetector returns a new simpletoken.Detector that matches
    35  // Huggingface API keys.
    36  func NewDetector() veles.Detector {
    37  	return simpletoken.Detector{
    38  		MaxLen: maxTokenLength,
    39  		Re:     keyRe,
    40  		FromMatch: func(b []byte) (veles.Secret, bool) {
    41  			return HuggingfaceAPIKey{Key: string(b)}, true
    42  		},
    43  	}
    44  }