PySAML2 项目使用教程

1. 项目目录结构及介绍

PySAML2 项目的目录结构如下：

pysaml2/
├── docs/
├── example/
├── script/
├── src/
├── tests/
├── .editorconfig
├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── CONTRIBUTING.md
├── DEVELOPERS.md
├── LICENSE
├── README.md
├── RELEASE.md
├── SECURITY.md
├── poetry.lock
└── pyproject.toml

目录介绍

• docs/: 包含项目的文档文件，详细介绍了如何使用 PySAML2。
• example/: 包含一些示例代码，展示了如何使用 PySAML2 构建 SAML2 服务提供商或身份提供商。
• script/: 包含一些脚本文件，可能用于项目的自动化任务。
• src/: 包含 PySAML2 的核心源代码。
• tests/: 包含项目的测试代码，用于确保代码的正确性和稳定性。
• .editorconfig: 配置文件，用于统一代码风格。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件，用于持续集成。
• CHANGELOG.md: 记录项目的变更日志。
• CONTRIBUTING.md: 贡献指南，指导开发者如何为项目贡献代码。
• DEVELOPERS.md: 开发者指南，包含开发和维护项目的相关信息。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和基本使用说明。
• RELEASE.md: 发布指南，包含如何发布新版本的说明。
• SECURITY.md: 安全指南，包含项目的安全相关信息。
• poetry.lock: Poetry 依赖锁定文件。
• pyproject.toml: Poetry 项目配置文件。

2. 项目启动文件介绍

PySAML2 是一个库，没有传统的“启动文件”。它主要通过导入 src 目录中的模块来使用。以下是一个简单的示例，展示了如何导入和使用 PySAML2：

from saml2 import saml
from saml2 import config

# 配置 SAML2 服务提供商
conf = config.SPConfig()
conf.load_file("sp_conf.py")

# 创建 SAML2 服务提供商实例
sp = saml.Server(config=conf)

# 处理 SAML 请求
response = sp.parse_authn_request(request_data)

在这个示例中，config.SPConfig() 用于加载配置文件，saml.Server() 用于创建 SAML2 服务提供商实例。

3. 项目配置文件介绍

PySAML2 的配置文件通常是一个 Python 文件，包含了 SAML2 服务提供商或身份提供商的配置信息。以下是一个简单的配置文件示例：

# sp_conf.py

from saml2 import config

CONFIG = config.SPConfig()

CONFIG.entityid = "https://example.com/saml/metadata"
CONFIG.service = {
    "sp": {
        "endpoints": {
            "assertion_consumer_service": [
                ("https://example.com/saml/acs", saml.BINDING_HTTP_POST),
            ],
        },
        "allow_unsolicited": True,
        "authn_requests_signed": False,
        "logout_requests_signed": True,
        "want_assertions_signed": True,
        "want_response_signed": False,
    },
}

CONFIG.metadata = {
    "local": ["idp_metadata.xml"],
}

CONFIG.key_file = "sp.key"
CONFIG.cert_file = "sp.crt"
CONFIG.encryption_keypairs = [
    {
        "key_file": "sp.key",
        "cert_file": "sp.crt",
    },
]

CONFIG.contact_person = [
    {
        "given_name": "Admin",
        "sur_name": "User",
        "company": "Example Inc.",
        "email_address": "[e-mail]",
        "contact_type": "technical",
    },
]

CONFIG.organization = {
    "name": [("Example Inc.", "en")],
    "display_name": [("Example Inc.", "en")],
    "url": [("https://example.com", "en")],
}

配置文件说明

• entityid: SAML2 实体的唯一标识符。
• service: 定义服务提供商（SP）的端点和行为。
• metadata: 定义元数据的位置，通常是身份提供商（IdP）的元数据文件。
• key_file 和 cert_file: 定义用于签名和加密的密钥和证书文件。
• contact_person: 定义联系人信息。
• organization: 定义组织信息。

通过这些配置，可以定制 SAML2 服务提供商的行为和属性。