opal-security 2.0.15 → 2.0.17

package/README.md

@@ -22,7 +22,7 @@ $ npm install -g opal-security
 $ opal COMMAND
 running command...
 $ opal (-v|--version|version)
-opal-security/2.0.15 darwin-x64 node-v14.16.1
+opal-security/2.0.17 darwin-x64 node-v16.17.1
 $ opal --help [COMMAND]
 USAGE
   $ opal COMMAND
@@ -43,6 +43,7 @@ USAGE
 * [`opal logout`](#opal-logout)
 * [`opal postgres-instances:start`](#opal-postgres-instancesstart)
 * [`opal resources:get`](#opal-resourcesget)
+* [`opal set-custom-header`](#opal-set-custom-header)
 * [`opal set-token`](#opal-set-token)
 * [`opal set-url`](#opal-set-url)
 * [`opal ssh:copyFrom`](#opal-sshcopyfrom)
@@ -87,7 +88,7 @@ EXAMPLE
   opal aws:identity
 ```
 
-_See code: [src/commands/aws/identity.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.15/src/commands/aws/identity.ts)_
+_See code: [src/commands/aws/identity.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.17/src/commands/aws/identity.ts)_
 
 ## `opal curl-example`
 
@@ -101,7 +102,7 @@ OPTIONS
   -h, --help  show CLI help
 ```
 
-_See code: [src/commands/curl-example.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.15/src/commands/curl-example.ts)_
+_See code: [src/commands/curl-example.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.17/src/commands/curl-example.ts)_
 
 ## `opal help [COMMAND]`
 
@@ -129,16 +130,18 @@ USAGE
   $ opal iam-roles:start
 
 OPTIONS
-  -h, --help             show CLI help
-  --id=id                The ID of the Opal role resource.
-  --sessionId=sessionId  SessionId of a session that has already been created via the web flow.
+  -h, --help                 show CLI help
+  --id=id                    The ID of the Opal role resource.
+  --profileName=profileName  Uses a custom AWS profile name for the IAM role. Default value is the role's name.
+  --sessionId=sessionId      SessionId of a session that has already been created via the web flow.
 
 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"
 ```
 
-_See code: [src/commands/iam-roles/start.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.15/src/commands/iam-roles/start.ts)_
+_See code: [src/commands/iam-roles/start.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.17/src/commands/iam-roles/start.ts)_
 
 ## `opal kube-roles:start`
 
@@ -161,7 +164,7 @@ EXAMPLES
   "arn:aws:iam::712234975475:role/acme-eks-cluster-admin-role"
 ```
 
-_See code: [src/commands/kube-roles/start.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.15/src/commands/kube-roles/start.ts)_
+_See code: [src/commands/kube-roles/start.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.17/src/commands/kube-roles/start.ts)_
 
 ## `opal login`
 
@@ -178,7 +181,7 @@ EXAMPLE
   $ opal login
 ```
 
-_See code: [src/commands/login.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.15/src/commands/login.ts)_
+_See code: [src/commands/login.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.17/src/commands/login.ts)_
 
 ## `opal logout`
 
@@ -195,7 +198,7 @@ EXAMPLE
   $ opal logout
 ```
 
-_See code: [src/commands/logout.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.15/src/commands/logout.ts)_
+_See code: [src/commands/logout.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.17/src/commands/logout.ts)_
 
 ## `opal postgres-instances:start`
 
@@ -217,7 +220,7 @@ EXAMPLES
   opal postgres-instances:start --id 51f7176b-0464-4a6f-8369-e951e187b398 --accessLevelRemoteId "fullaccess"
 ```
 
-_See code: [src/commands/postgres-instances/start.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.15/src/commands/postgres-instances/start.ts)_
+_See code: [src/commands/postgres-instances/start.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.17/src/commands/postgres-instances/start.ts)_
 
 ## `opal resources:get`
 
@@ -235,7 +238,25 @@ EXAMPLE
   opal resources:get --id 54052a3e-5375-4392-aeaf-0c6c44c131d4
 ```
 
-_See code: [src/commands/resources/get.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.15/src/commands/resources/get.ts)_
+_See code: [src/commands/resources/get.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.17/src/commands/resources/get.ts)_
+
+## `opal set-custom-header`
+
+Sets a custom HTTP header to connect to the Opal server.
+
+```
+USAGE
+  $ opal set-custom-header
+
+OPTIONS
+  -h, --help       show CLI help
+  --header=header
+
+EXAMPLE
+  $ opal set-custom-header --header 'cf-access-token: $TOKEN'
+```
+
+_See code: [src/commands/set-custom-header.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.17/src/commands/set-custom-header.ts)_
 
 ## `opal set-token`
 
@@ -252,7 +273,7 @@ EXAMPLE
   $ opal set-token
 ```
 
-_See code: [src/commands/set-token.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.15/src/commands/set-token.ts)_
+_See code: [src/commands/set-token.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.17/src/commands/set-token.ts)_
 
 ## `opal set-url`
 
@@ -273,10 +294,10 @@ OPTIONS
   --staging
 
 EXAMPLE
-  $ opal set-host
+  $ opal set-url
 ```
 
-_See code: [src/commands/set-url.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.15/src/commands/set-url.ts)_
+_See code: [src/commands/set-url.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.17/src/commands/set-url.ts)_
 
 ## `opal ssh:copyFrom`
 
@@ -303,7 +324,7 @@ EXAMPLES
   opal ssh:copyFrom --src instance/dir --dest my/dir --id 51f7176b-0464-4a6f-8369-e951e187b398
 ```
 
-_See code: [src/commands/ssh/copyFrom.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.15/src/commands/ssh/copyFrom.ts)_
+_See code: [src/commands/ssh/copyFrom.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.17/src/commands/ssh/copyFrom.ts)_
 
 ## `opal ssh:copyTo`
 
@@ -330,7 +351,7 @@ EXAMPLES
   opal ssh:copyTo --src my/dir --dest instance/dir --id 51f7176b-0464-4a6f-8369-e951e187b398
 ```
 
-_See code: [src/commands/ssh/copyTo.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.15/src/commands/ssh/copyTo.ts)_
+_See code: [src/commands/ssh/copyTo.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.17/src/commands/ssh/copyTo.ts)_
 
 ## `opal ssh:start`
 
@@ -350,5 +371,5 @@ EXAMPLES
   opal ssh:start --id 51f7176b-0464-4a6f-8369-e951e187b398
 ```
 
-_See code: [src/commands/ssh/start.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.15/src/commands/ssh/start.ts)_
+_See code: [src/commands/ssh/start.ts](https://github.com/opalsecurity/opal-cli/blob/v2.0.17/src/commands/ssh/start.ts)_
 <!-- commandsstop -->

package/lib/commands/iam-roles/start.d.ts

@@ -6,6 +6,7 @@ export default class StartIAMRoleSession extends Command {
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
         id: flags.IOptionFlag<string | undefined>;
         sessionId: flags.IOptionFlag<string | undefined>;
+        profileName: flags.IOptionFlag<string | undefined>;
     };
     run(): Promise<void>;
 }

package/lib/commands/iam-roles/start.js

@@ -114,6 +114,9 @@ class StartIAMRoleSession extends command_1.Command {
             }
             roleName = (sshInstanceResp === null || sshInstanceResp === void 0 ? void 0 : sshInstanceResp.data.resource.resource.name) || 'iam-role';
         }
+        if (flags.profileName && flags.profileName !== "") {
+            roleName = flags.profileName;
+        }
         const { resp, error } = await handler_1.runMutation({
             command: this,
             query: StartIAMRoleSessionDocument,
@@ -150,6 +153,7 @@ StartIAMRoleSession.description = 'Starts a session to assume an IAM role.';
 StartIAMRoleSession.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"',
 ];
 StartIAMRoleSession.flags = {
     help: command_1.flags.help({ char: 'h' }),
@@ -161,4 +165,8 @@ StartIAMRoleSession.flags = {
         multiple: false,
         description: 'SessionId of a session that has already been created via the web flow.',
     }),
+    profileName: command_1.flags.string({
+        multiple: false,
+        description: 'Uses a custom AWS profile name for the IAM role. Default value is the role\'s name.'
+    })
 };

package/lib/commands/kube-roles/start.js

@@ -120,7 +120,7 @@ class StartKubeIAMRoleSession extends command_1.Command {
                 switch (metadata === null || metadata === void 0 ? void 0 : metadata.__typename) {
                     case 'AwsIamFederatedEksSession': {
                         const updateAwsConfigCommand = aws_1.getAwsConfigUpdateCmd(roleName, metadata.awsAccessKeyId, metadata.awsSecretAccessKey, metadata.awsSessionToken);
-                        const updateKubeConfigCmd = `aws eks update-kubeconfig --name ${metadata.clusterName} --region ${metadata.clusterRegion} --profile opal`;
+                        const updateKubeConfigCmd = `aws eks update-kubeconfig --name ${metadata.clusterName} --region ${metadata.clusterRegion} --alias ${metadata.clusterName} --profile opal`;
                         const startSessionCmd = `${updateAwsConfigCommand} && ${updateKubeConfigCmd}`;
                         const awsEnvVarMessage = aws_1.getAwsEnvVarMessage();
                         cmd_1.runCommandExec(startSessionCmd, `Now set to use ${roleName ? `"${roleName}" role` : 'role'} with updated Kube config pointing to "${metadata.clusterName}" cluster.${awsEnvVarMessage}`, `Failed to assume ${roleName ? `"${roleName}" role` : 'role'} and update Kube config.`);

package/lib/commands/login.js

@@ -104,6 +104,7 @@ class Login extends command_1.Command {
                 issuer = await openid_client_1.Issuer.discover(ISSUER_DEV);
                 clientId = CLIENT_ID_DEV;
             }
+            /* eslint-disable camelcase */
             const client = new issuer.Client({
                 grant_types: [GRANT_TYPE],
                 client_id: clientId,
@@ -112,6 +113,7 @@ class Login extends command_1.Command {
                 token_endpoint_auth_method: 'none',
                 application_type: 'native',
             });
+            /* eslint-enable camelcase */
             const handle = await client.deviceAuthorization({
                 audience: 'https://opal.dev',
                 scope: 'openid email profile',
@@ -137,6 +139,7 @@ class Login extends command_1.Command {
             });
             if (authCheckErr || !((_e = (_d = (_c = authCheckResp === null || authCheckResp === void 0 ? void 0 : authCheckResp.data) === null || _c === void 0 ? void 0 : _c.organizationSettings) === null || _d === void 0 ? void 0 : _d.settings) === null || _e === void 0 ? void 0 : _e.id)) {
                 this.log('Error verifying log in. Authenticated commands may fail. Please double check your URL and use `opal logout; opal login` to try again.\n');
+                this.log(authCheckErr + '\n');
                 return;
             }
             this.log('🎉 You have successfully authenticated with Opal! You can now run authenticated commands.\n');

package/lib/commands/resources/get.d.ts

@@ -1,5 +1,5 @@
 import { Command, flags } from '@oclif/command';
-export declare const GetResourceDocument = "\nquery GetResource($id: ResourceId!) {\n  resource(input: {id: $id}) {\n    __typename\n    ... on ResourceResult {\n      resource {\n        name\n        id\n        description\n        ownerTeam {\n          name\n          id\n        }\n        connection {\n          name\n          id\n        }\n        resourceUsers {\n          user {\n            email\n          }\n        }\n      }\n    }\n    ... on ResourceNotFoundError {\n      message\n    }\n  }\n}";
+export declare const GetResourceDocument = "\nquery GetResource($id: ResourceId!) {\n  resource(input: {id: $id}) {\n    __typename\n    ... on ResourceResult {\n      resource {\n        name\n        id\n        description\n        connection {\n          name\n          id\n        }\n        resourceUsers {\n          user {\n            email\n          }\n        }\n      }\n    }\n    ... on ResourceNotFoundError {\n      message\n    }\n  }\n}";
 export default class GetResource extends Command {
     static description: string;
     static examples: string[];

package/lib/commands/resources/get.js

@@ -13,10 +13,6 @@ query GetResource($id: ResourceId!) {
         name
         id
         description
-        ownerTeam {
-          name
-          id
-        }
         connection {
           name
           id
@@ -41,12 +37,12 @@ class GetResource extends command_1.Command {
     }
 }
 exports.default = GetResource;
-GetResource.description = "Get resource info for a particular resource.";
-GetResource.examples = ["opal resources:get --id 54052a3e-5375-4392-aeaf-0c6c44c131d4"];
+GetResource.description = 'Get resource info for a particular resource.';
+GetResource.examples = ['opal resources:get --id 54052a3e-5375-4392-aeaf-0c6c44c131d4'];
 GetResource.flags = {
     help: command_1.flags.help({ char: 'h' }),
     id: command_1.flags.string({
         multiple: false,
         required: true,
-    })
+    }),
 };

package/lib/commands/set-custom-header.d.ts

@@ -0,0 +1,11 @@
+import { Command, flags } from '@oclif/command';
+export default class SetCustomHeader extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
+        header: flags.IOptionFlag<string | undefined>;
+    };
+    static args: never[];
+    run(): Promise<void>;
+}

package/lib/commands/set-custom-header.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const command_1 = require("@oclif/command");
+const apollo_1 = require("../lib/apollo");
+const config_1 = require("../lib/config");
+class SetCustomHeader extends command_1.Command {
+    async run() {
+        try {
+            const { flags } = this.parse(SetCustomHeader);
+            let header;
+            if (flags.header) {
+                header = flags.header;
+            }
+            const configData = config_1.getOrCreateConfigData(this.config.configDir);
+            configData[config_1.customHttpHeaderKey] = header;
+            config_1.writeConfigData(this.config.configDir, configData);
+            await apollo_1.initClient(this);
+            this.log('Custom HTTP header updated');
+        }
+        catch (error) {
+            this.error(error);
+        }
+    }
+}
+exports.default = SetCustomHeader;
+SetCustomHeader.description = 'Sets a custom HTTP header to connect to the Opal server.';
+SetCustomHeader.examples = ['$ opal set-custom-header --header \'cf-access-token: $TOKEN\''];
+SetCustomHeader.flags = {
+    help: command_1.flags.help({ char: 'h' }),
+    header: command_1.flags.string({
+        multiple: false,
+    }),
+};
+SetCustomHeader.args = [];

package/lib/commands/set-url.js

@@ -43,7 +43,7 @@ class SetUrl extends command_1.Command {
 }
 exports.default = SetUrl;
 SetUrl.description = `Sets the url of the Opal server. Defaults to ${config_1.defaultUrl}.`;
-SetUrl.examples = ['$ opal set-host'];
+SetUrl.examples = ['$ opal set-url'];
 SetUrl.flags = {
     help: command_1.flags.help({ char: 'h' }),
     custom: command_1.flags.string({

package/lib/lib/apollo.js

@@ -27,6 +27,13 @@ exports.initClient = async (command) => {
     });
     const httpAgent = new http.Agent({});
     const specifiedUrl = configData[config_1.urlKey];
+    const customHeader = configData[config_1.customHttpHeaderKey];
+    const customHeaderKey = customHeader === undefined ?
+        '' :
+        customHeader.split(':')[0];
+    const customHeaderValue = customHeader === undefined ?
+        '' :
+        customHeader.split(':')[1];
     const agent = specifiedUrl.includes('https') ? httpsAgent : httpAgent;
     const httpLink = core_1.createHttpLink({
         uri: `${specifiedUrl}/query`,
@@ -37,7 +44,7 @@ exports.initClient = async (command) => {
     });
     const authLink = context_1.setContext((_, { headers }) => {
         return {
-            headers: Object.assign(Object.assign({}, headers), { authorization: `Bearer ${accessToken}`, 'X-Opal-Organization-ID': organizationID }),
+            headers: Object.assign(Object.assign({}, headers), { authorization: `Bearer ${accessToken}`, 'X-Opal-Organization-ID': organizationID, customHeaderKey: customHeaderValue }),
         };
     });
     const checkCLIVersion = (operation) => {

package/lib/lib/config.d.ts

@@ -2,6 +2,7 @@ export declare const urlKey = "url";
 export declare const defaultUrl = "https://app.opal.dev";
 export declare const allowSelfSignedCertsKey = "allowSelfSignedCerts";
 export declare const defaultAllowSelfSignedCerts = false;
+export declare const customHttpHeaderKey = "customHttpHeader";
 export declare const getOrCreateConfigData: (configDir: string) => Record<string, any>;
 export declare const writeConfigData: (configDir: string, newConfigData: Record<string, any>) => void;
 export declare const isProduction: (configDir: string) => boolean;

package/lib/lib/config.js

@@ -1,32 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isProduction = exports.writeConfigData = exports.getOrCreateConfigData = exports.defaultAllowSelfSignedCerts = exports.allowSelfSignedCertsKey = exports.defaultUrl = exports.urlKey = void 0;
+exports.isProduction = exports.writeConfigData = exports.getOrCreateConfigData = exports.customHttpHeaderKey = exports.defaultAllowSelfSignedCerts = exports.allowSelfSignedCertsKey = exports.defaultUrl = exports.urlKey = void 0;
 const fs = require("fs");
 const path = require("path");
 exports.urlKey = 'url';
 exports.defaultUrl = 'https://app.opal.dev';
 exports.allowSelfSignedCertsKey = 'allowSelfSignedCerts';
 exports.defaultAllowSelfSignedCerts = false;
+exports.customHttpHeaderKey = 'customHttpHeader';
 exports.getOrCreateConfigData = (configDir) => {
-    try {
-        if (!fs.existsSync(configDir)) {
-            fs.mkdirSync(configDir, { recursive: true });
-        }
-    }
-    catch (error) {
-        throw error;
+    if (!fs.existsSync(configDir)) {
+        fs.mkdirSync(configDir, { recursive: true });
     }
     const configFilePath = path.join(configDir, 'config.json');
-    try {
-        if (!fs.existsSync(configFilePath)) {
-            fs.writeFileSync(configFilePath, JSON.stringify({
-                [exports.urlKey]: exports.defaultUrl,
-                [exports.allowSelfSignedCertsKey]: exports.defaultAllowSelfSignedCerts,
-            }));
-        }
-    }
-    catch (error) {
-        throw error;
+    if (!fs.existsSync(configFilePath)) {
+        fs.writeFileSync(configFilePath, JSON.stringify({
+            [exports.urlKey]: exports.defaultUrl,
+            [exports.allowSelfSignedCertsKey]: exports.defaultAllowSelfSignedCerts,
+        }));
     }
     let configData = {};
     try {

package/lib/lib/credentials.js

@@ -8,80 +8,55 @@ function removeAfter(credentials, lastIndex) {
 }
 exports.cred = {
     async removeCredentials(after) {
-        try {
-            const keyContents = await keytar.findCredentials(exports.OPAL_CREDS_KEY);
-            removeAfter(keyContents, after);
-        }
-        catch (error) {
-            throw error;
-        }
+        const keyContents = await keytar.findCredentials(exports.OPAL_CREDS_KEY);
+        removeAfter(keyContents, after);
     },
     get accountId() {
         return (async () => {
-            try {
-                const keyContents = await keytar.findCredentials(exports.OPAL_CREDS_KEY);
-                if (!keyContents[0]) {
-                    return undefined;
-                }
-                const { account } = keyContents[0];
-                return account;
-            }
-            catch (error) {
-                throw error;
+            const keyContents = await keytar.findCredentials(exports.OPAL_CREDS_KEY);
+            if (!keyContents[0]) {
+                return undefined;
             }
+            const { account } = keyContents[0];
+            return account;
         })();
     },
     get organizationID() {
         return (async () => {
-            try {
-                const keyContents = await keytar.findCredentials(exports.OPAL_CREDS_KEY);
-                if (!keyContents[0]) {
-                    return undefined;
-                }
-                const { account } = keyContents[0];
-                const parts = account.split('|');
-                if (!parts || parts.length <= 1) {
-                    return undefined;
-                }
-                return parts.pop();
+            const keyContents = await keytar.findCredentials(exports.OPAL_CREDS_KEY);
+            if (!keyContents[0]) {
+                return undefined;
             }
-            catch (error) {
-                throw error;
+            const { account } = keyContents[0];
+            const parts = account.split('|');
+            if (!parts || parts.length <= 1) {
+                return undefined;
             }
+            return parts.pop();
         })();
     },
     get email() {
         return (async () => {
-            try {
-                const keyContents = await keytar.findCredentials(exports.OPAL_CREDS_KEY);
-                if (!keyContents[0]) {
-                    return undefined;
-                }
-                const { account } = keyContents[0];
-                const parts = account.split('|');
-                if (!parts || parts.length <= 1) {
-                    return undefined;
-                }
-                return parts[0];
+            const keyContents = await keytar.findCredentials(exports.OPAL_CREDS_KEY);
+            if (!keyContents[0]) {
+                return undefined;
             }
-            catch (error) {
-                throw error;
+            const { account } = keyContents[0];
+            const parts = account.split('|');
+            if (!parts || parts.length <= 1) {
+                return undefined;
             }
+            return parts[0];
         })();
     },
     get accessToken() {
         return (async () => {
-            try {
-                const keyContents = await keytar.findCredentials(exports.OPAL_CREDS_KEY);
-                if (!keyContents[0]) {
-                    return undefined;
-                }
-                const { password } = keyContents[0];
-                return password;
-            }
-            catch (error) {
-                throw error;
+            const keyContents = await keytar.findCredentials(exports.OPAL_CREDS_KEY);
+            if (!keyContents[0]) {
+                return undefined;
             }
+            const { password } = keyContents[0];
+            return password;
         })();
     },
 };

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.0.15","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-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-host"],"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"],"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."}},"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.0.17","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":[]}}}

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.15",
+  "version": "2.0.17",
   "author": "Stephen Cobbe",
   "bin": {
     "opal": "./bin/run"
@@ -41,6 +41,7 @@
     "@types/mocha": "^5.2.7",
     "@types/node": "^14.14.37",
     "@types/semver": "^7.3.8",
+    "@typescript-eslint/eslint-plugin": "^5.31.0",
     "chai": "^4.3.4",
     "eslint": "^8.17.0",
     "eslint-config-oclif": "^3.1.0",