opal-security 2.0.19 → 2.1.0

package/lib/lib/resources.js

@@ -1,22 +1,81 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.promptUserForAccessLevels = exports.unexpectedAmountOfAccessLevelsFound = exports.resourcesAreEmpty = void 0;
-const cmd_1 = require("./cmd");
+exports.promptUserForAccessLevels = exports.promptUserForResource = exports.filterChoices = exports.DEFAULT_ACCESS_LEVEL = void 0;
 const handler_1 = require("../handler");
 const apollo_1 = require("./apollo");
 const inquirer = require("inquirer");
-exports.resourcesAreEmpty = (context, resources) => {
-    if (resources.length === 0) {
-        context.log('❗️ Oh no! You don\'t have any resources. Head to Opal to request some.');
-        return true;
+exports.DEFAULT_ACCESS_LEVEL = {
+    accessLevelName: '',
+    accessLevelRemoteId: '',
+};
+// Returns a filtered array of items that match the input
+exports.filterChoices = (input, choices) => {
+    input = input || '';
+    if (input === '') {
+        return choices;
     }
-    return false;
+    return choices.filter(choice => choice.name.toLowerCase().includes(input.toLowerCase()));
 };
-exports.unexpectedAmountOfAccessLevelsFound = (context) => {
-    context.log('❗️ Oh no! We weren\'t expecting the amount of access levels returned from Opal. Please contact your support engineer.');
+const ListResourcesDocumentTemplate = `
+query ListResources {
+  resources(input: {resourceTypes: [RESOURCE_TYPE], onlyMine: true, maxNumEntries: 1000}) {
+    __typename
+    ... on ResourcesResult {
+      resources {
+        name
+        id
+        parentResource {
+          name
+        }
+        connection {
+          name
+        }
+      }
+      cursor
+    }
+  }
+}`;
+exports.promptUserForResource = async (command, resourceType, message) => {
+    const listResourcesDocument = ListResourcesDocumentTemplate.replace('RESOURCE_TYPE', resourceType);
+    const { resp, error } = await handler_1.runQuery({
+        command: command,
+        query: listResourcesDocument,
+        variables: {},
+    });
+    if (error) {
+        return apollo_1.handleError(command, error, resp);
+    }
+    const resourceInfos = resp === null || resp === void 0 ? void 0 : resp.data.resources.resources.map((resource) => {
+        let name = resource.name;
+        if (resource.parentResource) {
+            name = `[${resource.parentResource.name}] ${name}`;
+        }
+        else if (resource.connection) {
+            name = `[${resource.connection.name}] ${name}`;
+        }
+        return {
+            id: resource.id,
+            name: name,
+        };
+    });
+    if (resourceInfos.length === 0) {
+        return apollo_1.handleError(command, 'Oh no! You don\'t have access to any resources. Please go to Opal to request access.');
+    }
+    const resourceInfoByName = {};
+    resourceInfos.forEach(resourceInfo => {
+        resourceInfoByName[resourceInfo.name] = resourceInfo;
+    });
+    inquirer.registerPrompt('autocomplete', require('inquirer-autocomplete-prompt'));
+    const selectedResourceInfo = await inquirer.prompt([{
+            name: 'resource',
+            message: message,
+            type: 'autocomplete',
+            source: (answers, input) => exports.filterChoices(input, resourceInfos),
+        }]);
+    return resourceInfoByName[selectedResourceInfo.resource];
 };
-const ListAccessRolesForResource = `
-query ListAccessRolesForResource($resourceId: ResourceId!) {
+const ListAccessLevelsForResource = `
+query ListAccessLevelsForResource($resourceId: ResourceId!) {
   accessLevels(input: {resourceId: $resourceId, onlyMine: true}) {
     __typename
     ... on ResourceAccessLevelsResult {
@@ -27,23 +86,23 @@ query ListAccessRolesForResource($resourceId: ResourceId!) {
     }
   }
 }`;
-exports.promptUserForAccessLevels = async (context, resourceId, instanceType, accessLevelRemoteId) => {
+exports.promptUserForAccessLevels = async (command, resourceId, instanceType, accessLevelRemoteId) => {
     var _a, _b, _c;
-    const { resp: accessLevelsResponse, error: accessLevelsError } = await handler_1.runQuery({
-        command: context,
-        query: ListAccessRolesForResource,
+    const { resp, error } = await handler_1.runQuery({
+        command: command,
+        query: ListAccessLevelsForResource,
         variables: { resourceId },
     });
-    if (accessLevelsError) {
-        apollo_1.printRequestOutput(context, accessLevelsResponse, accessLevelsError);
-        return null;
+    if (error) {
+        return apollo_1.handleError(command, error, resp);
     }
-    const accessLevelInfos = (_c = (_b = (_a = accessLevelsResponse === null || accessLevelsResponse === void 0 ? void 0 : accessLevelsResponse.data) === null || _a === void 0 ? void 0 : _a.accessLevels) === null || _b === void 0 ? void 0 : _b.accessLevels) === null || _c === void 0 ? void 0 : _c.map((resp) => ({ id: resp.accessLevelRemoteId, name: resp.accessLevelName }));
+    const accessLevelInfos = (_c = (_b = (_a = resp === null || resp === void 0 ? void 0 : resp.data) === null || _a === void 0 ? void 0 : _a.accessLevels) === null || _b === void 0 ? void 0 : _b.accessLevels) === null || _c === void 0 ? void 0 : _c.map((resp) => ({
+        id: resp.accessLevelRemoteId,
+        name: resp.accessLevelName,
+    }));
     if (!accessLevelInfos) {
-        exports.unexpectedAmountOfAccessLevelsFound(context);
-        return null;
+        return apollo_1.handleError(command, 'Oh no! We weren\'t expecting the amount of access levels returned from Opal. Please contact your support engineer.');
     }
-    // Prompt user to pick access levels available to them
     const accessLevelInfoByName = {};
     const accessLevelInfoByRemoteId = {};
     accessLevelInfos.forEach(accessLevelInfo => {
@@ -54,13 +113,14 @@ exports.promptUserForAccessLevels = async (context, resourceId, instanceType, ac
     if (accessLevelRemoteId) {
         selectedAccessLevel = accessLevelInfoByRemoteId[accessLevelRemoteId];
     }
+    // Prompt user to pick access levels available to them
     if (!selectedAccessLevel) {
         inquirer.registerPrompt('autocomplete', require('inquirer-autocomplete-prompt'));
         const selectedAccessLevelInfo = await inquirer.prompt([{
                 name: 'accessLevel',
                 message: `Select an access level to the ${instanceType}`,
                 type: 'autocomplete',
-                source: (answers, input) => cmd_1.filterChoices(input, accessLevelInfos),
+                source: (answers, input) => exports.filterChoices(input, accessLevelInfos),
             }]);
         selectedAccessLevel = accessLevelInfoByName[selectedAccessLevelInfo.accessLevel];
     }

package/lib/lib/sessions.d.ts

@@ -0,0 +1,4 @@
+import Command from '@oclif/command';
+import { ResourceAccessLevelInput } from '../types';
+export declare const getOrCreateSession: (command: Command, resourceId: string, accessLevel: ResourceAccessLevelInput, sessionId: string | undefined, metadataFragment: string) => Promise<any>;
+export declare const getSessionExpirationMessage: (session: any) => string;

package/lib/lib/sessions.js

@@ -0,0 +1,154 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSessionExpirationMessage = exports.getOrCreateSession = void 0;
+const open = require("open");
+const config_1 = require("../lib/config");
+const handler_1 = require("../handler");
+const moment = require("moment");
+const apollo_1 = require("../lib/apollo");
+const common_1 = require("../lib/common");
+const CreateSessionDocument = `
+mutation CreateSession($id: ResourceId!, $accessLevel: ResourceAccessLevelInput!, $sessionId: SessionId) {
+  createSession(input: {resourceId: $id, accessLevel: $accessLevel, sessionId: $sessionId}) {
+    __typename
+    ... on CreateSessionResult {
+      session {
+        id
+        accessLevelRemoteId
+        endTime
+        metadata {
+          METADATA_FRAGMENT
+        }
+      }
+    }
+    ... on SessionNotFoundError {
+      message
+    }
+    ... on MfaInvalidError {
+      message
+    }
+    ... on OidcIDTokenNotFoundError {
+      message
+    }
+    ... on ResourceNotFoundError {
+      message
+    }
+    ... on EndSystemAuthorizationError {
+      message
+    }
+  }
+}
+`;
+const ListSessionsDocument = `
+query ListSessions($id: ResourceId!) {
+  sessions(input: {resourceId: $id}) {
+    __typename
+    ... on SessionsResult {
+      sessions {
+        id
+        accessLevelRemoteId
+        endTime
+        metadata {
+          METADATA_FRAGMENT
+        }
+      }
+    }
+  }
+}
+`;
+const getSession = async (command, resourceId, accessLevelRemoteId, sessionId, metadataFragment) => {
+    const { resp, error } = await handler_1.runQuery({
+        command: command,
+        query: ListSessionsDocument.replace('METADATA_FRAGMENT', metadataFragment),
+        variables: {
+            id: resourceId,
+        },
+    });
+    if (error) {
+        return apollo_1.handleError(command, error);
+    }
+    switch (resp === null || resp === void 0 ? void 0 : resp.data.sessions.__typename) {
+        case 'SessionsResult': {
+            const sessions = resp.data.sessions.sessions;
+            let selectedSession;
+            for (const session of sessions) {
+                if (sessionId && session.id !== sessionId) {
+                    continue;
+                }
+                if (session.accessLevelRemoteId !== accessLevelRemoteId) {
+                    continue;
+                }
+                if (!selectedSession || moment(session.endTime).diff(selectedSession.endTime) > 0) {
+                    // Select the session with the latest end time
+                    selectedSession = session;
+                }
+            }
+            return selectedSession;
+        }
+        default:
+            return apollo_1.handleError(command, error, resp);
+    }
+};
+const openBrowserAndPollForSession = async (command, message, resourceId, accessLevelRemoteId, sessionId, metadataFragment) => {
+    command.log(message);
+    const configData = config_1.getOrCreateConfigData(command.config.configDir);
+    const url = configData[config_1.urlKey];
+    setTimeout(() => {
+        open(url + `/resources/${resourceId}?showModal=true`);
+    }, 2000); // Wait before opening the browser to give the user time to read the message
+    let session;
+    while (!session) {
+        // eslint-disable-next-line no-await-in-loop
+        await common_1.sleep(2000);
+        // eslint-disable-next-line no-await-in-loop
+        session = await getSession(command, resourceId, accessLevelRemoteId, sessionId, metadataFragment);
+    }
+    return session;
+};
+const createSession = async (command, resourceId, accessLevel, sessionId, metadataFragment) => {
+    const { resp, error } = await handler_1.runMutation({
+        command: command,
+        query: CreateSessionDocument.replace('METADATA_FRAGMENT', metadataFragment),
+        variables: {
+            id: resourceId,
+            accessLevel: accessLevel,
+            sessionId,
+        },
+    });
+    if (error) {
+        return apollo_1.handleError(command, error);
+    }
+    switch (resp === null || resp === void 0 ? void 0 : resp.data.createSession.__typename) {
+        case 'CreateSessionResult': {
+            return resp.data.createSession.session;
+        }
+        case 'MfaInvalidError': {
+            command.log();
+            return openBrowserAndPollForSession(command, '❗ MFA validation needed. Please connect via browser. Opening browser and awaiting validation...', resourceId, accessLevel.accessLevelRemoteId, sessionId, metadataFragment);
+        }
+        case 'OidcIDTokenNotFoundError': {
+            command.log();
+            return openBrowserAndPollForSession(command, '❗ OIDC authentication needed. Please connect via browser. Opening browser and awaiting authentication...', resourceId, accessLevel.accessLevelRemoteId, sessionId, metadataFragment);
+        }
+        default:
+            return apollo_1.handleError(command, error, resp);
+    }
+};
+exports.getOrCreateSession = async (command, resourceId, accessLevel, sessionId, metadataFragment) => {
+    // Use existing session if it exists
+    const existingSession = await getSession(command, resourceId, accessLevel.accessLevelRemoteId, sessionId, metadataFragment);
+    if (existingSession) {
+        return existingSession;
+    }
+    if (sessionId) {
+        return apollo_1.handleError(command, 'Session not found for given id: ' + sessionId);
+    }
+    // Create new session
+    return createSession(command, resourceId, accessLevel, sessionId, metadataFragment);
+};
+exports.getSessionExpirationMessage = (session) => {
+    const diff = moment(session.endTime).diff(moment(), 'minutes');
+    const hours = Math.floor(diff / 60);
+    const minutes = diff % 60;
+    return `${hours}h ${minutes}m`;
+};

package/lib/lib/ssh.d.ts

@@ -1,5 +1,3 @@
 import { Command } from '@oclif/command';
-import { ResourceInfo } from '../lib/cmd';
-export declare const ListSshInstancesDocument = "\nquery ListSSHInstances {\n  resources(input: {serviceType: SSH, onlyMine: true, maxNumEntries: 1000}) {\n    __typename\n    ... on ResourcesResult {\n      resources {\n        name\n        id\n      }\n      cursor\n    }\n  }\n}";
-export declare const selectComputeInstance: (command: Command, description: string) => Promise<ResourceInfo | undefined>;
+export declare const selectComputeInstance: (command: Command, action: string) => Promise<void | import("./resources").ResourceInfo>;
 export declare const assertSessionManagerPluginExists: () => Promise<boolean>;

package/lib/lib/ssh.js

@@ -1,56 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertSessionManagerPluginExists = exports.selectComputeInstance = exports.ListSshInstancesDocument = void 0;
-const handler_1 = require("../handler");
-const apollo_1 = require("../lib/apollo");
+exports.assertSessionManagerPluginExists = exports.selectComputeInstance = void 0;
 const cmd_1 = require("../lib/cmd");
-const inquirer = require("inquirer");
 const resources_1 = require("./resources");
-exports.ListSshInstancesDocument = `
-query ListSSHInstances {
-  resources(input: {serviceType: SSH, onlyMine: true, maxNumEntries: 1000}) {
-    __typename
-    ... on ResourcesResult {
-      resources {
-        name
-        id
-      }
-      cursor
-    }
-  }
-}`;
-exports.selectComputeInstance = async (command, description) => {
-    const { resp: sshInstancesResp, error } = await handler_1.runQuery({
-        command: command,
-        query: exports.ListSshInstancesDocument,
-        variables: {},
-    });
-    if (error) {
-        apollo_1.printRequestOutput(command, sshInstancesResp, error);
-        return;
-    }
-    const resourceInfos = sshInstancesResp === null || sshInstancesResp === void 0 ? void 0 : sshInstancesResp.data.resources.resources.map((resource) => {
-        return {
-            id: resource.id,
-            name: resource.name,
-        };
-    });
-    const noResourcesFound = resources_1.resourcesAreEmpty(command, resourceInfos);
-    if (noResourcesFound) {
-        return;
-    }
-    const resourceInfoByName = {};
-    resourceInfos.forEach(resourceInfo => {
-        resourceInfoByName[resourceInfo.name] = resourceInfo;
-    });
-    inquirer.registerPrompt('autocomplete', require('inquirer-autocomplete-prompt'));
-    const selectedInstanceInfo = await inquirer.prompt([{
-            name: 'instance',
-            message: `Select a compute instance to ${description}`,
-            type: 'autocomplete',
-            source: (answers, input) => cmd_1.filterChoices(input, resourceInfos),
-        }]);
-    return resourceInfoByName[selectedInstanceInfo.instance];
+exports.selectComputeInstance = async (command, action) => {
+    return resources_1.promptUserForResource(command, 'AWS_EC2_INSTANCE', `Select an EC2 instance to ${action}`);
 };
 exports.assertSessionManagerPluginExists = async () => {
     const errorMessage = '❗ AWS session manager plugin is required to use SSH functionality. ' +

package/lib/types.d.ts

@@ -4373,6 +4373,7 @@ export declare type Resource = {
     ownerTeam?: Maybe<Group>;
     connectionId: Scalars['ConnectionId'];
     connection?: Maybe<Connection>;
+    parentResource?: Maybe<Resource>;
     folderId?: Maybe<Scalars['ResourceFolderId']>;
     folder?: Maybe<ResourceFolder>;
     resourceUsers: Array<ResourceUser>;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.0.19","commands":{"curl-example":{"id":"curl-example","description":"Prints out an example cURL command containing the parameters the CLI uses to query the Opal server.","pluginName":"opal-security","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"login":{"id":"login","description":"Authenticates you with the Opal server.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["$ opal login"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"logout":{"id":"logout","description":"Clears locally stored Opal server authentication credentials.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["$ opal logout"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"set-custom-header":{"id":"set-custom-header","description":"Sets a custom HTTP header to connect to the Opal server.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["$ opal set-custom-header --header 'cf-access-token: $TOKEN'"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"header":{"name":"header","type":"option"}},"args":[]},"set-token":{"id":"set-token","description":"Sets an API token to authenticate with the Opal server - alternative auth flow for headless environments.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["$ opal set-token"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"set-url":{"id":"set-url","description":"Sets the url of the Opal server. Defaults to https://app.opal.dev.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["$ opal set-url"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"custom":{"name":"custom","type":"option"},"allowSelfSignedCerts":{"name":"allowSelfSignedCerts","type":"boolean","allowNo":false},"prod":{"name":"prod","type":"boolean","allowNo":false},"staging":{"name":"staging","type":"boolean","allowNo":false},"demo":{"name":"demo","type":"boolean","allowNo":false},"dev":{"name":"dev","type":"boolean","allowNo":false},"devLocal":{"name":"devLocal","type":"boolean","allowNo":false}},"args":[]},"aws:identity":{"id":"aws:identity","description":"Gets the current caller identity for the \"opal\" AWS profile.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["opal aws:identity"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"iam-roles:start":{"id":"iam-roles:start","description":"Starts a session to assume an IAM role.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["opal iam-roles:start","opal iam-roles:start --id 51f7176b-0464-4a6f-8369-e951e187b398","opal iam-roles:start --id 51f7176b-0464-4a6f-8369-e951e187b398 --profileName \"custom-profile\""],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"id":{"name":"id","type":"option","description":"The ID of the Opal role resource."},"sessionId":{"name":"sessionId","type":"option","description":"SessionId of a session that has already been created via the web flow."},"profileName":{"name":"profileName","type":"option","description":"Uses a custom AWS profile name for the IAM role. Default value is the role's name."}},"args":[]},"kube-roles:start":{"id":"kube-roles:start","description":"Starts a session to assume a Kubernetes cluster IAM role.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["opal kube-roles:start","opal kube-roles:start --id 51f7176b-0464-4a6f-8369-e951e187b398","opal kube-roles:start --id 51f7176b-0464-4a6f-8369-e951e187b398 --accessLevelRemoteId \"arn:aws:iam::712234975475:role/acme-eks-cluster-admin-role\""],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"id":{"name":"id","type":"option","description":"The ID of the Opal role resource."},"accessLevelRemoteId":{"name":"accessLevelRemoteId","type":"option","description":"The remote ID of the access level with which to access the cluster."},"sessionId":{"name":"sessionId","type":"option","description":"SessionId of a session that has already been created via the web flow."}},"args":[]},"postgres-instances:start":{"id":"postgres-instances:start","description":"Starts a session to query a Postgres database.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["opal postgres-instances:start","opal postgres-instances:start --id 51f7176b-0464-4a6f-8369-e951e187b398","opal postgres-instances:start --id 51f7176b-0464-4a6f-8369-e951e187b398 --accessLevelRemoteId \"fullaccess\""],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"id":{"name":"id","type":"option","description":"The ID of the Opal instance resource."},"accessLevelRemoteId":{"name":"accessLevelRemoteId","type":"option","description":"The remote ID of the access level with which to access the database."},"sessionId":{"name":"sessionId","type":"option","description":"SessionId of a session that has already been created via the web flow."}},"args":[]},"resources:get":{"id":"resources:get","description":"Get resource info for a particular resource.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["opal resources:get --id 54052a3e-5375-4392-aeaf-0c6c44c131d4"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"id":{"name":"id","type":"option","required":true}},"args":[]},"ssh:copyFrom":{"id":"ssh:copyFrom","description":"Use SCP to copy files from a compute instance.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["opal ssh:copyFrom --src instance/dir --dest my/dir","opal ssh:copyFrom --src instance/dir --dest my/dir --id 51f7176b-0464-4a6f-8369-e951e187b398"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"src":{"name":"src","type":"option","description":"The path of the directory or file you would like to copy over SCP. Note we only support one file or directory at a time.","required":true},"dest":{"name":"dest","type":"option","description":"Pick which directory you want your files to be copied to.","required":false,"default":"."},"user":{"name":"user","type":"option","description":"Pick which user you want to run SCP over. Keep in mind not all users will have access to each other's home directory.","required":false,"default":"ssm-user"},"id":{"name":"id","type":"option","description":"The ID of the Opal instance resource."},"sessionId":{"name":"sessionId","type":"option","description":"SessionId of a session that has already been created via the web flow."}},"args":[]},"ssh:copyTo":{"id":"ssh:copyTo","description":"Use SCP to copy files to a compute instance.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["opal ssh:copyTo --src my/dir --dest instance/dir","opal ssh:copyTo --src my/dir --dest instance/dir --id 51f7176b-0464-4a6f-8369-e951e187b398"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"src":{"name":"src","type":"option","description":"The path of the directory or file you would like to copy over SCP. Note we only support one file or directory at a time.","required":true},"dest":{"name":"dest","type":"option","description":"Pick which directory you want your files to be copied to.","required":false,"default":"."},"user":{"name":"user","type":"option","description":"Pick which user you want to run SCP over. Keep in mind not all users will have access to each other's home directory.","required":false,"default":"ssm-user"},"id":{"name":"id","type":"option","description":"The ID of the Opal instance resource."},"sessionId":{"name":"sessionId","type":"option","description":"SessionId of a session that has already been created via the web flow."}},"args":[]},"ssh:start":{"id":"ssh:start","description":"Start an SSH session to access a particular compute instance.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["opal ssh:start","opal ssh:start --id 51f7176b-0464-4a6f-8369-e951e187b398"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"id":{"name":"id","type":"option","description":"The ID of the Opal instance resource."},"sessionId":{"name":"sessionId","type":"option","description":"SessionId of a session that has already been created via the web flow."}},"args":[]}}}
+{"version":"2.1.0","commands":{"curl-example":{"id":"curl-example","description":"Prints out an example cURL command containing the parameters the CLI uses to query the Opal server.","pluginName":"opal-security","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"login":{"id":"login","description":"Authenticates you with the Opal server.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["$ opal login"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"email":{"name":"email","type":"option","description":"Email address to login with."}},"args":[]},"logout":{"id":"logout","description":"Clears locally stored Opal server authentication credentials.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["$ opal logout"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"set-custom-header":{"id":"set-custom-header","description":"Sets a custom HTTP header to connect to the Opal server.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["$ opal set-custom-header --header 'cf-access-token: $TOKEN'"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"header":{"name":"header","type":"option"}},"args":[]},"set-token":{"id":"set-token","description":"Sets an API token to authenticate with the Opal server - alternative auth flow for headless environments.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["$ opal set-token"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"set-url":{"id":"set-url","description":"Sets the url of the Opal server. Defaults to https://app.opal.dev.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["$ opal set-url"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"allowSelfSignedCerts":{"name":"allowSelfSignedCerts","type":"boolean","allowNo":false},"custom":{"name":"custom","type":"option","hidden":true},"prod":{"name":"prod","type":"boolean","hidden":true,"allowNo":false},"demo":{"name":"demo","type":"boolean","hidden":true,"allowNo":false},"dev":{"name":"dev","type":"boolean","hidden":true,"allowNo":false},"devLocal":{"name":"devLocal","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"url","description":"URL of the Opal server to use. If unspecified, defaults to https://app.opal.dev","required":false}]},"aws:identity":{"id":"aws:identity","description":"Gets the current caller identity for the \"opal\" AWS profile.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["opal aws:identity"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"iam-roles:start":{"id":"iam-roles:start","description":"Starts a session to assume an IAM role.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["opal iam-roles:start","opal iam-roles:start --id 51f7176b-0464-4a6f-8369-e951e187b398","opal iam-roles:start --id 51f7176b-0464-4a6f-8369-e951e187b398 --profileName \"custom-profile\""],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"id":{"name":"id","type":"option","description":"The ID of the Opal role resource."},"sessionId":{"name":"sessionId","type":"option","description":"SessionId of a session that has already been created via the web flow."},"profileName":{"name":"profileName","type":"option","description":"Uses a custom AWS profile name for the IAM role. Default value is the role's name."}},"args":[]},"kube-roles:start":{"id":"kube-roles:start","description":"Starts a session to assume a Kubernetes cluster IAM role.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["opal kube-roles:start","opal kube-roles:start --id 51f7176b-0464-4a6f-8369-e951e187b398","opal kube-roles:start --id 51f7176b-0464-4a6f-8369-e951e187b398 --accessLevelRemoteId \"arn:aws:iam::712234975475:role/acme-eks-cluster-admin-role\""],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"id":{"name":"id","type":"option","description":"The ID of the Opal role resource."},"accessLevelRemoteId":{"name":"accessLevelRemoteId","type":"option","description":"The remote ID of the access level with which to access the cluster."},"sessionId":{"name":"sessionId","type":"option","description":"SessionId of a session that has already been created via the web flow."}},"args":[]},"postgres-instances:start":{"id":"postgres-instances:start","description":"Starts a session to query a Postgres database.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["opal postgres-instances:start","opal postgres-instances:start --id 51f7176b-0464-4a6f-8369-e951e187b398","opal postgres-instances:start --id 51f7176b-0464-4a6f-8369-e951e187b398 --accessLevelRemoteId \"fullaccess\""],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"id":{"name":"id","type":"option","description":"The ID of the Opal instance resource."},"accessLevelRemoteId":{"name":"accessLevelRemoteId","type":"option","description":"The remote ID of the access level with which to access the database."},"sessionId":{"name":"sessionId","type":"option","description":"SessionId of a session that has already been created via the web flow."}},"args":[]},"resources:get":{"id":"resources:get","description":"Get resource info for a particular resource.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["opal resources:get --id 54052a3e-5375-4392-aeaf-0c6c44c131d4"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"id":{"name":"id","type":"option","required":true}},"args":[]},"ssh:copyFrom":{"id":"ssh:copyFrom","description":"Use SCP to copy files from a compute instance.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["opal ssh:copyFrom --src instance/dir --dest my/dir","opal ssh:copyFrom --src instance/dir --dest my/dir --id 51f7176b-0464-4a6f-8369-e951e187b398"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"src":{"name":"src","type":"option","description":"The path of the directory or file you would like to copy over SCP. Note we only support one file or directory at a time.","required":true},"dest":{"name":"dest","type":"option","description":"Pick which directory you want your files to be copied to.","required":false,"default":"."},"user":{"name":"user","type":"option","description":"Pick which user you want to run SCP over. Keep in mind not all users will have access to each other's home directory.","required":false,"default":"ssm-user"},"id":{"name":"id","type":"option","description":"The ID of the Opal instance resource."},"sessionId":{"name":"sessionId","type":"option","description":"SessionId of a session that has already been created via the web flow."}},"args":[]},"ssh:copyTo":{"id":"ssh:copyTo","description":"Use SCP to copy files to a compute instance.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["opal ssh:copyTo --src my/dir --dest instance/dir","opal ssh:copyTo --src my/dir --dest instance/dir --id 51f7176b-0464-4a6f-8369-e951e187b398"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"src":{"name":"src","type":"option","description":"The path of the directory or file you would like to copy over SCP. Note we only support one file or directory at a time.","required":true},"dest":{"name":"dest","type":"option","description":"Pick which directory you want your files to be copied to.","required":false,"default":"."},"user":{"name":"user","type":"option","description":"Pick which user you want to run SCP over. Keep in mind not all users will have access to each other's home directory.","required":false,"default":"ssm-user"},"id":{"name":"id","type":"option","description":"The ID of the Opal instance resource."},"sessionId":{"name":"sessionId","type":"option","description":"SessionId of a session that has already been created via the web flow."}},"args":[]},"ssh:start":{"id":"ssh:start","description":"Starts an SSH session to access a compute instance.","pluginName":"opal-security","pluginType":"core","aliases":[],"examples":["opal ssh:start","opal ssh:start --id 51f7176b-0464-4a6f-8369-e951e187b398"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"id":{"name":"id","type":"option","description":"The ID of the Opal instance resource."},"sessionId":{"name":"sessionId","type":"option","description":"SessionId of a session that has already been created via the web flow."}},"args":[]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "opal-security",
   "description": "Opal allows you to centrally manage access to all of your sensitive systems.",
-  "version": "2.0.19",
+  "version": "2.1.0",
   "author": "Stephen Cobbe",
   "bin": {
     "opal": "./bin/run"
@@ -41,7 +41,7 @@
     "@types/mocha": "^5.2.7",
     "@types/node": "^14.14.37",
     "@types/semver": "^7.3.8",
-    "@typescript-eslint/eslint-plugin": "^5.45.0",
+    "@typescript-eslint/eslint-plugin": "^5.31.0",
     "chai": "^4.3.4",
     "eslint": "^8.17.0",
     "eslint-config-oclif": "^3.1.0",
@@ -81,6 +81,7 @@
     "url": "https://github.com/opalsecurity/opal-cli.git"
   },
   "resolutions": {
+    "agent-base": "^6.0.1",
     "ansi-regex": "5.0.1"
   },
   "scripts": {