community.aws.accessanalyzer_validate_policy_info 模块 – 执行 IAM 策略验证

注意

此模块是 community.aws 集合 (版本 9.0.0) 的一部分。

如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.aws。要使用此模块，您需要其他需求，有关详细信息，请参阅 需求。

要在 playbook 中使用它，请指定： community.aws.accessanalyzer_validate_policy_info。

community.aws 5.0.0 中的新增功能

概要

  • 请求策略验证并返回发现列表。

需求

执行此模块的主机需要以下需求。

  • python >= 3.6

  • boto3 >= 1.28.0

  • botocore >= 1.31.0

参数

参数

注释

access_key

别名：aws_access_key_id，aws_access_key，ec2_access_key

字符串

AWS 访问密钥 ID。

有关访问令牌的更多信息，请参见 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。

还可以按优先级递减的顺序使用 AWS_ACCESS_KEY_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量。

aws_access_key 和 profile 选项是互斥的。

为与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。

ec2_access_key 别名已弃用，将在 2024-12-01 之后的发行版中删除。

EC2_ACCESS_KEY 环境变量的支持已弃用，将在 2024-12-01 之后的发行版中删除。

aws_ca_bundle

路径

验证 SSL 证书时使用的 CA 捆绑包的位置。

还可以使用 AWS_CA_BUNDLE 环境变量。

aws_config

字典

用于修改 botocore 配置的字典。

可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。

debug_botocore_endpoint_logs

布尔值

使用 botocore.endpoint 记录器来解析在任务期间进行的唯一（而不是总计）"resource:action" API 调用，将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间进行的总列表。

还可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。

选项

  • false ← (默认)

  • true

endpoint_url

别名：ec2_url，aws_endpoint_url，s3_url

字符串

连接到非默认 AWS 端点的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。

还可以按优先级递减的顺序使用 AWS_URL 或 EC2_URL 环境变量。

ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的发行版中删除。

EC2_URL 环境变量的支持已弃用，将在 2024-12-01 之后的发行版中删除。

locale

字符串

用于本地化发现结果的语言环境。

支持的区域设置包括DE、EN、ES、FR、IT、JA、KO、PT_BR、ZH_CN 和 ZH_TW。

有关支持的区域设置的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/access-analyzer/latest/APIReference/API_ValidatePolicy.html

默认值： "EN"

policy

别名：policy_document

json / 必需

正确格式化的 JSON 格式策略。

policy_type

字符串

要验证的策略类型。

identity 策略授予 IAM 主体权限，包括 IAM 角色、用户和组的托管策略和内联策略。

resource 策略授予 AWS 资源的权限，包括 IAM 角色的信任策略和 S3 存储桶的存储桶策略。

选项

  • "identity" ← (默认)

  • "resource"

  • "service_control"

profile

别名：aws_profile

字符串

用于身份验证的命名 AWS 配置文件。

有关命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。

也可以使用 AWS_PROFILE 环境变量。

profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。

region

别名：aws_region、ec2_region

字符串

要使用的 AWS 区域。

对于 IAM、Route53 和 CloudFront 等全球服务，将忽略 region。

也可以使用 AWS_REGION 或 EC2_REGION 环境变量。

有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。

已弃用 ec2_region 别名，并将在 2024 年 12 月 1 日之后的一个版本中删除。

已弃用对 EC2_REGION 环境变量的支持，并将在 2024 年 12 月 1 日之后的一个版本中删除。

resource_type

字符串

要附加到资源策略的资源类型。

除非 policy_type=resource，否则将被忽略。

支持的资源类型包括 AWS::S3::Bucket、AWS::S3::AccessPoint、AWS::S3::MultiRegionAccessPoint 和 AWS::S3ObjectLambda::AccessPoint

对于不支持作为有效值的资源类型，IAM Access Analyzer 将运行适用于所有资源策略的策略检查。

有关支持的区域设置的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/access-analyzer/latest/APIReference/API_ValidatePolicy.html

results_filter

列表 / 元素=字符串

筛选结果并将结果限制为特定结果类型。

