@cloud-copilot/iam-expand 0.11.0 → 0.11.1

package/LICENSE.txt

@@ -1,5 +1,5 @@
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
 
  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
@@ -7,17 +7,15 @@
 
                             Preamble
 
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
 
   The licenses for most software and other practical works are designed
 to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
+our General Public Licenses are intended to guarantee your freedom to
 share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
+software for all its users.
 
   When we speak of free software, we are referring to freedom, not
 price.  Our General Public Licenses are designed to make sure that you
@@ -26,44 +24,34 @@ them if you wish), that you receive source code or can get it if you
 want it, that you can change the software or use pieces of it in new
 free programs, and that you know you can do these things.
 
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
 
   The precise terms and conditions for copying, distribution and
 modification follow.
@@ -72,7 +60,7 @@ modification follow.
 
   0. Definitions.
 
-  "This License" refers to version 3 of the GNU General Public License.
+  "This License" refers to version 3 of the GNU Affero General Public License.
 
   "Copyright" also means copyright-like laws that apply to other kinds of
 works, such as semiconductor masks.
@@ -549,35 +537,45 @@ to collect a royalty for further conveying from those to whom you convey
 the Program, the only way you could satisfy both those terms and this
 License would be to refrain entirely from conveying the Program.
 
-  13. Use with the GNU Affero General Public License.
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
 
   Notwithstanding any other provision of this License, you have
 permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
+under version 3 of the GNU General Public License into a single
 combined work, and to convey the resulting work.  The terms of this
 License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
 
   14. Revised Versions of this License.
 
   The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
 address new problems or concerns.
 
   Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
+Program specifies that a certain numbered version of the GNU Affero General
 Public License "or any later version" applies to it, you have the
 option of following the terms and conditions either of that numbered
 version or of any later version published by the Free Software
 Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
+GNU Affero General Public License, you may choose any version ever published
 by the Free Software Foundation.
 
   If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
+versions of the GNU Affero General Public License can be used, that proxy's
 public statement of acceptance of a version permanently authorizes you
 to choose that version for the Program.
 
@@ -635,40 +633,29 @@ the "copyright" line and a pointer to where the full notice is found.
     Copyright (C) <year>  <name of author>
 
     This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
+    it under the terms of the GNU Affero General Public License as published by
     the Free Software Foundation, either version 3 of the License, or
     (at your option) any later version.
 
     This program is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
+    GNU Affero General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
+    You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    <program>  Copyright (C) <year>  <name of author>
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
+  If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
 
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<https://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<https://www.gnu.org/licenses/>.

package/README.md

@@ -1,12 +1,17 @@
 # Expand IAM Actions
+
+[![NPM Version](https://img.shields.io/npm/v/@cloud-copilot/iam-expand.svg?logo=nodedotjs)](https://www.npmjs.com/package/@cloud-copilot/iam-expand) [![License: AGPL v3](https://img.shields.io/github/license/cloud-copilot/iam-expand)](LICENSE.txt) [![GuardDog](https://github.com/cloud-copilot/iam-expand/actions/workflows/guarddog.yml/badge.svg)](https://github.com/cloud-copilot/iam-expand/actions/workflows/guarddog.yml) [![Known Vulnerabilities](https://snyk.io/test/github/cloud-copilot/iam-expand/badge.svg?targetFile=package.json&style=flat-square)](https://snyk.io/test/github/cloud-copilot/iam-expand?targetFile=package.json)
+
 Built in the Unix philosophy, this is a small tool that does one thing well: explain IAM actions with wildcards.
 
 Use this to:
-1) Expand wildcards when you are not allowed to use them in your policies.
-2) Get an exhaustive list of actions that are included in a policy to quickly search it for interesting actions.
-3) Investigate where interesting or dubious actions are being used in your policies.
+
+1. Expand wildcards when you are not allowed to use them in your policies.
+2. Get an exhaustive list of actions that are included in a policy to quickly search it for interesting actions.
+3. Investigate where interesting or dubious actions are being used in your policies.
 
 <!-- Image of demo.svg -->
