剖析 WordPress `wp_safe_redirect()` 函数的源码：如何通过 `wp_redirect_location` 过滤器增强安全性。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷，大家好！我是今天的主讲人，咱们今天聊聊 WordPress 里的 wp_safe_redirect() 这个函数，重点扒一扒它如何通过 wp_redirect_location 过滤器来提高安全性。

第一幕：什么是 wp_safe_redirect()？为什么要用它？

咱们先来认识一下主角 wp_safe_redirect()。简单来说，它就是一个更安全的 wp_redirect()。 wp_redirect() 呢，就是 WordPress 里用来做页面重定向的函数，相当于告诉浏览器：“嘿，别看这儿了，去另一个页面吧！”。

但是，直接用 wp_redirect() 有个问题：它不够安全。想象一下，如果有人能控制你重定向的 URL，那他就可以把你重定向到恶意网站，搞钓鱼，盗取用户信息，想想就可怕。

wp_safe_redirect() 就像是 wp_redirect() 的保镖，它会检查你要重定向的 URL 是否安全，只有确定安全才会放行。那么，它怎么判断安全呢？默认情况下，它会检查 URL 是否在 WordPress 站点的白名单里。

第二幕：wp_safe_redirect() 源码剖析：一层层揭开它的神秘面纱

咱们来一起看看 wp_safe_redirect() 的源码，看看它到底是怎么工作的。

function wp_safe_redirect( $location, $status = 302 ) {
    // Strip out any carriage returns and line feeds
    $location = preg_replace( "/rn|r|n/", '', $location );

    $location = wp_sanitize_redirect( $location );

    /**
     * Filters the safe redirect location.
     *
     * @since 3.0.0
     *
     * @param string $location The redirect location.
     * @param int    $status   The redirect status code.
     */
    $location = apply_filters( 'wp_safe_redirect_location', $location, $status );

    // Need to explicitly call exit() afterward
    wp_redirect( $location, $status );
    exit();
}

咱们一行一行分析：

$location = preg_replace( "/rn|r|n/", '', $location );：这一行把 URL 里的回车换行符给干掉。为什么要这么做？因为有些坏人可能会利用回车换行符来注入恶意代码。
$location = wp_sanitize_redirect( $location );：这一行调用了 wp_sanitize_redirect() 函数，对 URL 进行进一步的清理和过滤。咱们稍后会详细分析这个函数。
$location = apply_filters( 'wp_safe_redirect_location', $location, $status );：这一行是关键！它应用了一个名为 wp_safe_redirect_location 的过滤器。这个过滤器允许我们自定义 URL 的安全检查逻辑。也就是说，我们可以通过这个过滤器来增强 wp_safe_redirect() 的安全性。
wp_redirect( $location, $status );：这一行调用了 wp_redirect() 函数，执行实际的重定向操作。注意，这里的 $location 已经是经过安全检查的 URL 了。
exit();：这一行结束脚本的执行。 非常重要！ 如果没有 exit()，后面的代码还会继续执行，这可能会导致一些意想不到的问题。

第三幕：wp_sanitize_redirect()：又一道安全防线

刚才咱们提到了 wp_sanitize_redirect() 函数，它在 wp_safe_redirect() 中扮演着重要的角色。咱们来看看它的源码：

function wp_sanitize_redirect( $location ) {
    $location = wp_kses_no_null( $location );
    $location = str_replace( '%0d', '', $location ); // Remove line breaks
    $location = str_replace( '%0a', '', $location );
    return $location;
}

这个函数主要做了两件事：

$location = wp_kses_no_null( $location );：调用 wp_kses_no_null() 函数，移除 URL 中的 NULL 字符。 NULL 字符可能会被用来绕过一些安全检查。
$location = str_replace( '%0d', '', $location ); 和 $location = str_replace( '%0a', '', $location );：这两行代码分别移除 URL 中的 %0d 和 %0a，它们分别代表回车符和换行符的 URL 编码。再次强调，移除回车换行符是为了防止恶意代码注入。

