mirror of
https://github.com/Termix-SSH/Termix.git
synced 2026-10-28 06:05:24 +00:00
453 lines
13 KiB
TypeScript
453 lines
13 KiB
TypeScript
import type { WebSocket } from "ws";
|
|
import { resolveExternalSecretRefs } from "./external-secrets.js";
|
|
import { sshLogger, authLogger } from "../utils/logger.js";
|
|
import { createCurrentHostResolutionRepository } from "../database/repositories/factory.js";
|
|
interface ResolvedCredentials {
|
|
username: string;
|
|
password?: string;
|
|
key?: Buffer;
|
|
keyPassword?: string;
|
|
authType?: string;
|
|
certPublicKey?: string;
|
|
}
|
|
|
|
interface HostConfig {
|
|
id: number;
|
|
ip: string;
|
|
port: number;
|
|
username: string;
|
|
password?: string;
|
|
key?: string;
|
|
keyPassword?: string;
|
|
keyType?: string;
|
|
authType?: string;
|
|
useWarpgate?: boolean;
|
|
credentialId?: number;
|
|
userId?: string;
|
|
forceKeyboardInteractive?: boolean;
|
|
}
|
|
|
|
interface AuthContext {
|
|
userId: string;
|
|
ws: WebSocket;
|
|
hostId: number;
|
|
isKeyboardInteractive: boolean;
|
|
keyboardInteractiveResponded: boolean;
|
|
keyboardInteractiveFinish: ((responses: string[]) => void) | null;
|
|
totpPromptSent: boolean;
|
|
warpgateAuthPromptSent: boolean;
|
|
totpTimeout: NodeJS.Timeout | null;
|
|
warpgateAuthTimeout: NodeJS.Timeout | null;
|
|
totpAttempts: number;
|
|
}
|
|
|
|
export class SSHAuthManager {
|
|
public context: AuthContext;
|
|
|
|
constructor(context: AuthContext) {
|
|
this.context = context;
|
|
}
|
|
|
|
async resolveCredentials(
|
|
hostConfig: HostConfig,
|
|
): Promise<ResolvedCredentials> {
|
|
let resolvedCredentials: ResolvedCredentials = {
|
|
username: hostConfig.username,
|
|
authType: hostConfig.authType || "none",
|
|
};
|
|
|
|
if (hostConfig.credentialId) {
|
|
const cred =
|
|
await createCurrentHostResolutionRepository().findCredentialByIdForUser(
|
|
hostConfig.credentialId,
|
|
this.context.userId,
|
|
);
|
|
|
|
if (cred) {
|
|
// Credentials may hold secret references instead of secrets.
|
|
await resolveExternalSecretRefs(
|
|
cred as unknown as Record<string, unknown>,
|
|
this.context.userId,
|
|
);
|
|
resolvedCredentials = {
|
|
username: (cred.username as string) || hostConfig.username,
|
|
password: (cred.password as string) || undefined,
|
|
key:
|
|
cred.key || cred.privateKey
|
|
? Buffer.from((cred.key || cred.privateKey) as string)
|
|
: undefined,
|
|
keyPassword: (cred.keyPassword as string) || undefined,
|
|
authType: (cred.authType as string) || "none",
|
|
certPublicKey: (cred.certPublicKey as string) || undefined,
|
|
};
|
|
}
|
|
} else {
|
|
if (hostConfig.password) {
|
|
resolvedCredentials.password = hostConfig.password;
|
|
resolvedCredentials.authType = "password";
|
|
}
|
|
|
|
if (hostConfig.key) {
|
|
resolvedCredentials.key = Buffer.from(hostConfig.key, "utf8");
|
|
resolvedCredentials.authType = "key";
|
|
|
|
if (hostConfig.keyPassword) {
|
|
resolvedCredentials.keyPassword = hostConfig.keyPassword;
|
|
}
|
|
}
|
|
}
|
|
|
|
return resolvedCredentials;
|
|
}
|
|
|
|
handleKeyboardInteractive(
|
|
name: string,
|
|
instructions: string,
|
|
instructionsLang: string,
|
|
prompts: Array<{ prompt: string; echo: boolean }>,
|
|
finish: (responses: string[]) => void,
|
|
resolvedCredentials: ResolvedCredentials,
|
|
hostConfig?: HostConfig,
|
|
): void {
|
|
this.context.isKeyboardInteractive = true;
|
|
const promptTexts = prompts.map((p) => p.prompt);
|
|
|
|
const warpgatePattern = /warpgate\s+authentication/i;
|
|
const isWarpgate =
|
|
warpgatePattern.test(name) ||
|
|
warpgatePattern.test(instructions) ||
|
|
promptTexts.some((p) => warpgatePattern.test(p));
|
|
|
|
if (isWarpgate) {
|
|
this.handleWarpgateAuth(name, instructions, promptTexts, finish);
|
|
return;
|
|
}
|
|
|
|
// FortiToken-style prompt: asks the user to type a code OR the literal
|
|
// word "push" (e.g. "Enter your Token or type 'push' to receive a push
|
|
// notification:"). Unlike JumpCloud/DUO's confirm-only push, this needs a
|
|
// text field, so it must not fall into the empty-answerable push pattern
|
|
// below. Checked first since its text also contains "push notification".
|
|
const fortiTokenPattern = /type\s+['"]?push['"]?/i;
|
|
const isFortiTokenPrompt = promptTexts.some((p) =>
|
|
fortiTokenPattern.test(p),
|
|
);
|
|
|
|
// JumpCloud Protect / DUO-style push MFA: a menu choice ("Choose [1] Push,
|
|
// or [2] TOTP:") followed by an empty-answerable confirm ("Press enter to
|
|
// send Push request:"). Checked before the TOTP regex because the menu
|
|
// prompt's own text ("...or [2] TOTP:") would otherwise match it and get
|
|
// misrouted into the numeric-code flow.
|
|
const pushPromptPattern =
|
|
/choose.*push.*totp|press enter.*(push|send)|push notification|authentication by phone/i;
|
|
const isPushPrompt =
|
|
!isFortiTokenPrompt && promptTexts.some((p) => pushPromptPattern.test(p));
|
|
|
|
if (isPushPrompt) {
|
|
sshLogger.info("Push/menu MFA prompt detected", {
|
|
operation: "ssh_keyboard_interactive_push",
|
|
hostId: this.context.hostId,
|
|
});
|
|
this.handlePasswordAuth(prompts, finish, resolvedCredentials, hostConfig);
|
|
return;
|
|
}
|
|
|
|
const totpPromptIndex = prompts.findIndex((p) =>
|
|
/verification code|verification_code|token|otp|2fa|authenticator|google.*auth/i.test(
|
|
p.prompt,
|
|
),
|
|
);
|
|
|
|
if (totpPromptIndex !== -1) {
|
|
this.handleTotpAuth(
|
|
prompts,
|
|
totpPromptIndex,
|
|
finish,
|
|
resolvedCredentials,
|
|
);
|
|
return;
|
|
}
|
|
|
|
this.handlePasswordAuth(prompts, finish, resolvedCredentials, hostConfig);
|
|
}
|
|
|
|
private handleWarpgateAuth(
|
|
name: string,
|
|
instructions: string,
|
|
promptTexts: string[],
|
|
finish: (responses: string[]) => void,
|
|
): void {
|
|
const fullText = `${name}\n${instructions}\n${promptTexts.join("\n")}`;
|
|
|
|
const urlMatch = fullText.match(/https?:\/\/[^\s\n]+/i);
|
|
const keyMatch = fullText.match(
|
|
/security key[:\s]+([a-z0-9](?:\s+[a-z0-9]){3}|[a-z0-9]{4})/i,
|
|
);
|
|
|
|
if (urlMatch) {
|
|
this.context.keyboardInteractiveFinish = () => {
|
|
finish([""]);
|
|
};
|
|
|
|
this.context.warpgateAuthPromptSent = true;
|
|
|
|
this.sendLog("auth", "info", "Warpgate authentication required");
|
|
|
|
this.context.ws.send(
|
|
JSON.stringify({
|
|
type: "warpgate_auth_required",
|
|
url: urlMatch[0],
|
|
securityKey: keyMatch ? keyMatch[1] : "N/A",
|
|
instructions: instructions,
|
|
}),
|
|
);
|
|
|
|
this.context.warpgateAuthTimeout = setTimeout(() => {
|
|
if (this.context.keyboardInteractiveFinish) {
|
|
this.context.keyboardInteractiveFinish = null;
|
|
this.context.warpgateAuthPromptSent = false;
|
|
sshLogger.warn("Warpgate authentication timeout", {
|
|
operation: "warpgate_timeout",
|
|
hostId: this.context.hostId,
|
|
});
|
|
this.context.ws.send(
|
|
JSON.stringify({
|
|
type: "error",
|
|
message: "Warpgate authentication timeout. Please reconnect.",
|
|
}),
|
|
);
|
|
}
|
|
}, 300000);
|
|
}
|
|
}
|
|
|
|
private handleTotpAuth(
|
|
prompts: Array<{ prompt: string; echo: boolean }>,
|
|
totpPromptIndex: number,
|
|
finish: (responses: string[]) => void,
|
|
resolvedCredentials: ResolvedCredentials,
|
|
): void {
|
|
if (this.context.totpPromptSent) {
|
|
sshLogger.warn("TOTP prompt asked again - invalid code", {
|
|
operation: "ssh_keyboard_interactive_totp_retry",
|
|
hostId: this.context.hostId,
|
|
});
|
|
authLogger.warn("TOTP verification failed for SSH session", {
|
|
operation: "terminal_totp_failed",
|
|
userId: this.context.userId,
|
|
hostId: this.context.hostId,
|
|
});
|
|
|
|
this.sendLog("auth", "warning", "Invalid TOTP code");
|
|
|
|
this.context.ws.send(
|
|
JSON.stringify({
|
|
type: "totp_retry",
|
|
}),
|
|
);
|
|
return;
|
|
}
|
|
|
|
this.context.totpPromptSent = true;
|
|
this.context.keyboardInteractiveResponded = true;
|
|
|
|
this.context.keyboardInteractiveFinish = (totpResponses: string[]) => {
|
|
const totpCode = (totpResponses[0] || "").trim();
|
|
|
|
const responses = prompts.map((p, index) => {
|
|
if (index === totpPromptIndex) {
|
|
return totpCode;
|
|
}
|
|
if (/password/i.test(p.prompt) && resolvedCredentials.password) {
|
|
return resolvedCredentials.password;
|
|
}
|
|
return "";
|
|
});
|
|
|
|
finish(responses);
|
|
};
|
|
|
|
if (this.context.totpTimeout) {
|
|
clearTimeout(this.context.totpTimeout);
|
|
}
|
|
|
|
this.context.totpTimeout = setTimeout(() => {
|
|
if (this.context.keyboardInteractiveFinish) {
|
|
this.context.keyboardInteractiveFinish = null;
|
|
this.context.totpPromptSent = false;
|
|
sshLogger.warn("TOTP prompt timeout", {
|
|
operation: "totp_timeout",
|
|
hostId: this.context.hostId,
|
|
});
|
|
this.context.ws.send(
|
|
JSON.stringify({
|
|
type: "error",
|
|
message: "TOTP verification timeout. Please reconnect.",
|
|
}),
|
|
);
|
|
}
|
|
}, 180000);
|
|
|
|
this.sendLog("auth", "info", "TOTP verification required");
|
|
authLogger.info("TOTP verification prompt sent to client", {
|
|
operation: "terminal_totp_prompt",
|
|
userId: this.context.userId,
|
|
hostId: this.context.hostId,
|
|
});
|
|
|
|
this.context.ws.send(
|
|
JSON.stringify({
|
|
type: "totp_required",
|
|
prompt: prompts[totpPromptIndex].prompt,
|
|
}),
|
|
);
|
|
}
|
|
|
|
private handlePasswordAuth(
|
|
prompts: Array<{ prompt: string; echo: boolean }>,
|
|
finish: (responses: string[]) => void,
|
|
resolvedCredentials: ResolvedCredentials,
|
|
hostConfig?: HostConfig,
|
|
): void {
|
|
// For Warpgate hosts: auto-answer password prompts silently using stored credentials.
|
|
// Warpgate sends a password prompt before its browser-verification round; we must
|
|
// not show a UI prompt here -- the WarpgateDialog handles user interaction later.
|
|
if (hostConfig?.useWarpgate) {
|
|
const responses = prompts.map((p) => {
|
|
if (/password/i.test(p.prompt) && resolvedCredentials.password) {
|
|
return resolvedCredentials.password as string;
|
|
}
|
|
return "";
|
|
});
|
|
finish(responses);
|
|
return;
|
|
}
|
|
|
|
const hasStoredPassword =
|
|
resolvedCredentials.password && resolvedCredentials.authType !== "none";
|
|
|
|
const passwordPromptIndex = prompts.findIndex((p) =>
|
|
/password/i.test(p.prompt),
|
|
);
|
|
|
|
// Find the first prompt we can't auto-answer. This handles DUO/PAM challenges
|
|
// that don't say "password" (e.g. "Passcode or option (1-N):").
|
|
const firstUnansweredIndex = prompts.findIndex((p) => {
|
|
if (/password/i.test(p.prompt) && hasStoredPassword) return false;
|
|
return true;
|
|
});
|
|
|
|
if (firstUnansweredIndex !== -1) {
|
|
if (this.context.keyboardInteractiveResponded) {
|
|
return;
|
|
}
|
|
this.context.keyboardInteractiveResponded = true;
|
|
|
|
const promptIndex =
|
|
passwordPromptIndex !== -1 && !hasStoredPassword
|
|
? passwordPromptIndex
|
|
: firstUnansweredIndex;
|
|
|
|
const pushPromptPattern =
|
|
/choose.*push.*totp|press enter.*(push|send)|push notification|authentication by phone/i;
|
|
const isPushPrompt = pushPromptPattern.test(prompts[promptIndex].prompt);
|
|
|
|
this.context.keyboardInteractiveFinish = (userResponses: string[]) => {
|
|
const userInput = (userResponses[0] || "").trim();
|
|
|
|
const responses = prompts.map((p, index) => {
|
|
if (index === promptIndex) {
|
|
return userInput;
|
|
}
|
|
if (/password/i.test(p.prompt) && resolvedCredentials.password) {
|
|
return resolvedCredentials.password;
|
|
}
|
|
return "";
|
|
});
|
|
|
|
finish(responses);
|
|
};
|
|
|
|
if (this.context.totpTimeout) {
|
|
clearTimeout(this.context.totpTimeout);
|
|
}
|
|
|
|
this.context.totpTimeout = setTimeout(
|
|
() => {
|
|
if (this.context.keyboardInteractiveFinish) {
|
|
this.context.keyboardInteractiveFinish = null;
|
|
this.context.keyboardInteractiveResponded = false;
|
|
sshLogger.warn("Password prompt timeout", {
|
|
operation: "password_timeout",
|
|
hostId: this.context.hostId,
|
|
});
|
|
this.context.ws.send(
|
|
JSON.stringify({
|
|
type: "error",
|
|
message: "Password verification timeout. Please reconnect.",
|
|
}),
|
|
);
|
|
}
|
|
},
|
|
isPushPrompt ? 300000 : 180000,
|
|
);
|
|
|
|
this.sendLog("auth", "info", "Password authentication required");
|
|
|
|
this.context.ws.send(
|
|
JSON.stringify({
|
|
type: "password_required",
|
|
prompt: prompts[promptIndex].prompt,
|
|
echo: prompts[promptIndex].echo,
|
|
}),
|
|
);
|
|
return;
|
|
}
|
|
|
|
const responses = prompts.map((p) => {
|
|
if (/password/i.test(p.prompt) && resolvedCredentials.password) {
|
|
return resolvedCredentials.password;
|
|
}
|
|
return "";
|
|
});
|
|
|
|
finish(responses);
|
|
}
|
|
|
|
sendLog(
|
|
stage: string,
|
|
level: string,
|
|
message: string,
|
|
details?: Record<string, unknown>,
|
|
): void {
|
|
this.context.ws.send(
|
|
JSON.stringify({
|
|
type: "connection_log",
|
|
data: {
|
|
stage,
|
|
level,
|
|
message,
|
|
details,
|
|
},
|
|
}),
|
|
);
|
|
}
|
|
|
|
cleanup(): void {
|
|
if (this.context.totpTimeout) {
|
|
clearTimeout(this.context.totpTimeout);
|
|
this.context.totpTimeout = null;
|
|
}
|
|
|
|
if (this.context.warpgateAuthTimeout) {
|
|
clearTimeout(this.context.warpgateAuthTimeout);
|
|
this.context.warpgateAuthTimeout = null;
|
|
}
|
|
|
|
this.context.keyboardInteractiveFinish = null;
|
|
this.context.totpPromptSent = false;
|
|
this.context.warpgateAuthPromptSent = false;
|
|
this.context.keyboardInteractiveResponded = false;
|
|
}
|
|
}
|