@actsecurity/iam-collect 0.1.216 → 0.1.217
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
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# iam-collect
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/@actsecurity/iam-collect) [](LICENSE.txt) [](https://github.com/act-security-labs/iam-collect/actions/workflows/guarddog.yml) [](https://snyk.io/test/github/act-security-labs/iam-collect?targetFile=package.json)
|
|
4
4
|
|
|
5
5
|
Get every possible policy in any set of AWS accounts. This is built to run out of the box in simple use cases, and also work in terribly oppressive environments with a little more configuration. If you want to analyze IAM data at scale this is what you've been looking for.
|
|
6
6
|
|
|
@@ -56,7 +56,7 @@ By default, iam-collect will use the credentials configured in your environment
|
|
|
56
56
|
You don't need the AWS CLI, but a good way to make sure your credentials are configured is to ensure you can run `aws sts get-caller-identity` and a command that requires a region be set such as `aws ec2 describe-instances`.
|
|
57
57
|
|
|
58
58
|
```bash
|
|
59
|
-
npm install -g @
|
|
59
|
+
npm install -g @actsecurity/iam-collect
|
|
60
60
|
# Create a default configuration file
|
|
61
61
|
iam-collect init
|
|
62
62
|
# Download iam data from the current account to `./iam-data`
|
|
@@ -68,7 +68,7 @@ iam-collect download
|
|
|
68
68
|
You need Node.js >= 20.
|
|
69
69
|
|
|
70
70
|
```bash
|
|
71
|
-
npm install -g @
|
|
71
|
+
npm install -g @actsecurity/iam-collect
|
|
72
72
|
```
|
|
73
73
|
|
|
74
74
|
### Initialize
|
|
@@ -109,14 +109,14 @@ This will show you your data that was downloaded. See the [storage docs](docs/St
|
|
|
109
109
|
|
|
110
110
|
### iam-lens
|
|
111
111
|
|
|
112
|
-
To explore effective access in your environment check out [iam-lens](https://github.com/
|
|
112
|
+
To explore effective access in your environment check out [iam-lens](https://github.com/act-security-labs/iam-lens). iam-lens reads your iam-collect data to answer questions like: "Who can access this resource?", "Who can assume this role?", and "Does this principal have access to this bucket?"
|
|
113
113
|
|
|
114
114
|
### Leveraging Your AI
|
|
115
115
|
|
|
116
116
|
Use [AgentInstructions.md](docs/AgentInstructions.md) to help your AI understand the data and how to interrogate it.
|
|
117
117
|
|
|
118
118
|
```bash
|
|
119
|
-
curl -O https://raw.githubusercontent.com/
|
|
119
|
+
curl -O https://raw.githubusercontent.com/act-security-labs/iam-collect/main/docs/AgentInstructions.md
|
|
120
120
|
```
|
|
121
121
|
|
|
122
122
|
Then you can start asking questions like "Using AgentInstructions.md as context...":
|
|
@@ -185,4 +185,4 @@ If you prefer, you can configure iam-collect to pull data from AWS Config instea
|
|
|
185
185
|
| sso | Instances | id, name, owner account id, status, tags |
|
|
186
186
|
| sso | Permission Sets | name, description, AWS managed policies, customer managed policies, inline policy, permission boundary, accounts, tags |
|
|
187
187
|
|
|
188
|
-
If you don't see the data you are looking for, please check the [open resource issues](https://github.com/
|
|
188
|
+
If you don't see the data you are looking for, please check the [open resource issues](https://github.com/act-security-labs/iam-collect/issues?q=is%3Aissue%20state%3Aopen%20label%3Aresource) and comment on the issue or create a new one.
|