第四幕：wp_redirect()：重定向的幕后推手

wp_safe_redirect() 最终会调用 wp_redirect() 来执行重定向。我们也简单看一下 wp_redirect() 的源码：

function wp_redirect( $location, $status = 302 ) {
    global $is_IIS;

    $status = apply_filters( 'wp_redirect_status', $status, $location );

    if ( ! $location ) {
        return false;
    }

    $location = wp_get_location_header( $location );

    if ( headers_sent() ) {
        return false;
    }

    header( 'Location: ' . $location, true, $status );

    return true;
}

wp_redirect() 函数的主要步骤如下：

$status = apply_filters( 'wp_redirect_status', $status, $location );：应用 wp_redirect_status 过滤器，允许修改重定向的状态码（例如 302、301）。
if ( ! $location ) { return false; }：检查 URL 是否为空，如果为空则返回 false。
$location = wp_get_location_header( $location );：调用 wp_get_location_header() 函数，对 URL 进行一些格式化处理。
if ( headers_sent() ) { return false; }：检查 HTTP 头部是否已经发送。如果已经发送，就不能再发送重定向头部了，函数会返回 false。
header( 'Location: ' . $location, true, $status );：发送 Location 头部，告诉浏览器要重定向到哪个 URL。

第五幕： wp_safe_redirect_location 过滤器：安全性增强的利器

现在，终于到了咱们今天的主题：wp_safe_redirect_location 过滤器。咱们前面已经看到，wp_safe_redirect() 在执行重定向之前，会应用这个过滤器。那么，我们如何利用这个过滤器来增强安全性呢？

最常见的用法是，添加我们自己的安全检查逻辑。例如，我们可以检查 URL 是否属于我们允许的域名列表，或者检查 URL 是否包含某些敏感参数。

咱们来看一个例子：

add_filter( 'wp_safe_redirect_location', 'my_custom_safe_redirect', 10, 2 );

function my_custom_safe_redirect( $location, $status ) {
    $allowed_domains = array(
        'example.com',
        'example.net',
        home_url(), // 允许重定向到站内URL
    );

    $url_components = wp_parse_url( $location );

    if ( isset( $url_components['host'] ) ) {
        $host = $url_components['host'];
        if ( ! in_array( $host, $allowed_domains, true ) ) {
            // 如果 URL 的域名不在白名单里，就拒绝重定向
            $location = home_url(); // 重定向到站点首页
        }
    } else {
        // 如果没有 host， 可能是站内链接， 允许
    }

    return $location;
}

这段代码做了以下事情：

add_filter( 'wp_safe_redirect_location', 'my_custom_safe_redirect', 10, 2 );：将 my_custom_safe_redirect 函数注册为 wp_safe_redirect_location 过滤器的回调函数。 10 是优先级，2 是参数个数。
function my_custom_safe_redirect( $location, $status ) { ... }：定义了我们的回调函数。这个函数接收两个参数：$location (要重定向的 URL) 和 $status (重定向状态码)。
$allowed_domains = array( ... );：定义了一个允许的域名列表。只有 URL 的域名在这个列表里，才允许重定向。
$url_components = wp_parse_url( $location );：使用 wp_parse_url() 函数解析 URL，获取 URL 的各个组成部分。
if ( isset( $url_components['host'] ) ) { ... }：检查 URL 是否包含域名 (host)。
$host = $url_components['host'];：获取 URL 的域名。
if ( ! in_array( $host, $allowed_domains, true ) ) { ... }：检查域名是否在允许的域名列表里。如果不在，就将 $location 设置为站点首页的 URL，拒绝重定向到未经授权的域名。
return $location;：返回经过安全检查的 URL。

第六幕：更高级的用法：检查 URL 参数

除了检查域名之外，我们还可以检查 URL 的参数。例如，我们可以检查 URL 是否包含 admin 或 login 等敏感参数。

