opal-security 3.1.1-beta.153d5b3 → 3.1.1-beta.189ac0c

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -22,7 +22,7 @@ $ npm install -g opal-security
22
22
  $ opal COMMAND
23
23
  running command...
24
24
  $ opal (--version)
25
- opal-security/3.1.1-beta.153d5b3 linux-x64 node-v20.19.2
25
+ opal-security/3.1.1-beta.189ac0c linux-x64 node-v20.19.2
26
26
  $ opal --help [COMMAND]
27
27
  USAGE
28
28
  $ opal COMMAND
@@ -44,9 +44,6 @@ USAGE
44
44
  * [`opal login`](#opal-login)
45
45
  * [`opal logout`](#opal-logout)
46
46
  * [`opal postgres-instances start`](#opal-postgres-instances-start)
47
- * [`opal request create`](#opal-request-create)
48
- * [`opal request get`](#opal-request-get)
49
- * [`opal request list`](#opal-request-list)
50
47
  * [`opal resources get`](#opal-resources-get)
51
48
  * [`opal set-auth-provider`](#opal-set-auth-provider)
52
49
  * [`opal set-custom-header`](#opal-set-custom-header)
@@ -105,7 +102,7 @@ EXAMPLES
105
102
  $ opal aws:identity
106
103
  ```
107
104
 
108
- _See code: [src/commands/aws/identity.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/aws/identity.ts)_
105
+ _See code: [src/commands/aws/identity.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.189ac0c/src/commands/aws/identity.ts)_
109
106
 
110
107
  ## `opal clear-auth-provider`
111
108
 
@@ -125,7 +122,7 @@ EXAMPLES
125
122
  $ opal clear-auth-provider
126
123
  ```
127
124
 
128
- _See code: [src/commands/clear-auth-provider.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/clear-auth-provider.ts)_
125
+ _See code: [src/commands/clear-auth-provider.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.189ac0c/src/commands/clear-auth-provider.ts)_
129
126
 
130
127
  ## `opal curl-example`
131
128
 
@@ -142,7 +139,7 @@ DESCRIPTION
142
139
  Prints out an example cURL command containing the parameters the CLI uses to query the Opal server.
143
140
  ```
144
141
 
145
- _See code: [src/commands/curl-example.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/curl-example.ts)_
142
+ _See code: [src/commands/curl-example.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.189ac0c/src/commands/curl-example.ts)_
146
143
 
147
144
  ## `opal groups get`
148
145
 
@@ -163,7 +160,7 @@ EXAMPLES
163
160
  $ opal groups:get --id 54052a3e-5375-4392-aeaf-0c6c44c131d4
164
161
  ```
165
162
 
166
- _See code: [src/commands/groups/get.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/groups/get.ts)_
163
+ _See code: [src/commands/groups/get.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.189ac0c/src/commands/groups/get.ts)_
167
164
 
168
165
  ## `opal help [COMMANDS]`
169
166
 
@@ -213,7 +210,7 @@ EXAMPLES
213
210
  $ opal iam-roles:start --id 51f7176b-0464-4a6f-8369-e951e187b398 --profileName "custom-profile"
214
211
  ```
215
212
 
216
- _See code: [src/commands/iam-roles/start.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/iam-roles/start.ts)_
213
+ _See code: [src/commands/iam-roles/start.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.189ac0c/src/commands/iam-roles/start.ts)_
217
214
 
218
215
  ## `opal kube-roles start`
219
216
 
@@ -244,7 +241,7 @@ EXAMPLES
244
241
  $ opal kube-roles:start --id 51f7176b-0464-4a6f-8369-e951e187b398 --accessLevelRemoteId "arn:aws:iam::712234975475:role/acme-eks-cluster-admin-role"
245
242
  ```
246
243
 
247
- _See code: [src/commands/kube-roles/start.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/kube-roles/start.ts)_
244
+ _See code: [src/commands/kube-roles/start.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.189ac0c/src/commands/kube-roles/start.ts)_
248
245
 
249
246
  ## `opal login`
250
247
 
@@ -265,7 +262,7 @@ EXAMPLES
265
262
  $ opal login
266
263
  ```
267
264
 
268
- _See code: [src/commands/login.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/login.ts)_
265
+ _See code: [src/commands/login.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.189ac0c/src/commands/login.ts)_
269
266
 
270
267
  ## `opal logout`
271
268
 
@@ -285,7 +282,7 @@ EXAMPLES
285
282
  $ opal logout
286
283
  ```
287
284
 
288
- _See code: [src/commands/logout.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/logout.ts)_
285
+ _See code: [src/commands/logout.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.189ac0c/src/commands/logout.ts)_
289
286
 
290
287
  ## `opal postgres-instances start`
291
288
 
@@ -322,82 +319,7 @@ EXAMPLES
322
319
  $ opal postgres-instances:start --id 51f7176b-0464-4a6f-8369-e951e187b398 --accessLevelRemoteId fullaccess --action view
323
320
  ```
324
321
 
325
- _See code: [src/commands/postgres-instances/start.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/postgres-instances/start.ts)_
326
-
327
- ## `opal request create`
328
-
329
- Creates an Opal access request via an interactive form
330
-
331
- ```
332
- USAGE
333
- $ opal request create [-h] [-a <value>...] [-r <value>] [-d <value>]
334
-
335
- FLAGS
336
- -a, --assets=<value>... The ids of the assets (resource, group) to request access to. Append a role ID using a colon
337
- if needed, e.g. `--assets 123:456`.
338
- If not provided, an interactive selection flow will be available to select assets to request.
339
- -d, --duration=<value> The duration of access for the request in minutes. If not provided, you will be prompted.
340
- -h, --help Show CLI help.
341
- -r, --reason=<value> The reason for the request, contained in quotes. If not provided, you will be prompted.
342
-
343
- DESCRIPTION
344
- Creates an Opal access request via an interactive form
345
- ```
346
-
347
- _See code: [src/commands/request/create.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/request/create.ts)_
348
-
349
- ## `opal request get`
350
-
351
- Lists access requests
352
-
353
- ```
354
- USAGE
355
- $ opal request get [-h] [-i <value>] [-v]
356
-
357
- FLAGS
358
- -h, --help Show CLI help.
359
- -i, --id=<value> The Opal ID of the asset. You can find this from the URL, e.g. https://opal.dev/resources/[ID]
360
- -v, --verbose Enable verbose output, prints full response in JSON format. Defaults to false.
361
-
362
- DESCRIPTION
363
- Lists access requests
364
-
365
- EXAMPLES
366
- $ opal request get --id 54052a3e-5375-4392-aeaf-0c6c44c131d4
367
-
368
- $ opal request get --id 54052a3e-5375-4392-aeaf-0c6c44c131d4 --verbose
369
- ```
370
-
371
- _See code: [src/commands/request/get.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/request/get.ts)_
372
-
373
- ## `opal request list`
374
-
375
- Lists your n recent outgoing access requests
376
-
377
- ```
378
- USAGE
379
- $ opal request list [-h] [-n <value>] [-p] [-v]
380
-
381
- FLAGS
382
- -h, --help Show CLI help.
383
- -n, --n=<value> [default: 10] Defines number of requests to be returned. 1 <= n <= 100.
384
- -p, --pending Show only pending requests. Defaults to false.
385
- -v, --verbose Enable verbose output, prints full response in JSON format. Defaults to false.
386
-
387
- DESCRIPTION
388
- Lists your n recent outgoing access requests
389
-
390
- EXAMPLES
391
- $ opal request list --n 5
392
-
393
- $ opal request list --n 5 --pending
394
-
395
- $ opal request list --n 5 --verbose
396
-
397
- $ opal request list --n 5 --pending --verbose
398
- ```
399
-
400
- _See code: [src/commands/request/list.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/request/list.ts)_
322
+ _See code: [src/commands/postgres-instances/start.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.189ac0c/src/commands/postgres-instances/start.ts)_
401
323
 
402
324
  ## `opal resources get`
403
325
 
@@ -418,7 +340,7 @@ EXAMPLES
418
340
  $ opal resources:get --id 54052a3e-5375-4392-aeaf-0c6c44c131d4
419
341
  ```
420
342
 
421
- _See code: [src/commands/resources/get.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/resources/get.ts)_
343
+ _See code: [src/commands/resources/get.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.189ac0c/src/commands/resources/get.ts)_
422
344
 
423
345
  ## `opal set-auth-provider`
424
346
 
@@ -444,7 +366,7 @@ EXAMPLES
444
366
  $ opal set-auth-provider --clientID 1234asdf --issuerUrl https://auth.example.com
445
367
  ```
446
368
 
447
- _See code: [src/commands/set-auth-provider.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/set-auth-provider.ts)_
369
+ _See code: [src/commands/set-auth-provider.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.189ac0c/src/commands/set-auth-provider.ts)_
448
370
 
449
371
  ## `opal set-custom-header`
450
372
 
@@ -465,7 +387,7 @@ EXAMPLES
465
387
  $ opal set-custom-header --header 'cf-access-token: $TOKEN'
466
388
  ```
467
389
 
468
- _See code: [src/commands/set-custom-header.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/set-custom-header.ts)_
390
+ _See code: [src/commands/set-custom-header.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.189ac0c/src/commands/set-custom-header.ts)_
469
391
 
470
392
  ## `opal set-token`
471
393
 
@@ -485,7 +407,7 @@ EXAMPLES
485
407
  $ opal set-token
486
408
  ```
487
409
 
488
- _See code: [src/commands/set-token.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/set-token.ts)_
410
+ _See code: [src/commands/set-token.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.189ac0c/src/commands/set-token.ts)_
489
411
 
490
412
  ## `opal set-url [URL]`
491
413
 
@@ -509,7 +431,7 @@ EXAMPLES
509
431
  $ opal set-url
510
432
  ```
511
433
 
512
- _See code: [src/commands/set-url.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/set-url.ts)_
434
+ _See code: [src/commands/set-url.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.189ac0c/src/commands/set-url.ts)_
513
435
 
514
436
  ## `opal ssh copyFrom`
515
437
 
@@ -540,7 +462,7 @@ EXAMPLES
540
462
  $ opal ssh:copyFrom --src instance/dir --dest my/dir --id 51f7176b-0464-4a6f-8369-e951e187b398
541
463
  ```
542
464
 
543
- _See code: [src/commands/ssh/copyFrom.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/ssh/copyFrom.ts)_
465
+ _See code: [src/commands/ssh/copyFrom.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.189ac0c/src/commands/ssh/copyFrom.ts)_
544
466
 
545
467
  ## `opal ssh copyTo`
546
468
 
@@ -571,7 +493,7 @@ EXAMPLES
571
493
  $ opal ssh:copyTo --src my/dir --dest instance/dir --id 51f7176b-0464-4a6f-8369-e951e187b398
572
494
  ```
573
495
 
574
- _See code: [src/commands/ssh/copyTo.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/ssh/copyTo.ts)_
496
+ _See code: [src/commands/ssh/copyTo.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.189ac0c/src/commands/ssh/copyTo.ts)_
575
497
 
576
498
  ## `opal ssh start`
577
499
 
@@ -598,7 +520,7 @@ EXAMPLES
598
520
  $ opal ssh:start --id 51f7176b-0464-4a6f-8369-e951e187b398
599
521
  ```
600
522
 
601
- _See code: [src/commands/ssh/start.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/ssh/start.ts)_
523
+ _See code: [src/commands/ssh/start.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.189ac0c/src/commands/ssh/start.ts)_
602
524
 
603
525
  ## `opal version`
604
526
 
@@ -622,7 +544,7 @@ _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/
622
544
 
623
545
  ## `opal whoami`
624
546
 
625
- Describes current url set, organization name, and logged in user if applicable.
547
+ Describes current url set, organization name, and logged in user if applicabled.
626
548
 
627
549
  ```
628
550
  USAGE
@@ -632,8 +554,8 @@ FLAGS
632
554
  -h, --help Show CLI help.
633
555
 
634
556
  DESCRIPTION
635
- Describes current url set, organization name, and logged in user if applicable.
557
+ Describes current url set, organization name, and logged in user if applicabled.
636
558
  ```
637
559
 
638
- _See code: [src/commands/whoami.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.153d5b3/src/commands/whoami.ts)_
560
+ _See code: [src/commands/whoami.ts](https://github.com/opalsecurity/opal-cli/blob/v3.1.1-beta.189ac0c/src/commands/whoami.ts)_
639
561
  <!-- commandsstop -->
@@ -1,5 +1,6 @@
1
1
  import { Command } from "@oclif/core";
2
2
  export default class RequestCreate extends Command {
3
+ static hidden: boolean;
3
4
  static description: string;
4
5
  static flags: {
5
6
  help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
@@ -2,15 +2,15 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const core_1 = require("@oclif/core");
4
4
  const apollo_1 = require("../../lib/apollo");
5
- const cmd_1 = require("../../lib/cmd");
6
5
  const flags_1 = require("../../lib/flags");
7
6
  const requests_1 = require("../../lib/requests");
8
7
  const displays_1 = require("../../utils/displays");
8
+ const utils_1 = require("../../utils/utils");
9
9
  class RequestCreate extends core_1.Command {
10
10
  async run() {
11
- (0, cmd_1.setMostRecentCommand)(this);
12
11
  await (0, apollo_1.initClient)(this, true);
13
12
  const client = await (0, apollo_1.getClient)(this, true);
13
+ (0, utils_1.restrictToDev)(); //TODO: Remove after development is complete
14
14
  const { flags } = await this.parse(RequestCreate);
15
15
  const metadata = (0, requests_1.initEmptyRequestMetadata)();
16
16
  if (flags.assets) {
@@ -60,6 +60,7 @@ class RequestCreate extends core_1.Command {
60
60
  await (0, requests_1.submitFinalRequest)(this, client, metadata);
61
61
  }
62
62
  }
63
+ RequestCreate.hidden = true;
63
64
  RequestCreate.description = "Creates an Opal access request via an interactive form";
64
65
  RequestCreate.flags = {
65
66
  help: flags_1.SHARED_FLAGS.help,
@@ -1,5 +1,6 @@
1
1
  import { Command } from "@oclif/core";
2
2
  export default class GetRequest extends Command {
3
+ static hidden: boolean;
3
4
  static description: string;
4
5
  static flags: {
5
6
  help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
@@ -8,6 +8,7 @@ const cmd_1 = require("../../lib/cmd");
8
8
  const config_1 = require("../../lib/config");
9
9
  const flags_1 = require("../../lib/flags");
10
10
  const displays_1 = require("../../utils/displays");
11
+ const utils_1 = require("../../utils/utils");
11
12
  const GET_REQUEST = (0, graphql_1.graphql)(`
12
13
  query GetRequest(
13
14
  $id: RequestId!
@@ -57,6 +58,7 @@ const GET_REQUEST = (0, graphql_1.graphql)(`
57
58
  `);
58
59
  class GetRequest extends core_1.Command {
59
60
  async run() {
61
+ (0, utils_1.restrictToDev)(); //TODO: Remove after development is complete
60
62
  (0, cmd_1.setMostRecentCommand)(this);
61
63
  const configData = (0, config_1.getOrCreateConfigData)(this.config.configDir);
62
64
  const client = await (0, apollo_1.getClient)(this, true);
@@ -94,6 +96,7 @@ class GetRequest extends core_1.Command {
94
96
  }
95
97
  }
96
98
  }
99
+ GetRequest.hidden = true;
97
100
  GetRequest.description = "Lists access requests";
98
101
  GetRequest.flags = {
99
102
  help: flags_1.SHARED_FLAGS.help,
@@ -1,5 +1,6 @@
1
1
  import { Command } from "@oclif/core";
2
2
  export default class ListRequests extends Command {
3
+ static hidden: boolean;
3
4
  static description: string;
4
5
  static examples: string[];
5
6
  static flags: {
@@ -6,6 +6,7 @@ const apollo_1 = require("../../lib/apollo");
6
6
  const cmd_1 = require("../../lib/cmd");
7
7
  const flags_1 = require("../../lib/flags");
8
8
  const displays_1 = require("../../utils/displays");
9
+ const utils_1 = require("../../utils/utils");
9
10
  // Add date filters, search query,
10
11
  const GET_REQUESTS = (0, graphql_1.graphql)(`
11
12
  query GetRequests($pageSize: Int, $showPendingOnly: Boolean!) {
@@ -58,6 +59,7 @@ const GET_REQUESTS = (0, graphql_1.graphql)(`
58
59
  }`);
59
60
  class ListRequests extends core_1.Command {
60
61
  async run() {
62
+ (0, utils_1.restrictToDev)(); //TODO: Remove after development is complete
61
63
  (0, cmd_1.setMostRecentCommand)(this);
62
64
  const client = await (0, apollo_1.getClient)(this, true);
63
65
  let pageSize = 10;
@@ -86,6 +88,7 @@ class ListRequests extends core_1.Command {
86
88
  }
87
89
  }
88
90
  }
91
+ ListRequests.hidden = true;
89
92
  ListRequests.description = "Lists your n recent outgoing access requests";
90
93
  ListRequests.examples = [
91
94
  "opal request list --n 5",
@@ -27,7 +27,7 @@ class WhoAmI extends core_1.Command {
27
27
  }
28
28
  }
29
29
  }
30
- WhoAmI.description = "Describes current url set, organization name, and logged in user if applicable.";
30
+ WhoAmI.description = "Describes current url set, organization name, and logged in user if applicabled.";
31
31
  WhoAmI.flags = {
32
32
  help: flags_1.SHARED_FLAGS.help,
33
33
  };
@@ -319,7 +319,7 @@
319
319
  "whoami": {
320
320
  "aliases": [],
321
321
  "args": {},
322
- "description": "Describes current url set, organization name, and logged in user if applicable.",
322
+ "description": "Describes current url set, organization name, and logged in user if applicabled.",
323
323
  "flags": {
324
324
  "help": {
325
325
  "char": "h",
@@ -660,6 +660,7 @@
660
660
  }
661
661
  },
662
662
  "hasDynamicHelp": false,
663
+ "hidden": true,
663
664
  "hiddenAliases": [],
664
665
  "id": "request:create",
665
666
  "pluginAlias": "opal-security",
@@ -708,6 +709,7 @@
708
709
  }
709
710
  },
710
711
  "hasDynamicHelp": false,
712
+ "hidden": true,
711
713
  "hiddenAliases": [],
712
714
  "id": "request:get",
713
715
  "pluginAlias": "opal-security",
@@ -766,6 +768,7 @@
766
768
  }
767
769
  },
768
770
  "hasDynamicHelp": false,
771
+ "hidden": true,
769
772
  "hiddenAliases": [],
770
773
  "id": "request:list",
771
774
  "pluginAlias": "opal-security",
@@ -1028,5 +1031,5 @@
1028
1031
  ]
1029
1032
  }
1030
1033
  },
1031
- "version": "3.1.1-beta.153d5b3"
1034
+ "version": "3.1.1-beta.189ac0c"
1032
1035
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "opal-security",
3
3
  "description": "Opal allows you to centrally manage access to all of your sensitive systems.",
4
- "version": "3.1.1-beta.153d5b3",
4
+ "version": "3.1.1-beta.189ac0c",
5
5
  "author": "Stephen Cobbe",
6
6
  "bin": {
7
7
  "opal": "./bin/run"