github.com/google/osv-scalibr@v0.4.1/veles/secrets/hcp/hcp.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 hcp contains Veles Secret types and Detectors for HashiCorp Cloud Platform credentials.
    16  //
    17  // It supports detecting HCP client credentials (HCP_CLIENT_ID + HCP_CLIENT_SECRET)
    18  // and HCP access tokens (HCP_ACCESS_TOKEN).
    19  package hcp
    20  
    21  // ClientCredentials is a Veles Secret representing an HCP OAuth2 client credential pair.
    22  // Both fields are needed together; they cannot be validated independently.
    23  type ClientCredentials struct {
    24  	ClientID     string
    25  	ClientSecret string
    26  }
    27  
    28  // AccessToken is a Veles Secret representing an HCP access token.
    29  type AccessToken struct {
    30  	Token string
    31  	// Optional identity enrichment fields populated by validators/enrichers.
    32  	OrganizationID string
    33  	ProjectID      string
    34  	PrincipalID    string
    35  	PrincipalType  string
    36  	ServiceName    string
    37  	GroupIDs       []string
    38  	UserID         string
    39  	UserEmail      string
    40  }