Skip to content
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.

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

[Tuning] GitHub Actions Trust Policy #1492

Merged
merged 1 commit into from
Jan 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
67 changes: 42 additions & 25 deletions policies/aws_iam_policies/aws_iam_role_github_actions_trust.py
Original file line number Diff line number Diff line change
@@ -1,38 +1,55 @@
import json

from panther_base_helpers import deep_get


def policy(resource):
assume_role_policy = deep_get(resource, "AssumeRolePolicyDocument", "Statement", default=[])
is_valid = False
# check if resource.AssumRolePolicyDocument is a string, and if so convert to json
if isinstance(resource.get("AssumeRolePolicyDocument"), str):
policy_document = json.loads(resource.get("AssumeRolePolicyDocument", {}))
else:
policy_document = resource.get("AssumeRolePolicyDocument", {})
assume_role_policy = policy_document.get("Statement", [])

for statement in assume_role_policy:
if statement.get(
"Effect"
) != "Allow" or "sts:AssumeRoleWithWebIdentity" not in statement.get("Action", []):
# only check for Allow sts:AssumeRoleWithWebIdentity
if (
statement.get("Effect") != "Allow"
or statement.get("Action") != "sts:AssumeRoleWithWebIdentity"
):
continue

principal = deep_get(statement, "Principal", "Federated")
if not principal or principal == "*":
return False
if "oidc-provider/token.actions.githubusercontent.com" not in principal:
continue

# Validate the conditions only if the Principal is valid for GitHub Actions
conditions = statement.get("Condition", {})
audience = deep_get(conditions, "StringEquals", "token.actions.githubusercontent.com:aud")
audience = deep_get(
statement, "Condition", "StringEquals", "token.actions.githubusercontent.com:aud"
)
subject = deep_get(
conditions, "StringLike", "token.actions.githubusercontent.com:sub", default=""
statement,
"Condition",
"StringLike",
"token.actions.githubusercontent.com:sub",
default="",
) or deep_get(
conditions, "StringEquals", "token.actions.githubusercontent.com:sub", default=""
statement,
"Condition",
"StringEquals",
"token.actions.githubusercontent.com:sub",
default="",
)

if (
audience != "sts.amazonaws.com"
or not subject.startswith("repo:")
or ("*" in subject and not subject.startswith("repo:org/repo:*"))
):
return False

is_valid = True # Mark as valid if all checks pass

return is_valid
if subject.startswith("repo:"):
# repo subjects must have github as the principal and sts.amazonaws.com as the audience
if any(
[
"oidc-provider/token.actions.githubusercontent.com" not in principal,
audience != "sts.amazonaws.com",
("*" in subject and not subject.startswith("repo:org/repo:*")),
]
):
return False
else:
# non-repo subjects must not have github as the principal
if "oidc-provider/token.actions.githubusercontent.com" in principal:
return False

return True
22 changes: 22 additions & 0 deletions policies/aws_iam_policies/aws_iam_role_github_actions_trust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -200,3 +200,25 @@ Tests:
]
}
}

- Name: Non-GitHub IAM Role
ExpectedResult: true
Resource:
{
"AccountId": "123412341233",
"Arn": "arn:aws:iam::123412341233:role/DevAdministrator",
"AssumeRolePolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"arn:aws:iam::12341523456:root\",\"arn:aws:iam::123412341233:root\"]},\"Action\":\"sts:AssumeRole\",\"Condition\":{\"Bool\":{\"aws:MultiFactorAuthPresent\":\"true\",\"aws:SecureTransport\":\"true\"},\"NumericLessThan\":{\"aws:MultiFactorAuthAge\":\"28800\"}}}]}",
"ManagedPolicyARNs": [
"arn:aws:iam::aws:policy/AdministratorAccess"
],
"ManagedPolicyNames": [
"AdministratorAccess"
],
"MaxSessionDuration": 28800,
"Name": "DevAdministrator",
"Path": "/",
"Region": "global",
"ResourceId": "arn:aws:iam::123412341233:role/DevAdministrator",
"ResourceType": "AWS.IAM.Role",
"TimeCreated": "2023-11-08T23:50:46Z"
}
Loading