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.

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

feat(assume_role): support specifying session policy arns #285

Merged
merged 3 commits into from
Dec 11, 2024
Merged

feat(assume_role): support specifying session policy arns #285

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3bd9759
feat(assume_role): support specifying session policy arns
mbarneyjr Oct 16, 2024
a5f579f
fix(tests): fix session policy arn in arg namespace
mbarneyjr Oct 16, 2024
a8c3e78
fix(docs): add session policy and policy arn usage documentation
mbarneyjr Dec 11, 2024
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
25 changes: 24 additions & 1 deletion awsume/awsumepy/default_plugins.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,13 @@ def add_arguments(config: dict, parser: argparse.ArgumentParser):
metavar='session_policy',
help='Custom session policy JSON',
)
parser.add_argument('--session-policy-arns',
nargs='+',
default=[],
dest='session_policy_arns',
metavar='session_policy_arns',
help='List of policy ARNs',
)
parser.add_argument('--role-duration',
action='store',
dest='role_duration',
Expand Down Expand Up @@ -345,7 +352,17 @@ def assume_role_from_cli(config: dict, arguments: dict, profiles: dict):
logger.debug('Session name: {}'.format(session_name))
if not arguments.source_profile:
logger.debug('Using current credentials to assume role')
role_session = aws_lib.assume_role({}, arguments.role_arn, session_name, session_policy=arguments.session_policy, region=region, external_id=arguments.external_id, role_duration=role_duration, tags=arguments.session_tags)
role_session = aws_lib.assume_role(
{},
arguments.role_arn,
session_name,
session_policy=arguments.session_policy,
session_policy_arns=arguments.session_policy_arns,
region=region,
external_id=arguments.external_id,
role_duration=role_duration,
tags=arguments.session_tags,
)
else:
logger.debug('Using the source_profile from the cli to call assume_role')
source_profile = profiles.get(arguments.source_profile)
Expand All @@ -364,6 +381,7 @@ def assume_role_from_cli(config: dict, arguments: dict, profiles: dict):
arguments.role_arn,
session_name,
session_policy=arguments.session_policy,
session_policy_arns=arguments.session_policy_arns,
region=region,
external_id=arguments.external_id,
role_duration=role_duration,
Expand All @@ -378,6 +396,7 @@ def assume_role_from_cli(config: dict, arguments: dict, profiles: dict):
arguments.role_arn,
session_name,
session_policy=arguments.session_policy,
session_policy_arns=arguments.session_policy_arns,
region=region,
external_id=arguments.external_id,
role_duration=role_duration,
Expand All @@ -403,6 +422,7 @@ def assume_role_from_cli(config: dict, arguments: dict, profiles: dict):
arguments.role_arn,
session_name,
session_policy=arguments.session_policy,
session_policy_arns=arguments.session_policy_arns,
region=region,
external_id=arguments.external_id,
role_duration=role_duration,
Expand All @@ -423,6 +443,7 @@ def get_assume_role_credentials(config: dict, arguments: argparse.Namespace, pro
target_profile.get('role_arn'),
profile_lib.get_session_name(config, arguments, profiles, target_profile_name),
session_policy=arguments.session_policy,
session_policy_arns=arguments.session_policy_arns,
region=region,
external_id=external_id,
role_duration=role_duration,
Expand Down Expand Up @@ -469,6 +490,7 @@ def get_assume_role_credentials_mfa_required(config: dict, arguments: argparse.N
target_profile.get('role_arn'),
profile_lib.get_session_name(config, arguments, profiles, target_profile_name),
session_policy=arguments.session_policy,
session_policy_arns=arguments.session_policy_arns,
region=region,
external_id=external_id,
role_duration=role_duration,
Expand Down Expand Up @@ -500,6 +522,7 @@ def get_assume_role_credentials_mfa_required_large_custom_duration(config: dict,
target_profile.get('role_arn'),
profile_lib.get_session_name(config, arguments, profiles, target_profile_name),
session_policy=arguments.session_policy,
session_policy_arns=arguments.session_policy_arns,
region=region,
external_id=external_id,
role_duration=role_duration,
Expand Down
5 changes: 4 additions & 1 deletion awsume/awsumepy/lib/aws.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import os
from typing import Union
from typing import List, Union

import boto3
import botocore
Expand Down Expand Up @@ -33,6 +33,7 @@ def assume_role(
role_arn: str,
session_name: str,
session_policy: str = None,
session_policy_arns: List[str] = [],
external_id: str = None,
region: str = None,
role_duration: int = None,
Expand All @@ -56,6 +57,8 @@ def assume_role(
kwargs = { 'RoleSessionName': session_name, 'RoleArn': role_arn }
if session_policy:
kwargs['Policy'] = session_policy
if session_policy_arns:
kwargs['PolicyArns'] = [{'arn': arn} for arn in session_policy_arns]
if external_id:
kwargs['ExternalId'] = external_id
if role_duration:
Expand Down
14 changes: 14 additions & 0 deletions test/unit/awsume/awsumepy/test_default_plugins.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

def generate_namespace_with_defaults(
session_policy=None,
session_policy_arns=None,
session_tags=None,
region=None,
source_profile=None,
Expand All @@ -26,8 +27,10 @@ def generate_namespace_with_defaults(
who=None,
**kwargs
) -> argparse.Namespace:
arns = [] if session_policy_arns is None else session_policy_arns
return argparse.Namespace(
session_policy=session_policy,
session_policy_arns=arns,
session_tags=session_tags,
region=region,
source_profile=source_profile,
Expand Down Expand Up @@ -429,6 +432,7 @@ def test_assume_role_from_cli(aws_lib: MagicMock, profile_lib: MagicMock):
aws_lib.assume_role.assert_called_with(
{}, arguments.role_arn, 'awsume-cli-role',
session_policy=arguments.session_policy,
session_policy_arns=arguments.session_policy_arns,
region=profile_lib.get_region.return_value,
external_id=arguments.external_id,
role_duration=0,
Expand Down Expand Up @@ -467,6 +471,7 @@ def test_assume_role_from_cli_source_profile(aws_lib: MagicMock, profile_lib: Ma
arguments.role_arn,
'awsume-cli-role',
session_policy=arguments.session_policy,
session_policy_arns=arguments.session_policy_arns,
region=profile_lib.get_region.return_value,
external_id=arguments.external_id,
role_duration=0,
Expand Down Expand Up @@ -505,6 +510,7 @@ def test_assume_role_from_cli_source_profile_role_duration_mfa(aws_lib: MagicMoc
arguments.role_arn,
'awsume-cli-role',
session_policy=arguments.session_policy,
session_policy_arns=arguments.session_policy_arns,
region=profile_lib.get_region.return_value,
external_id=arguments.external_id,
role_duration='43200',
Expand Down Expand Up @@ -544,6 +550,7 @@ def test_assume_role_from_cli_source_profile_role_duration_no_mfa(aws_lib: Magic
arguments.role_arn,
'awsume-cli-role',
session_policy=arguments.session_policy,
session_policy_arns=arguments.session_policy_arns,
region=profile_lib.get_region.return_value,
external_id=arguments.external_id,
role_duration='43200',
Expand Down Expand Up @@ -589,6 +596,7 @@ def test_assume_role_from_cli_source_profile_no_role_duration_mfa(aws_lib: Magic
arguments.role_arn,
'awsume-cli-role',
session_policy=arguments.session_policy,
session_policy_arns=arguments.session_policy_arns,
region=profile_lib.get_region.return_value,
external_id=arguments.external_id,
role_duration=0,
Expand Down Expand Up @@ -626,6 +634,7 @@ def test_assume_role_from_cli_source_profile_no_role_duration_no_mfa(aws_lib: Ma
arguments.role_arn,
'awsume-cli-role',
session_policy=arguments.session_policy,
session_policy_arns=arguments.session_policy_arns,
region=profile_lib.get_region.return_value,
external_id=arguments.external_id,
role_duration=0,
Expand Down Expand Up @@ -699,6 +708,7 @@ def test_get_credentials(aws_lib: MagicMock, create_autoawsume_profile: MagicMoc
'myrolearn',
'mysessionname',
session_policy=arguments.session_policy,
session_policy_arns=arguments.session_policy_arns,
region=None,
external_id='myexternalid',
role_duration=0,
Expand Down Expand Up @@ -752,6 +762,7 @@ def test_get_credentials_auto_refresh(aws_lib: MagicMock, create_autoawsume_prof
'myrolearn',
'mysessionname',
session_policy=arguments.session_policy,
session_policy_arns=arguments.session_policy_arns,
region=None,
external_id='myexternalid',
role_duration=0,
Expand Down Expand Up @@ -795,6 +806,7 @@ def test_get_credentials_role_duration(aws_lib: MagicMock, create_autoawsume_pro
'myrolearn',
'mysessionname',
session_policy=arguments.session_policy,
session_policy_arns=arguments.session_policy_arns,
region=None,
external_id='myexternalid',
role_duration=43200,
Expand Down Expand Up @@ -910,6 +922,7 @@ def test_get_credentials_no_mfa_role(aws_lib: MagicMock, create_autoawsume_profi
'myrolearn',
'mysessionname',
session_policy=arguments.session_policy,
session_policy_arns=arguments.session_policy_arns,
region=None,
external_id='myexternalid',
role_duration=0,
Expand Down Expand Up @@ -1009,6 +1022,7 @@ def test_post_add_arguments_session_tags(aws_lib: MagicMock):
arguments.role_arn,
'awsume-cli-role',
session_policy=arguments.session_policy,
session_policy_arns=arguments.session_policy_arns,
external_id=arguments.external_id,
role_duration='43200',
tags=[
Expand Down
Loading