@p0security/cli 0.8.0 → 0.8.2

package/dist/plugins/oidc/login.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.oidcLogin = exports.validateProviderDomain = void 0;
+exports.oidcLogin = exports.oidcLoginSteps = exports.waitForActivation = exports.fetchOidcToken = exports.authorize = exports.validateProviderDomain = exports.DEVICE_GRANT_TYPE = void 0;
 /** Copyright © 2024-present P0 Security
 
 This file is part of @p0security/cli
@@ -27,107 +27,147 @@ const oidc_1 = require("../../common/auth/oidc");
 const fetch_1 = require("../../common/fetch");
 const stdio_1 = require("../../drivers/stdio");
 const util_1 = require("../../util");
-const lodash_1 = require("lodash");
 const open_1 = __importDefault(require("open"));
-const DEVICE_GRANT_TYPE = "urn:ietf:params:oauth:grant-type:device_code";
+exports.DEVICE_GRANT_TYPE = "urn:ietf:params:oauth:grant-type:device_code";
 const validateProviderDomain = (org) => {
     if (!org.providerDomain)
         throw "Login requires a configured provider domain.";
 };
 exports.validateProviderDomain = validateProviderDomain;
+const oidcProviderLabels = (providerType) => {
+    switch (providerType) {
+        case "okta":
+            return "Okta";
+        case "ping":
+            return "PingOne";
+        case "google":
+        case "google-oidc":
+            return "Google";
+        case "oidc-pkce":
+            return "OIDC";
+        case "aws-oidc":
+            return "AWS";
+        case "azure-oidc":
+        case "microsoft":
+            return "Entra ID";
+        default:
+            (0, util_1.throwAssertNever)(providerType);
+    }
+    throw "Invalid provider type";
+};
 /** Executes the first step of a device-authorization grant flow */
 // cf. https://developer.okta.com/docs/guides/device-authorization-grant/main/
