Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ All notable changes to `sustech-cli` are documented in this file.

## [Unreleased]

### Fixed

- macOS Keychain credentials no longer prompt for the login password on every
command after a Node/Homebrew upgrade. The stored item now trusts the stable
`/usr/bin/security` helper instead of the Node interpreter that created it,
and `auth login` can replace an item whose ACL no longer permits reads.

## [0.13.0] - 2026-10-19

### Added
Expand Down
57 changes: 41 additions & 16 deletions src/core/keyring.ts
Original file line number Diff line number Diff line change
Expand Up @@ -166,9 +166,17 @@ export async function saveStoredCredentials(

const account = existing?.account ?? credentialAccount(profile, sid);
let previousPassword: string | undefined;
let secretTouched = false;
let previousReadable = false;
try {
previousPassword = await store.get(account);
previousReadable = true;
} catch {
// The old item may be protected by an ACL that no longer trusts this
// interpreter (for example after a Node/Homebrew upgrade). A fresh login
// must still be able to replace it, so carry on without a rollback baseline.
}
let secretTouched = false;
try {
await store.set(account, password);
secretTouched = true;
const verifiedPassword = await store.get(account);
Expand All @@ -182,7 +190,7 @@ export async function saveStoredCredentials(
);
}
} catch (error) {
if (secretTouched && !await restoreSecret(store, account, previousPassword)) {
if (secretTouched && previousReadable && !await restoreSecret(store, account, previousPassword)) {
throw credentialRollbackError("save", store.backend);
}
throw storeAccessError("credentials", "write", store.backend, error);
Expand Down Expand Up @@ -484,30 +492,37 @@ async function resolveMacosKeychain(
const timeoutMs = credentialCommandTimeoutMs(options);
try {
await access(executable, constants.X_OK);
const { AsyncEntry } = await import("@napi-rs/keyring");
// Construction initializes the native Security-framework store without reading or writing a credential.
new AsyncEntry(namespace.service, "availability-probe");
const store: SecretStore = {
backend,
persistent: true,
async has(account) {
return await macosCredentialExists(executable, namespace.service, account, env, timeoutMs);
},
async get(account) {
const password = await new AsyncEntry(namespace.service, account).getPassword() ?? undefined;
if (password !== undefined) return password;
if (!await macosCredentialExists(executable, namespace.service, account, env, timeoutMs)) return undefined;
throw new Error("macOS Keychain item exists, but its secret could not be read.");
const result = await runCredentialCommand(executable, [
"find-generic-password", "-s", namespace.service, "-a", account, "-w",
], undefined, env, timeoutMs);
if (macosItemNotFound(result)) return undefined;
if (result.code !== 0) throw macosKeychainCommandError("read", result);
return result.stdout.replace(/\r?\n$/, "") || undefined;
},
async set(account, password) {
await new AsyncEntry(namespace.service, account).setPassword(password);
// Trust the stable system helper this backend already uses instead of
// the Node interpreter. Otherwise macOS binds the item to the Homebrew
// Node path that created it, and every Node upgrade makes later
// invocations prompt for the login password again.
const result = await runCredentialCommand(executable, [
"add-generic-password", "-U", "-T", executable, "-s", namespace.service, "-a", account, "-w",
], `${password}\n${password}\n`, env, timeoutMs);
if (result.code !== 0) throw macosKeychainCommandError("write", result);
},
async delete(account) {
const deleted = await new AsyncEntry(namespace.service, account).deleteCredential();
if (await macosCredentialExists(executable, namespace.service, account, env, timeoutMs)) {
throw new Error("macOS Keychain delete could not be verified.");
}
return deleted;
const result = await runCredentialCommand(executable, [
"delete-generic-password", "-s", namespace.service, "-a", account,
], undefined, env, timeoutMs);
if (macosItemNotFound(result)) return false;
if (result.code !== 0) throw macosKeychainCommandError("delete", result);
return true;
},
};
return { backend, available: true, persistent: true, store };
Expand All @@ -517,7 +532,7 @@ async function resolveMacosKeychain(
available: false,
persistent: true,
reason: safeStoreReason(error),
remediation: "Reinstall sustech-cli so its native keyring package matches this macOS system and CPU.",
remediation: "Unlock the login keychain in the current graphical session, then retry.",
};
}
}
Expand All @@ -542,6 +557,16 @@ function macosItemNotFound(result: { code: number; stderr: string }): boolean {
&& /(?:specified item could not be found|errSecItemNotFound|-25300)/i.test(result.stderr);
}

function macosKeychainCommandError(
action: "read" | "write" | "delete",
result: { code: number; stderr: string },
): Error {
const detail = result.stderr.trim().split("\n")[0];
return new Error(
`macOS Keychain ${action} failed (security exit ${result.code})${detail ? `: ${detail}` : ""}.`,
);
}

async function resolveWindowsCredentialManager(namespace: SecretNamespace): Promise<BackendResolution> {
const backend = "windows-credential-manager" as const;
try {
Expand Down
30 changes: 30 additions & 0 deletions src/test/keyring.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,36 @@ test("saving a named profile never changes the implicit default profile", async
}
});

test("a new login replaces a credential the old ACL no longer allows reading", async () => {
const configDir = await mkdtemp(join(tmpdir(), "sustech-cli-keyring-stale-acl-"));
const store = new MemoryStore();
try {
await saveStoredCredentials({ sid: "12410000", password: "old-secret" }, { configDir, store });
const readableGet = store.get.bind(store);
let denyNextRead = true;
store.get = async (account: string) => {
if (denyNextRead) {
denyNextRead = false;
throw new Error("macOS Keychain read was denied by the item ACL.");
}
return await readableGet(account);
};

const saved = await saveStoredCredentials(
{ sid: "12410000", password: "new-secret" },
{ configDir, store },
);
assert.equal(saved.backend, "macos-keychain");
assert.equal(store.values.get("default:12410000"), "new-secret");
assert.deepEqual(
(await loadStoredCredentials(undefined, { configDir, store, env: {} })).password,
"new-secret",
);
} finally {
await rm(configDir, { recursive: true, force: true });
}
});

test("an unverified credential write is rolled back before metadata is committed", async () => {
const configDir = await mkdtemp(join(tmpdir(), "sustech-cli-keyring-verify-"));
const store = new MemoryStore();
Expand Down
Loading