Skip to content

Self-hosted, plugin-based server management.

2.3 KB
Raw Blame
/**
 * Decides which username to use when a host is backed by a saved credential.
 *
 * An explicitly-set host username always wins - if the user typed a username on
 * the host it should be honoured even when a credential is attached. The
 * credential's username is only used as a fallback when the host has none. The
 * `overrideCredentialUsername` flag forces the host username regardless.
 */
export function pickResolvedUsername(
  hostUsername: unknown,
  credentialUsername: unknown,
  overrideCredentialUsername?: unknown,
): string | undefined {
  const host = isNonEmptyString(hostUsername) ? hostUsername : undefined;
  const cred = isNonEmptyString(credentialUsername)
    ? credentialUsername
    : undefined;

  if (overrideCredentialUsername) return host;
  if (host) return host;
  return cred;
}

/**
 * A host can keep a per-host password while using a shared key credential.
 * Prefer that host-specific value and fall back to the credential password.
 */
export function pickResolvedPassword(
  hostPassword: unknown,
  credentialPassword: unknown,
): string | undefined {
  if (isNonEmptyString(hostPassword)) return hostPassword;
  if (isNonEmptyString(credentialPassword)) return credentialPassword;
  return undefined;
}

const USERNAME_PLACEHOLDER = /\$external\.username/g;

/**
 * Expands `$external.username` in an SSH username to the name the connecting
 * user signed in with through SSO or LDAP: the subject of their first
 * external identity. Returns the username unchanged if it has no placeholder
 * or the user has no external sign-in.
 */
export async function expandExternalUsername(
  username: string | undefined,
  userId: string,
): Promise<string | undefined> {
  if (!username || !new RegExp(USERNAME_PLACEHOLDER.source).test(username)) {
    return username;
  }

  try {
    const { createCurrentUserAuthRepository } =
      await import("../database/repositories/factory.js");
    const identities =
      await createCurrentUserAuthRepository().listIdentitiesForUser(userId);
    const externalName = [...identities].sort((a, b) => a.id - b.id)[0]
      ?.subject;
    if (!externalName) return username;

    return username.replace(USERNAME_PLACEHOLDER, () => externalName);
  } catch {
    return username;
  }
}

function isNonEmptyString(value: unknown): value is string {
  return typeof value === "string" && value.trim() !== "";
}