@p0security/cli 0.8.0 → 0.8.2

package/dist/plugins/ssh-agent/index.js

@@ -21,49 +21,15 @@ 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/>.
 **/
 const keys_1 = require("../../common/keys");
+const subprocess_1 = require("../../common/subprocess");
 const stdio_1 = require("../../drivers/stdio");
-const node_child_process_1 = require("node:child_process");
-/** Spawns a subprocess with given command, args, and options.
- * May write content to its standard input.
- * Stdout and stderr of the subprocess is printed to stderr in debug mode.
- * The returned promise resolves or rejects with the exit code. */
-const asyncSpawn = ({ debug }, command, args, options, writeStdin) => __awaiter(void 0, void 0, void 0, function* () {
-    return new Promise((resolve, reject) => {
-        var _a;
-        const child = (0, node_child_process_1.spawn)(command, args, options);
-        if (writeStdin) {
-            if (!child.stdin)
-                return reject("Child process has no stdin");
-            child.stdin.write(writeStdin);
-        }
-        child.stdout.on("data", (data) => {
-            if (debug) {
-                (0, stdio_1.print2)(data.toString("utf-8"));
-            }
-        });
-        child.stderr.on("data", (data) => {
-            if (debug) {
-                (0, stdio_1.print2)(data.toString("utf-8"));
-            }
-        });
-        child.on("exit", (code) => {
-            if (code !== 0) {
-                return reject(code);
-            }
-            resolve(code);
-        });
-        if (writeStdin) {
-            (_a = child.stdin) === null || _a === void 0 ? void 0 : _a.end();
-        }
-    });
-});
 const isSshAgentRunning = (args) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         if (args.debug)
             (0, stdio_1.print2)("Searching for active ssh-agents");
         // TODO: There's a possible edge-case but unlikely that ssh-agent has an invalid process or PID.
         // We can check to see if the active PID matches the current socket to mitigate this.
-        yield asyncSpawn(args, `pgrep`, ["-x", "ssh-agent"]);
+        yield (0, subprocess_1.asyncSpawn)(args, `pgrep`, ["-x", "ssh-agent"]);
         if (args.debug)
             (0, stdio_1.print2)("At least one SSH agent is running");
         return true;
@@ -76,7 +42,7 @@ const isSshAgentRunning = (args) => __awaiter(void 0, void 0, void 0, function*
 });
 const isSshAgentAuthSocketSet = (args) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        yield asyncSpawn(args, `sh`, ["-c", '[ -n "$SSH_AUTH_SOCK" ]']);
+        yield (0, subprocess_1.asyncSpawn)(args, `sh`, ["-c", '[ -n "$SSH_AUTH_SOCK" ]']);
         if (args.debug)
             (0, stdio_1.print2)(`SSH_AUTH_SOCK=${process.env.SSH_AUTH_SOCK}`);
         return true;