选项

  • "error"

  • "security"

  • "suggestion"

  • "warning"

secret_key

别名：aws_secret_access_key、aws_secret_key、ec2_secret_key

字符串

AWS 密钥。

有关访问令牌的更多信息，请参见 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。

也可以按优先级递减顺序使用 AWS_SECRET_ACCESS_KEY、AWS_SECRET_KEY 或 EC2_SECRET_KEY 环境变量。

secret_key 和 profile 选项互斥。

为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。

已弃用 ec2_secret_key 别名，并将在 2024 年 12 月 1 日之后的一个版本中删除。

已弃用对 EC2_SECRET_KEY 环境变量的支持，并将在 2024 年 12 月 1 日之后的一个版本中删除。

session_token

别名：aws_session_token、security_token、aws_security_token、access_token

字符串

与临时凭证一起使用的 AWS STS 会话令牌。

有关访问令牌的更多信息，请参见 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。

也可以按优先级递减顺序使用 AWS_SESSION_TOKEN、AWS_SECURITY_TOKEN 或 EC2_SECURITY_TOKEN 环境变量。

security_token 和 profile 选项互斥。

在 3.2.0 版本中添加了 aws_session_token 和 session_token 别名，在 6.0.0 版本中将参数名称从 security_token 重命名为 session_token。

已弃用 security_token、aws_security_token 和 access_token 别名，并将在 2024 年 12 月 1 日之后的一个版本中删除。

已弃用对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持，并将在 2024 年 12 月 1 日之后的一个版本中删除。

validate_certs

布尔值

设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。

强烈建议不要设置 validate_certs=false，作为替代方案，请考虑改为设置 aws_ca_bundle。

选项

  • false

  • true ← (默认)

注释

注意

  • 警告：对于模块，环境变量和配置文件是从 Ansible 的“主机”上下文而不是“控制器”上下文读取的。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible 的“控制器”上下文而不是“主机”上下文读取的。

  • Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible “主机”上下文中的其配置文件（通常为 ~/.aws/credentials）读取凭据和其他设置的默认值，例如区域。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

# Validate a policy
- name: Validate a simple IAM policy
  community.aws.accessanalyzer_validate_policy_info:
    policy: "{{ lookup('template', 'managed_policy.json.j2') }}"

返回值

此处记录了常见的返回值 此处，以下是此模块特有的字段

键

描述

findings

列表 / 元素=字典

IAM Access Analyzer 根据其策略检查套件返回的策略中的结果列表。

已返回：成功

finding_details

字符串

描述结果的本地化消息。

已返回：成功

示例： "资源 ARN 与预期的 ARN 格式不匹配。 更新 ARN 的资源部分。 "

finding_type

字符串

结果的严重性。

已返回：成功

示例： "ERROR"

issue_code

字符串

发现的问题类型的标识符。

已返回：成功

示例： "INVALID_ARN_RESOURCE"

字符串

指向有关结果类型的附加信息的链接。

已返回：成功

示例： "https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-policy-checks.html"

locations

列表 / 元素=字典

导致建议的项目的所在位置。

已返回：成功

路径

列表 / 元素=字典

策略中的路径，表示为路径元素序列。

已返回：成功

示例： [{"value": "Statement"}, {"index": 0}, {"value": "Resource"}, {"index": 0}]

span

字典

结果引用的策略中的位置。

注意 - 使用查找或将字典传递给 policy 时，策略字符串可能会转换为单行 JSON，从而更改列、行和偏移值。

已返回：成功

end

字典

跨度的结束位置。

已返回：成功

column

整数

位置的列，从 0 开始。

已返回：成功

line

整数

位置的行，从 1 开始。

已返回：成功

offset

整数

与位置相对应的策略中的偏移量，从 0 开始。

已返回：成功

start

字典

跨度的起始位置。

已返回：成功

column

整数

位置的列，从 0 开始。

已返回：成功

line

整数

位置的行，从 1 开始。

已返回：成功

offset

整数

与位置相对应的策略中的偏移量，从 0 开始。

已返回：成功

作者

  • Mark Chappell (@tremble)