Skip to content

docs: IAM policy support doc #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JigarJoshi merged 2 commits into from
Feb 21, 2025
Merged

docs: IAM policy support doc #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
639744c
docs: IAM policy support doc
JigarJoshi Feb 6, 2025
3ec3436
Merge branch 'main' into jmj/iam-docs
JigarJoshi Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/iam/iam-policy-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Tigris IAM Policy Support

An IAM (Identity and Access Management) policy is a set of rules that define
permissions, specifying what actions can be performed on specific resources
optionally with some conditions. IAM policy is very broad and in context of
Tigris we support the following blocks:

| Block | Supported | Description |
| ------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Version | Yes | Specifies the version of the policy language. The supported version is `2012-10-17` |
| Id | Yes | An optional identifier of the policy. |
| Statement | Yes | An array of one or more statements that define the permissions. |
| statement.sid_block | Yes | An optional identifier for the statement. |
| statement.effect | Yes | Specifies whether the action is allowed or denied. |
| statement.action | Yes | Specifies the action that is allowed. Note that here Tigris supports format `s3:MethodName`, For example: `s3:PutBucket`. Tigris supports wildcard (`*`) and prefixes (eg: `s3:Put*`) here. |
| statement.resource | Yes | Specifies the Amazon Resource Name (ARN) of the resource to which the policy applies. Tigris supports wildcard (`*`) and prefixes for object (eg: `arn:aws:s3:::my-bucket/images/*`). |
| statement.condition | Partially | Tigris supports `IpAddress`, `NotIpAddress`, `DateEquals`, `DateNotEquals`, `DateGreaterThan`, `DateGreaterThanEquals`, `DateLessThan`, `DateLessThanEquals` condition. |

Note that for date-time conditions - only supported variable is
`aws:CurrentTime` which represents the current time when server is processing
the request.
7 changes: 7 additions & 0 deletions docs/iam/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,13 @@ you'll need to attach IAM policies to the new access key.
Let's create an IAM policy and attach it to an access key. Here's an example IAM
policy. You'll need to save it as a `.json` file.

:::note

Refer [here](./iam-policy-support.md) for more information on what blocks of IAM
policies are supported by Tigris.

:::

```
nano file:///path/to/policy.json

Expand Down
1 change: 1 addition & 0 deletions sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ const sidebars = {
label: "IAM",
items: [
"iam/index",
"iam/iam-policy-support",
"iam/create-access-key/index",
"iam/limited-access-key",
"iam/ip-restrictions",
Expand Down