gimme-aws-creds 项目教程

gimme-aws-creds 项目教程

gimme-aws-credsA CLI that utilizes Okta IdP via SAML to acquire temporary AWS credentials项目地址:https://gitcode.com/gh_mirrors/gi/gimme-aws-creds

1. 项目的目录结构及介绍

gimme-aws-creds 项目的目录结构如下：

gimme-aws-creds/
├── gimme_aws_creds/
│   ├── __init__.py
│   ├── main.py
│   ├── ui.py
│   ├── config.py
│   ├── okta.py
│   ├── aws.py
│   ├── version.py
│   └── ...
├── tests/
│   ├── __init__.py
│   ├── test_main.py
│   └── ...
├── setup.py
├── README.md
├── LICENSE
└── ...

目录结构介绍

• gimme_aws_creds/: 包含项目的主要代码文件。
  • __init__.py: 初始化文件。
  • main.py: 主程序入口。
  • ui.py: 用户界面相关代码。
  • config.py: 配置文件处理代码。
  • okta.py: Okta 认证相关代码。
  • aws.py: AWS 相关代码。
  • version.py: 版本信息。
• tests/: 包含项目的测试代码。
  • __init__.py: 初始化文件。
  • test_main.py: 主程序的测试代码。
• setup.py: 项目安装脚本。
• README.md: 项目说明文档。
• LICENSE: 项目许可证。

2. 项目的启动文件介绍

项目的启动文件是 gimme_aws_creds/main.py。这个文件包含了程序的主要逻辑和入口点。

主要功能

• 读取配置文件。
• 通过 Okta 进行认证。
• 获取 AWS 临时凭证。
• 选择 AWS 角色。
• 生成并输出 AWS 凭证。

代码示例

from gimme_aws_creds import main

if __name__ == "__main__":
    main.GimmeAWSCreds().run()

3. 项目的配置文件介绍

项目的配置文件通常位于用户主目录下的 .okta_aws_login_config 文件中。这个文件包含了 Okta 和 AWS 的相关配置信息。

配置文件示例

[default]
okta_org_url = https://your-okta-domain.okta.com
client_id = your-client-id
aws_appname = your-aws-appname
aws_rolename = your-aws-rolename

配置项说明

• okta_org_url: Okta 组织的 URL。
• client_id: Okta 客户端 ID。
• aws_appname: AWS 应用程序名称。
• aws_rolename: AWS 角色名称。

通过以上配置，gimme-aws-creds 可以自动完成 Okta 认证和 AWS 凭证的获取。

gimme-aws-credsA CLI that utilizes Okta IdP via SAML to acquire temporary AWS credentials项目地址:https://gitcode.com/gh_mirrors/gi/gimme-aws-creds