Psalm静态分析工具中的自定义污点源配置指南

Psalm静态分析工具中的自定义污点源配置指南

【免费下载链接】psalm A static analysis tool for finding errors in PHP applications 项目地址: https://gitcode.com/gh_mirrors/ps/psalm

什么是污点分析

污点分析(taint analysis)是一种静态代码分析技术，用于追踪不可信数据(污点)在程序中的传播路径。在Psalm静态分析工具中，污点分析可以帮助开发者识别潜在的安全问题，如数据库查询注入、跨站脚本等。

为什么需要自定义污点源

默认情况下，Psalm已经内置了许多常见的污点源识别规则。但在实际项目中，我们经常需要：

1. 标记特定函数或方法作为污点源
2. 根据项目特殊需求定义新的污点类型
3. 对特定变量名或代码模式进行污点标记

两种自定义污点源的方法

1. 使用注解标记污点源

这是最简单直接的方式，通过在函数或方法上添加@psalm-taint-source注解来标记污点源。

/**
 * @psalm-taint-source input
 */
function getUserInput(string $param): string {
    return $_GET[$param] ?? '';
}

注解中的input表示污点类型，Psalm内置了多种污点类型，包括但不限于：

• input：用户输入
• sql：SQL查询相关
• html：HTML输出相关
• shell：shell命令相关
• custom：自定义类型

2. 编写污点分析插件

对于更复杂的场景，可以通过编写插件来实现自定义污点分析逻辑。插件方式提供了更大的灵活性，可以根据变量名、代码模式等条件动态标记污点源。

namespace MyApp\Psalm\Plugin;

use PhpParser\Node\Expr\Variable;
use Psalm\Plugin\EventHandler\AddTaintsInterface;
use Psalm\Plugin\EventHandler\Event\AddRemoveTaintsEvent;
use Psalm\Type\TaintKindGroup;

class SensitiveDataPlugin implements AddTaintsInterface
{
    public static function addTaints(AddRemoveTaintsEvent $event): array
    {
        $expr = $event->getExpr();
        
        // 标记所有名为$externalApiResponse的变量为污点源
        if ($expr instanceof Variable && $expr->name === 'externalApiResponse') {
            return TaintKindGroup::ALL_INPUT;
        }
        
        return [];
    }
}

实际应用场景示例

场景1：标记第三方API返回数据

/**
 * @psalm-taint-source external
 */
function callExternalApi(string $endpoint): array {
    // 调用外部API并返回数据
}

场景2：标记特定格式的日志数据

class Logger {
    /**
     * @psalm-taint-source log
     */
    public function write(string $message): void {
        // 写入日志
    }
}

场景3：通过插件标记敏感配置

class ConfigTaintPlugin implements AddTaintsInterface
{
    public static function addTaints(AddRemoveTaintsEvent $event): array
    {
        if ($event->getExpr() instanceof PropertyFetch
            && $event->getExpr()->var->name === 'config'
        ) {
            return ['config'];
        }
        
        return [];
    }
}

最佳实践建议

1. 明确污点类型：为不同类型的污点使用不同的标识，便于后续分析
2. 适度使用：不要过度标记，只标记真正需要追踪的敏感数据
3. 文档记录：为自定义的污点源添加说明文档
4. 定期审查：随着项目演进，定期审查污点源定义是否仍然合理
5. 结合其他分析：将污点分析与Psalm的其他安全分析功能结合使用

总结

Psalm的自定义污点源功能为开发者提供了强大的安全分析能力。通过注解和插件两种方式，可以灵活地适应各种项目需求，帮助构建更安全的PHP应用程序。无论是简单的函数标记还是复杂的动态分析，Psalm都提供了相应的工具支持。

【免费下载链接】psalm A static analysis tool for finding errors in PHP applications 项目地址: https://gitcode.com/gh_mirrors/ps/psalm