跳到主要内容

参数​

请参阅 插件通用配置 了解所有插件可用的配置选项。

  • sp_issuer

    string

    required

    服务提供商 (SP) 在 SAML 认证过程中与身份提供商 (IdP) 通信时使用的唯一标识符。

  • idp_uri

    string

    required

    服务提供商 (SP) 发送认证请求以启动 SAML 认证过程的身份提供商 (IdP) 的 URL。

  • idp_cert

    string

    required

    身份提供商 (IdP) 提供的 X.509 证书，服务提供商 (SP) 使用它来验证 SAML 断言和响应的真实性和完整性。

  • login_callback_uri

    string

    required

    服务提供商 (SP) 上的端点，身份提供商 (IdP) 将在用户成功认证后向其发送 SAML 响应。

    登录回调 URI 应该是路由 URI 的子路径。例如，如果路由 uri 是 /anything/*，则登录回调 URI 可以是 /anything/login_callback。

  • logout_uri

    string

    required

    触发 SAML 注销过程的 URI 路径。

    注销 URI 应该是路由 URI 的子路径。例如，如果路由 uri 是 /anything/*，则注销 URI 可以是 /anything/logout。

  • logout_callback_uri

    string

    required

    服务提供商 (SP) 上接收身份提供商 (IdP) 在注销过程完成后发送的 SAML 注销响应的端点。

    注销回调 URI 应该是路由 URI 的子路径。例如，如果路由 uri 是 /anything/*，则注销回调 URI 可以是 /anything/logout_callback。

  • logout_redirect_uri

    string

    required

    注销过程完成后用户被重定向到的 URI，通常是回到服务提供商 (SP) 的应用程序或指定的着陆页。

    注销重定向 URI 应该是路由 URI 的子路径。例如，如果路由 uri 是 /anything/*，则注销重定向 URI 可以是 /anything/logout_ok。

  • sp_cert

    string

    required

    服务提供商 (SP) 用于签署 SAML 请求和断言的 X.509 证书，确保与身份提供商 (IdP) 的安全通信。

  • sp_private_key

    string

    required

    对应于服务提供商 (SP) 证书 sp_cert 的私钥，用于签署 SAML 请求和解密 SAML 断言。

    该值在存储到数据库前会使用 AES 加密。

  • secret

    string

    required

    vaild vaule:

    8 到 32 个字符

    用于派生加密密钥以保护 SAML 会话数据和令牌的加密密钥。该密钥应为安全的强随机字符串，确保敏感的认证信息被加密且防篡改。

    该值在存储到数据库前会使用 AES 加密。

    该参数从 API7 企业版 3.9.3 起可用。

  • auth_protocol_binding_method

    string

    default: HTTP-Redirect

    vaild vaule:

    HTTP-Redirect 或 HTTP-POST

    认证协议绑定方式。该参数从 API7 企业版 3.9.3 起可用。

    当绑定方式为 HTTP-Redirect 时，插件通过浏览器 GET 请求重定向发送 SAML 消息。插件不会显式配置该绑定的 cookie 属性；cookie 遵循浏览器或底层 HTTP 协议栈的默认设置（例如 SameSite 通常默认为 Lax，Secure 属性可能根据环境而省略）。

    当绑定方式为 HTTP-POST 时，插件通过 POST 请求发送 SAML 消息。Cookie 会显式配置 SameSite=None 并启用 Secure 属性，以支持 HTTPS 上的跨域认证。

  • secret_fallbacks

    array[string]

    密钥轮换期间使用的备用密钥数组。

    该参数从 API7 企业版 3.9.3 起可用。