Class: SshKeyStore
Stores user-scoped SSH keys and trusted Databricks gateway host keys.
Each workspace and AppKit user receives a separate Ed25519 key pair. The store writes private keys, gateway fingerprints, and OpenSSH known-host files with owner-only permissions beneath the configured root directory.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SshKeyStore(
root?):SshKeyStore
Creates a key store rooted at the default AppKit application-data path.
Parameters
Section titled “Parameters”string = ...
Returns
Section titled “Returns”SshKeyStore
Methods
Section titled “Methods”ensureRegistered()
Section titled “ensureRegistered()”ensureRegistered(
api,userId,signal?):Promise<StoredKey&object>
Loads or creates the user’s key pair and registers its public key when the workspace does not already contain the matching key hash.
Parameters
Section titled “Parameters”userId
Section titled “userId”string
signal?
Section titled “signal?”AbortSignal
Returns
Section titled “Returns”Promise<StoredKey & object>
The local key material and the gateway host returned by Databricks, when available.
knownHost()
Section titled “knownHost()”knownHost(
scope,userId,host,port):Promise<string|undefined>
Returns the stored SHA-256 gateway fingerprint, or undefined when untrusted.
Parameters
Section titled “Parameters”string
userId
Section titled “userId”string
string
number
Returns
Section titled “Returns”Promise<string | undefined>
knownHostsPath()
Section titled “knownHostsPath()”knownHostsPath(
scope,userId,host,port):string
Returns the OpenSSH known-host file path for one workspace, user, and gateway.
Parameters
Section titled “Parameters”string
userId
Section titled “userId”string
string
number
Returns
Section titled “Returns”string
rememberHost()
Section titled “rememberHost()”rememberHost(
scope,userId,host,port,fingerprint,key):Promise<void>
Stores the accepted gateway fingerprint and OpenSSH host-key entry with owner-only file permissions.
Parameters
Section titled “Parameters”string
userId
Section titled “userId”string
string
number
fingerprint
Section titled “fingerprint”string
Buffer
Returns
Section titled “Returns”Promise<void>