Add VSCode extension configuration to disable KeyChain storage for cr…

…edentials

.vscode/launch.json

@@ -10,7 +10,7 @@
       "request": "launch",
       "mode": "auto",
       "program": "${workspaceFolder}/cmd/publisher/main.go",
-      "args": ["ui", "--listen=localhost:9001", "-vv"],
+      "args": ["ui", "--listen=localhost:9001", "-vv", "--use-keychain=false"],
       "cwd": "${workspaceFolder}/test/sample-content"
     }
   ]

cmd/publisher/commands/ui.go

@@ -4,15 +4,17 @@ package commands
 
 import (
 	"github.com/posit-dev/publisher/internal/cli_types"
+	"github.com/posit-dev/publisher/internal/credentials"
 	"github.com/posit-dev/publisher/internal/events"
 	"github.com/posit-dev/publisher/internal/services/api"
 	"github.com/posit-dev/publisher/internal/util"
 	"github.com/r3labs/sse/v2"
 )
 
 type UICmd struct {
-	Path   util.Path `help:"Sets the current working directory for the agent." arg:"" default:"."`
-	Listen string    `help:"Network address to listen on." placeholder:"HOST[:PORT]" default:"localhost:0"`
+	Path        util.Path `help:"Sets the current working directory for the agent." arg:"" default:"."`
+	Listen      string    `help:"Network address to listen on." placeholder:"HOST[:PORT]" default:"localhost:0"`
+	UseKeychain bool      `help:"Use Keychain services to store/manage credentials." default:"true"`
 }
 
 func (cmd *UICmd) Run(args *cli_types.CommonArgs, ctx *cli_types.CLIContext) error {
@@ -31,6 +33,8 @@ func (cmd *UICmd) Run(args *cli_types.CommonArgs, ctx *cli_types.CLIContext) err
 		return err
 	}
 
+	credentials.UseKeychain = cmd.UseKeychain
+
 	// Auto-initialize if needed. This will be replaced by an API call from the UI
 	// for better error handling and startup performance.
 	svc := api.NewService(

extensions/vscode/package.json

@@ -41,6 +41,11 @@
             "markdownDescription": "Verify TLS certificates for connections. Only **disable** this setting if you experience certificate verification errors and the Posit Connect server is using a self-signed, expired, or otherwise misconfigured certificate.",
             "type": "boolean",
             "default": true
+          },
+          "positPublisher.useKeyChainCredentialStorage": {
+            "markdownDescription": "Enable Key Chain storage when retrieving and storing credentials. On systems which do not support a Key Chain facility, this configuration option is ignored. When the Key Chain facility is not used, a YAML file is used instead. (`~/.connect_credentials`). After changing this value, you must restart the extension to have the setting go into effect.",
+            "type": "boolean",
+            "default": true
           }
         }
       }

extensions/vscode/src/commands.ts