+
 ![Demo](assets/demo.svg)
 
 Extended demo [on YouTube](https://www.youtube.com/watch?v=357-uGru7300).
@@ -16,23 +21,31 @@ Published as an [npm package](#typescriptnodejs-usage) in ESM and CommonJS plus
 All information is sourced from [@cloud-copilot/iam-data](https://github.com/cloud-copilot/iam-data) which is updated daily.
 
 ## Only Valid Values
+
 `iam-expand` intends to only return valid, actual actions, if any invalid values are passed in such as an invalid format or a service/action that does not exist, they will be left out of the output. There are options to override this behavior.
 
 ## Use In Browser
+
 [http://iam.cloudcopilot.io/tools/iam-expand](http://iam.cloudcopilot.io/tools/iam-expand)
 
 ## CLI
+
 There is a CLI! The [examples folder](examples/README.md) has examples showing how to use the CLI to find interesting actions in your IAM policies.
 
 ### Global CLI Installation
+
 You can install it globally. This also works in the default AWS CloudShell!
+
 ```bash
 npm install -g @cloud-copilot/iam-expand
 ```
-*Depending on your configuration sudo may be required to install globally.*
+
+_Depending on your configuration sudo may be required to install globally._
 
 ### Install CLI In a Project
+
 You can also install the CLI in a project and run it with `npx`.
+
 ```bash
 npm install @cloud-copilot/iam-expand
 # Run with npx inside your project
@@ -40,7 +53,9 @@ npx @cloud-copilot/iam-expand
 ```
 
 ### Expand Actions
+
 The simplest usage is to pass in the actions you want to expand.
+
 ```bash
 iam-expand s3:Get*Tagging
 # Outputs all Get*Tagging actions
@@ -67,7 +82,9 @@ s3:PutStorageLensConfigurationTaggin
 ```
 
 ### Inverting Actions
+
 Use this to find all actions that are not in a set of patterns
+
 ```bash
 iam-expand --invert s3:Get*Tagging s3:Put*Tagging
 #Outputs all actions that are not Get*Tagging or Put*Tagging
@@ -81,7 +98,9 @@ a4b:AssociateContactWithAddressBook
 ```
 
 ### Help
+
 Run the command with no options to show usage:
+
 ```bash
 iam-expand
 ```
@@ -89,7 +108,9 @@ iam-expand
 ### Options
 
 #### `--expand-asterisk`
+
 By default, a single `*` will not be expanded. If you want to expand a single `*` you can set this flag.
+
 ```bash
 iam-expand "*"
 # Returns the asterisk
@@ -100,9 +121,11 @@ iam-expand --expand-asterisk "*"
 ```
 
 #### `--error-on-invalid-format`
+
 By default, if an invalid format is passed in, such as:
-*  `s3Get*Tagging` (missing a separator) or
-*  `s3:Get:Tagging*` (too many separators)
+
+- `s3Get*Tagging` (missing a separator) or
+- `s3:Get:Tagging*` (too many separators)
 
 it will be silenty ignored and left out of the output. If you want to throw an error when an invalid format is passed in you can set this flag.
 
@@ -116,6 +139,7 @@ iam-expand --error-on-invalid-format "s3Get*Tagging"
 ```
 
 #### `--error-on-invalid-service`
+
 By default, if a service is passed in that does not exist in the IAM data, it will be silently ignored and left out of the output. If you want to throw an error when a service is passed in that does not exist you can set this flag.
 
 ```bash
@@ -128,26 +152,29 @@ iam-expand --error-on-invalid-service "r2:Get*Tagging"
 ```
 
 #### `--invalid-action-behavior`
+
 By default, if an action is passed in that does not exist in the IAM data, it will be silently ignored and left out of the output. There are two options to override this behavior: `error` and `include`.
 
 ```bash
 iam-expand "ec2:DestroyAvailabilityZone"
 # Returns nothing
 
-iam-expand --invalid-action-behavior=remove "ec2:DestroyAvailabilityZone"
+iam-expand --invalid-action-behavior remove "ec2:DestroyAvailabilityZone"
 # Returns nothing
 
-iam-expand --invalid-action-behavior=error "ec2:DestroyAvailabilityZone"
+iam-expand --invalid-action-behavior error "ec2:DestroyAvailabilityZone"
 # Throws an error and returns a non zero exit code
 # Invalid action: ec2:DestroyAvailabilityZone
 
-iam-expand --invalid-action-behavior=include "ec2:DestroyAvailabilityZone"
+iam-expand --invalid-action-behavior include "ec2:DestroyAvailabilityZone"
 # Returns the invalid action
 ec2:DestroyAvailabilityZone
 ```
 
 #### `--invert`
+
 Use this to find all actions that are not in a set of patterns. Only works for actions passed as arguments, or unstructured content from stdin.
+
 ```bash
 iam-expand --invert s3:Get*Tagging s3:Put*Tagging
 #Outputs all actions that are not Get*Tagging or Put*Tagging
@@ -161,13 +188,17 @@ a4b:AssociateContactWithAddressBook
 ```
 
 #### `--invert-not-actions`
-*This operates only on JSON input*. It will recursively search the JSON document for any `NotAction` that is a string or an array of strings. The `NotAction` will be replaced with an `Action` key that is the inverse of the `NotAction` actions or patterns.
+
+_This operates only on JSON input_. It will recursively search the JSON document for any `NotAction` that is a string or an array of strings. The `NotAction` will be replaced with an `Action` key that is the inverse of the `NotAction` actions or patterns.
+
 ```bash
 cat policy.json | iam-expand --invert-not-actions
 ```
+
 See [Read from Stdin](#read-from-stdin) for more details
 
 #### `--show-data-version`
+
 Show the version of the data that is being used to expand the actions and exit.
 
 ```bash
@@ -180,26 +211,29 @@ Update with either:
 ```
 
 #### `--read-wait-ms`
+
 When reading from stdin (see [below](#read-from-stdin)) the CLI will wait 10 seconds for the first byte to be read before timing out. This is enough time for most operations. If you want to wait longer you can set this flag to the number of milliseconds you want to wait.
 
 ```bash
 cat policy.json | iam-expand
 # Will wait up to 10 seconds for input to start, which is plenty of time for a local file.
 
-curl "https://government-secrets.s3.amazonaws.com/secret-policy.json" | iam-expand --read-wait-ms=20_000
+curl "https://government-secrets.s3.amazonaws.com/secret-policy.json" | iam-expand --read-wait-ms 20000
 # Will wait up to 20 seconds to receive first byte from curl before timing out. Adjust as needed
 ```
 
 ### Read from stdin
+
 If no actions are passed as arguments, the CLI will read from stdin.
 
 #### Expanding JSON input
+
 If the input is a valid json document, the CLI will find every instance of `Action` and `NotAction` that is a string or an array of strings and expand them. This is useful for finding all the actions in a policy document or set of documents.
 
 Given `policy.json`
-```json
 
- {
+```json
+{
   "Version": "2012-10-17",
   "Statement": [
     {
@@ -213,7 +247,7 @@ Given `policy.json`
       "Resource": "*"
     }
   ]
- }
+}
 ```
 
 ```bash
@@ -221,6 +255,7 @@ cat policy.json | iam-expand > expanded-policy.json
 ```
 
 Gives this file in `expanded-policy.json`
+
 ```json
 {
   "Version": "2012-10-17",
@@ -255,15 +290,17 @@ Gives this file in `expanded-policy.json`
       "Resource": "*"
     }
   ]
- }
+}
 ```
 
-You can also invert the `NotAction` using `--invert-not-actions`.  This will replace the `NotAction` element with an `Action` element that is the inverse of actions listed in the `NotAction`.
+You can also invert the `NotAction` using `--invert-not-actions`. This will replace the `NotAction` element with an `Action` element that is the inverse of actions listed in the `NotAction`.
+
 ```bash
 cat policy.json | iam-expand --invert-not-actions > inverted-policy.json
 ```
 
 Gives this file in `inverted-policy.json`
+
 ```json
 {
   "Version": "2012-10-17",
@@ -299,38 +336,44 @@ Gives this file in `inverted-policy.json`
  }
 ```
 
-
 You can also use this to expand the actions from the output of commands.
+
 ```bash
-aws iam get-account-authorization-details --output json | iam-expand --read-wait-ms=20_000 > expanded-authorization-details.json
+aws iam get-account-authorization-details --output json | iam-expand --read-wait-ms 20000 > expanded-authorization-details.json
 # Now you can search the output for actions you are interested in
 grep -n "kms:DisableKey" expanded-authorization-details.json
 ```
 
 #### Expanding arbitrary input
+
 If the input from stdin is not json, the content is searched for IAM actions then expands them. Throw anything at it and it will find all the actions it can and expand them.
 
 You can echo content:
+
 ```bash
 echo "s3:Get*Tagging" | iam-expand
 ```
 
 You can pull out part of a json file and pipe it in:
+
 ```bash
 cat policy.json | jq '.Statement[].Action' | iam-expand
 ```
 
 Or some Terraform:
+
 ```bash
 cat main.tf | iam-expand
 ```
 
 Or some CloudFormation:
+
 ```bash
 cat template.yaml | iam-expand
 ```
 
 Or even some HTML:
+
 ```bash
 curl "https://docs.aws.amazon.com/aws-managed-policy/latest/reference/ReadOnlyAccess.html" | iam-expand
 ```
@@ -344,25 +387,24 @@ Please give this anything you can think of and open an issue if you see an oppor
 ## Typescript/NodeJS Usage
 
 ## Add to a project
+
 ```bash
 npm install @cloud-copilot/iam-expand
 ```
 
 ```typescript
-import { expandIamActions } from '@cloud-copilot/iam-expand';
+import { expandIamActions } from '@cloud-copilot/iam-expand'
 
-expandIamActions('s3:Get*Tagging')
-[
-  's3:GetBucketTagging',
+expandIamActions('s3:Get*Tagging')[
+  ('s3:GetBucketTagging',
   's3:GetJobTagging',
   's3:GetObjectTagging',
   's3:GetObjectVersionTagging',
-  's3:GetStorageLensConfigurationTagging'
+  's3:GetStorageLensConfigurationTagging')
 ]
 
-expandIamActions(['s3:Get*Tagging', 's3:Put*Tagging'])
-[
-  's3:GetBucketTagging',
+expandIamActions(['s3:Get*Tagging', 's3:Put*Tagging'])[
+  ('s3:GetBucketTagging',
   's3:GetJobTagging',
   's3:GetObjectTagging',
   's3:GetObjectVersionTagging',
@@ -371,24 +413,28 @@ expandIamActions(['s3:Get*Tagging', 's3:Put*Tagging'])
   's3:PutJobTagging',
   's3:PutObjectTagging',
   's3:PutObjectVersionTagging',
-  's3:PutStorageLensConfigurationTagging'
+  's3:PutStorageLensConfigurationTagging')
 ]
 ```
 
 ## API Reference
 
 ## `expandIamActions`
+
 `expandIamActions(actionStringOrStrings: string | string[], overrideOptions?: Partial<ExpandIamActionsOptions>)` is the main function that will expand the actions of the IAM policy. Takes a string or array of strings and returns an array of strings that the input matches.
 
 ## Only Valid Values
+
 `expandIamActions` intends to only return valid actual actions, if any invalid values are passed in such as an invalid format or a service/action that does not exist, they will be left out of the output. There are options to override this behavior.
 
 Any escaped unicode characters will be converted to their original character as part of the process. So `s3:\\u0067et*` will be converted to `s3:Get*` before processing. Even something like `s3:\\u0067etBucket` will be converted to `s3:GetBucket` even though it has no wildcards..
 
 ## Options
+
 `expandIamActions` an optional second argument that is an object with the following options:
 
 ### `expandAsterisk`
+
 By default, a single `*` will not be expanded. If you want to expand a single `*` you can set this option to `true`.
 
 ```typescript
@@ -406,9 +452,11 @@ expandIamActions('*', { expandAsterisk: true })
 ```
 
 ### `errorOnInvalidFormat`
+
 By default, if an invalid format is passed in, such as:
-*  `s3Get*Tagging` (missing a separator) or
-*  `s3:Get:Tagging*` (too many separators)
+
+- `s3Get*Tagging` (missing a separator) or
+- `s3:Get:Tagging*` (too many separators)
 
 it will be silenty ignored and left out of the output. If you want to throw an error when an invalid format is passed in you can set this option to `true`.
 
@@ -425,6 +473,7 @@ expandIamActions('s3Get*Tagging', { errorOnInvalidFormat: true })
 ```
 
 ### `errorOnInvalidService`
+
 By default, if a service is passed in that does not exist in the IAM data, it will be silently ignored and left out of the output. If you want to throw an error when a service is passed in that does not exist you can set this option to `true`.
 
 ```typescript
@@ -440,6 +489,7 @@ expandIamActions('r2:Get*Tagging', { errorOnInvalidService: true })
 ```
 
 ### `invalidActionBehavior`
+
 By default, if an action is passed in that does not exist in the IAM data, it will be silently ignored and left out of the output. There are two options to override this behavior: `Error` and `Include`.
 
 ```typescript
@@ -463,4 +513,5 @@ expandIamActions('ec2:DestroyAvailabilityZone', { invalidActionBehavior: Invalid
 ```
 
 ## `invertIamActions`
+
 `invertIamActions(actionString: string): string` will take an action string and return all actions not matching . For example `s3:Get*Tagging` will return all actions from all services except those s3 actions that match the pattern `Get*Tagging`.