@@ -89,7 +55,7 @@ const isSshAgentAuthSocketSet = (args) => __awaiter(void 0, void 0, void 0, func
 });
 const privateKeyExists = (args) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        yield asyncSpawn(args, `sh`, [
+        yield (0, subprocess_1.asyncSpawn)(args, `sh`, [
             "-c",
             `KEY_PATH="${keys_1.PRIVATE_KEY_PATH}" && KEY_FINGERPRINT=$(ssh-keygen -lf "$KEY_PATH" | awk '{print $2}') && ssh-add -l | grep -q "$KEY_FINGERPRINT" && exit 0 || exit 1`,
         ]);
@@ -106,7 +72,7 @@ const privateKeyExists = (args) => __awaiter(void 0, void 0, void 0, function* (
 exports.privateKeyExists = privateKeyExists;
 const addPrivateKey = (args) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        yield asyncSpawn(args, `ssh-add`, [
+        yield (0, subprocess_1.asyncSpawn)(args, `ssh-add`, [
             keys_1.PRIVATE_KEY_PATH,
             ...(args.debug ? ["-v", "-v", "-v"] : ["-q"]),
         ]);

package/dist/types/aws/oidc.d.ts

@@ -0,0 +1,36 @@
+/** Copyright © 2024-present P0 Security
+
+This file is part of @p0security/cli
+
+@p0security/cli is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3 of the License.
+
+@p0security/cli is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with @p0security/cli. If not, see <https://www.gnu.org/licenses/>.
+**/
+export declare type AWSClientInformation = {
+    authorizationEndpoint: string;
+    clientId: string;
+    clientIdIssuedAt: number;
+    clientSecret: string;
+    clientSecretExpiresAt: number;
+    tokenEndpoint: string;
+};
+/**
+ * AWS OIDC token response uses camelCase instead of snake_case
+ */
+export declare type AWSTokenResponse = {
+    accessToken: string;
+    expiresIn: number;
+    idToken: string;
+    refreshToken: string;
+    tokenType: string;
+};
+export declare type AWSAuthorizeResponse = {
+    deviceCode: string;
+    expiresIn: number;
+    interval: number;
+    userCode: string;
+    verificationUri: string;
+    verificationUriComplete: string;
+};

package/dist/types/aws/oidc.js

@@ -0,0 +1,12 @@
+"use strict";
+/** Copyright © 2024-present P0 Security
+
+This file is part of @p0security/cli
+
+@p0security/cli is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3 of the License.
+
+@p0security/cli is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with @p0security/cli. If not, see <https://www.gnu.org/licenses/>.
+**/
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/oidc.d.ts

@@ -1,3 +1,4 @@
+import { LoginPluginType } from "../plugins/login";
 /** Copyright © 2024-present P0 Security
 
 This file is part of @p0security/cli
@@ -39,3 +40,23 @@ export declare type TokenResponse = {
 export declare type TokenErrorResponse = {
     error: "access_denied" | "authorization_pending" | "bad grant type" | "expired_token" | "missing parameter" | "not found" | "slow_down";
 };
+export declare type OidcLoginSteps<A> = {
+    providerType: LoginPluginType;
+    validateResponse: (response: Response) => Promise<Response>;
+    buildAuthorizeRequest: () => {
+        url: string;
+        init: RequestInit;
+    };
+    buildTokenRequest: (authorize: A) => {
+        url: string;
+        init: RequestInit;
+    };
+    processAuthzResponse: (authorize: A) => {
+        user_code: string;
+        verification_uri_complete: string;
+    };
+    processAuthzExpiry: (authorize: A) => {
+        expires_in: number;
+        interval: number;
+    };
+};

package/dist/types/request.d.ts

@@ -8,22 +8,20 @@ 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 { PluginSshRequest } from "./ssh";
 export declare const DONE_STATUSES: readonly ["DONE", "DONE_NOTIFIED"];
 export declare const DENIED_STATUSES: readonly ["DENIED", "DENIED_NOTIFIED"];
 export declare const ERROR_STATUSES: readonly ["ERRORED", "ERRORED", "ERRORED_NOTIFIED"];
-export declare type PluginRequest = {
-    permission: object;
-    generated?: object;
+export declare type PermissionSpec<K extends string, P extends {
+    type: string;
+}, G extends object | undefined = undefined> = {
+    type: K;
+    permission: P;
+    generated: G;
 };
-export declare type Request<P extends PluginRequest = {
-    permission: object;
-}> = {
+export declare type PluginRequest = PluginSshRequest;
+export declare type Request<P extends PluginRequest> = P & {
     status: string;
-    generatedRoles: {
-        role: string;
-    }[];
-    generated: P["generated"];
-    permission: P["permission"];
     principal: string;
 };
 export declare type RequestResponse<T> = {

package/dist/types/request.js

@@ -1,16 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ERROR_STATUSES = exports.DENIED_STATUSES = exports.DONE_STATUSES = void 0;
-/** Copyright © 2024-present P0 Security
-
-This file is part of @p0security/cli
-
-@p0security/cli is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3 of the License.
-
-@p0security/cli is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along with @p0security/cli. If not, see <https://www.gnu.org/licenses/>.
-**/
 exports.DONE_STATUSES = ["DONE", "DONE_NOTIFIED"];
 exports.DENIED_STATUSES = ["DENIED", "DENIED_NOTIFIED"];
 exports.ERROR_STATUSES = [

package/dist/types/ssh.d.ts

@@ -0,0 +1,27 @@
+/** Copyright © 2024-present P0 Security
+
+This file is part of @p0security/cli
+
+@p0security/cli is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3 of the License.
+
+@p0security/cli is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+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 { AwsSsh, AwsSshPermissionSpec, AwsSshRequest } from "../plugins/aws/types";
+import { GcpSsh, GcpSshPermissionSpec, GcpSshRequest } from "../plugins/google/types";
+import { Request } from "./request";
+export declare type CliSshRequest = AwsSsh | GcpSsh;
+export declare type PluginSshRequest = AwsSshPermissionSpec | GcpSshPermissionSpec;
+export declare type CliPermissionSpec<P extends PluginSshRequest, C extends object | undefined> = P & {
+    cliLocalData: C;
+};
+export declare const SupportedSshProviders: readonly ["aws", "gcloud"];
+export declare type SupportedSshProvider = (typeof SupportedSshProviders)[number];
+export declare type SshProvider<PR extends PluginSshRequest = PluginSshRequest, O extends object | undefined = undefined, SR extends SshRequest = SshRequest> = {
+    requestToSsh: (request: CliPermissionSpec<PR, O>) => SR;
+    toCliRequest: (request: Request<PR>, options?: {
+        debug?: boolean;
+    }) => Promise<Request<CliSshRequest>>;
+};
+export declare type SshRequest = AwsSshRequest | GcpSshRequest;

package/dist/types/ssh.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SupportedSshProviders = void 0;
+// The prefix of installed SSH accounts in P0 is the provider name
+exports.SupportedSshProviders = ["aws", "gcloud"];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@p0security/cli",
-  "version": "0.8.0",
+  "version": "0.8.2",
   "description": "Execute infra CLI commands with P0 grants",
   "main": "index.ts",
   "repository": {

package/dist/plugins/aws/ssm/index.js

@@ -1,213 +0,0 @@
-"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 aws_1 = require("../../okta/aws");
-const ssh_agent_1 = require("../../ssh-agent");
-const install_1 = require("./install");
-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 UNPROVISIONED_ACCESS_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 UNPROVISIONED_SCP_ACCESS_MESSAGE = /\bConnection closed\b.*\b(?:by UNKNOWN port \d+|by remote host)?/;
-/** Maximum amount of time after AWS SSM process starts to check for {@link UNPROVISIONED_ACCESS_MESSAGE}
- *  in the process's stderr
- */
-const UNPROVISIONED_ACCESS_VALIDATION_WINDOW_MS = 5e3;
-/** Maximum number of attempts to start an SSM session
- *
- * Note that each attempt consumes ~ 1 s.
- */
-const MAX_SSM_RETRIES = 30;
-/** The name of the SessionManager port forwarding document. This document is managed by AWS.  */
-const START_SSH_SESSION_DOCUMENT_NAME = "AWS-StartSSHSession";
-/** Checks if access has propagated through AWS to the SSM agent
- *
- * AWS takes about 8 minutes to fully resolve access after it is granted. During
- * this time, calls to `aws ssm start-session` will fail randomly with an
- * access denied exception.
- *
- * This function checks AWS to see if this exception is print1d to the SSM
- * error output within the first 5 seconds of startup. If it is, the returned
- * `isAccessPropagated()` function will return false. When this occurs, the
- * consumer of this function should retry the AWS SSM session.
- *
- * Note that this function requires interception of the AWS SSM 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) => {
-    let isEphemeralAccessDeniedException = false;
-    const beforeStart = Date.now();
-    child.stderr.on("data", (chunk) => {
-        const chunkString = chunk.toString("utf-8");
-        const match = chunkString.match(UNPROVISIONED_ACCESS_MESSAGE) ||
-            chunkString.match(UNPROVISIONED_SCP_ACCESS_MESSAGE);
-        if (match &&
-            Date.now() <= beforeStart + UNPROVISIONED_ACCESS_VALIDATION_WINDOW_MS) {
-            isEphemeralAccessDeniedException = true;
-            return;
-        }
-        (0, stdio_1.print2)(chunkString);
-    });
-    return {
-        isAccessPropagated: () => !isEphemeralAccessDeniedException,
-    };
-};
-const createBaseSsmCommand = (args) => {
-    return [
-        "aws",
-        "ssm",
-        "start-session",
-        "--region",
-        args.region,
-        "--target",
-        args.instance,
-    ];
-};
-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,
-});
-/** 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 spawnSsmNode(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);
-            const { isAccessPropagated } = accessPropagationGuard(child);
-            const exitListener = child.on("exit", (code) => {
-                var _a, _b;
-                exitListener.unref();
-                // In the case of ephemeral AccessDenied exceptions due to unpropagated
-                // permissions, continually retry access until success
-                if (!isAccessPropagated()) {
-                    const attemptsRemaining = (_a = options === null || options === void 0 ? void 0 : options.attemptsRemaining) !== null && _a !== void 0 ? _a : MAX_SSM_RETRIES;
-                    if (attemptsRemaining <= 0) {
-                        reject("Access did not propagate through AWS before max retry attempts were exceeded. Please contact support@p0.dev for assistance.");
-                        return;
-                    }
-                    spawnSsmNode(Object.assign(Object.assign({}, options), { attemptsRemaining: attemptsRemaining - 1 }))
-                        .then((code) => resolve(code))
-                        .catch(reject);
-                    return;
-                }
-                (_b = options.abortController) === null || _b === void 0 ? void 0 : _b.abort(code);
-                (0, stdio_1.print2)(`SSH session terminated`);
-                resolve(code);
-            });
-        });
-    });
-}
-const createProxyCommands = (data, args, debug) => {
-    const ssmCommand = [
-        ...createBaseSsmCommand({
-            region: data.region,
-            instance: "%h",
-        }),
-        "--document-name",
-        START_SSH_SESSION_DOCUMENT_NAME,
-        "--parameters",
-        '"portNumber=%p"',
-    ];
-    const commonArgs = [
-        ...(debug ? ["-v"] : []),
-        "-o",
-        `ProxyCommand=${ssmCommand.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 sshOrScp = (authn, data, cmdArgs, privateKey) => __awaiter(void 0, void 0, void 0, function* () {
-    if (!(yield (0, install_1.ensureSsmInstall)())) {
-        throw "Please try again after installing the required AWS utilities";
-    }
-    if (!privateKey) {
-        throw "Failed to load a private key for this request. Please contact support@p0.dev for assistance.";
-    }
-    const credential = yield (0, aws_1.assumeRoleWithOktaSaml)(authn, {
-        account: data.accountId,
-        role: data.role,
-    });
-    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}"`,
-                `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`);
-        }
-        return spawnSsmNode({
-            credential,
-            abortController: new AbortController(),
-            command,
-            args,
-            stdio: ["inherit", "inherit", "pipe"],
-        });
-    }));
-});
-exports.sshOrScp = sshOrScp;