validate-usernametoken

在允许访问受保护资源之前,请使用 验证用户名令牌 策略来验证 SOAP 有效内容中的 Web Service 安全性 (WS-Security) UsernameToken 。

网关支持

表 1. 该表显示了支持此策略的网关以及对应的策略版本
网关 策略版本
DataPower® Gateway (v5 compatible) 1.0.0

1.1.0

本主题描述如何在 OpenAPI 源中配置策略; 有关如何在组合件用户界面中配置策略的详细信息,请参阅 验证用户名令牌

关于

validate-usernametoken 策略具有以下格式:
- validate-usernametoken:
    version: version
    title: title
    description: description
    auth-type: Authentication URL_or_LDAP Registry (policy version 1.0.0 only)
    auth-url: authentication_url_to_use (policy version 1.0.0 only)
    tls-profile: tls_profile_to_use (policy version 1.0.0 only)
    ldap-registry: name_of_the_ldap_user_registry (policy version 1.0.0 only)
    registry: name_of_the_ldap_or_authurl_user_registry (policy version 1.1.0 and later)
    ldap-search-attribute: name_of_the_ldap_user_password_attribute

属性

下表描述了该策略的属性:

表 2. 验证用户名令牌 策略属性
属性 必需 描述 数据类型
version 策略版本号 字符串
title 策略的标题。 字符串
description False 对策略的描述。 字符串
auth-type(仅适用于策略版本 1.0.0) 用于验证 UsernameToken 的认证类型。
有效值:
  • Authentication URL:指定此值以针对认证 URL 验证用户凭证。
  • LDAP registry:指定此值以针对 LDAP 用户注册表验证用户凭证。
缺省值为:Authentication URL
字符串
auth-url(仅适用于策略版本 1.0.0) 验证 UsernameToken 用户凭证时所依据的认证 URL。
注: 仅当 认证类型 设置为 Authentication URL时,才需要此属性。
字符串
tls-profile(仅适用于策略版本 1.0.0) False 要用于将数据安全传输至认证 URL 的 TLS 概要文件。
注: 仅当 认证类型 设置为 Authentication URL时,此属性才可用。
字符串
ldap-registry(仅适用于策略版本 1.0.0) 验证 UsernameToken 用户凭证时所依据的 LDAP 用户注册表名称。
注: 仅当 认证类型 设置为 LDAP registry时,才需要此属性。
字符串
registry(适用于策略版本 1.1.0 及更高版本) 用于验证 UsernameToken 的 LDAP 或认证 URL 注册表的名称。 字符串
ldap-search-attribute LDAP 用户密码属性的名称。
注: 仅 LDAP 用户注册表需要此属性。
字符串

示例

以下示例显示了 LDAP 用户注册表认证:
- validate-usernametoken:
    version: 1.0.0
    title: "validate-usernametoken"
    auth-type: "LDAP Registry"
    ldap-registry: "wstest"
    ldap-search-attribute: "userPassword"
以下示例显示了认证 URL 定义:
- validate-usernametoken:
    version: 1.0.0
    title: "validate-usernametoken"
    auth-type: "Authentication URL"
    auth-url: "https://www.google.com"
    tls-profile: "default-ssl-profile"

有关如何使用 validate-usernametoken 安全策略的更多信息,请参阅内置策略部分中的 验证用户名令牌