add_filter( 'wp_safe_redirect_location', 'my_custom_safe_redirect_params', 10, 2 );

function my_custom_safe_redirect_params( $location, $status ) {
    $bad_params = array(
        'admin',
        'login',
        'password',
    );

    $url_components = wp_parse_url( $location );

    if ( isset( $url_components['query'] ) ) {
        parse_str( $url_components['query'], $params );

        foreach ( $bad_params as $param ) {
            if ( isset( $params[ $param ] ) ) {
                // 如果 URL 包含敏感参数，就拒绝重定向
                $location = home_url();
                break;
            }
        }
    }

    return $location;
}

这段代码做了以下事情：

$bad_params = array( ... );：定义了一个敏感参数列表。
if ( isset( $url_components['query'] ) ) { ... }：检查 URL 是否包含查询字符串 (query)。
parse_str( $url_components['query'], $params );：使用 parse_str() 函数将查询字符串解析成一个数组。
foreach ( $bad_params as $param ) { ... }：遍历敏感参数列表。
if ( isset( $params[ $param ] ) ) { ... }：检查查询字符串是否包含敏感参数。如果包含，就将 $location 设置为站点首页的 URL，拒绝重定向到包含敏感参数的 URL。

第七幕：使用场景和最佳实践

wp_safe_redirect() 及其 wp_safe_redirect_location 过滤器在很多场景下都非常有用。比如：

登录/注册页面： 确保用户登录或注册成功后，重定向到安全的页面。
表单提交： 确保表单提交成功后，重定向到正确的页面。
插件设置页面： 确保插件设置保存成功后，重定向到插件的设置页面。

在使用 wp_safe_redirect() 和 wp_safe_redirect_location 过滤器时，应该注意以下几点：

始终使用 wp_safe_redirect() 而不是 wp_redirect()。 这是最重要的一点！
仔细审查你要重定向的 URL。 不要盲目地信任用户输入的 URL。
使用 wp_safe_redirect_location 过滤器来添加你自己的安全检查逻辑。
只允许重定向到你信任的域名。
不要重定向到包含敏感参数的 URL。
确保在 wp_safe_redirect() 之后调用 exit()。

第八幕：总结与展望

总而言之，wp_safe_redirect() 是 WordPress 中一个非常重要的安全函数。通过使用 wp_safe_redirect() 和 wp_safe_redirect_location 过滤器，我们可以有效地防止恶意重定向，保护我们的网站和用户的安全。

掌握 wp_safe_redirect() 的原理和用法，是每个 WordPress 开发者必备的技能。希望今天的讲座对大家有所帮助。

表格总结:

函数/过滤器	作用	备注
`wp_safe_redirect()`	安全地重定向到指定的 URL。它会检查 URL 是否安全，只有确定安全才会放行。	建议始终使用 `wp_safe_redirect()` 而不是 `wp_redirect()`。记得调用 `exit()` 结束脚本执行。
`wp_sanitize_redirect()`	对 URL 进行清理和过滤，移除 NULL 字符和回车换行符等。	`wp_safe_redirect()` 会自动调用此函数。
`wp_redirect()`	执行实际的重定向操作，发送 `Location` 头部。	`wp_safe_redirect()` 在安全检查通过后会调用此函数。
`wp_safe_redirect_location`	过滤器，允许我们自定义 URL 的安全检查逻辑。	可以用来添加自定义的域名白名单、检查 URL 参数等。是增强 `wp_safe_redirect()` 安全性的关键。
`wp_parse_url()`	解析 URL，获取 URL 的各个组成部分（例如域名、路径、查询字符串）。	在 `wp_safe_redirect_location` 过滤器中，经常会使用此函数来获取 URL 的域名和查询字符串，以便进行安全检查。

最后的温馨提示： 安全无小事，要时刻保持警惕，不断学习新的安全知识，才能更好地保护我们的网站！

发表回复 取消回复

发表回复取消回复