chore: make cred stores be tools

Author: ibuildthecloud

pkg/cli/credential.go

@@ -9,10 +9,7 @@ import (
 	"time"
 
 	cmd2 "github.com/gptscript-ai/cmd"
-	"github.com/gptscript-ai/gptscript/pkg/config"
-	"github.com/gptscript-ai/gptscript/pkg/credentials"
 	"github.com/gptscript-ai/gptscript/pkg/gptscript"
-	"github.com/gptscript-ai/gptscript/pkg/repos/runtimes"
 	"github.com/spf13/cobra"
 )
 
@@ -37,33 +34,19 @@ func (c *Credential) Customize(cmd *cobra.Command) {
 }
 
 func (c *Credential) Run(cmd *cobra.Command, _ []string) error {
-	cfg, err := config.ReadCLIConfig(c.root.ConfigFile)
-	if err != nil {
-		return fmt.Errorf("failed to read CLI config: %w", err)
-	}
-
 	opts, err := c.root.NewGPTScriptOpts()
 	if err != nil {
 		return err
 	}
-	opts = gptscript.Complete(opts)
-	if opts.Runner.RuntimeManager == nil {
-		opts.Runner.RuntimeManager = runtimes.Default(opts.Cache.CacheDir, opts.SystemToolsDir)
-	}
-
-	ctxs := opts.CredentialContexts
-	if c.AllContexts {
-		ctxs = []string{credentials.AllCredentialContexts}
-	}
-
-	if err = opts.Runner.RuntimeManager.SetUpCredentialHelpers(cmd.Context(), cfg); err != nil {
+	gptScript, err := gptscript.New(cmd.Context(), opts)
+	if err != nil {
 		return err
 	}
+	defer gptScript.Close(true)
 
-	// Initialize the credential store and get all the credentials.
-	store, err := credentials.NewStore(cfg, opts.Runner.RuntimeManager, ctxs, opts.Cache.CacheDir)
+	store, err := gptScript.CredentialStoreFactory.NewStore(opts.CredentialContexts)
 	if err != nil {
-		return fmt.Errorf("failed to get credentials store: %w", err)
+		return err
 	}
 
 	creds, err := store.List(cmd.Context())

pkg/cli/credential_delete.go

@@ -3,10 +3,7 @@ package cli
 import (
 	"fmt"
 
-	"github.com/gptscript-ai/gptscript/pkg/config"
-	"github.com/gptscript-ai/gptscript/pkg/credentials"
 	"github.com/gptscript-ai/gptscript/pkg/gptscript"
-	"github.com/gptscript-ai/gptscript/pkg/repos/runtimes"
 	"github.com/spf13/cobra"
 )
 
@@ -28,23 +25,15 @@ func (c *Delete) Run(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	cfg, err := config.ReadCLIConfig(c.root.ConfigFile)
+	gptScript, err := gptscript.New(cmd.Context(), opts)
 	if err != nil {
-		return fmt.Errorf("failed to read CLI config: %w", err)
-	}
-
-	opts = gptscript.Complete(opts)
-	if opts.Runner.RuntimeManager == nil {
-		opts.Runner.RuntimeManager = runtimes.Default(opts.Cache.CacheDir, opts.SystemToolsDir)
-	}
-
-	if err = opts.Runner.RuntimeManager.SetUpCredentialHelpers(cmd.Context(), cfg); err != nil {
 		return err
 	}
+	defer gptScript.Close(true)
 
-	store, err := credentials.NewStore(cfg, opts.Runner.RuntimeManager, opts.CredentialContexts, opts.Cache.CacheDir)
+	store, err := gptScript.CredentialStoreFactory.NewStore(opts.CredentialContexts)
 	if err != nil {
-		return fmt.Errorf("failed to get credentials store: %w", err)
+		return err
 	}
 
 	if err = store.Remove(cmd.Context(), args[0]); err != nil {

pkg/cli/credential_show.go

@@ -5,10 +5,7 @@ import (
 	"os"
 	"text/tabwriter"
 
-	"github.com/gptscript-ai/gptscript/pkg/config"
-	"github.com/gptscript-ai/gptscript/pkg/credentials"
 	"github.com/gptscript-ai/gptscript/pkg/gptscript"
-	"github.com/gptscript-ai/gptscript/pkg/repos/runtimes"
 	"github.com/spf13/cobra"
 )
 
@@ -30,23 +27,15 @@ func (c *Show) Run(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	cfg, err := config.ReadCLIConfig(c.root.ConfigFile)
+	gptScript, err := gptscript.New(cmd.Context(), opts)
 	if err != nil {
-		return fmt.Errorf("failed to read CLI config: %w", err)
-	}
-
-	opts = gptscript.Complete(opts)
-	if opts.Runner.RuntimeManager == nil {
-		opts.Runner.RuntimeManager = runtimes.Default(opts.Cache.CacheDir, opts.SystemToolsDir)
-	}
-
-	if err = opts.Runner.RuntimeManager.SetUpCredentialHelpers(cmd.Context(), cfg); err != nil {
 		return err
 	}
+	defer gptScript.Close(true)
 
-	store, err := credentials.NewStore(cfg, opts.Runner.RuntimeManager, opts.CredentialContexts, opts.Cache.CacheDir)
+	store, err := gptScript.CredentialStoreFactory.NewStore(opts.CredentialContexts)
 	if err != nil {
-		return fmt.Errorf("failed to get credentials store: %w", err)
+		return err
 	}
 
 	cred, exists, err := store.Get(cmd.Context(), args[0])

pkg/config/cliconfig.go

@@ -3,11 +3,9 @@ package config
 import (
 	"encoding/base64"
 	"encoding/json"
-	"errors"
 	"fmt"
 	"os"
 	"runtime"
-	"slices"
 	"strings"
 	"sync"
 
@@ -23,25 +21,19 @@ const (
 	FileCredHelper          = "file"
 	SqliteCredHelper        = "sqlite"
 	PostgresCredHelper      = "postgres"
-
-	GPTScriptHelperPrefix = "gptscript-credential-"
 )
 
 var (
 	darwinHelpers  = []string{OsxkeychainCredHelper, FileCredHelper, SqliteCredHelper, PostgresCredHelper}
 	windowsHelpers = []string{WincredCredHelper, FileCredHelper}
 	linuxHelpers   = []string{SecretserviceCredHelper, PassCredHelper, FileCredHelper, SqliteCredHelper, PostgresCredHelper}
-)
 
-func listAsString(helpers []string) string {
-	if len(helpers) == 0 {
-		return ""
-	} else if len(helpers) == 1 {
-		return helpers[0]
-	}
+	// Helpers is a list of all supported credential helpers from github.com/gptscript-ai/gptscript-credential-helpers
+	Helpers = []string{WincredCredHelper, OsxkeychainCredHelper, SecretserviceCredHelper, PassCredHelper}
 
-	return strings.Join(helpers[:len(helpers)-1], ", ") + " or " + helpers[len(helpers)-1]
-}
+	// DBHelpers is a list of all supported credential helpers from github.com/gptscript-ai/gptscript-credential-database
+	DBHelpers = []string{SqliteCredHelper, PostgresCredHelper}
+)
 
 type AuthConfig types.AuthConfig
 
@@ -74,8 +66,8 @@ func (a *AuthConfig) UnmarshalJSON(data []byte) error {
 type CLIConfig struct {
 	Auths            map[string]AuthConfig `json:"auths,omitempty"`
 	CredentialsStore string                `json:"credsStore,omitempty"`
-	Integrations     map[string]string     `json:"integrations,omitempty"`
 
+	raw       []byte
 	auths     map[string]types.AuthConfig
 	authsLock *sync.Mutex
 	location  string
@@ -108,7 +100,19 @@ func (c *CLIConfig) Save() error {
 		}
 		c.auths = nil
 	}
-	data, err := json.Marshal(c)
+
+	// This is to not overwrite additional fields that might be the config file
+	out := map[string]any{}
+	if len(c.raw) > 0 {
+		err := json.Unmarshal(c.raw, &out)
+		if err != nil {
+			return err
+		}
+	}
+	out["auths"] = c.Auths
+	out["credsStore"] = c.CredentialsStore
+
+	data, err := json.Marshal(out)
 	if err != nil {
 		return err
 	}
@@ -154,34 +158,22 @@ func ReadCLIConfig(gptscriptConfigFile string) (*CLIConfig, error) {
 	result := &CLIConfig{
 		authsLock: &sync.Mutex{},
 		location:  gptscriptConfigFile,
+		raw:       data,
 	}
 	if err := json.Unmarshal(data, result); err != nil {
 		return nil, fmt.Errorf("failed to unmarshal %s: %v", gptscriptConfigFile, err)
 	}
 
+	if store := os.Getenv("GPTSCRIPT_CREDENTIALS_STORE"); store != "" {
+		result.CredentialsStore = store
+	}
+
 	if result.CredentialsStore == "" {
 		if err := result.setDefaultCredentialsStore(); err != nil {
 			return nil, err
 		}
 	}
 
-	if !isValidCredentialHelper(result.CredentialsStore) {
-		errMsg := fmt.Sprintf("invalid credential store '%s'", result.CredentialsStore)
-		switch runtime.GOOS {
-		case "darwin":
-			errMsg += fmt.Sprintf(" (use %s)", listAsString(darwinHelpers))
-		case "windows":
-			errMsg += fmt.Sprintf(" (use %s)", listAsString(windowsHelpers))
-		case "linux":
-			errMsg += fmt.Sprintf(" (use %s)", listAsString(linuxHelpers))
-		default:
-			errMsg += " (use file)"
-		}
-		errMsg += fmt.Sprintf("\nPlease edit your config file at %s to fix this.", result.location)
-
-		return nil, errors.New(errMsg)
-	}
-
 	return result, nil
 }
 
@@ -197,19 +189,6 @@ func (c *CLIConfig) setDefaultCredentialsStore() error {
 	return c.Save()
 }
 
-func isValidCredentialHelper(helper string) bool {
-	switch runtime.GOOS {
-	case "darwin":
-		return slices.Contains(darwinHelpers, helper)
-	case "windows":
-		return slices.Contains(windowsHelpers, helper)
-	case "linux":
-		return slices.Contains(linuxHelpers, helper)
-	default:
-		return helper == FileCredHelper
-	}
-}
-
 func readFile(path string) ([]byte, error) {
 	data, err := os.ReadFile(path)
 	if os.IsNotExist(err) {

pkg/credentials/factory.go

@@ -0,0 +1,80 @@
+package credentials
+
+import (
+	"context"
+
+	"github.com/docker/docker-credential-helpers/client"
+	"github.com/gptscript-ai/gptscript/pkg/config"
+	"github.com/gptscript-ai/gptscript/pkg/types"
+)
+
+type ProgramLoaderRunner interface {
+	Load(ctx context.Context, toolName string) (prg types.Program, err error)
+	Run(ctx context.Context, prg types.Program, input string) (output string, err error)
+}
+
+func NewFactory(ctx context.Context, cfg *config.CLIConfig, plr ProgramLoaderRunner) (StoreFactory, error) {
+	toolName := translateToolName(cfg.CredentialsStore)
+	if toolName == config.FileCredHelper {
+		return StoreFactory{
+			file: true,
+		}, nil
+	}
+
+	prg, err := plr.Load(ctx, toolName)
+	if err != nil {
+		return StoreFactory{}, err
+	}
+
+	return StoreFactory{
+		ctx:    ctx,
+		prg:    prg,
+		runner: plr,
+	}, nil
+}
+
+type StoreFactory struct {
+	ctx    context.Context
+	prg    types.Program
+	file   bool
+	runner ProgramLoaderRunner
+	cfg    *config.CLIConfig
+}
+
+func (s *StoreFactory) NewStore(credCtxs []string) (CredentialStore, error) {
+	if err := validateCredentialCtx(credCtxs); err != nil {
+		return nil, err
+	}
+	if s.file {
+		return Store{
+			credCtxs: credCtxs,
+			cfg:      s.cfg,
+		}, nil
+	}
+	return Store{
+		credCtxs: credCtxs,
+		cfg:      s.cfg,
+		program:  s.program,
+	}, nil
+}
+
+func (s *StoreFactory) program(args ...string) client.Program {
+	return &runnerProgram{
+		factory: s,
+		action:  args[0],
+	}
+}
+
+func translateToolName(toolName string) string {
+	for _, helper := range config.Helpers {
+		if helper == toolName {
+			return "github.com/gptscript-ai/gptscript-credential-helpers/" + toolName + "/cmd"
+		}
+	}
+	for _, helper := range config.DBHelpers {
+		if helper == toolName {
+			return "github.com/gptscript-ai/gptscript-credential-database/" + toolName
+		}
+	}
+	return toolName
+}

pkg/credentials/noop.go

@@ -1,6 +1,8 @@
 package credentials
 
-import "context"
+import (
+	"context"
+)
 
 type NoopStore struct{}
 

pkg/credentials/runnerprogram.go

@@ -0,0 +1,29 @@
+package credentials
+
+import (
+	"io"
+)
+
+type runnerProgram struct {
+	factory *StoreFactory
+	action  string
+	output  string
+	err     error
+}
+
+func (r *runnerProgram) Output() ([]byte, error) {
+	return []byte(r.output), r.err
+}
+
+func (r *runnerProgram) Input(in io.Reader) {
+	input, err := io.ReadAll(in)
+	if err != nil {
+		r.err = err
+		return
+	}
+
+	prg := r.factory.prg
+	prg.EntryToolID = prg.ToolSet[prg.EntryToolID].LocalTools[r.action]
+
+	r.output, r.err = r.factory.runner.Run(r.factory.ctx, prg, string(input))
+}