mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-05 20:54:56 -05:00
293c1d6889
This PR introduces a significant update to the Toolbox configuration file format, which is one of the primary **breaking changes** required for the implementation of the Advanced Control Plane. # Summary of Changes The configuration schema has been updated to enforce resource isolation and facilitate atomic, incremental updates. * Resource Isolation: Resource definitions are now separated into individual blocks, using a distinct structure for each resource type (Source, Tool, Toolset, etc.). This improves readability, management, and auditing of configuration files. * Field Name Modification: Internal field names have been modified to align with declarative methodologies. Specifically, the configuration now separates kind (general resource type, e.g., Source) from type (specific implementation, e.g., Postgres). # User Impact Existing tools.yaml configuration files are now in an outdated format. Users must eventually update their files to the new YAML format. # Mitigation & Compatibility Backward compatibility is maintained during this transition to ensure no immediate user action is required for existing files. * Immediate Backward Compatibility: The source code includes a pre-processing layer that automatically detects outdated configuration files (v1 format) and converts them to the new v2 format under the hood. * [COMING SOON] Migration Support: The new toolbox migrate subcommand will be introduced to allow users to automatically convert their old configuration files to the latest format. # Example Example for config file v2: ``` kind: sources name: my-pg-instance type: cloud-sql-postgres project: my-project region: my-region instance: my-instance database: my_db user: my_user password: my_pass --- kind: authServices name: my-google-auth type: google clientId: testing-id --- kind: tools name: example_tool type: postgres-sql source: my-pg-instance description: some description statement: SELECT * FROM SQL_STATEMENT; parameters: - name: country type: string description: some description --- kind: tools name: example_tool_2 type: postgres-sql source: my-pg-instance description: returning the number one statement: SELECT 1; --- kind: toolsets name: example_toolset tools: - example_tool ``` --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com>
83 lines
2.1 KiB
Go
83 lines
2.1 KiB
Go
// Copyright 2024 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package google
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net/http"
|
|
|
|
"github.com/googleapis/genai-toolbox/internal/auth"
|
|
"google.golang.org/api/idtoken"
|
|
)
|
|
|
|
const AuthServiceType string = "google"
|
|
|
|
// validate interface
|
|
var _ auth.AuthServiceConfig = Config{}
|
|
|
|
// Auth service configuration
|
|
type Config struct {
|
|
Name string `yaml:"name" validate:"required"`
|
|
Type string `yaml:"type" validate:"required"`
|
|
ClientID string `yaml:"clientId" validate:"required"`
|
|
}
|
|
|
|
// Returns the auth service type
|
|
func (cfg Config) AuthServiceConfigType() string {
|
|
return AuthServiceType
|
|
}
|
|
|
|
// Initialize a Google auth service
|
|
func (cfg Config) Initialize() (auth.AuthService, error) {
|
|
a := &AuthService{
|
|
Config: cfg,
|
|
}
|
|
return a, nil
|
|
}
|
|
|
|
var _ auth.AuthService = AuthService{}
|
|
|
|
// struct used to store auth service info
|
|
type AuthService struct {
|
|
Config
|
|
}
|
|
|
|
// Returns the auth service type
|
|
func (a AuthService) AuthServiceType() string {
|
|
return AuthServiceType
|
|
}
|
|
|
|
func (a AuthService) ToConfig() auth.AuthServiceConfig {
|
|
return a.Config
|
|
}
|
|
|
|
// Returns the name of the auth service
|
|
func (a AuthService) GetName() string {
|
|
return a.Name
|
|
}
|
|
|
|
// Verifies Google ID token and return claims
|
|
func (a AuthService) GetClaimsFromHeader(ctx context.Context, h http.Header) (map[string]any, error) {
|
|
if token := h.Get(a.Name + "_token"); token != "" {
|
|
payload, err := idtoken.Validate(ctx, token, a.ClientID)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("Google ID token verification failure: %w", err) //nolint:staticcheck
|
|
}
|
|
return payload.Claims, nil
|
|
}
|
|
return nil, nil
|
|
}
|