-const authorize = (org, scope) => __awaiter(void 0, void 0, void 0, function* () {
-    if (org.providerType === undefined) {
-        throw "Login requires a configured provider type.";
-    }
-    const init = {
-        method: "POST",
-        headers: oidc_1.OIDC_HEADERS,
-        body: (0, fetch_1.urlEncode)({
-            client_id: org.clientId,
-            scope,
-        }),
-    };
-    (0, exports.validateProviderDomain)(org);
-    // This is the "org" authorization server; the okta.apps.* scopes are not
-    // available with custom authorization servers
-    const url = org.providerType === "okta"
-        ? `https:${org.providerDomain}/oauth2/v1/device/authorize`
-        : org.providerType === "ping"
-            ? `https://${org.providerDomain}/${org.environmentId}/as/device_authorization`
-            : (0, util_1.throwAssertNever)(org.providerType);
+const authorize = (request, validateResponse) => __awaiter(void 0, void 0, void 0, function* () {
+    const { url, init } = request;
     const response = yield fetch(url, init);
-    yield (0, fetch_1.validateResponse)(response);
+    yield validateResponse(response);
     return (yield response.json());
 });
+exports.authorize = authorize;
 /** Attempts to fetch this device's OIDC token
  *
  * The authorization may or may not be granted at this stage. If it is not, the
  * authorization server will return "authorization_pending", in which case this
  * function will return undefined.
  */
-const fetchOidcToken = (org, authorize) => __awaiter(void 0, void 0, void 0, function* () {
-    if (org.providerType === undefined) {
-        throw "Login requires a configured provider type.";
-    }
-    const init = {
-        method: "POST",
-        headers: oidc_1.OIDC_HEADERS,
-        body: (0, fetch_1.urlEncode)({
-            client_id: org.clientId,
-            device_code: authorize.device_code,
-            grant_type: DEVICE_GRANT_TYPE,
-        }),
-    };
-    (0, exports.validateProviderDomain)(org);
-    const url = org.providerType === "okta"
-        ? `https:${org.providerDomain}/oauth2/v1/token`
-        : org.providerType === "ping"
-            ? `https://${org.providerDomain}/${org.environmentId}/as/token`
-            : (0, util_1.throwAssertNever)(org.providerType);
+const fetchOidcToken = (request) => __awaiter(void 0, void 0, void 0, function* () {
+    const { url, init } = request;
     const response = yield fetch(url, init);
     if (!response.ok) {
         if (response.status === 400) {
             const data = yield response.json();
             if (data.error === "authorization_pending")
                 return undefined;
+            if (data.error === "access_denied")
+                throw "Access denied, try again";
         }
         yield (0, fetch_1.validateResponse)(response);
     }
     return (yield response.json());
 });
+exports.fetchOidcToken = fetchOidcToken;
 /** Waits until user device authorization is complete
  *
  * Returns the OIDC token after completion.
  */
-const waitForActivation = (org, authorize) => __awaiter(void 0, void 0, void 0, function* () {
+const waitForActivation = (authorize, extractExpiryInterval, // Aws implementation differs from standard OIDC response, need function to extract expiry
+tokenRequest) => __awaiter(void 0, void 0, void 0, function* () {
     const start = Date.now();
-    while (Date.now() - start <= authorize.expires_in * 1e3) {
-        const response = yield fetchOidcToken(org, authorize);
+    const { expires_in, interval } = extractExpiryInterval(authorize);
+    while (Date.now() - start <= expires_in * 1e3) {
+        const response = yield (0, exports.fetchOidcToken)(tokenRequest);
         if (!response)
-            yield (0, util_1.sleep)(authorize.interval * 1e3);
+            yield (0, util_1.sleep)(interval * 1e3);
         else
             return response;
     }
     throw "Expired awaiting in-browser authorization.";
 });
-/** Logs in to an Identity Provider via OIDC */
-const oidcLogin = (org, scope) => __awaiter(void 0, void 0, void 0, function* () {
+exports.waitForActivation = waitForActivation;
+const oidcLoginSteps = (org, scope, urls) => {
+    const { deviceAuthorizationUrl, tokenUrl } = urls();
     if (org.providerType === undefined) {
-        throw "Login requires a configured provider type.";
+        throw "Your organization's login configuration does not support this access. Your P0 admin will need to install a supported OIDC provider in order for you to use this command.";
     }
-    const authorizeResponse = yield authorize(org, scope);
+    const buildOidcAuthorizeRequest = () => {
+        (0, exports.validateProviderDomain)(org);
+        return {
+            init: {
+                method: "POST",
+                headers: oidc_1.OIDC_HEADERS,
+                body: (0, fetch_1.urlEncode)({
+                    client_id: org.clientId,
+                    scope,
+                }),
+            },
+            url: deviceAuthorizationUrl,
+        };
+    };
+    const buildOidcTokenRequest = (authorize) => {
+        (0, exports.validateProviderDomain)(org);
+        return {
+            url: tokenUrl,
+            init: {
+                method: "POST",
+                headers: oidc_1.OIDC_HEADERS,
+                body: (0, fetch_1.urlEncode)({
+                    client_id: org.clientId,
+                    device_code: authorize.device_code,
+                    grant_type: exports.DEVICE_GRANT_TYPE,
+                }),
+            },
+        };
+    };
+    return {
+        providerType: org.providerType,
+        validateResponse: fetch_1.validateResponse,
+        buildAuthorizeRequest: buildOidcAuthorizeRequest,
+        buildTokenRequest: buildOidcTokenRequest,
+        processAuthzExpiry: (authorize) => ({
+            expires_in: authorize.expires_in,
+            interval: authorize.interval,
+        }),
+        processAuthzResponse: (authorize) => ({
+            user_code: authorize.user_code,
+            verification_uri_complete: authorize.verification_uri_complete,
+        }),
+    };
+};
+exports.oidcLoginSteps = oidcLoginSteps;
+/** Logs in to an Identity Provider via OIDC */
+const oidcLogin = (steps) => __awaiter(void 0, void 0, void 0, function* () {
+    const { providerType, buildAuthorizeRequest, buildTokenRequest, processAuthzExpiry, processAuthzResponse, validateResponse, } = steps;
+    const deviceAuthorizationResponse = yield (0, exports.authorize)(buildAuthorizeRequest(), validateResponse);
+    const { user_code, verification_uri_complete } = processAuthzResponse(deviceAuthorizationResponse);
     (0, stdio_1.print2)(`Please use the opened browser window to continue your P0 login.
-  
-When prompted, confirm that ${(0, lodash_1.capitalize)(org.providerType)} displays this code:
-
-  ${authorizeResponse.user_code}
 
-Waiting for authorization...
-`);
-    void (0, open_1.default)(authorizeResponse.verification_uri_complete);
-    const oidcResponse = yield waitForActivation(org, authorizeResponse);
-    return oidcResponse;
+    When prompted, confirm that ${oidcProviderLabels(providerType)} displays this code:
+    
+      ${user_code}
+    
+    Waiting for authorization...
+    `);
+    void (0, open_1.default)(verification_uri_complete);
+    return yield (0, exports.waitForActivation)(deviceAuthorizationResponse, processAuthzExpiry, buildTokenRequest(deviceAuthorizationResponse));
 });
 exports.oidcLogin = oidcLogin;

package/dist/plugins/okta/aws.d.ts

@@ -1,5 +1,5 @@
 import { Authn } from "../../types/identity";
 export declare const assumeRoleWithOktaSaml: (authn: Authn, args: {
-    account?: string;
+    accountId?: string;
     role: string;
 }) => Promise<import("../aws/types").AwsCredentials>;

package/dist/plugins/okta/aws.js

@@ -24,8 +24,8 @@ const role_1 = require("../../commands/aws/role");
 const auth_1 = require("../../drivers/auth");
 const assumeRole_1 = require("../aws/assumeRole");
 const assumeRoleWithOktaSaml = (authn, args) => __awaiter(void 0, void 0, void 0, function* () {
-    return yield (0, auth_1.cached)(`aws-okta-${args.account}-${args.role}`, () => __awaiter(void 0, void 0, void 0, function* () {
-        const { account, config, samlResponse } = yield (0, role_1.initOktaSaml)(authn, args.account);
+    return yield (0, auth_1.cached)(`aws-okta-${args.accountId}-${args.role}`, () => __awaiter(void 0, void 0, void 0, function* () {
+        const { account, config, samlResponse } = yield (0, role_1.initOktaSaml)(authn, args.accountId);
         const { roles } = (0, role_1.rolesFromSaml)(account, samlResponse);
         if (!roles.includes(args.role))
             throw `Role not available. Available roles:\n${roles.map((r) => `  ${r}`).join("\n")}`;

package/dist/plugins/okta/login.js

@@ -66,7 +66,17 @@ const fetchSamlResponse = (org, { access_token }) => __awaiter(void 0, void 0, v
     return samlInput === null || samlInput === void 0 ? void 0 : samlInput.value;
 });
 /** Logs in to Okta via OIDC */
-const oktaLogin = (org) => __awaiter(void 0, void 0, void 0, function* () { return (0, login_1.oidcLogin)(org, "openid email profile okta.apps.sso"); });
+const oktaLogin = (org) => __awaiter(void 0, void 0, void 0, function* () {
+    return (0, login_1.oidcLogin)((0, login_1.oidcLoginSteps)(org, "openid email profile okta.apps.sso", () => {
+        if (org.providerType !== "okta") {
+            throw `Invalid provider type ${org.providerType} (expected "okta")`;
+        }
+        return {
+            deviceAuthorizationUrl: `https://${org.providerDomain}/oauth2/v1/device/authorize`,
+            tokenUrl: `https://${org.providerDomain}/oauth2/v1/token`,
+        };
+    }));
+});
 exports.oktaLogin = oktaLogin;
 /** Retrieves a SAML response for an okta app */
 // TODO: Inject Okta app

package/dist/plugins/ping/login.d.ts

@@ -8,6 +8,7 @@ This file is part of @p0security/cli
 
 You should have received a copy of the GNU General Public License along with @p0security/cli. If not, see <https://www.gnu.org/licenses/>.
 **/
+import { TokenResponse } from "../../types/oidc";
 import { OrgData } from "../../types/org";
 /** Logs in to PingOne via OIDC */
-export declare const pingLogin: (org: OrgData) => Promise<import("../../types/oidc").TokenResponse>;
+export declare const pingLogin: (org: OrgData) => Promise<TokenResponse>;

package/dist/plugins/ping/login.js

@@ -12,5 +12,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.pingLogin = void 0;
 const login_1 = require("../oidc/login");
 /** Logs in to PingOne via OIDC */
-const pingLogin = (org) => __awaiter(void 0, void 0, void 0, function* () { return (0, login_1.oidcLogin)(org, "openid email profile"); });
+const pingLogin = (org) => __awaiter(void 0, void 0, void 0, function* () {
+    return (0, login_1.oidcLogin)((0, login_1.oidcLoginSteps)(org, "openid email profile", () => {
+        if (org.providerType !== "ping" || org.providerType === undefined) {
+            throw `Invalid provider type ${org.providerType} (expected "ping")`;
+        }
+        return {
+            deviceAuthorizationUrl: `https://${org.providerDomain}/${org.environmentId}/as/device_authorization`,
+            tokenUrl: `https://${org.providerDomain}/${org.environmentId}/as/token`,
+        };
+    }));
+});
 exports.pingLogin = pingLogin;

package/dist/plugins/{aws/ssm → ssh}/index.d.ts

@@ -8,6 +8,7 @@ This file is part of @p0security/cli
 
 You should have received a copy of the GNU General Public License along with @p0security/cli. If not, see <https://www.gnu.org/licenses/>.
 **/
-import { ScpCommandArgs, SshCommandArgs, SshRequest } from "../../../commands/shared";
-import { Authn } from "../../../types/identity";
+import { ScpCommandArgs, SshCommandArgs } from "../../commands/shared/ssh";
+import { Authn } from "../../types/identity";
+import { SshRequest } from "../../types/ssh";
 export declare const sshOrScp: (authn: Authn, data: SshRequest, cmdArgs: ScpCommandArgs | SshCommandArgs, privateKey: string) => Promise<number | null>;

package/dist/plugins/ssh/index.js

@@ -0,0 +1,311 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sshOrScp = void 0;
+const keys_1 = require("../../common/keys");
+const stdio_1 = require("../../drivers/stdio");
+const util_1 = require("../../util");
+const config_1 = require("../aws/config");
+const idc_1 = require("../aws/idc");
+const install_1 = require("../aws/ssm/install");
+const aws_1 = require("../okta/aws");
+const ssh_agent_1 = require("../ssh-agent");
+const node_child_process_1 = require("node:child_process");
+/** Matches the error message that AWS SSM print1 when access is not propagated */
+// Note that the resource will randomly be either the SSM document or the EC2 instance
+const UNAUTHORIZED_START_SESSION_MESSAGE = /An error occurred \(AccessDeniedException\) when calling the StartSession operation: User: arn:aws:sts::.*:assumed-role\/P0GrantsRole.* is not authorized to perform: ssm:StartSession on resource: arn:aws:.*:.*:.* because no identity-based policy allows the ssm:StartSession action/;
+/**
+ * Matches the following error messages that AWS SSM print1 when ssh authorized
+ * key access hasn't propagated to the instance yet.
+ * - Connection closed by UNKNOWN port 65535
+ * - scp: Connection closed
+ * - kex_exchange_identification: Connection closed by remote host
+ */
+const CONNECTION_CLOSED_MESSAGE = /\bConnection closed\b.*\b(?:by UNKNOWN port \d+|by remote host)?/;
+const PUBLIC_KEY_DENIED_MESSAGE = /Permission denied \(publickey\)/;
+const UNAUTHORIZED_TUNNEL_USER_MESSAGE = /Error while connecting \[4033: 'not authorized'\]/;
+const UNAUTHORIZED_INSTANCES_GET_MESSAGE = /Required 'compute\.instances\.get' permission/;
+const DESTINATION_READ_ERROR = /Error while connecting \[4010: 'destination read failed'\]/;
+const GOOGLE_LOGIN_MESSAGE = /You do not currently have an active account selected/;
+/** Maximum amount of time after SSH subprocess starts to check for {@link UNPROVISIONED_ACCESS_MESSAGES}
+ *  in the process's stderr
+ */
+const DEFAULT_VALIDATION_WINDOW_MS = 5e3;
+/** Maximum number of attempts to start an SSH session
+ *
+ * Note that each attempt consumes ~ 1 s.
+ */
+const DEFAULT_MAX_SSH_RETRIES = 30;
+const GCP_MAX_SSH_RETRIES = 120; // GCP requires more time to propagate access
+/** The name of the SessionManager port forwarding document. This document is managed by AWS.  */
+const START_SSH_SESSION_DOCUMENT_NAME = "AWS-StartSSHSession";
+/**
+ * AWS
+ * There are 2 cases of unprovisioned access in AWS
+ * 1. SSM:StartSession action is missing either on the SSM document (AWS-StartSSHSession) or the EC2 instance
+ * 2. Temporary error when issuing an SCP command
+ *
+ * 1: results in UNAUTHORIZED_START_SESSION_MESSAGE
+ * 2: results in CONNECTION_CLOSED_MESSAGE
+ *
+ * Google Cloud
+ * There are 5 cases of unprovisioned access in Google Cloud.
+ * These are all potentially subject to propagation delays.
+ * 1. The linux user name is not present in the user's Google Workspace profile `posixAccounts` attribute
+ * 2. The public key is not present in the user's Google Workspace profile `sshPublicKeys` attribute
+ * 3. The user cannot act as the service account of the compute instance
+ * 4. The user cannot tunnel through the IAP tunnel to the instance
+ * 5. The user doesn't have osLogin or osAdminLogin role to the instance
+ * 5.a. compute.instances.get permission is missing
+ * 5.b. compute.instances.osLogin permission is missing
+ * 6: Rare occurrence, the exact conditions so far undetermined (together with CONNECTION_CLOSED_MESSAGE)
+ *
+ * 1, 2, 3 (yes!), 5b: result in PUBLIC_KEY_DENIED_MESSAGE
+ * 4: results in UNAUTHORIZED_TUNNEL_USER_MESSAGE and also CONNECTION_CLOSED_MESSAGE
+ * 5a: results in UNAUTHORIZED_INSTANCES_GET_MESSAGE
+ * 6: results in DESTINATION_READ_ERROR and also CONNECTION_CLOSED_MESSAGE
+ */
+const UNPROVISIONED_ACCESS_MESSAGES = [
+    { pattern: UNAUTHORIZED_START_SESSION_MESSAGE },
+    { pattern: CONNECTION_CLOSED_MESSAGE },
+    { pattern: PUBLIC_KEY_DENIED_MESSAGE },
+    { pattern: UNAUTHORIZED_TUNNEL_USER_MESSAGE },
+    { pattern: UNAUTHORIZED_INSTANCES_GET_MESSAGE, validationWindowMs: 30e3 },
+    { pattern: DESTINATION_READ_ERROR },
+];
+/** Checks if access has propagated through AWS to the SSM agent
+ *
+ * AWS takes about 8 minutes, GCP takes under 1 minute
+ * to fully resolve access after it is granted.
+ * During this time, calls to `aws ssm start-session` / `gcloud compute start-iap-tunnel`
+ * will fail randomly with an various error messages.
+ *
+ * This function checks the subprocess output to see if any of the error messages
+ * are printed to the error output within the first 5 seconds of startup.
+ * If they are, the returned `isAccessPropagated()` function will return false.
+ * When this occurs, the consumer of this function should retry the `aws` / `gcloud` command.
+ *
+ * Note that this function requires interception of the subprocess stderr stream.
+ * This works because AWS SSM wraps the session in a single-stream pty, so we
+ * do not capture stderr emitted from the wrapped shell session.
+ */
+const accessPropagationGuard = (child, debug) => {
+    let isEphemeralAccessDeniedException = false;
+    let isGoogleLoginException = false;
+    const beforeStart = Date.now();
+    child.stderr.on("data", (chunk) => {
+        const chunkString = chunk.toString("utf-8");
+        if (debug)
+            (0, stdio_1.print2)(chunkString);
+        const match = UNPROVISIONED_ACCESS_MESSAGES.find((message) => chunkString.match(message.pattern));
+        if (match &&
+            Date.now() <=
+                beforeStart + (match.validationWindowMs || DEFAULT_VALIDATION_WINDOW_MS)) {
+            isEphemeralAccessDeniedException = true;
+        }
+        const googleLoginMatch = chunkString.match(GOOGLE_LOGIN_MESSAGE);
+        isGoogleLoginException = isGoogleLoginException || !!googleLoginMatch; // once true, always true
+        if (isGoogleLoginException) {
+            isEphemeralAccessDeniedException = false; // always overwrite to false so we don't retry the access
+        }
+    });
+    return {
+        isAccessPropagated: () => !isEphemeralAccessDeniedException,
+        isGoogleLoginException: () => isGoogleLoginException,
+    };
+};
+const spawnChildProcess = (credential, command, args, stdio) => (0, node_child_process_1.spawn)(command, args, {
+    env: Object.assign(Object.assign({}, process.env), credential),
+    stdio,
+    shell: false,
+});
+const friendlyProvider = (provider) => provider === "aws"
+    ? "AWS"
+    : provider === "gcloud"
+        ? "Google Cloud"
+        : (0, util_1.throwAssertNever)(provider);
+/** Starts an SSM session in the terminal by spawning `aws ssm` as a subprocess
+ *
+ * Requires `aws ssm` to be installed on the client machine.
+ */
+function spawnSshNode(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return new Promise((resolve, reject) => {
+            const child = spawnChildProcess(options.credential, options.command, options.args, options.stdio);
+            // TODO ENG-2284 support login with Google Cloud: currently return a boolean to indicate if the exception was a Google login error.
+            const { isAccessPropagated, isGoogleLoginException } = accessPropagationGuard(child, options.debug);
+            const exitListener = child.on("exit", (code) => {
+                var _a;
+                exitListener.unref();
+                // In the case of ephemeral AccessDenied exceptions due to unpropagated
+                // permissions, continually retry access until success
+                if (!isAccessPropagated()) {
+                    const attemptsRemaining = options.attemptsRemaining;
+                    if (options.debug) {
+                        (0, stdio_1.print2)(`Waiting for access to propagate. Retrying SSH session... (remaining attempts: ${attemptsRemaining})`);
+                    }
+                    if (attemptsRemaining <= 0) {
+                        reject(`Access did not propagate through ${friendlyProvider(options.provider)} before max retry attempts were exceeded. Please contact support@p0.dev for assistance.`);
+                        return;
+                    }
+                    spawnSshNode(Object.assign(Object.assign({}, options), { attemptsRemaining: attemptsRemaining - 1 }))
+                        .then((code) => resolve(code))
+                        .catch(reject);
+                    return;
+                }
+                else if (isGoogleLoginException()) {
+                    reject(`Please login to Google Cloud CLI with 'gcloud auth login'`);
+                    return;
+                }
+                (_a = options.abortController) === null || _a === void 0 ? void 0 : _a.abort(code);
+                (0, stdio_1.print2)(`SSH session terminated`);
+                resolve(code);
+            });
+        });
+    });
+}
+const createProxyCommands = (data, args, debug) => {
+    let proxyCommand;
+    if (data.type === "aws") {
+        proxyCommand = [
+            "aws",
+            "ssm",
+            "start-session",
+            "--region",
+            data.region,
+            "--target",
+            "%h",
+            "--document-name",
+            START_SSH_SESSION_DOCUMENT_NAME,
+            "--parameters",
+            '"portNumber=%p"',
+        ];
+    }
+    else if (data.type === "gcloud") {
+        proxyCommand = [
+            "gcloud",
+            "compute",
+            "start-iap-tunnel",
+            data.id,
+            "%p",
+            // --listen-on-stdin flag is required for interactive SSH session.
+            // It is undocumented on page https://cloud.google.com/sdk/gcloud/reference/compute/start-iap-tunnel
+            // but mention on page https://cloud.google.com/iap/docs/tcp-by-host
+            // and also found in `gcloud ssh --dry-run` output
+            "--listen-on-stdin",
+            `--zone=${data.zone}`,
+            `--project=${data.projectId}`,
+        ];
+    }
+    else {
+        throw (0, util_1.assertNever)(data);
+    }
+    const commonArgs = [
+        ...(debug ? ["-v"] : []),
+        "-o",
+        `ProxyCommand=${proxyCommand.join(" ")}`,
+    ];
+    if ("source" in args) {
+        return {
+            command: "scp",
+            args: [
+                ...commonArgs,
+                // if a response is not received after three 5 minute attempts,
+                // the connection will be closed.
+                "-o",
+                "ServerAliveCountMax=3",
+                `-o`,
+                "ServerAliveInterval=300",
+                ...(args.recursive ? ["-r"] : []),
+                args.source,
+                args.destination,
+            ],
+        };
+    }
+    return {
+        command: "ssh",
+        args: [
+            ...commonArgs,
+            ...(args.A ? ["-A"] : []),
+            ...(args.L ? ["-L", args.L] : []),
+            ...(args.N ? ["-N"] : []),
+            `${data.linuxUserName}@${data.id}`,
+            ...(args.command ? [args.command] : []),
+            ...args.arguments.map((argument) => 
+            // escape all double quotes (") in commands such as `p0 ssh <instance>> echo 'hello; "world"'` because we
+            // need to encapsulate command arguments in double quotes as we pass them along to the remote shell
+            `"${String(argument).replace(/"/g, '\\"')}"`),
+        ],
+    };
+};
+/** Converts arguments for manual execution - arguments may have to be quoted or certain characters escaped when executing the commands from a shell */
+const transformForShell = (args) => {
+    return args.map((arg) => {
+        // The ProxyCommand option must be surrounded by single quotes
+        if (arg.startsWith("ProxyCommand=")) {
+            const [name, ...value] = arg.split("="); // contains the '=' character in the parameters option: ProxyCommand=aws ssm start-session ... --parameters "portNumber=%p"
+            return `${name}='${value.join("=")}'`;
+        }
+        return arg;
+    });
+};
+const awsLogin = (authn, data) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c, _d;
+    if (!(yield (0, install_1.ensureSsmInstall)())) {
+        throw "Please try again after installing the required AWS utilities";
+    }
+    const { config } = yield (0, config_1.getAwsConfig)(authn, data.accountId);
+    if (!((_a = config.login) === null || _a === void 0 ? void 0 : _a.type) || ((_b = config.login) === null || _b === void 0 ? void 0 : _b.type) === "iam") {
+        throw "This account is not configured for SSH access via the P0 CLI";
+    }
+    return ((_c = config.login) === null || _c === void 0 ? void 0 : _c.type) === "idc"
+        ? yield (0, idc_1.assumeRoleWithIdc)(data)
+        : ((_d = config.login) === null || _d === void 0 ? void 0 : _d.type) === "federated"
+            ? yield (0, aws_1.assumeRoleWithOktaSaml)(authn, data)
+            : (0, util_1.throwAssertNever)(config.login);
+});
+const sshOrScp = (authn, data, cmdArgs, privateKey) => __awaiter(void 0, void 0, void 0, function* () {
+    if (!privateKey) {
+        throw "Failed to load a private key for this request. Please contact support@p0.dev for assistance.";
+    }
+    // TODO ENG-2284 support login with Google Cloud
+    const credential = data.type === "aws" ? yield awsLogin(authn, data) : undefined;
+    return (0, ssh_agent_1.withSshAgent)(cmdArgs, () => __awaiter(void 0, void 0, void 0, function* () {
+        const { command, args } = createProxyCommands(data, cmdArgs, cmdArgs.debug);
+        if (cmdArgs.debug) {
+            const reproCommands = [
+                `eval $(ssh-agent)`,
+                `ssh-add "${keys_1.PRIVATE_KEY_PATH}"`,
+                // TODO ENG-2284 support login with Google Cloud
+                // TODO: Modify commands to add the ability to get permission set commands
+                ...(data.type === "aws" && data.access !== "idc"
+                    ? [
+                        `eval $(p0 aws role assume ${data.role} --account ${data.accountId})`,
+                    ]
+                    : []),
+                `${command} ${transformForShell(args).join(" ")}`,
+            ];
+            (0, stdio_1.print2)(`Execute the following commands to create a similar SSH/SCP session:\n*** COMMANDS BEGIN ***\n${reproCommands.join("\n")}\n*** COMMANDS END ***"\n`);
+        }
+        const maxRetries = data.type === "gcloud" ? GCP_MAX_SSH_RETRIES : DEFAULT_MAX_SSH_RETRIES;
+        return spawnSshNode({
+            credential,
+            abortController: new AbortController(),
+            command,
+            args,
+            stdio: ["inherit", "inherit", "pipe"],
+            debug: cmdArgs.debug,
+            provider: data.type,
+            attemptsRemaining: maxRetries,
+        });
+    }));
+});
+exports.sshOrScp = sshOrScp;

package/dist/plugins/ssh/types.d.ts

@@ -15,4 +15,8 @@ declare type SshItemConfig = {
 export declare type SshConfig = {
     "iam-write": Record<string, SshItemConfig>;
 };
+export declare type CommonSshPermissionSpec = {
+    publicKey: string;
+    sudo?: boolean;
+};
 export {};