@@ -11,10 +11,20 @@ export const create = async (
   context: ExtensionContext,
   path: string,
   port: number,
+  useKeyChain: boolean,
   subcommand: string = "ui",
 ): Promise<[string, string[]]> => {
   const executable = await getExecutableBinary(context);
-  return [executable, [subcommand, "-vv", `--listen=${HOST}:${port}`, path]];
+  return [
+    executable,
+    [
+      subcommand,
+      "-vv",
+      `--listen=${HOST}:${port}`,
+      `--use-keychain=${useKeyChain}`,
+      path,
+    ],
+  ];
 };
 
 const getExecutableBinary = (context: ExtensionContext): string => {

extensions/vscode/src/extension.ts

@@ -66,7 +66,9 @@ export async function activate(context: ExtensionContext) {
   const stream = new EventStream(port);
   context.subscriptions.push(stream);
 
-  service = new Service(context, port, useExternalAgent);
+  const useKeyChain = extensionSettings.useKeyChainCredentialStorage();
+
+  service = new Service(context, port, useExternalAgent, useKeyChain);
   service.start();
 
   const watchers = new WatcherManager();
@@ -119,10 +121,18 @@ export async function deactivate() {
 
 export const extensionSettings = {
   verifyCertificates(): boolean {
-    // set value from extension configuration - defaults to true
+    // get value from extension configuration - defaults to true
     const configuration = workspace.getConfiguration("positPublisher");
     const value: boolean | undefined =
       configuration.get<boolean>("verifyCertificates");
     return value !== undefined ? value : true;
   },
+  useKeyChainCredentialStorage(): boolean {
+    // get value from extension configuration - defaults to true
+    const configuration = workspace.getConfiguration("positPublisher");
+    const value: boolean | undefined = configuration.get<boolean>(
+      "useKeyChainCredentialStorage",
+    );
+    return value !== undefined ? value : true;
+  },
 };

extensions/vscode/src/servers.ts

@@ -13,12 +13,14 @@ import * as workspaces from "src/workspaces";
 export class Server implements Disposable {
   readonly port: number;
   readonly outputChannel: OutputChannel;
+  readonly useKeyChain: boolean;
 
   process: ChildProcessWithoutNullStreams | undefined = undefined;
 
-  constructor(port: number) {
+  constructor(port: number, useKeyChain: boolean) {
     this.port = port;
     this.outputChannel = window.createOutputChannel(`Posit Publisher`);
+    this.useKeyChain = useKeyChain;
   }
 
   /**
@@ -38,7 +40,12 @@ export class Server implements Disposable {
       // todo - make this configurable
       const path = workspaces.path();
       // Create command to send to terminal stdin
-      const [command, args] = await commands.create(context, path!, this.port);
+      const [command, args] = await commands.create(
+        context,
+        path!,
+        this.port,
+        this.useKeyChain,
+      );
       // Spawn child process
       this.process = spawn(command, args);
       // Handle error output

extensions/vscode/src/services.ts

@@ -11,17 +11,20 @@ export class Service implements Disposable {
   private server: Server;
   private agentURL: string;
   private useExternalAgent: boolean;
+  private useKeyChain: boolean;
 
   constructor(
     context: ExtensionContext,
     port: number,
     useExternalAgent: boolean,
+    useKeyChain: boolean,
   ) {
     this.context = context;
     this.useExternalAgent = useExternalAgent;
+    this.useKeyChain = useKeyChain;
 
     this.agentURL = `http://${HOST}:${port}/api`;
-    this.server = new Server(port);
+    this.server = new Server(port, this.useKeyChain);
     initApi(this.isUp(), this.agentURL);
   }
 

internal/credentials/credentials.go

@@ -66,6 +66,8 @@ type CredentialRecord struct {
 
 type CredentialTable = map[string]CredentialRecord
 
+var UseKeychain bool = true
+
 // ToCredential converts a CredentialRecord to a Credential based on its version.
 func (cr *CredentialRecord) ToCredential() (*Credential, error) {
 	switch cr.Version {
@@ -93,12 +95,19 @@ type CredentialsService interface {
 // The main credentials service constructor that determines if the system's keyring is available to be used,
 // if not, returns a file based credentials service.
 func NewCredentialsService(log logging.Logger) (CredentialsService, error) {
-	krService := NewKeyringCredentialsService(log)
-	if krService.IsSupported() {
-		return krService, nil
+	var fcService *fileCredentialsService = nil
+
+	if UseKeychain {
+		krService := NewKeyringCredentialsService(log)
+		if krService.IsSupported() {
+			log.Debug("Using keychain for credential storage.")
+			return krService, nil
+		}
+		log.Debug("Fallback to file managed credentials service due to unavailable system keyring.")
+	} else {
+		log.Debug("Configuration has disabled keychain credentials. Using file managed credentials instead.")
 	}
 
-	log.Debug("Fallback to file managed credentials service due to unavailable system keyring")
 	fcService, err := NewFileCredentialsService(log)
 	if err != nil {
 		return fcService, err

internal/credentials/credentials_test.go

@@ -103,6 +103,11 @@ func (s *CredentialsServiceTestSuite) TestCredentialRecord_VersionErr() {
 
 func (s *CredentialsServiceTestSuite) TestNewCredentialsService_KeyringOK() {
 	keyring.MockInit()
+
+	// Don't set credentials.UseKeychain to any value, let it default
+
+	s.log.On("Debug", "Using keychain for credential storage.").Return()
+
 	credservice, err := NewCredentialsService(s.log)
 	s.NoError(err)
 	s.Implements((*CredentialsService)(nil), credservice)
@@ -118,7 +123,38 @@ func (s *CredentialsServiceTestSuite) TestNewCredentialsService_KeyringErrFallba
 	keyring.MockInitWithError(keyringErr)
 
 	s.log.On("Debug", "System keyring service is not available", "error", "failed to load credentials: this is a teapot, unsupported system").Return()
-	s.log.On("Debug", "Fallback to file managed credentials service due to unavailable system keyring").Return()
+	s.log.On("Debug", "Fallback to file managed credentials service due to unavailable system keyring.").Return()
+
+	credservice, err := NewCredentialsService(s.log)
+	s.NoError(err)
+	s.Implements((*CredentialsService)(nil), credservice)
+}
+
+func (s *CredentialsServiceTestSuite) TestNewCredentialsService_WithUseKeyringTrue() {
+	keyring.MockInit()
+
+	// set credentials.UseKeychain to true
+	UseKeychain = true
+
+	s.log.On("Debug", "Using keychain for credential storage.").Return()
+
+	credservice, err := NewCredentialsService(s.log)
+	s.NoError(err)
+	s.Implements((*CredentialsService)(nil), credservice)
+}
+
+func (s *CredentialsServiceTestSuite) TestNewCredentialsService_WithUseKeyringFalse() {
+	// Use an in memory filesystem for this test
+	// avoiding to manipulate users ~/.connect-credentials
+	fsys = afero.NewMemMapFs()
+	defer func() { fsys = afero.NewOsFs() }()
+
+	keyring.MockInit()
+
+	s.log.On("Debug", "Configuration has disabled keychain credentials. Using file managed credentials instead.").Return()
+
+	// set credentials.UseKeychain to true
+	UseKeychain = false
 
 	credservice, err := NewCredentialsService(s.log)
 	s.NoError(err)

internal/logging/loggingtest/mock_logger.go

@@ -42,3 +42,8 @@ func (m *MockLogger) WithArgs(args ...any) logging.Logger {
 	mockArgs := m.Called(args...)
 	return mockArgs.Get(0).(logging.Logger)
 }
+
+func (m *MockLogger) Debug(msg string, args ...any) {
+	mockArgs := append([]any{msg}, args...)
+	m.Called(mockArgs...)
+}