| Name | iam-sarif-report JSON |
| Version |
2.3.2
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-04-04 22:11:11 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2021 George Alton Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# IAM SARIF Report
[](https://github.com/psf/black)
Validate your IAM Policies and SCPs with AWS Policy Validator, and convert those results into SARIF documents for reporting.
## Use Me
To generate findings, iam-sarif-report makes AWS API requests. The AWS Principal you use must be allowed to use the `access-analyzer:ValidatePolicy` command.
```json
{
"Effect": "Allow",
"Action": "access-analyzer:ValidatePolicy",
"Resource": "*"
}
```
### GitHub Action
See the [action.yaml](action.yaml) for detailed usage information.
```yaml
on: [push]
jobs:
example:
permissions:
id-token: write
security-events: write # When using GitHub Advanced Security
actions: read
contents: read
checks: write # When using SARIF annotator
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
# setup aws access
- uses: aws-actions/configure-aws-credentials@v3
with:
role-to-assume: arn:aws:iam::111111111111:role/my-github-actions-role-test
aws-region: eu-west-1
# validate some policies and write a SARIF result file
- uses: georgealton/iam-sarif-report@v2
with:
policies: policies/
result: results/iam.sarif
# Public repositories and Organizations with GitHub Advanced Security
# can upload sarif files using CodeQL
- uses: github/codeql-action/upload-sarif@v2
with:
sarif_file: results
# Without GitHub Advanced Security use sarif-annotator
- uses: SirYwell/sarif-annotator@v0.2.1
with:
report-path: results/iam.sarif
source: qodana
```
### Locally
```sh
pipx run iam-sarif-report tests/data/policy_checks/policies/*
```
Raw data
{
"_id": null,
"home_page": null,
"name": "iam-sarif-report",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "George Alton <georgealton@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/53/ef/c4dede1a2c71d2afdaed43dff917818f2c1282c10e1e8b1d906580901bc8/iam-sarif-report-2.3.2.tar.gz",
"platform": null,
"description": "# IAM SARIF Report\n\n[](https://github.com/psf/black)\n\nValidate your IAM Policies and SCPs with AWS Policy Validator, and convert those results into SARIF documents for reporting.\n\n## Use Me\n\nTo generate findings, iam-sarif-report makes AWS API requests. The AWS Principal you use must be allowed to use the `access-analyzer:ValidatePolicy` command.\n\n```json\n{\n \"Effect\": \"Allow\",\n \"Action\": \"access-analyzer:ValidatePolicy\",\n \"Resource\": \"*\"\n}\n```\n\n### GitHub Action\n\nSee the [action.yaml](action.yaml) for detailed usage information.\n\n```yaml\non: [push]\njobs:\n example:\n permissions:\n id-token: write\n security-events: write #\u00a0When using GitHub Advanced Security\n actions: read\n contents: read\n checks: write # When using SARIF annotator\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v3\n\n # setup aws access\n - uses: aws-actions/configure-aws-credentials@v3\n with:\n role-to-assume: arn:aws:iam::111111111111:role/my-github-actions-role-test\n aws-region: eu-west-1\n\n # validate some policies and write a SARIF result file\n - uses: georgealton/iam-sarif-report@v2\n with:\n policies: policies/\n result: results/iam.sarif\n\n # Public repositories and Organizations with GitHub Advanced Security\n # can upload sarif files using CodeQL\n - uses: github/codeql-action/upload-sarif@v2\n with:\n sarif_file: results\n\n # Without GitHub Advanced Security use sarif-annotator\n - uses: SirYwell/sarif-annotator@v0.2.1\n with:\n report-path: results/iam.sarif\n source: qodana\n```\n\n### Locally\n\n```sh\npipx run iam-sarif-report tests/data/policy_checks/policies/*\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2021 George Alton Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": null,
"version": "2.3.2",
"project_urls": {
"homepage": "https://github.com/georgealton/iam-sarif-report",
"repository": "https://github.com/georgealton/iam-sarif-report"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4409d7360476aee4b0835f23878b604b4e00927d893f2e216df856b5dca86840",
"md5": "6a7dc8bb407f9caa5553281d345f8ab0",
"sha256": "b7a204aa2e6c08d48c3ee97621cc47e7e2e3efd8ab8ae246efc9a32d86180fa7"
},
"downloads": -1,
"filename": "iam_sarif_report-2.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6a7dc8bb407f9caa5553281d345f8ab0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 37342,
"upload_time": "2024-04-04T22:11:10",
"upload_time_iso_8601": "2024-04-04T22:11:10.149979Z",
"url": "https://files.pythonhosted.org/packages/44/09/d7360476aee4b0835f23878b604b4e00927d893f2e216df856b5dca86840/iam_sarif_report-2.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "53efc4dede1a2c71d2afdaed43dff917818f2c1282c10e1e8b1d906580901bc8",
"md5": "9f2ef75730070d7773100c60afbcc626",
"sha256": "3576fd27485e296ab2716251ef9b6857416d02c7aa7b47aa7942d277e13cf3aa"
},
"downloads": -1,
"filename": "iam-sarif-report-2.3.2.tar.gz",
"has_sig": false,
"md5_digest": "9f2ef75730070d7773100c60afbcc626",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 58533,
"upload_time": "2024-04-04T22:11:11",
"upload_time_iso_8601": "2024-04-04T22:11:11.540271Z",
"url": "https://files.pythonhosted.org/packages/53/ef/c4dede1a2c71d2afdaed43dff917818f2c1282c10e1e8b1d906580901bc8/iam-sarif-report-2.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 22:11:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "georgealton",
"github_project": "iam-sarif-report",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "iam-sarif-report"
}
